View Source Assent.HTTPAdapter behaviour (Assent v0.2.9)

HTTP adapter helper module.

You can configure the which HTTP adapter Assent uses by setting the configuring:

http_adapter: Assent.HTTPAdapter.Httpc

Default options can be set by passing a list of options:

http_adapter: {Assent.HTTPAdapter.Httpc, [...]}

You can also set global application config:

config :assent, :http_adapter, Assent.HTTPAdapter.Httpc

Usage

defmodule MyApp.MyHTTPAdapter do
  @behaviour Assent.HTTPAdapter

  @impl true
  def request(method, url, body, headers, opts) do
    # ...
  end
end

body()

headers()

method()

Sets a user agent header

@type body() :: binary() | nil

@type headers() :: [{binary(), binary()}]

@type method() :: :get | :post

@callback request(method(), binary(), body(), headers(), Keyword.t()) ::
  {:ok, map()} | {:error, any()}

@spec user_agent_header() :: {binary(), binary()}

Sets a user agent header

The header value will be Assent-VERSION with VERSION being the :vsn of :assent app.