line_bot v0.1.0 LineBot.APIClient View Source

An implementation of HTTPoison.Base for making API calls to the Messaging API.

API Client

This module is for creating and sending HTTP requests manually. To use the documented messaging API endpoints, use the LineBot module, which calls the functions in this module.

Implementation

This module extends HTTPoison.Base with the following behaviour:

The Authorization header containing the bearer token is automatically added. The access token is retreived from LineBot.TokenServer.
URLs are automatically prefixed with https://api.line.me/v2/bot/. When making a request, only the path after this prefix is required.
JSON responses are automatically decoded.
POST requests are automatically encoded into JSON, and the appropriate Content-Type header is added.
401 Unauthorized errors are caught. When an unauthorized request is received, an attempt to retrieve a new access token is made by calling LineBot.TokenServer.purge/0. However, after three successive unauthorized errors, further unauthorized responses are returned directly.

Link to this section Summary

Types

body()

headers()

options()

params()

request()

url()

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

delete(url, headers \\ [], options \\ [])

Issues a DELETE request to the given url.

delete!(url, headers \\ [], options \\ [])

Issues a DELETE request to the given url, raising an exception in case of failure.

get(url, headers \\ [], options \\ [])

Issues a GET request to the given url.

get!(url, headers \\ [], options \\ [])

Issues a GET request to the given url, raising an exception in case of failure.

head(url, headers \\ [], options \\ [])

Issues a HEAD request to the given url.

head!(url, headers \\ [], options \\ [])

Issues a HEAD request to the given url, raising an exception in case of failure.

options(url, headers \\ [], options \\ [])

Issues an OPTIONS request to the given url.

options!(url, headers \\ [], options \\ [])

Issues a OPTIONS request to the given url, raising an exception in case of failure.

patch(url, body, headers \\ [], options \\ [])

Issues a PATCH request to the given url.

patch!(url, body, headers \\ [], options \\ [])

Issues a PATCH request to the given url, raising an exception in case of failure.

post(url, body, headers \\ [])

Issues a POST request to the given url. The body is automatically encoded into JSON, and the Content-Type header is added.

post(url, body, headers \\ [], options \\ [])

Issues a POST request to the given url.

post!(url, body, headers \\ [])

Issues a POST request to the given url. The body is automatically encoded into JSON, and the Content-Type header is added.

post!(url, body, headers \\ [], options \\ [])

Issues a POST request to the given url, raising an exception in case of failure.

process_headers(headers) deprecated

Callback implementation for HTTPoison.Base.process_headers/1.

process_request_body(body)

Callback implementation for HTTPoison.Base.process_request_body/1.

process_request_headers(headers)

Adds the OAuth Bearer token to the Authorization header. The token is retrieved by calling LineBot.TokenServer.get_token/0.

process_request_options(options)

Callback implementation for HTTPoison.Base.process_request_options/1.

process_request_params(params)

Callback implementation for HTTPoison.Base.process_request_params/1.

process_request_url(url)

Prepends the request url with https://api.line.me/v2/bot/.

process_response(response)

If the reponse headers indidate that the response is JSON, the response body is automatically decoded.

process_response_body(body)

Callback implementation for HTTPoison.Base.process_response_body/1.

process_response_chunk(chunk)

Callback implementation for HTTPoison.Base.process_response_chunk/1.

process_response_headers(headers)

Callback implementation for HTTPoison.Base.process_response_headers/1.

process_response_status_code(status_code)

Callback implementation for HTTPoison.Base.process_response_status_code/1.

process_status_code(status_code) deprecated

Callback implementation for HTTPoison.Base.process_status_code/1.

process_url(url) deprecated

Callback implementation for HTTPoison.Base.process_url/1.

put(url, body \\ "", headers \\ [], options \\ [])

Issues a PUT request to the given url.

put!(url, body \\ "", headers \\ [], options \\ [])

Issues a PUT request to the given url, raising an exception in case of failure.

request(request)

Issues an HTTP request using a Request struct.

request(method, url, body \\ "", headers \\ [], options \\ [])

In addition to the HTTPoison.request/5 behaviour, will automatically refresh the access token after an unauthorized request. Gives up after three subsequent unauthorized errors.

request!(method, url, body \\ "", headers \\ [], options \\ [])

Issues an HTTP request with the given method to the given url, raising an exception in case of failure.

start()

Starts HTTPoison and its dependencies.

start_link(opts)

stream_next(resp)

Requests the next message to be streamed for a given HTTPoison.AsyncResponse.

Link to this section Types

body()

body() :: HTTPoison.Base.body()

headers()

headers() :: HTTPoison.Base.headers()

options()

options() :: HTTPoison.Base.options()

params()

params() :: HTTPoison.Base.params()

request()

request() :: HTTPoison.Base.request()

url()

url() :: HTTPoison.Base.url()

Link to this section Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

delete(url, headers \\ [], options \\ [])

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

Issues a DELETE request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

delete!(url, headers \\ [], options \\ [])

delete!(binary(), headers(), Keyword.t()) ::
  HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()

Issues a DELETE request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

get(url, headers \\ [], options \\ [])

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

Issues a GET request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

get!(url, headers \\ [], options \\ [])

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

Issues a GET request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

