HTTPoison.Base behaviour (HTTPoison v2.0.0) View Source

Provides a default implementation for HTTPoison functions.

This module is meant to be use'd in custom modules in order to wrap the functionalities provided by HTTPoison. For example, this is very useful to build API clients around HTTPoison:

defmodule GitHub do
  use HTTPoison.Base

  @endpoint "https://api.github.com"

  def process_request_url(url) do
    @endpoint <> url
  end
end

The example above shows how the GitHub module can wrap HTTPoison functionalities to work with the GitHub API in particular; this way, for example, all requests done through the GitHub module will be done to the GitHub API:

GitHub.get("/users/octocat/orgs")
#=> will issue a GET request at https://api.github.com/users/octocat/orgs

Overriding functions

HTTPoison.Base defines the following list of functions, all of which can be overridden (by redefining them). The following list also shows the typespecs for these functions and a short description.

# Called in order to process the url passed to any request method before
# actually issuing the request.
@spec process_request_url(binary) :: binary
def process_request_url(url)

# Called to arbitrarily process the request body before sending it with the
# request.
@spec process_request_body(term) :: binary
def process_request_body(body)

# Called to arbitrarily process the request headers before sending them
# with the request.
@spec process_request_headers(term) :: [{binary, term}]
def process_request_headers(headers)

# Called to arbitrarily process the request options before sending them
# with the request.
@spec process_request_options(keyword) :: keyword
def process_request_options(options)

# Called before returning the response body returned by a request to the
# caller.
@spec process_response_body(binary) :: term
def process_response_body(body)

# Used when an async request is made; it's called on each chunk that gets
# streamed before returning it to the streaming destination.
@spec process_response_chunk(binary) :: term
def process_response_chunk(chunk)

# Called to process the response headers before returning them to the
# caller.
@spec process_headers([{binary, term}]) :: term
def process_headers(headers)

# Used to arbitrarily process the status code of a response before
# returning it to the caller.
@spec process_response_status_code(integer) :: term
def process_response_status_code(status_code)

Link to this section Summary

Types

body()

headers()

method()

options()

params()

request()

response()

url()

Callbacks

delete(url)

delete(url, headers)

delete(url, headers, options)

delete!(url)

delete!(url, headers)

delete!(url, headers, options)

get(url)

get(url, headers)

get(url, headers, options)

get!(url)

get!(url, headers)

get!(url, headers, options)

head(url)

head(url, headers)

head(url, headers, options)

head!(url)

head!(url, headers)

head!(url, headers, options)

options(url)

options(url, headers)

options(url, headers, options)

options!(url)

options!(url, headers)

options!(url, headers, options)

patch(url, body)

patch(url, body, headers)

patch(url, body, headers, options)

patch!(url, body)

patch!(url, body, headers)

patch!(url, body, headers, options)

post(url, body)

post(url, body, headers)

post(url, body, headers, options)

post!(url, body)

post!(url, body, headers)

post!(url, body, headers, options)

process_headers(list)

process_request_body(body)

process_request_headers(headers)

process_request_options(options)

process_request_params(params)

process_request_url(url)

process_response(response)

process_response_body(binary)

process_response_chunk(binary)

process_response_headers(list)

process_response_status_code(integer)

process_status_code(integer)

process_url(url)

put(url)

put(url, body)

put(url, body, headers)

put(url, body, headers, options)

put!(url)

put!(url, body)

put!(url, body, headers)

put!(url, body, headers, options)

request(t)

request(method, url)

request(method, url, body)

request(method, url, body, headers)

request(method, url, body, headers, options)

request!(method, url)

request!(method, url, body)

request!(method, url, body, headers)

request!(method, url, body, headers, options)

start()

stream_next(t)

Link to this section Types

body()

Specs

body() :: HTTPoison.Request.body()

headers()

Specs

headers() :: HTTPoison.Request.headers()

method()

Specs

method() :: HTTPoison.Request.method()

options()

Specs

options() :: HTTPoison.Request.options()

params()

Specs

params() :: HTTPoison.Request.params()

request()

Specs

request() :: HTTPoison.Request.t()

response()

Specs

response() :: HTTPoison.Response.t()

url()

