Tentacat v1.6.0 Tentacat View Source
Link to this section Summary
Functions
Take an existing URI and add addition params, appending and replacing as necessary
Same as authorization_header/2
but defaults initial headers to include @user_agent
There are two ways to authenticate through GitHub API v3
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
Underlying utility retrieval function. The options passed affect both the return value and, ultimately, the number of requests made to GitHub
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
Issues an OPTIONS request to the given url
Issues a OPTIONS request to the given url, raising an exception in case of failure
Callback implementation for HTTPoison.Base.patch/3
Issues a PATCH request to the given url
Issues a PATCH request to the given url, raising an exception in case of failure
Callback implementation for HTTPoison.Base.post/3
Issues a POST request to the given url
Issues a POST request to the given url, raising an exception in case of failure
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
Issues a PUT request to the given url, raising an exception in case of failure
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
body()
View Source
body() :: HTTPoison.Base.body()
body() :: HTTPoison.Base.body()
headers()
View Source
headers() :: HTTPoison.Base.headers()
headers() :: HTTPoison.Base.headers()
pagination_response()
View Source
pagination_response() :: {response(), binary() | nil, Tentacat.Client.auth()}
pagination_response() :: {response(), binary() | nil, Tentacat.Client.auth()}
response()
View Source
response() ::
{:ok, :jsx.json_term(), HTTPoison.Response.t()}
| {integer(), any(), HTTPoison.Response.t()}
| pagination_response()
response() :: {:ok, :jsx.json_term(), HTTPoison.Response.t()} | {integer(), any(), HTTPoison.Response.t()} | pagination_response()
Link to this section Functions
add_params_to_url(url, params) View Source
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"
authorization_header(options) View Source
Same as authorization_header/2
but defaults initial headers to include @user_agent
.
authorization_header(arg1, headers)
View Source
authorization_header(Tentacat.Client.auth(), list()) :: list()
authorization_header(Tentacat.Client.auth(), list()) :: list()
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
delete(url, headers \\ [], options \\ [])
View Source
delete(binary(), headers(), Keyword.t()) ::
{:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
| {:error, HTTPoison.Error.t()}
delete(binary(), Tentacat.Client.t(), any()) :: response()
delete(binary(), headers(), Keyword.t()) :: {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()} | {:error, HTTPoison.Error.t()}
delete(binary(), Tentacat.Client.t(), any()) :: response()
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 \\ [])
View Source
delete!(binary(), headers(), Keyword.t()) ::
HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()
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 \\ [])
View Source
get(binary(), headers(), Keyword.t()) ::
{:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
| {:error, HTTPoison.Error.t()}
get(binary(), Tentacat.Client.t(), keyword()) :: response()
get(binary(), headers(), Keyword.t()) :: {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()} | {:error, HTTPoison.Error.t()}
get(binary(), Tentacat.Client.t(), keyword()) :: response()
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(path, client, params \\ [], options \\ [])
View Source
get(binary(), Tentacat.Client.t(), keyword(), keyword()) ::
response() | Enumerable.t() | pagination_response()
get(binary(), Tentacat.Client.t(), keyword(), keyword()) :: response() | Enumerable.t() | pagination_response()
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")
andTentacat.Repositories.list_users("octocat")
have the same interface though one call will page many times and the other not at all.:stream
will return aStream
, 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.
get!(url, headers \\ [], options \\ [])
View Source
get!(binary(), headers(), Keyword.t()) ::
HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()
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 \\ [])
View Source
head(binary(), headers(), Keyword.t()) ::
{:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
| {:error, HTTPoison.Error.t()}
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 \\ [])
View Source
head!(binary(), headers(), Keyword.t()) ::
HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()
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.
json_request(method, url, body \\ "", headers \\ [], options \\ []) View Source
options(url, headers \\ [], options \\ [])
View Source
options(binary(), headers(), Keyword.t()) ::
{:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
| {:error, HTTPoison.Error.t()}
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 \\ [])
View Source
options!(binary(), headers(), Keyword.t()) ::
HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()
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(path, client, body \\ "")
View Source
patch(binary(), Tentacat.Client.t(), any()) :: response()
patch(binary(), Tentacat.Client.t(), any()) :: response()
Callback implementation for HTTPoison.Base.patch/3
.
patch(url, body, headers \\ [], options \\ [])
View Source
patch(binary(), any(), headers(), Keyword.t()) ::
{:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
| {:error, HTTPoison.Error.t()}
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.
patch!(url, body, headers \\ [], options \\ [])
View Source
patch!(binary(), any(), headers(), Keyword.t()) ::
HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()
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.
post(path, client, body \\ "")
View Source
post(binary(), Tentacat.Client.t(), any()) :: response()
post(binary(), Tentacat.Client.t(), any()) :: response()
Callback implementation for HTTPoison.Base.post/3
.
post(url, body, headers \\ [], options \\ [])
View Source
post(binary(), any(), headers(), Keyword.t()) ::
{:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
| {:error, HTTPoison.Error.t()}
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.
post!(url, body, headers \\ [], options \\ [])
View Source
post!(binary(), any(), headers(), Keyword.t()) ::
HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()
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.
process_headers(headers) View Source
Callback implementation for HTTPoison.Base.process_headers/1
.
process_request_body(body) View Source
Callback implementation for HTTPoison.Base.process_request_body/1
.
process_request_headers(headers) View Source
Callback implementation for HTTPoison.Base.process_request_headers/1
.
process_request_options(options) View Source
Callback implementation for HTTPoison.Base.process_request_options/1
.
process_response(resp)
View Source
process_response(
HTTPoison.Response.t()
| {integer(), any(), HTTPoison.Response.t()}
) :: response()
process_response( HTTPoison.Response.t() | {integer(), any(), HTTPoison.Response.t()} ) :: response()
process_response_body(body) View Source
Callback implementation for HTTPoison.Base.process_response_body/1
.
process_response_chunk(chunk) View Source
Callback implementation for HTTPoison.Base.process_response_chunk/1
.
process_status_code(status_code) View Source
Callback implementation for HTTPoison.Base.process_status_code/1
.
process_url(url) View Source
Callback implementation for HTTPoison.Base.process_url/1
.
put(path, client, body \\ "")
View Source
put(binary(), Tentacat.Client.t(), any()) :: response()
put(binary(), Tentacat.Client.t(), any()) :: response()
Callback implementation for HTTPoison.Base.put/3
.
put(url, body \\ "", headers \\ [], options \\ [])
View Source
put(binary(), any(), headers(), Keyword.t()) ::
{:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
| {:error, HTTPoison.Error.t()}
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.
put!(url, body \\ "", headers \\ [], options \\ [])
View Source
put!(binary(), any(), headers(), Keyword.t()) ::
HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()
put!(binary(), any(), 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.
raw_request(method, url, body \\ "", headers \\ [], options \\ []) View Source
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()}
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 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{: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 tostream_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 thessl
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"}])
request!(method, url, body \\ "", headers \\ [], options \\ [])
View Source
request!(atom(), binary(), any(), headers(), Keyword.t()) ::
HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()
request!(atom(), binary(), any(), headers(), Keyword.t()) :: HTTPoison.Response.t() | HTTPoison.AsyncResponse.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.
request_stream(method, url, auth, body \\ "", override \\ nil)
View Source
request_stream(
atom(),
binary(),
Tentacat.Client.auth(),
any(),
:one_page | nil | :stream
) :: Enumerable.t() | response()
request_stream( atom(), binary(), Tentacat.Client.auth(), any(), :one_page | nil | :stream ) :: Enumerable.t() | response()
request_with_pagination(method, url, auth, body \\ "")
View Source
request_with_pagination(atom(), binary(), Tentacat.Client.auth(), any()) ::
pagination_response()
request_with_pagination(atom(), binary(), Tentacat.Client.auth(), any()) :: pagination_response()
start() View Source
Starts HTTPoison and its dependencies.
stream_next(resp)
View Source
stream_next(HTTPoison.AsyncResponse.t()) ::
{:ok, HTTPoison.AsyncResponse.t()} | {:error, HTTPoison.Error.t()}
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.