campminder v0.0.1 CampMinder
An HTTP client for CampMinder. https://webapi.campminder.com/help
Summary
Functions
Generates a time-locked use API header key. How long is this valid for?
Returns the CampMinder camp ID from either the system or application environment
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
Decode and convert the body into a keyword list. ERROR: This should be cleaner but the get_id_success test fails if it isn't broken into two steps
Prepend the CampMinder API URL to each request
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
http://elixir-lang.org/docs/stable/elixir/Application.html
Returns the CampMinder token from either the system or application environment
Types
Functions
Specs
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.
Specs
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.
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
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.
Specs
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.
Specs
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.
Specs
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.
Decode and convert the body into a keyword list. ERROR: This should be cleaner but the get_id_success test fails if it isn't broken into two steps...
Specs
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.
Specs
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
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 be a regular url or a {Host, Proxy}
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"}])
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.