Specs

url() :: HTTPoison.Request.url()

Link to this section Callbacks

delete(url)

Specs

delete(url()) ::
  {:ok,
   HTTPoison.Response.t()
   | HTTPoison.AsyncResponse.t()
   | HTTPoison.MaybeRedirect.t()}
  | {:error, HTTPoison.Error.t()}

delete(url, headers)

Specs

delete(url(), headers()) ::
  {:ok,
   HTTPoison.Response.t()
   | HTTPoison.AsyncResponse.t()
   | HTTPoison.MaybeRedirect.t()}
  | {:error, HTTPoison.Error.t()}

delete(url, headers, options)

Specs

delete(url(), headers(), options()) ::
  {:ok,
   HTTPoison.Response.t()
   | HTTPoison.AsyncResponse.t()
   | HTTPoison.MaybeRedirect.t()}
  | {:error, HTTPoison.Error.t()}

delete!(url)

Specs

delete!(url()) ::
  HTTPoison.Response.t()
  | HTTPoison.AsyncResponse.t()
  | HTTPoison.MaybeRedirect.t()

delete!(url, headers)

Specs

delete!(url(), headers()) ::
  HTTPoison.Response.t()
  | HTTPoison.AsyncResponse.t()
  | HTTPoison.MaybeRedirect.t()

delete!(url, headers, options)

Specs

delete!(url(), headers(), options()) ::
  HTTPoison.Response.t()
  | HTTPoison.AsyncResponse.t()
  | HTTPoison.MaybeRedirect.t()

get(url)

Specs

