client

package

v1.1.16 Latest Latest Go to latest Published: Apr 8, 2024 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/Moranilt/http-utils

Links

Open Source Insights

README ¶

Client

It's an implementation of http.Client

You can use it to make requests to the server and easy to mock in tests using client_mock package.

Example of usage

repository.go:

type Repository struct {
  client Client
}

func New(client Client) *Repository {
  return &Repository{
    client: client,
  }
}

func (repo *Repository) CustomFunction(ctx context.Context, userName string) (string, error) {
  response, err := repo.client.Post(context.Background(), "http://test.com/users", []byte(userName), map[string]string{
    "Content-Type": "application/json",
  })
  if err != nil {
    return "", fmt.Errorf("error: %v", err)
  }
  return http.StatusText(response.StatusCode), nil
}

repository_test.go:

func TestCustomFunction(t *testing.T) {
  var (
    url      = "http://test.com/users"
    body     = []byte("test")
    err      error
    response = &http.Response{
      StatusCode: http.StatusOK,
    }
    headers = map[string]string{
      "Content-Type": "application/json",
    }

    mockedClient = client_mock.New()
    mockedRepo = New(mockedClient)
  )

  mockedClient.ExpectPost(url, body, err, response, headers)

  result, err := mockedRepo.CustomFunction(context.Background(), "test")
  if err != nil {
    t.Error(err)
  }

  if result != http.StatusText(http.StatusOK) {
    t.Errorf("not equal responses, expect %s, go %s", http.StatusText(http.StatusOK), result)
  }

  if err := mockedClient.AllExpectationsDone(); err != nil {
    t.Error(err)
  }
}

Documentation ¶

Index ¶

Constants
func GetIP(req *http.Request) string
func SetTimeout(val time.Duration)
func Timeout() time.Duration
type Client
- func New() Client
type Expecter
type Headers
- func NewHeaders(h map[string]string) Headers
type HeadersStore
type Method
type MockedClient
type Mocker
- func NewMock() Mocker

Constants ¶

View Source

const (
	ERR_Unexpected_Method  = "call %q expected method %q, got %q"
	ERR_Unexpected_Url     = "call %q expected url %q, got %q"
	ERR_Unexpected_Data    = "call %q expected data %v, got %v"
	ERR_Unexpected_Headers = "call %q expected headers %v, got %v"
)

Variables ¶

This section is empty.

Functions ¶

func GetIP ¶

func GetIP(req *http.Request) string

Get IP address from request using X-Real-IP or X-Forwarded-For headers

func SetTimeout ¶

func SetTimeout(val time.Duration)

Set request timeout

func Timeout ¶

func Timeout() time.Duration

Get request timeout

Types ¶

type Client ¶

type Client interface {
	Post(ctx context.Context, url string, body []byte, headers Headers) (*http.Response, error)
	Put(ctx context.Context, url string, body []byte, headers Headers) (*http.Response, error)
	Patch(ctx context.Context, url string, body []byte, headers Headers) (*http.Response, error)
	Delete(ctx context.Context, url string, body []byte, headers Headers) (*http.Response, error)
	Get(ctx context.Context, url string, headers Headers) (*http.Response, error)

	Do(ctx context.Context, method Method, url string, body []byte, headers Headers) (*http.Response, error)
}

func New ¶

func New() Client

Create new Client instance

type Expecter ¶ added in v1.1.13

type Expecter interface {
	ExpectPost(url string, body []byte, err error, response *http.Response, headers Headers)
	ExpectPut(url string, body []byte, err error, response *http.Response, headers Headers)
	ExpectPatch(url string, body []byte, err error, response *http.Response, headers Headers)
	ExpectDelete(url string, body []byte, err error, response *http.Response, headers Headers)
	ExpectGet(url string, err error, response *http.Response, headers Headers)
	ExpectDo(url string, method Method, body []byte, err error, response *http.Response, headers Headers)

	AllExpectationsDone() error
	Reset()
}

type Headers ¶ added in v1.1.14

type Headers interface {
	Set(key, value string)
	Keys() []string
	Get(key string) string
	Value() map[string]string
}

func NewHeaders ¶ added in v1.1.14

func NewHeaders(h map[string]string) Headers

type HeadersStore ¶ added in v1.1.14

type HeadersStore map[string]string

func (HeadersStore) Get ¶ added in v1.1.14

func (h HeadersStore) Get(key string) string

func (HeadersStore) Keys ¶ added in v1.1.14

func (h HeadersStore) Keys() []string

func (HeadersStore) Set ¶ added in v1.1.14

func (h HeadersStore) Set(key, value string)

func (HeadersStore) Value ¶ added in v1.1.14

func (h HeadersStore) Value() map[string]string

type Method ¶ added in v1.1.13

type Method string

const (
	MethodGet    Method = http.MethodGet
	MethodPost   Method = http.MethodPost
	MethodPut    Method = http.MethodPut
	MethodPatch  Method = http.MethodPatch
	MethodDelete Method = http.MethodDelete
)

type MockedClient ¶ added in v1.1.13

type MockedClient struct {
	// contains filtered or unexported fields
}

func (*MockedClient) AllExpectationsDone ¶ added in v1.1.13

func (m *MockedClient) AllExpectationsDone() error

Check if all expected calls were done

func (*MockedClient) Delete ¶ added in v1.1.13

func (m *MockedClient) Delete(ctx context.Context, url string, body []byte, headers Headers) (*http.Response, error)

Check if call of Post method was expected and returning expected response and error