Tentacat
Summary
| authorization_header(options) | Same as |
| authorization_header(arg1, headers) | There are two ways to authenticate through GitHub API v3: |
| delete!(url, headers \\ [], options \\ []) | Issues a DELETE request to the given url, raising an exception in case of failure |
| delete(url, headers \\ [], options \\ []) | Issues a DELETE request to the given url |
| get!(url, headers \\ [], options \\ []) | Issues a GET request to the given url, raising an exception in case of failure |
| get(url, headers \\ [], options \\ []) | Issues a GET request to the given url |
| head!(url, headers \\ [], options \\ []) | Issues a HEAD request to the given url, raising an exception in case of failure |
| head(url, headers \\ [], options \\ []) | Issues a HEAD request to the given url |
| json_request(method, url, body \\ "", headers \\ [], options \\ []) | |
| options!(url, headers \\ [], options \\ []) | Issues a OPTIONS request to the given url, raising an exception in case of failure |
| options(url, headers \\ [], options \\ []) | Issues an OPTIONS 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 |
| patch(path, client, body \\ "") | |
| patch(url, body, headers \\ [], options \\ []) | Issues a PATCH 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 |
| post(path, client, body \\ "") | |
| post(url, body, headers \\ [], options \\ []) | Issues a POST request to the given url |
| process_response(response) | |
| put!(url, body, headers \\ [], options \\ []) | Issues a PUT request to the given url, raising an exception in case of failure |
| put(path, client, body \\ "") | |
| put(url, body, headers \\ [], options \\ []) | Issues a PUT request to the given url |
| raw_request(method, url, body \\ "", headers \\ [], options \\ []) | |
| 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 |
| request(method, url, body \\ "", headers \\ [], options \\ []) | Issues an HTTP request with the given method to the given url |
| start() | Starts HTTPoison and its dependencies |
Types
headers :: [{binary, binary}]
response :: {integer, any} | :jsx.json_term
Functions
Same as authorization_header/2 but defaults initial headers to include @user_agent.
Specs:
- authorization_header(Tentacat.Client.auth, list) :: list
There are two ways to authenticate through GitHub API v3:
- Basic authentication
- OAuth2 Token
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"}]More info
http:\developer.github.com/v3/#authentication
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.
Specs:
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.
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.
Specs:
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.
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.
Specs:
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.
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.
Specs:
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.
Specs:
- patch(binary, binary, 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.
Specs:
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.
Specs:
- post(binary, binary, 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.
Specs:
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.
Specs:
- process_response(HTTPoison.Response.t) :: response
Specs:
- put(binary, binary, 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.
Specs:
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.
Specs:
- request(atom, binary, binary, 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 listbody- request body. See more belowheaders- 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 by a regular url or a{Host, Proxy}tuple:proxy_auth- proxy authentication{User, Password}tuple:ssl- SSL options supported by thesslerlang module:follow_redirect- a boolean that causes redirects to be followed:max_redirect- an integer denoting the maximum number of redirects to follow
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"}])Specs:
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.