discourse_elixir v0.5.1 DiscourseElixir
This is a Discourse client for Elixir that builds upon HTTPoison.Base.
This module is primarily intended to allow for the creation and management of Discourse users. More functionality may be added, though it is not a priority.
Summary
Functions
Issues a POST request to create a subcategory for the community topic category whose id is provided
Issues a POST request to create a subcategory for the community topic category whose id is provided
Issues a POST request to create a community topic for the given company name, and generates all of its proper subcategories as well
Issues a POST request to create a community topic for the given company name, and generates all of its proper subcategories as well
Issues a POST request to create a user with the provided params
Issues a POST request to create a user with the provided params, raising an error if the request fails
Issues a PUT request to deactivate the given user
Issues a PUT request to deactivate the given user
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 POST request to generate an API key for the given user_id
Issues a POST request to generate an API key for the given user_id, raising an error if the request fails
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
Issues a PUT request to the given url
Issues a PUT request to the given url, raising an exception in case of failure
Issues a PUT request to reactivate the given user
Issues a PUT request to reactivate the given user, raising an error if the request fails
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
Issues a POST request to revoke an API key for the given user_id
Issues a POST request to revoke an API key for the given user_id, raising an error if the request fails
Starts HTTPoison and its dependencies
Requests the next message to be streamed for a given HTTPoison.AsyncResponse
Issues a GET request for the given user, returning the full response body or that the user doesn’t exist
Issues a GET request for the given user, returning the full response body or that the user doesn’t exist, and raising an error if the request fails
Issues a GET request for the given user, returning the user’s id or that the user doesn’t exist
Issues a GET request for the given user, returning the user’s id or that the user doesn’t exist, and raising an error if it fails
Types
Functions
create_category(string, string, integer, string, string) :: {:ok, map} | {:error, HTTPoison.Error.t}
Issues a POST request to create a subcategory for the community topic category whose id is provided.
If successful, returns {:ok, category}, otherwise returns {:error, reason}
create_category!(string, string, integer, string, string) :: map | no_return
Issues a POST request to create a subcategory for the community topic category whose id is provided.
This function works the same way as create_category
but only returns the
category when the request is successful. If the request fails, an error is raised.
create_community_topic(string, string) :: {:ok, map} | {:error, HTTPoison.Error.t}
Issues a POST request to create a community topic for the given company name, and generates all of its proper subcategories as well.
If successful, returns {:ok, category}, otherwise returns {:error, reason}
Issues a POST request to create a community topic for the given company name, and generates all of its proper subcategories as well.
This function works the same way as create_community_topic
but only returns the
response when the request is successful. If the request fails, an error is raised.
create_user(string, string, string) :: {:ok, map | string} | {:error, map | HTTPoison.Error.t}
Issues a POST request to create a user with the provided params.
If successful, returns {:ok, body}
. If Discourse doesn’t create the user due to a
username or email already being taken, or the password not being valid, returns some
variation of {:error,
%{errors: %{"email" => [],
"password" => ["is too short (minimum is 10 characters)"],
"username" => ["must be unique"]}}}
If HTTPoison throws an error, returns {:error, reason}
create_user!(string, string, string) :: map | string | no_return
Issues a POST request to create a user with the provided params, raising an error if the request fails.
This function works the same way as create_user/3
but only returns the response when
the request is successful. If the request fails, an error is raised.
Issues a PUT request to deactivate the given user.
If successful, returns {:ok, "User has been deactivated}
or {:ok, "User does not exist}
and if the request fails, returns {:error, reason}
Issues a PUT request to deactivate the given user.
If successful, returns {:ok, "OK"}
or {:ok, "User not found"}
and if the request fails, returns {:error, reason}
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!(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.
generate_user_api_key(integer) :: {:ok, string} | {:error, HTTPoison.Error.t}
Issues a POST request to generate an API key for the given user_id.
If successful, returns {:ok, "api key"}
and if the request fails, returns {error: reason}
Issues a POST request to generate an API key for the given user_id, raising an error if the request fails.
This function works the same way as generate_user_api_key/1
but only returns the
api_key string when the request is successful. If the request fails, an error is raised.
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!(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(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!(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(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!(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(binary, body, 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!(binary, body, 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(binary, body, 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!(binary, body, 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.
put(binary, body, 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.
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 a PUT request to reactivate the given user.
If successful, returns {:ok, "User has been deactivated}
or {:ok, "User does not exist"}
and if the request fails, returns {:error, reason}
Issues a PUT request to reactivate the given user, raising an error if the request fails.
This function works the same way as reactivate_user/1
but only returns the response when
the request is successful. If the request fails, an error is raised.
request(atom, binary, body, 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: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, Proxy}
tuple:proxy_auth
- proxy authentication{User, Password}
tuple: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
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!(atom, binary, body, headers, Keyword.t) :: HTTPoison.Response.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.
revoke_user_api_key(integer) :: {:ok, string} | {:error, HTTPoison.Error.t}
Issues a POST request to revoke an API key for the given user_id.
If successful, returns {:ok, "Successfully revoked the api key"}
and if the request
fails, returns {error: reason}
Issues a POST request to revoke an API key for the given user_id, raising an error if the request fails.
This function works the same way as revoke_user_api_key/1
but only returns the
response when the request is successful. If the request fails, an error is raised.
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.
Issues a GET request for the given user, returning the full response body or that the user doesn’t exist.
If successful, returns {:ok, %{user: %{"foo" => "bar", ...}, user_badges: []}}
or
{:ok, "User not found"}
If an error is raised, returns {:error, reason}
Issues a GET request for the given user, returning the full response body or that the user doesn’t exist, and raising an error if the request fails.
This function works the same as user/1
but only returns the body when the request is
successful. If the request fails, an error is raised.
Issues a GET request for the given user, returning the user’s id or that the user doesn’t exist
This function returns {:ok, value}
if the request is successful, {:error, reason}
otherwise.
Issues a GET request for the given user, returning the user’s id or that the user doesn’t exist, and raising an error if it fails.
This function works the same as user_id/1
but only returns value
when there is a
successful request. If the request fails, an error is raised.