head(url, headers \\ [], options \\ [])

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

Issues a HEAD request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

head!(url, headers \\ [], options \\ [])

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

Issues a HEAD request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

options(url, headers \\ [], options \\ [])

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

Issues an OPTIONS request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

options!(url, headers \\ [], options \\ [])

options!(binary(), headers(), Keyword.t()) ::
  HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()

Issues a OPTIONS request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

patch(url, body, headers \\ [], options \\ [])

patch(binary(), any(), headers(), Keyword.t()) ::
  {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
  | {:error, HTTPoison.Error.t()}

Issues a PATCH request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

patch!(url, body, headers \\ [], options \\ [])

patch!(binary(), any(), headers(), Keyword.t()) ::
  HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()

Issues a PATCH request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

post(url, body, headers \\ [])

Issues a POST request to the given url. The body is automatically encoded into JSON, and the Content-Type header is added.

post(url, body, headers \\ [], options \\ [])

post(binary(), any(), headers(), Keyword.t()) ::
  {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
  | {:error, HTTPoison.Error.t()}

Issues a POST request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

post!(url, body, headers \\ [])

Issues a POST request to the given url. The body is automatically encoded into JSON, and the Content-Type header is added.

post!(url, body, headers \\ [], options \\ [])

post!(binary(), any(), headers(), Keyword.t()) ::
  HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()

Issues a POST request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

process_headers(headers)

process_headers(list()) :: any()

This function is deprecated. Use process_response_headers/1 instead.

Callback implementation for HTTPoison.Base.process_headers/1.

process_request_body(body)

process_request_body(body()) :: body()

Callback implementation for HTTPoison.Base.process_request_body/1.

process_request_headers(headers)

process_request_headers(headers()) :: headers()

Adds the OAuth Bearer token to the Authorization header. The token is retrieved by calling LineBot.TokenServer.get_token/0.

Also adds the User-Agent header with a value of line-botsdk-elixir/vX.X.X. This follows the pattern of Line Bot libraries in other languages.

process_request_options(options)

process_request_options(options()) :: options()

Callback implementation for HTTPoison.Base.process_request_options/1.

process_request_params(params)

process_request_params(params()) :: params()

Callback implementation for HTTPoison.Base.process_request_params/1.

process_request_url(url)

process_request_url(url()) :: url()

Prepends the request url with https://api.line.me/v2/bot/.

process_response(response)

process_response(HTTPoison.Base.response()) :: any()

If the reponse headers indidate that the response is JSON, the response body is automatically decoded.

process_response_body(body)

process_response_body(binary()) :: any()

Callback implementation for HTTPoison.Base.process_response_body/1.

process_response_chunk(chunk)

process_response_chunk(binary()) :: any()

Callback implementation for HTTPoison.Base.process_response_chunk/1.

process_response_headers(headers)

process_response_headers(list()) :: any()

Callback implementation for HTTPoison.Base.process_response_headers/1.

process_response_status_code(status_code)

process_response_status_code(integer()) :: any()

Callback implementation for HTTPoison.Base.process_response_status_code/1.

process_status_code(status_code)

process_status_code(integer()) :: any()

This function is deprecated. Use process_response_status_code/1 instead.

Callback implementation for HTTPoison.Base.process_status_code/1.

process_url(url)

process_url(url()) :: url()

This function is deprecated. Use process_request_url/1 instead.

Callback implementation for HTTPoison.Base.process_url/1.

put(url, body \\ "", headers \\ [], options \\ [])

put(binary(), any(), headers(), Keyword.t()) ::
  {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
  | {:error, HTTPoison.Error.t()}

Issues a PUT request to the given url.

Returns {:ok, response} if the request is successful, {:error, reason} otherwise.

See request/5 for more detailed information.

put!(url, body \\ "", headers \\ [], options \\ [])

put!(binary(), any(), headers(), Keyword.t()) ::
  HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()

Issues a PUT request to the given url, raising an exception in case of failure.

If the request does not fail, the response is returned.

See request!/5 for more detailed information.

request(request)

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

Issues an HTTP request using a Request struct.

This function returns {:ok, response} or {:ok, async_response} if the request is successful, {:error, reason} otherwise.

Examples

request = %HTTPoison.Request{
  method: :post,
  url: "https://my.website.com",
  body: "{\"foo\": 3}",
  headers: [{"Accept", "application/json"}]
}

request(request)

request(method, url, body \\ "", headers \\ [], options \\ [])

request(atom(), binary(), any(), headers(), Keyword.t()) ::
  {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
  | {:error, HTTPoison.Error.t()}

In addition to the HTTPoison.request/5 behaviour, will automatically refresh the access token after an unauthorized request. Gives up after three subsequent unauthorized errors.

request!(method, url, body \\ "", headers \\ [], options \\ [])

request!(atom(), binary(), any(), headers(), Keyword.t()) ::
  HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()

Issues an HTTP request with the given method to the given url, raising an exception in case of failure.

request!/5 works exactly like request/5 but it returns just the response in case of a successful request, raising an exception in case the request fails.

start()

Starts HTTPoison and its dependencies.

start_link(opts)

stream_next(resp)

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

Requests the next message to be streamed for a given HTTPoison.AsyncResponse.

See request!/5 for more detailed information.