AccessGrid.HttpClient.Behaviour behaviour (AccessGrid v0.1.0)

Copy Markdown View Source

Behaviour for HTTP clients.

Implementations must normalize responses to AccessGrid.HttpResponse and errors to AccessGrid.HttpFailure.

Summary

Types

request_opts()
url()

Callbacks

delete(url, request_opts)

Performs an HTTP DELETE request.

get(url, request_opts)

Performs an HTTP GET request.

head(url, request_opts)

Performs an HTTP HEAD request.

patch(url, request_opts)

Performs an HTTP PATCH request.

post(url, request_opts)

Performs an HTTP POST request.

put(url, request_opts)

Performs an HTTP PUT request.

Types

request_opts()

@type request_opts() :: %{
  optional(:headers) => [{String.t(), String.t()}],
  optional(:params) => %{optional(String.t()) => String.t()},
  optional(:timeout) => integer(),
  optional(:body) => term()
}

url()

@type url() :: String.t()

Callbacks

delete(url, request_opts)

@callback delete(url(), request_opts()) ::
  {:ok, AccessGrid.HttpResponse.t()} | {:error, AccessGrid.HttpFailure.t()}

Performs an HTTP DELETE request.

get(url, request_opts)

@callback get(url(), request_opts()) ::
  {:ok, AccessGrid.HttpResponse.t()} | {:error, AccessGrid.HttpFailure.t()}

Performs an HTTP GET request.

head(url, request_opts)

@callback head(url(), request_opts()) ::
  {:ok, AccessGrid.HttpResponse.t()} | {:error, AccessGrid.HttpFailure.t()}

Performs an HTTP HEAD request.

patch(url, request_opts)

@callback patch(url(), request_opts()) ::
  {:ok, AccessGrid.HttpResponse.t()} | {:error, AccessGrid.HttpFailure.t()}

Performs an HTTP PATCH request.

post(url, request_opts)

@callback post(url(), request_opts()) ::
  {:ok, AccessGrid.HttpResponse.t()} | {:error, AccessGrid.HttpFailure.t()}

Performs an HTTP POST request.

put(url, request_opts)

@callback put(url(), request_opts()) ::
  {:ok, AccessGrid.HttpResponse.t()} | {:error, AccessGrid.HttpFailure.t()}

Performs an HTTP PUT request.