Merge branch 'feature/new-user-routes' into 'develop'

[akkoma] / lib / pleroma / http / http.ex

diff --git a/lib/pleroma/http/http.ex b/lib/pleroma/http/http.ex
index 59afacf4cd54c5fc4659b6e9307dd111dcb4fd8b..3c02565757622e30748a891519fbfc7c11cd570e 100644 (file)
--- a/lib/pleroma/http/http.ex
+++ b/lib/pleroma/http/http.ex
@@ -1,8 +1,25 @@
 defmodule Pleroma.HTTP do
-  require HTTPoison
+  @moduledoc """
+
+  """
+
   alias Pleroma.HTTP.Connection
   alias Pleroma.HTTP.RequestBuilder, as: Builder
 
+  @doc """
+  Builds and perform http request.
+
+  # Arguments:
+  `method` - :get, :post, :put, :delete
+  `url`
+  `body`
+  `headers` - a keyworld list of headers, e.g. `[{"content-type", "text/plain"}]`
+  `options` - custom, per-request middleware or adapter options
+
+  # Returns:
+  `{:ok, %Tesla.Env{}}` or `{:error, error}`
+
+  """
   def request(method, url, body \\ "", headers \\ [], options \\ []) do
     options =
       process_request_options(options)
@@ -19,6 +36,7 @@ defmodule Pleroma.HTTP do
   end
 
   defp process_sni_options(options, nil), do: options
+
   defp process_sni_options(options, url) do
     uri = URI.parse(url)
     host = uri.host |> to_charlist()
@@ -40,9 +58,19 @@ defmodule Pleroma.HTTP do
     end
   end
 
+  @doc """
+  Performs GET request.
+
+  See `Pleroma.HTTP.request/5`
+  """
   def get(url, headers \\ [], options \\ []),
     do: request(:get, url, "", headers, options)
 
+  @doc """
+  Performs POST request.
+
+  See `Pleroma.HTTP.request/5`
+  """
   def post(url, body, headers \\ [], options \\ []),
     do: request(:post, url, body, headers, options)
 end