ExLine.Client.Adapter behaviour (ExLine v0.1.0)

Copy Markdown View Source

Behaviour for the HTTP transport used by ExLine.Client.

The default implementation is ExLine.Client.Req. Swapping the adapter is the supported way to mock LINE API calls in tests — assert on the request/1 argument instead of hitting the network.

Example (Mox)

Mox.defmock(MyApp.LineAdapterMock, for: ExLine.Client.Adapter)
client = ExLine.Client.new(access_token: "tok", adapter: MyApp.LineAdapterMock)

Summary

Types

request()

Normalized request handed to the adapter.

response()

Normalized response the adapter must return on a completed HTTP round-trip.

Callbacks

request(request)

Performs the HTTP request.

Types

request()

@type request() :: %{
  method: atom(),
  url: String.t(),
  headers: [{String.t(), String.t()}],
  body: term() | nil,
  raw_body: binary() | nil,
  form: keyword() | map() | nil,
  query: keyword()
}

Normalized request handed to the adapter.

response()

@type response() :: %{status: pos_integer(), body: term(), headers: term()}

Normalized response the adapter must return on a completed HTTP round-trip.

Callbacks

request(request)

@callback request(request()) :: {:ok, response()} | {:error, ExLine.Error.t()}

Performs the HTTP request.

Returns {:ok, response} whenever an HTTP response was received (any status), or {:error, ExLine.Error.t()} for transport-level failures.