Ark_Elixir v0.1.3 Ark_Elixir.Api View Source

Operations for querying the API.

Link to this section Summary

Functions

Issues a DELETE request to the given url

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

Allow us to make a request on the network of our choice, using get_main or get_dev, to the desired endpoint, with the possibility of passing optional parameters and the matching headers

Issues a GET request to the given url

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

Allow us to make a request on the Dev network to the desired endpoint, with the possibility of passing optional parameters

Get the adequates headers for the Ark Dev network

Allow us to make a request on the Main network to the desired endpoint, with the possibility of passing optional parameters

Get the adequates headers for the Ark Main network

Issues a HEAD request to the given url

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

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

Issues a PUT request to the given url

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

Allow us to pass optional parameters to our 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 delete(url, headers \\ [], options \\ []) View Source
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 \\ []) View Source

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(endpoint, opts \\ []) View Source
get(path(), options()) :: response()

Allow us to make a request on the network of our choice, using get_main or get_dev, to the desired endpoint, with the possibility of passing optional parameters and the matching headers.

The default network is Main.

Examples

iex> Ark_Elixir.Api.get(“api/blocks”) # Query on the main net iex> Ark_Elixir.Api.get(“api/blocks”, [limit: 2]) # Query on the main net iex> Ark_Elixir.Api.get(“api/blocks”, [limit: 2, network: :dev]) # Query on the dev net iex> Ark_Elixir.Api.get(“api/blocks”, [network: :dev, limit: 2]) # In any order iex> Ark_Elixir.Api.get(“api/blocks”, [network: :dev]) # No query params, just the network and the whole response iex> Ark_Elixir.Api.get(“api/blocks”, [network: :bar]) # Incorrect network, switching on the main one iex> Ark_Elixir.Api.get(“api/blocks”, [network: :dev]) # You can specify the network as an Atom

Link to this function get(url, headers \\ [], options \\ []) View Source
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 \\ []) View Source

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 get_dev(endpoint, opts \\ []) View Source
get_dev(path(), options()) :: response()

Allow us to make a request on the Dev network to the desired endpoint, with the possibility of passing optional parameters.

Link to this function get_dev_headers() View Source
get_dev_headers() :: [nethash: String.t(), version: String.t(), port: String.t()]

Get the adequates headers for the Ark Dev network.

Link to this function get_main(endpoint, opts \\ []) View Source
get_main(path(), options()) :: response()

Allow us to make a request on the Main network to the desired endpoint, with the possibility of passing optional parameters.

Link to this function get_main_headers() View Source
get_main_headers() :: [nethash: String.t(), version: String.t(), port: String.t()]

Get the adequates headers for the Ark Main network.

Link to this function head(url, headers \\ [], options \\ []) View Source
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 \\ []) View Source

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 options(url, headers \\ [], options \\ []) View Source
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 \\ []) View Source

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 \\ []) View Source
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 \\ []) View Source
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 \\ []) View Source
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 \\ []) View Source
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) View Source
Link to this function process_request_body(body) View Source
process_request_body(any()) :: body()
Link to this function process_request_headers(headers) View Source
process_request_headers(headers()) :: headers()
Link to this function process_request_options(options) View Source
Link to this function process_response_body(body) View Source
process_response_body(binary()) :: any()
Link to this function process_response_chunk(chunk) View Source
Link to this function process_status_code(status_code) View Source
Link to this function put(url, body \\ "", headers \\ [], options \\ []) View Source
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 \\ []) View Source

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.

Allow us to pass optional parameters to our request.

Link to this function request(method, url, body \\ "", headers \\ [], options \\ []) View Source
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 \\ []) View Source
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.

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

See request!/5 for more detailed information.