http

Documentation

Overview

Package http is a generated GoMock package.

Package http is a generated GoMock package.

Index

• Constants
• Variables
• type AddHeaderTransport
  • func (adt *AddHeaderTransport) RoundTrip(req *http.Request) (*http.Response, error)
• type Client
  • func NewClient[R interface{}](args ClientArgs) Client[R]
• type ClientArgs
• type CookieJar
• type MockClient
  • func NewMockClient[R interface{}](ctrl *gomock.Controller) *MockClient[R]
  • func (m *MockClient[R]) Do(req *http.Request) (*http.Response, error)
  • func (m *MockClient[R]) EXPECT() *MockClientMockRecorder[R]
  • func (m *MockClient[R]) NewRequest(method, url string, body io.Reader) (*http.Request, error)
  • func (m *MockClient[R]) Send(request Request) (Result[R], error)
• type MockClientMockRecorder
  • func (mr *MockClientMockRecorder[R]) Do(req interface{}) *gomock.Call
  • func (mr *MockClientMockRecorder[R]) NewRequest(method, url, body interface{}) *gomock.Call
  • func (mr *MockClientMockRecorder[R]) Send(request interface{}) *gomock.Call
• type MockCookieJar
  • func NewMockCookieJar(ctrl *gomock.Controller) *MockCookieJar
  • func (m *MockCookieJar) Cookies(u *url.URL) []*http.Cookie
  • func (m *MockCookieJar) EXPECT() *MockCookieJarMockRecorder
  • func (m *MockCookieJar) Save() error
  • func (m *MockCookieJar) SetCookies(u *url.URL, cookies []*http.Cookie)
• type MockCookieJarMockRecorder
  • func (mr *MockCookieJarMockRecorder) Cookies(u interface{}) *gomock.Call
  • func (mr *MockCookieJarMockRecorder) Save() *gomock.Call
  • func (mr *MockCookieJarMockRecorder) SetCookies(u, cookies interface{}) *gomock.Call
• type Payload
• type Request
• type ResponseFormat
• type Result
• type URLPayload
• type XMLPayload

Constants

const (
	MethodGET  = "GET"
	MethodPOST = "POST"
)

Variables

var (
	ErrCreateRequest          = errors.New("failed to create HTTP request")
	ErrEncodePayloadXML       = errors.New("failed to encode XML object")
	ErrGetPayloadData         = errors.New("failed to get payload data")
	ErrGetResponseBody        = errors.New("failed to get response body")
	ErrRequest                = errors.New("failed to send request")
	ErrSaveCookie             = errors.New("failed to save cookies")
	ErrUnmarshalJSON          = errors.New("failed to unmarshal JSON data")
	ErrUnmarshalXML           = errors.New("failed to unmarshal XML data")
	ErrUnsupportedContentType = errors.New("unsupported response body content type")
	ErrUnsupportedValueType   = errors.New("unsupported value type")
)

Types

type AddHeaderTransport

type AddHeaderTransport struct {
	T http.RoundTripper
}

func (*AddHeaderTransport) RoundTrip

func (adt *AddHeaderTransport) RoundTrip(req *http.Request) (*http.Response, error)

type Client

type Client[R interface{}] interface {
	Send(request Request) (Result[R], error)
	Do(req *http.Request) (*http.Response, error)
	NewRequest(method, url string, body io.Reader) (*http.Request, error)
}

func NewClient

func NewClient[R interface{}](args ClientArgs) Client[R]

type ClientArgs

type ClientArgs struct {
	CookieJar CookieJar
}

type CookieJar

type CookieJar interface {
	http.CookieJar

	Save() error
}

type MockClient

type MockClient[R interface{}] struct {
	// contains filtered or unexported fields
}

MockClient is a mock of Client interface.

func NewMockClient

func NewMockClient[R interface{}](ctrl *gomock.Controller) *MockClient[R]

NewMockClient creates a new mock instance.

func (*MockClient[R]) Do

func (m *MockClient[R]) Do(req *http.Request) (*http.Response, error)

Do mocks base method.

func (*MockClient[R]) EXPECT

func (m *MockClient[R]) EXPECT() *MockClientMockRecorder[R]

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockClient[R]) NewRequest

func (m *MockClient[R]) NewRequest(method, url string, body io.Reader) (*http.Request, error)

NewRequest mocks base method.

func (*MockClient[R]) Send

func (m *MockClient[R]) Send(request Request) (Result[R], error)

Send mocks base method.

type MockClientMockRecorder

type MockClientMockRecorder[R interface{}] struct {
	// contains filtered or unexported fields
}

MockClientMockRecorder is the mock recorder for MockClient.

func (*MockClientMockRecorder[R]) Do

func (mr *MockClientMockRecorder[R]) Do(req interface{}) *gomock.Call

Do indicates an expected call of Do.

func (*MockClientMockRecorder[R]) NewRequest

func (mr *MockClientMockRecorder[R]) NewRequest(method, url, body interface{}) *gomock.Call

NewRequest indicates an expected call of NewRequest.

func (*MockClientMockRecorder[R]) Send

func (mr *MockClientMockRecorder[R]) Send(request interface{}) *gomock.Call

Send indicates an expected call of Send.

type MockCookieJar

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

MockCookieJar is a mock of CookieJar interface.

func NewMockCookieJar

func NewMockCookieJar(ctrl *gomock.Controller) *MockCookieJar

NewMockCookieJar creates a new mock instance.

func (*MockCookieJar) Cookies

func (m *MockCookieJar) Cookies(u *url.URL) []*http.Cookie

Cookies mocks base method.

func (*MockCookieJar) EXPECT

func (m *MockCookieJar) EXPECT() *MockCookieJarMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockCookieJar) Save

func (m *MockCookieJar) Save() error

Save mocks base method.

func (*MockCookieJar) SetCookies

func (m *MockCookieJar) SetCookies(u *url.URL, cookies []*http.Cookie)

SetCookies mocks base method.

type MockCookieJarMockRecorder

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

MockCookieJarMockRecorder is the mock recorder for MockCookieJar.

func (*MockCookieJarMockRecorder) Cookies

func (mr *MockCookieJarMockRecorder) Cookies(u interface{}) *gomock.Call

Cookies indicates an expected call of Cookies.

func (*MockCookieJarMockRecorder) Save

func (mr *MockCookieJarMockRecorder) Save() *gomock.Call

Save indicates an expected call of Save.

func (*MockCookieJarMockRecorder) SetCookies

func (mr *MockCookieJarMockRecorder) SetCookies(u, cookies interface{}) *gomock.Call

SetCookies indicates an expected call of SetCookies.

type Payload

type Payload interface {
	// contains filtered or unexported methods
}

type Request

type Request struct {
	Method         string
	URL            string
	Headers        map[string]string
	Payload        Payload
	ResponseFormat ResponseFormat
}

type ResponseFormat

type ResponseFormat string

const (
	ResponseFormatJSON ResponseFormat = "json"
	ResponseFormatXML  ResponseFormat = "xml"
	DefaultUserAgent                  = "Configurator/2.15 (Macintosh; OperatingSystem X 11.0.0; 16G29) AppleWebKit/2603.3.8"
)

type Result

type Result[R interface{}] struct {
	StatusCode int
	Headers    map[string]string
	Data       R
}

type URLPayload

type URLPayload struct {
	Content map[string]interface{}
}

type XMLPayload

type XMLPayload struct {
	Content map[string]interface{}
}