1 # Pleroma: A lightweight social networking server
2 # Copyright © 2017-2019 Pleroma Authors <https://pleroma.social/>
3 # SPDX-License-Identifier: AGPL-3.0-only
5 defmodule Pleroma.HTTP.RequestBuilder do
7 Helper functions for building Tesla requests
11 Specify the request method when building a request
15 - request (Map) - Collected request options
16 - m (atom) - Request method
22 @spec method(map(), atom) :: map()
23 def method(request, m) do
24 Map.put_new(request, :method, m)
28 Specify the request method when building a request
32 - request (Map) - Collected request options
33 - u (String) - Request URL
39 @spec url(map(), String.t()) :: map()
40 def url(request, u) do
41 Map.put_new(request, :url, u)
45 Add headers to the request
47 @spec headers(map(), list(tuple)) :: map()
48 def headers(request, header_list) do
49 header_list = header_list ++ [{"User-Agent", Pleroma.Application.user_agent()}]
50 Map.put_new(request, :headers, header_list)
54 Add custom, per-request middleware or adapter options to the request
56 @spec opts(map(), Keyword.t()) :: map()
57 def opts(request, options) do
58 Map.put_new(request, :opts, options)
62 Add optional parameters to the request
66 - request (Map) - Collected request options
67 - definitions (Map) - Map of parameter name to parameter location.
68 - options (KeywordList) - The provided optional parameters
74 @spec add_optional_params(map(), %{optional(atom) => atom}, keyword()) :: map()
75 def add_optional_params(request, _, []), do: request
77 def add_optional_params(request, definitions, [{key, value} | tail]) do
79 %{^key => location} ->
81 |> add_param(location, key, value)
82 |> add_optional_params(definitions, tail)
85 add_optional_params(request, definitions, tail)
90 Add optional parameters to the request
94 - request (Map) - Collected request options
95 - location (atom) - Where to put the parameter
96 - key (atom) - The name of the parameter
97 - value (any) - The value of the parameter
103 @spec add_param(map(), atom, atom, any()) :: map()
104 def add_param(request, :query, :query, values), do: Map.put(request, :query, values)
106 def add_param(request, :body, :body, value), do: Map.put(request, :body, value)
108 def add_param(request, :body, key, value) do
110 |> Map.put_new_lazy(:body, &Tesla.Multipart.new/0)
113 &Tesla.Multipart.add_field(
116 Jason.encode!(value),
117 headers: [{:"Content-Type", "application/json"}]
122 def add_param(request, :file, name, path) do
124 |> Map.put_new_lazy(:body, &Tesla.Multipart.new/0)
125 |> Map.update!(:body, &Tesla.Multipart.add_file(&1, path, name: name))
128 def add_param(request, :form, name, value) do
130 |> Map.update(:body, %{name => value}, &Map.put(&1, name, value))
133 def add_param(request, location, key, value) do
134 Map.update(request, location, [{key, value}], &(&1 ++ [{key, value}]))