Take an existing URI and add addition params, appending and replacing as necessary

Examples

iex> add_params_to_url("http://example.com/wat", [])
"http://example.com/wat"

iex> add_params_to_url("http://example.com/wat", [q: 1])
"http://example.com/wat?q=1"

iex> add_params_to_url("http://example.com/wat", [q: 1, t: 2])
"http://example.com/wat?q=1&t=2"

iex> add_params_to_url("http://example.com/wat", %{q: 1, t: 2})
"http://example.com/wat?q=1&t=2"

iex> add_params_to_url("http://example.com/wat?q=1&t=2", [])
"http://example.com/wat?q=1&t=2"

iex> add_params_to_url("http://example.com/wat?q=1", [t: 2])
"http://example.com/wat?q=1&t=2"

iex> add_params_to_url("http://example.com/wat?q=1", [q: 3, t: 2])
"http://example.com/wat?q=3&t=2"

iex> add_params_to_url("http://example.com/wat?q=1&s=4", [q: 3, t: 2])
"http://example.com/wat?q=3&s=4&t=2"

iex> add_params_to_url("http://example.com/wat?q=1&s=4", %{q: 3, t: 2})
"http://example.com/wat?q=3&s=4&t=2"

Same as authorization_header/2 but defaults initial headers to include @user_agent.

There are two ways to authenticate through GitHub API v3:

• Basic authentication
• OAuth2 Token
• JWT

This function accepts both.

Examples

iex> Tentacat.authorization_header(%{user: "user", password: "password"}, [])
[{"Authorization", "Basic dXNlcjpwYXNzd29yZA=="}]

iex> Tentacat.authorization_header(%{access_token: "92873971893"}, [])
[{"Authorization", "token 92873971893"}]

iex> Tentacat.authorization_header(%{jwt: "92873971893"}, [])
[{"Authorization", "Bearer 92873971893"}]

More info

http:\developer.github.com/v3/#authentication

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.

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.

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.

Underlying utility retrieval function. The options passed affect both the return value and, ultimately, the number of requests made to GitHub.

Options:

• :pagination - Can be :none, :manual, :stream, or :auto. Defaults to :auto :none will only return the first page. You won't have access to the headers to manually paginate. :auto will block until all the pages have been retrieved and concatenated together. Most of the time, this is what you want. For example, Tentacat.Repositories.list_users("chrismccord") and Tentacat.Repositories.list_users("octocat") have the same interface though one call will page many times and the other not at all. :stream will return a Stream, prepopulated with the first page. :manual will return a 3 element tuple of {page_body, url_for_next_page, auth_credentials}, which will allow you to control the paging yourself.

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.

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.

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.

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.

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.

Callback implementation for HTTPoison.Base.patch/3.

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.

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.

Callback implementation for HTTPoison.Base.post/3.

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.

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.

Callback implementation for HTTPoison.Base.process_headers/1.

Callback implementation for HTTPoison.Base.process_request_body/1.

Callback implementation for HTTPoison.Base.process_request_headers/1.

Callback implementation for HTTPoison.Base.process_request_options/1.

Callback implementation for HTTPoison.Base.process_response_body/1.

Callback implementation for HTTPoison.Base.process_response_chunk/1.

Callback implementation for HTTPoison.Base.process_status_code/1.

Callback implementation for HTTPoison.Base.process_url/1.

Callback implementation for HTTPoison.Base.put/3.

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.

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.

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 for establishing a TCP or SSL connection, in milliseconds. Default is 8000
• :recv_timeout - timeout for receiving an HTTP response from the socket. 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, or a {:socks5, ProxyHost, ProxyPort} tuple
• :proxy_auth - proxy authentication {User, Password} tuple
• :socks5_user- socks5 username
• :socks5_pass- socks5 password
• :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
• :max_body_length - a non-negative integer denoting the max response body length. Errors when body length exceeds. See :hackney.body/2

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"}])

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.