Merge remote-tracking branch 'origin/develop' into pool-usage

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

diff --git a/lib/pleroma/http/http.ex b/lib/pleroma/http/http.ex
index 93ac9d62bc8247d426a2747f6af907e296ec0c6e..b8103cef601e6e072b66e9541525e00d309e7e3d 100644 (file)
--- a/lib/pleroma/http/http.ex
+++ b/lib/pleroma/http/http.ex
@@ -1,8 +1,31 @@
+# Pleroma: A lightweight social networking server
+# Copyright © 2017-2019 Pleroma Authors <https://pleroma.social/>
+# SPDX-License-Identifier: AGPL-3.0-only
+
 defmodule Pleroma.HTTP do
-  require HTTPoison
+  @moduledoc """
+
+  """
+
   alias Pleroma.HTTP.Connection
   alias Pleroma.HTTP.RequestBuilder, as: Builder
 
+  @type t :: __MODULE__
+
+  @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)
@@ -18,6 +41,8 @@ defmodule Pleroma.HTTP do
     |> (&Tesla.request(Connection.new(), &1)).()
   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()
@@ -31,7 +56,6 @@ defmodule Pleroma.HTTP do
   def process_request_options(options) do
     config = Application.get_env(:pleroma, :http, [])
     proxy = Keyword.get(config, :proxy_url, nil)
-    options = options ++ [adapter: [pool: :default]]
 
     case proxy do
       nil -> options
@@ -39,9 +63,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