Lob.Util (lob_elixir v1.6.0)

Module responsible for transforming arguments for requests.

Summary

Functions

build_body(body)

Transforms a map to a tuple recognized by HTTPoison/hackney for use as a multipart request body.

build_headers(headers)

Transforms a map to a list of tuples recognized by HTTPoison/hackeny for use as request headers.

build_query_string(params)

Transforms a map of request params to a URL encoded query string.

Functions

build_body(body)

@spec build_body(map()) :: {:multipart, list()}

Transforms a map to a tuple recognized by HTTPoison/hackney for use as a multipart request body.

Example

iex> {:multipart, parts} = Lob.Util.build_body(%{description: "body", to: %{name: "Larry", species: "Lobster"}, front: %{local_path: "a/b/c"}}) iex> Enum.member?(parts, {"description", "body"}) true iex> Enum.member?(parts, {"to[name]", "Larry"}) true iex> Enum.member?(parts, {"to[species]", "Lobster"}) true iex> Enum.member?(parts, {:file, "a/b/c", {"form-data", [name: "front", filename: "a/b/c"]}, []}) true

build_headers(headers)

@spec build_headers(map()) :: [{String.t(), String.t()}]

Transforms a map to a list of tuples recognized by HTTPoison/hackeny for use as request headers.

Example

iex> Lob.Util.build_headers(%{"Idempotency-Key" => "abc123", "Lob-Version" => "2017-11-08"}) [{"Idempotency-Key", "abc123"}, {"Lob-Version", "2017-11-08"}]

build_query_string(params)

@spec build_query_string(map()) :: String.t()

Transforms a map of request params to a URL encoded query string.

Example

iex> Lob.Util.build_query_string(%{count: 1, include: ["total_count"], metadata: %{name: "Larry"}}) "count=1&include%5B%5D=total_count&metadata%5Bname%5D=Larry"