myhttp

README

MyHttp

Easy to use API to make timeout supported http GET requests in Go.

MyHttp is for coders who don't want to write timeout support logic and don't want to deal with heavy APIs, just to make http GET request in Go.

It's battle-tested in production and has tests which even verifies connection leaking issues.

I'd been dealing with this issue myself, I read many documents, and saw that there are no simple and lightweight APIs to do http GET request with timeout logic. So, I created MyHttp in one of my projects and wanted to move it here.

Installation

go get github.com/inancgumus/myhttp

Documentation

See MyHttp GoDoc for the documentation.

Usage example

Get

Get simply gets the url and returns an http.Response.

import (
	"time"
	"github.com/inancgumus/myhttp"
)

mh := myhttp.New(time.Second * 10) // timeout after 10 seconds

res, err := mh.Get("http://www.domain.com/foo")
if err != nil {
	panic(err)
}

// use res here...

WrapGet

WrapGet accepts a function in its second argument and runs it after getting the http.Response from the url and automatically closes the http.Response.Body, in case you may forget to close it.

import (
	"time"
	"github.com/inancgumus/myhttp"
)

mh := myhttp.New(time.Second * 10) // timeout after 10 seconds

err := mh.WrapGet("http://www.domain.com/foo", func(r *http.Response) error {
	// use res here...
	// MyHttp will automatically close http.Response.Body for you after this func ends.
})

if err != nil {
	panic(err)
}

Author

Inanc Gumus – @inancgumus – inanc@pixenka.com

Distributed under the MIT license. See LICENSE for more information.

Contributing

1. Fork it (https://github.com/inancgumus/myhttp/fork)
2. Create your feature branch (git checkout -b feature/foo)
3. Commit your changes (git commit -am 'add: foo')
4. Push to the branch (git push origin feature/foo)
5. Create a new Pull Request

Documentation

Index

• type Getter
  • func New(to time.Duration) *Getter
  • func (g *Getter) Get(url string) (*http.Response, error)
  • func (g *Getter) WrapGet(url string, do func(r *http.Response) error) error
• type HTTPGetter

Types

type Getter

type Getter struct {
	Timeout time.Duration
	Client  *http.Client
}

Getter are for implementing HTTPGetter interface and reserved for the future work

func New

func New(to time.Duration) *Getter

New creates a new Getter

func (*Getter) Get

func (g *Getter) Get(url string) (*http.Response, error)

Get fetches url with a timeout

func (*Getter) WrapGet

func (g *Getter) WrapGet(url string, do func(r *http.Response) error) error

WrapGet gets from `url` and closes the body automatically after running in `do`

type HTTPGetter

type HTTPGetter interface {
	Get(url string) (*http.Response, error)
	WrapGet(url string, do func(r *http.Response) error) error
}

HTTPGetter does a get request to a http endpoint