osu!ex v0.2.0 OsuEx.API.HTTP View Source
The underlying osu! API HTTP wrapper.
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
Issues a GET request to the given url
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
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
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_request_params/1
Callback implementation for HTTPoison.Base.process_request_url/1
Callback implementation for HTTPoison.Base.process_response/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_response_headers/1
Callback implementation for HTTPoison.Base.process_response_status_code/1
Callback implementation for HTTPoison.Base.process_status_code/1
Callback implementation for HTTPoison.Base.process_url/1
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 using a Request
struct
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()
options()
View Source
options() :: HTTPoison.Base.options()
options() :: HTTPoison.Base.options()
params()
View Source
params() :: HTTPoison.Base.params()
params() :: HTTPoison.Base.params()
request()
View Source
request() :: HTTPoison.Base.request()
request() :: HTTPoison.Base.request()
response()
View Source
response() :: HTTPoison.Base.response()
response() :: HTTPoison.Base.response()
url()
View Source
url() :: HTTPoison.Base.url()
url() :: HTTPoison.Base.url()
Link to this section Functions
delete(url, headers \\ [], options \\ [])
View Source
delete(binary(), headers(), Keyword.t()) ::
{:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
| {:error, HTTPoison.Error.t()}
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 \\ [])
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(), 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 \\ [])
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.
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(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(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_request_params(params) View Source
Callback implementation for HTTPoison.Base.process_request_params/1
.
process_request_url(url) View Source
Callback implementation for HTTPoison.Base.process_request_url/1
.
process_response(response) View Source
Callback implementation for HTTPoison.Base.process_response/1
.
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_response_headers(headers) View Source
Callback implementation for HTTPoison.Base.process_response_headers/1
.
process_response_status_code(status_code) View Source
Callback implementation for HTTPoison.Base.process_response_status_code/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(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.
request(request)
View Source
request(HTTPoison.Request.t()) ::
{:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
| {:error, HTTPoison.Error.t()}
request(HTTPoison.Request.t()) :: {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()} | {:error, HTTPoison.Error.t()}
Issues an HTTP request using a Request
struct.
This function returns {:ok, response}
or {:ok, async_response}
if the
request is successful, {:error, reason}
otherwise.
Examples
request = %HTTPoison.Request{
method: :post,
url: "https://my.website.com",
body: "{\"foo\": 3}",
headers: [{"Accept", "application/json"}]
}
request(request)
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: see type HTTPoison.Request
Options: see type HTTPoison.Request
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.
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.