stripity_stripe

v1.6.0

stripity_stripe v1.6.0 Stripe

A HTTP client for Stripe. This module contains the Application that you can use to perform transactions on stripe API. ### Configuring By default the STRIPE_SECRET_KEY environment variable is used to find your API key for Stripe. You can also manually set your API key by configuring the :stripity_stripe 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 :stripity_stripe, secret_key: YOUR_STRIPE_KEY
config :stripity_stripe, platform_client_id: STRIPE_PLATFORM_CLIENT_ID

Summary

Types

body()
headers()

Functions

config_or_env_key()

Grabs STRIPE_SECRET_KEY from system ENV Returns binary

config_or_env_platform_client_id()

Grabs STRIPE_PLATFORM_CLIENT_ID from system ENV Returns binary

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

make_oauth_deauthorize_request(stripe_user_id)
make_oauth_token_callback_request(body)
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 - stripe key passed to the api
  • body - request body
  • headers - request headers
  • options - request options Returns tuple
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 - stripe key passed to the api
  • body - request body
  • headers - request headers
  • options - request options Returns tuple
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 \\ [], options \\ [])

Issues a POST request to the given url

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

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

process_response_body(body)

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

  • body - string binary response Returns Record or ArgumentError
process_url(endpoint)

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

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

req_headers(key)

Set our request headers for every request

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

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

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

Types 

body ::
  binary |
  {:form, [{atom, any}]} |
  {:file, binary}
headers ::
  [{binary, binary}] |
  %{optional(binary) => binary}

Functions

config_or_env_key()

Grabs STRIPE_SECRET_KEY from system ENV Returns binary

config_or_env_platform_client_id()

Grabs STRIPE_PLATFORM_CLIENT_ID from system ENV Returns binary

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

Specs

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 \\ [])

Specs

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 \\ [])

Specs

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 \\ [])

Specs

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 \\ [])

Specs

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 \\ [])

Specs

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.

make_oauth_deauthorize_request(stripe_user_id)
make_oauth_token_callback_request(body)
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 - stripe key passed to the api
  • body - request body
  • headers - request headers
  • options - request options Returns tuple
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 - stripe key passed to the api
  • body - request body
  • headers - request headers
  • options - request options Returns tuple
options(url, headers \\ [], options \\ [])

Specs

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 \\ [])

Specs

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 \\ [])

Specs

patch(binary, body, 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 \\ [])

Specs

patch!(binary, body, 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 \\ [], options \\ [])

Specs

post(binary, body, 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 \\ [], options \\ [])

Specs

post!(binary, body, 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_response_body(body)

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

  • body - string binary response Returns Record or ArgumentError
process_url(endpoint)

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

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

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

Args:

  • endpoint - part of the API we’re hitting

Returns string

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

Specs

put(binary, body, 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 \\ [])

Specs

put!(binary, body, 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.

req_headers(key)

Set our request headers for every request.

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

Specs

request(atom, binary, body, 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

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
  • :proxy - a proxy to be used for the request; it can be a regular url or a {Host, Proxy} 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"}])
request!(method, url, body \\ "", headers \\ [], options \\ [])

Specs

request!(atom, binary, body, 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.

start()

Starts HTTPoison and its dependencies.