git.squeep.com Git - akkoma/blob - lib/pleroma/http/request_builder.ex

   1 # Pleroma: A lightweight social networking server
   2 # Copyright © 2017-2021 Pleroma Authors <https://pleroma.social/>
   3 # SPDX-License-Identifier: AGPL-3.0-only
   4
   5 defmodule Pleroma.HTTP.RequestBuilder do
   6   @moduledoc """
   7   Helper functions for building Tesla requests
   8   """
   9
  10   alias Pleroma.HTTP.Request
  11   alias Tesla.Multipart
  12
  13   @mix_env Mix.env()
  14
  15   @doc """
  16   Creates new request
  17   """
  18   @spec new(Request.t()) :: Request.t()
  19   def new(%Request{} = request \\ %Request{}), do: request
  20
  21   @doc """
  22   Specify the request method when building a request
  23   """
  24   @spec method(Request.t(), Request.method()) :: Request.t()
  25   def method(request, m), do: %{request | method: m}
  26
  27   @doc """
  28   Specify the request method when building a request
  29   """
  30   @spec url(Request.t(), Request.url()) :: Request.t()
  31   def url(request, u), do: %{request | url: u}
  32
  33   @doc """
  34   Add headers to the request
  35   """
  36   @spec headers(Request.t(), Request.headers()) :: Request.t()
  37   def headers(request, headers) do
  38     headers_list = maybe_add_user_agent(headers, @mix_env)
  39
  40     %{request | headers: headers_list}
  41   end
  42
  43   @doc """
  44   Add custom, per-request middleware or adapter options to the request
  45   """
  46   @spec opts(Request.t(), keyword()) :: Request.t()
  47   def opts(request, options), do: %{request | opts: options}
  48
  49   @doc """
  50   Add optional parameters to the request
  51   """
  52   @spec add_param(Request.t(), atom(), atom(), any()) :: Request.t()
  53   def add_param(request, :query, :query, values), do: %{request | query: values}
  54
  55   def add_param(request, :body, :body, value), do: %{request | body: value}
  56
  57   def add_param(request, :body, key, value) do
  58     request
  59     |> Map.put(:body, Multipart.new())
  60     |> Map.update!(
  61       :body,
  62       &Multipart.add_field(
  63         &1,
  64         key,
  65         Jason.encode!(value),
  66         headers: [{"content-type", "application/json"}]
  67       )
  68     )
  69   end
  70
  71   def add_param(request, :file, name, path) do
  72     request
  73     |> Map.put(:body, Multipart.new())
  74     |> Map.update!(:body, &Multipart.add_file(&1, path, name: name))
  75   end
  76
  77   def add_param(request, :form, name, value) do
  78     Map.update(request, :body, %{name => value}, &Map.put(&1, name, value))
  79   end
  80
  81   def add_param(request, location, key, value) do
  82     Map.update(request, location, [{key, value}], &(&1 ++ [{key, value}]))
  83   end
  84
  85   def convert_to_keyword(request) do
  86     request
  87     |> Map.from_struct()
  88     |> Enum.into([])
  89   end
  90
  91   defp maybe_add_user_agent(headers, :test) do
  92     with true <- Pleroma.Config.get([:http, :send_user_agent]) do
  93       [{"user-agent", Pleroma.Application.user_agent()} | headers]
  94     else
  95       _ ->
  96         headers
  97     end
  98   end
  99
 100   defp maybe_add_user_agent(headers, _),
 101     do: [{"user-agent", Pleroma.Application.user_agent()} | headers]
 102 end