ex_openpay v0.1.2 ExOpenpay

A HTTP client for ExOpenpay. This module contains the Application that you can use to perform transactions on openpay API.

Configuring

By default the OPENPAY_MERCHANT_ID environment variable is used to find your API key for ExOpenpay. You can also manually set your API key by configuring the :ex_openpay application. You can see the default configuration in the default_config/0 private function at the bottom of this file. The value for platform client id is optional.

  config :ex_openpay, merchant_id: YOUR_OPENPAY_MERCHANT_ID
  config :ex_openpay, api_key: YOUR_OPENPAY_API_KEY

Link to this section Summary

Functions

Grabs OPENPAY_OPENPAY_MERCHANT_ID from system ENV Returns binary

Grabs OPENPAY_MERCHANT_ID from system ENV Returns binary

Issues a DELETE request to the given url

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

Issues a GET request to the given url

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

Issues a HEAD request to the given url

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

Boilerplate code to make requests with the key read from config or env.see config_or_env_key/0 Args:

  • method - request method
  • endpoint - string requested API endpoint
  • key - openpay key passed to the api
  • body - request body
  • headers - request headers
  • options - request options Returns tuple

Boilerplate code to make requests with a given key. Args:

  • method - request method
  • endpoint - string requested API endpoint
  • key - openpay key passed to the api
  • body - request body
  • headers - request headers
  • options - request options Returns tuple

Issues an OPTIONS request to the given url

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

Issues a PATCH request to the given url

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

Issues a POST request to the given url

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

Converts the binary keys in our response to atoms. Args:

  • body - string binary response Returns Record or ArgumentError

Creates the URL for our endpoint. You can also manually set API base url for testing purpose by configuring the :ex_openpay application with :api_base_url key. By default https://api.openpay.com/v1/. Here is an example

Issues a PUT request to the given url

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

Set our request headers for every request

Issues an HTTP request with the given method to the given url

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

Starts HTTPoison and its dependencies

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

Link to this section Types

Link to this section Functions

Link to this function config_or_api_key()

Grabs OPENPAY_OPENPAY_MERCHANT_ID from system ENV Returns binary

Link to this function config_or_env_key()

Grabs OPENPAY_MERCHANT_ID from system ENV Returns binary

Link to this function 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.

Link to this function delete!(url, headers \\ [], options \\ [])

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.

Link to this function 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.

Link to this function get!(url, headers \\ [], options \\ [])

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.

Link to this function 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.

Link to this function head!(url, headers \\ [], options \\ [])

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.

Link to this function make_request(method, endpoint, body \\ %{}, headers \\ %{}, options \\ [])

Boilerplate code to make requests with the key read from config or env.see config_or_env_key/0 Args:

  • method - request method
  • endpoint - string requested API endpoint
  • key - openpay key passed to the api
  • body - request body
  • headers - request headers
  • options - request options Returns tuple
Link to this function make_request_with_key(method, endpoint, key, body \\ %{}, headers \\ %{}, options \\ [])

Boilerplate code to make requests with a given key. Args:

  • method - request method
  • endpoint - string requested API endpoint
  • key - openpay key passed to the api
  • body - request body
  • headers - request headers
  • options - request options Returns tuple
Link to this function 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.

Link to this function options!(url, headers \\ [], options \\ [])

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.

Link to this function 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.

Link to this function 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.

Link to this function 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.

Link to this function 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.

Link to this function process_headers(headers)
Link to this function process_request_body(body)
process_request_body(any()) :: body()
Link to this function process_request_headers(headers)
process_request_headers(headers()) :: headers()
Link to this function process_request_options(options)
Link to this function process_response_body(body)
process_response_body(binary()) :: any()

Converts the binary keys in our response to atoms. Args:

  • body - string binary response Returns Record or ArgumentError
Link to this function process_response_chunk(chunk)
Link to this function process_status_code(status_code)
Link to this function process_url(url)

Creates the URL for our endpoint. You can also manually set API base url for testing purpose by configuring the :ex_openpay application with :api_base_url key. By default https://api.openpay.com/v1/. Here is an example:

iex> Application.put_env(:ex_openpay, :api_base_url, "http://localhost:4004")
:ok

iex> ExOpenpay.process_url("/plans")
"http://localhost:4004/plans"

Args:

  • endpoint - part of the API we’re hitting Returns string
Link to this function 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.

Link to this function put!(url, body \\ "", headers \\ [], options \\ [])

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.

Link to this function req_headers(key)

Set our request headers for every request.

Link to this function request(method, url, body \\ "", headers \\ [], options \\ [])
request(atom(), binary(), any(), headers(), Keyword.t()) ::
  {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()} |
  {:error, HTTPoison.Error.t()}

Issues an HTTP request with the given method to the given url.

This function is usually used indirectly by get/3, post/4, put/4, etc

Args:

  • method - HTTP method as an atom (:get, :head, :post, :put, :delete, etc.)
  • url - target url as a binary string or char list
  • body - request body. See more below
  • headers - HTTP headers as an orddict (e.g., [{"Accept", "application/json"}])
  • options - Keyword list of options

Body:

  • binary, char list or an iolist
  • {:form, [{K, V}, ...]} - send a form url encoded
  • {:file, "/path/to/file"} - send a file
  • {:stream, enumerable} - lazily send a stream of binaries/charlists

Options:

  • :timeout - timeout to establish a connection, in milliseconds. Default is 8000
  • :recv_timeout - timeout used when receiving a connection. Default is 5000
  • :stream_to - a PID to stream the response to
  • :async - if given :once, will only stream one message at a time, requires call to stream_next
  • :proxy - a proxy to be used for the request; it can be a regular url or a {Host, Port} tuple
  • :proxy_auth - proxy authentication {User, Password} tuple
  • :ssl - SSL options supported by the ssl erlang module
  • :follow_redirect - a boolean that causes redirects to be followed
  • :max_redirect - an integer denoting the maximum number of redirects to follow
  • :params - an enumerable consisting of two-item tuples that will be appended to the url as query string parameters

Timeouts can be an integer or :infinity

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

Examples

request(:post, "https://my.website.com", "{\"foo\": 3}", [{"Accept", "application/json"}])
Link to this function request!(method, url, body \\ "", headers \\ [], options \\ [])
request!(atom(), binary(), any(), headers(), Keyword.t()) :: HTTPoison.Response.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.

Starts HTTPoison and its dependencies.

Link to this function 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.