get(url()) ::
  {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
  | {:error, HTTPoison.Error.t()}

get(url, headers)

Specs

get(url(), headers()) ::
  {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
  | {:error, HTTPoison.Error.t()}

get(url, headers, options)

Specs

get(url(), headers(), options()) ::
  {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
  | {:error, HTTPoison.Error.t()}

get!(url)

Specs

get!(url()) :: HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()

get!(url, headers)

Specs

get!(url(), headers()) :: HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()

get!(url, headers, options)

Specs

get!(url(), headers(), options()) ::
  HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()

head(url)

Specs

head(url()) ::
  {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
  | {:error, HTTPoison.Error.t()}

head(url, headers)

Specs

head(url(), headers()) ::
  {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
  | {:error, HTTPoison.Error.t()}

head(url, headers, options)

Specs

head(url(), headers(), options()) ::
  {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
  | {:error, HTTPoison.Error.t()}

head!(url)

Specs

head!(url()) :: HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()

head!(url, headers)

Specs

head!(url(), headers()) :: HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()

head!(url, headers, options)

Specs

head!(url(), headers(), options()) ::
  HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()

options(url)

Specs

options(url()) ::
  {:ok,
   HTTPoison.Response.t()
   | HTTPoison.AsyncResponse.t()
   | HTTPoison.MaybeRedirect.t()}
  | {:error, HTTPoison.Error.t()}

options(url, headers)

Specs

options(url(), headers()) ::
  {:ok,
   HTTPoison.Response.t()
   | HTTPoison.AsyncResponse.t()
   | HTTPoison.MaybeRedirect.t()}
  | {:error, HTTPoison.Error.t()}

options(url, headers, options)

Specs

options(url(), headers(), options()) ::
  {:ok,
   HTTPoison.Response.t()
   | HTTPoison.AsyncResponse.t()
   | HTTPoison.MaybeRedirect.t()}
  | {:error, HTTPoison.Error.t()}

options!(url)

Specs

options!(url()) ::
  HTTPoison.Response.t()
  | HTTPoison.AsyncResponse.t()
  | HTTPoison.MaybeRedirect.t()

options!(url, headers)

Specs

options!(url(), headers()) ::
  HTTPoison.Response.t()
  | HTTPoison.AsyncResponse.t()
  | HTTPoison.MaybeRedirect.t()

options!(url, headers, options)

Specs

options!(url(), headers(), options()) ::
  HTTPoison.Response.t()
  | HTTPoison.AsyncResponse.t()
  | HTTPoison.MaybeRedirect.t()

patch(url, body)

Specs

patch(url(), body()) ::
  {:ok,
   HTTPoison.Response.t()
   | HTTPoison.AsyncResponse.t()
   | HTTPoison.MaybeRedirect.t()}
  | {:error, HTTPoison.Error.t()}

patch(url, body, headers)

Specs

patch(url(), body(), headers()) ::
  {:ok,
   HTTPoison.Response.t()
   | HTTPoison.AsyncResponse.t()
   | HTTPoison.MaybeRedirect.t()}
  | {:error, HTTPoison.Error.t()}

patch(url, body, headers, options)

Specs

patch(url(), body(), headers(), options()) ::
  {:ok,
   HTTPoison.Response.t()
   | HTTPoison.AsyncResponse.t()
   | HTTPoison.MaybeRedirect.t()}
  | {:error, HTTPoison.Error.t()}

patch!(url, body)

Specs

patch!(url(), body()) ::
  HTTPoison.Response.t()
  | HTTPoison.AsyncResponse.t()
  | HTTPoison.MaybeRedirect.t()

patch!(url, body, headers)

Specs

patch!(url(), body(), headers()) ::
  HTTPoison.Response.t()
  | HTTPoison.AsyncResponse.t()
  | HTTPoison.MaybeRedirect.t()

patch!(url, body, headers, options)

Specs

patch!(url(), body(), headers(), options()) ::
  HTTPoison.Response.t()
  | HTTPoison.AsyncResponse.t()
  | HTTPoison.MaybeRedirect.t()

post(url, body)

Specs

post(url(), body()) ::
  {:ok,
   HTTPoison.Response.t()
   | HTTPoison.AsyncResponse.t()
   | HTTPoison.MaybeRedirect.t()}
  | {:error, HTTPoison.Error.t()}

post(url, body, headers)

Specs

post(url(), body(), headers()) ::
  {:ok,
   HTTPoison.Response.t()
   | HTTPoison.AsyncResponse.t()
   | HTTPoison.MaybeRedirect.t()}
  | {:error, HTTPoison.Error.t()}

post(url, body, headers, options)

Specs

post(url(), body(), headers(), options()) ::
  {:ok,
   HTTPoison.Response.t()
   | HTTPoison.AsyncResponse.t()
   | HTTPoison.MaybeRedirect.t()}
  | {:error, HTTPoison.Error.t()}

post!(url, body)

Specs

post!(url(), body()) ::
  HTTPoison.Response.t()
  | HTTPoison.AsyncResponse.t()
  | HTTPoison.MaybeRedirect.t()

post!(url, body, headers)

Specs

post!(url(), body(), headers()) ::
  HTTPoison.Response.t()
  | HTTPoison.AsyncResponse.t()
  | HTTPoison.MaybeRedirect.t()

post!(url, body, headers, options)

Specs

post!(url(), body(), headers(), options()) ::
  HTTPoison.Response.t()
  | HTTPoison.AsyncResponse.t()
  | HTTPoison.MaybeRedirect.t()

process_headers(list)

Specs

process_headers(list()) :: term()

process_request_body(body)

Specs

process_request_body(body()) :: body()

process_request_headers(headers)

Specs

process_request_headers(headers()) :: headers()

process_request_options(options)

Specs

process_request_options(options()) :: options()

process_request_params(params)

Specs

process_request_params(params()) :: params()

process_request_url(url)

Specs

process_request_url(url()) :: url()

process_response(response)

Specs

process_response(response()) :: term()

process_response_body(binary)

Specs

process_response_body(binary()) :: term()

process_response_chunk(binary)

Specs

process_response_chunk(binary()) :: term()

process_response_headers(list)

Specs

process_response_headers(list()) :: term()

process_response_status_code(integer)

Specs

process_response_status_code(integer()) :: term()

process_status_code(integer)

Specs

process_status_code(integer()) :: term()

process_url(url)

Specs

process_url(url()) :: url()

put(url)

Specs

put(url()) ::
  {:ok,
   HTTPoison.Response.t()
   | HTTPoison.AsyncResponse.t()
   | HTTPoison.MaybeRedirect.t()}
  | {:error, HTTPoison.Error.t()}

put(url, body)

Specs

put(url(), body()) ::
  {:ok,
   HTTPoison.Response.t()
   | HTTPoison.AsyncResponse.t()
   | HTTPoison.MaybeRedirect.t()}
  | {:error, HTTPoison.Error.t()}

put(url, body, headers)

Specs

put(url(), body(), headers()) ::
  {:ok,
   HTTPoison.Response.t()
   | HTTPoison.AsyncResponse.t()
   | HTTPoison.MaybeRedirect.t()}
  | {:error, HTTPoison.Error.t()}

put(url, body, headers, options)

Specs

put(url(), body(), headers(), options()) ::
  {:ok,
   HTTPoison.Response.t()
   | HTTPoison.AsyncResponse.t()
   | HTTPoison.MaybeRedirect.t()}
  | {:error, HTTPoison.Error.t()}

put!(url)

Specs

put!(url()) ::
  HTTPoison.Response.t()
  | HTTPoison.AsyncResponse.t()
  | HTTPoison.MaybeRedirect.t()

put!(url, body)

Specs

put!(url(), body()) ::
  HTTPoison.Response.t()
  | HTTPoison.AsyncResponse.t()
  | HTTPoison.MaybeRedirect.t()

put!(url, body, headers)

Specs

put!(url(), body(), headers()) ::
  HTTPoison.Response.t()
  | HTTPoison.AsyncResponse.t()
  | HTTPoison.MaybeRedirect.t()

put!(url, body, headers, options)

Specs

put!(url(), body(), headers(), options()) ::
  HTTPoison.Response.t()
  | HTTPoison.AsyncResponse.t()
  | HTTPoison.MaybeRedirect.t()

request(t)

Specs

request(HTTPoison.Request.t()) ::
  {:ok,
   HTTPoison.Response.t()
   | HTTPoison.AsyncResponse.t()
   | HTTPoison.MaybeRedirect.t()}
  | {:error, HTTPoison.Error.t()}

request(method, url)

Specs

request(method(), url()) ::
  {:ok,
   HTTPoison.Response.t()
   | HTTPoison.AsyncResponse.t()
   | HTTPoison.MaybeRedirect.t()}
  | {:error, HTTPoison.Error.t()}

request(method, url, body)

Specs

request(method(), url(), body()) ::
  {:ok,
   HTTPoison.Response.t()
   | HTTPoison.AsyncResponse.t()
   | HTTPoison.MaybeRedirect.t()}
  | {:error, HTTPoison.Error.t()}

request(method, url, body, headers)

Specs

request(method(), url(), body(), headers()) ::
  {:ok,
   HTTPoison.Response.t()
   | HTTPoison.AsyncResponse.t()
   | HTTPoison.MaybeRedirect.t()}
  | {:error, HTTPoison.Error.t()}

request(method, url, body, headers, options)

Specs

request(method(), url(), body(), headers(), options()) ::
  {:ok,
   HTTPoison.Response.t()
   | HTTPoison.AsyncResponse.t()
   | HTTPoison.MaybeRedirect.t()}
  | {:error, HTTPoison.Error.t()}

request!(method, url)

Specs

request!(method(), url()) ::
  HTTPoison.Response.t()
  | HTTPoison.AsyncResponse.t()
  | HTTPoison.MaybeRedirect.t()

request!(method, url, body)

Specs

request!(method(), url(), body()) ::
  HTTPoison.Response.t()
  | HTTPoison.AsyncResponse.t()
  | HTTPoison.MaybeRedirect.t()

request!(method, url, body, headers)

Specs

request!(method(), url(), body(), headers()) ::
  HTTPoison.Response.t()
  | HTTPoison.AsyncResponse.t()
  | HTTPoison.MaybeRedirect.t()

request!(method, url, body, headers, options)

Specs

request!(method(), url(), body(), headers(), options()) ::
  HTTPoison.Response.t()
  | HTTPoison.AsyncResponse.t()
  | HTTPoison.MaybeRedirect.t()

start()

Specs

start() :: {:ok, [atom()]} | {:error, term()}

stream_next(t)

Specs

stream_next(HTTPoison.AsyncResponse.t()) ::
  {:ok, HTTPoison.AsyncResponse.t()} | {:error, HTTPoison.Error.t()}