add back the ability to pass options as a final param

Author: dnsbty

README.md

@@ -9,7 +9,7 @@ The package can be installed by adding `podium_ex` to your list of dependencies
 ```elixir
 def deps do
   [
-    {:podium_ex, "~> 0.6"}
+    {:podium_ex, "~> 0.7"}
   ]
 end
 ```
@@ -25,7 +25,7 @@ You will need to provide the following configuration options (usually in `config
 
 You can optionally also include the following:
 
-`:base_url` - The root URL onto which all paths are appended. Defaults to `https://api.podium.com/api/v2`
+- `:base_url` - The root URL onto which all paths are appended. Defaults to `https://api.podium.com/api/v2`
 
 ### Example Configuration
 

lib/podium.ex

@@ -1,7 +1,13 @@
 defmodule Podium do
   @moduledoc """
-  Podium is a client for Podium's public API. It allows your to create new
+  Podium is a client for Podium's public API. It allows you to create new
   messages and send them, among other things.
+
+  All functions accept a keyword list of options as an optional second
+  argument. Those options will be passed through to `HTTPoison.Request`. Other
+  options include the following:
+
+  - `:headers` - allows you to add headers to the defaults sent by the library
   """
 
   alias Podium.{
@@ -19,102 +25,119 @@ defmodule Podium do
   @doc """
   Create a conversation item. Read about conversation items [here](https://hexdocs.pm/podium_ex/Podium.ConversationItem.html#content).
   """
-  @spec create_conversation_item(ConversationItem.t()) :: ConversationItem.t()
-  def create_conversation_item(%ConversationItem{} = item) do
+  @spec create_conversation_item(ConversationItem.t(), Keyword.t()) :: ConversationItem.t()
+  def create_conversation_item(%ConversationItem{} = item, opts \\ []) do
+    {headers, opts} = Keyword.pop(opts, :headers, [])
+
     conversation_item =
       item
       |> remove_nils()
       |> format_actions()
       |> inject_application_uid()
       |> inject_source_type()
 
-    conversation_item =
+    body =
       Caramelize.camelize(%{
         conversation_item: conversation_item
       })
 
-    API.post("/conversation_items", Caramelize.camelize(conversation_item))
+    API.post("/conversation_items", body, headers, opts)
   end
 
   @doc """
   Update a [conversation item](https://hexdocs.pm/podium_ex/Podium.ConversationItem.html#content).
   """
-  @spec update_conversation_item(ConversationItem.t()) :: ConversationItem.t()
-  def update_conversation_item(%ConversationItem{} = item) do
+  @spec update_conversation_item(ConversationItem.t(), Keyword.t()) :: ConversationItem.t()
+  def update_conversation_item(%ConversationItem{} = item, opts \\ []) do
+    {headers, opts} = Keyword.pop(opts, :headers, [])
+
     conversation_item =
       item
       |> remove_nils()
       |> inject_application_uid()
       |> inject_source_type()
 
-    conversation_item = %{
-      conversation_item: conversation_item
-    }
+    body =
+      Caramelize.camelize(%{
+        conversation_item: conversation_item
+      })
 
-    API.put("/conversation_items", Caramelize.camelize(conversation_item))
+    API.put("/conversation_items", body, headers, opts)
   end
 
   @doc """
   Delete a [conversation item](https://hexdocs.pm/podium_ex/Podium.ConversationItem.html#content).
   """
-  @spec delete_conversation_item(String.t(), String.t()) :: :ok
-  def delete_conversation_item(uid, organization_uid) do
+  @spec delete_conversation_item(String.t(), String.t(), Keyword.t()) :: :ok
+  def delete_conversation_item(uid, org_uid, opts \\ []) do
+    {headers, opts} = Keyword.pop(opts, :headers, [])
     application_uid = Application.get_env(:podium_ex, :application_uid)
 
-    API.delete("/applications/#{application_uid}/organizations/#{organization_uid}/conversation_items/#{uid}")
+    path = "/applications/#{application_uid}/organizations/#{org_uid}/conversation_items/#{uid}"
+
+    API.delete(path, headers, opts)
   end
 
   @doc """
   Create a message. Read about messages [here](https://hexdocs.pm/podium_ex/Podium.Message.html#content).
   """
-  @spec create_message(Message.t()) :: Message.t()
-  def create_message(%Message{} = msg) do
+  @spec create_message(Message.t(), Keyword.t()) :: Message.t()
+  def create_message(%Message{} = msg, opts \\ []) do
+    {headers, opts} = Keyword.pop(opts, :headers, [])
+
     message =
       msg
       |> remove_nils()
       |> inject_application_uid()
 
-    message = %{
-      conversation_item: message
-    }
+    body =
+      Caramelize.camelize(%{
+        conversation_item: message
+      })
 
-    API.post("/messages", Caramelize.camelize(message))
+    API.post("/messages", body, headers, opts)
   end
 
   @doc """
   Create an interaction. Read about interactions [here](https://hexdocs.pm/podium_ex/Podium.Interaction.html#content).
   """
-  @spec create_interaction(Interaction.t()) :: Interaction.t()
-  def create_interaction(%Interaction{} = interaction) do
+  @spec create_interaction(Interaction.t(), Keyword.t()) :: Interaction.t()
+  def create_interaction(%Interaction{} = interaction, opts \\ []) do
+    {headers, opts} = Keyword.pop(opts, :headers, [])
+
     interaction =
       interaction
       |> remove_nils()
       |> inject_application_uid()
       |> inject_source_type()
 
-    interaction = %{
-      interaction: interaction
-    }
+    body =
+      Caramelize.camelize(%{
+        interaction: interaction
+      })
 
-    API.post("/interactions", Caramelize.camelize(interaction))
+    API.post("/interactions", body, headers, opts)
   end
 
   @doc """
   Update an [interaction](https://hexdocs.pm/podium_ex/Podium.Interaction.html#content).
   """
-  @spec update_interaction(Interaction.t()) :: Interaction.t()
-  def update_interaction(%Interaction{uid: uid} = interaction) do
+  @spec update_interaction(Interaction.t(), Keyword.t()) :: Interaction.t()
+  def update_interaction(%Interaction{uid: uid} = interaction, opts \\ []) do
+    {headers, opts} = Keyword.pop(opts, :headers, [])
+
     interaction =
       interaction
       |> remove_nils()
       |> inject_application_uid()
       |> inject_source_type()
 
-    interaction = %{
-      interaction: interaction
-    }
+    body =
+      Caramelize.camelize(%{
+        interaction: interaction
+      })
 
-    API.put("/interactions/#{uid}", Caramelize.camelize(interaction))
+    API.put("/interactions/#{uid}", body, headers, opts)
   end
 
   @doc """
@@ -128,10 +151,12 @@ defmodule Podium do
       iex> get_organization("non-existent UID")
       nil
   """
-  @spec get_organization(String.t()) :: Organization.t() | nil
-  def get_organization(uid) do
+  @spec get_organization(String.t(), Keyword.t()) :: Organization.t() | nil
+  def get_organization(uid, opts \\ []) do
+    {headers, opts} = Keyword.pop(opts, :headers, [])
+
     with {:ok, %HTTPoison.Response{body: body, status_code: 200}} <-
-           API.get("/organizations/#{uid}"),
+           API.get("/organizations/#{uid}", headers, opts),
          {:ok, %{"data" => %{"organization" => org}}} <- Jason.decode(body),
          %{"uid" => uid, "locations" => locations, "businessName" => name} <- org do
       %Organization{

lib/podium/api.ex

@@ -8,12 +8,12 @@ defmodule Podium.API do
 
   use HTTPoison.Base
 
-  @spec process_url(String.t()) :: String.t()
+  @impl HTTPoison.Base
   def process_url(path) do
     base_url() <> path
   end
 
-  @spec process_request_headers(list()) :: list()
+  @impl HTTPoison.Base
   def process_request_headers(headers) do
     [
       {"Accept", "application/json"},
@@ -23,17 +23,28 @@ defmodule Podium.API do
     ] ++ headers
   end
 
-  @spec process_request_body(map()) :: String.t()
+  @impl HTTPoison.Base
   def process_request_body(body) do
     Jason.encode!(body)
   end
 
+  @impl HTTPoison.Base
+  def process_request_options(opts) do
+    opts ++ [timeout: timeout(), recv_timeout: recv_timeout()]
+  end
+
   @spec api_key() :: String.t()
   defp api_key, do: Application.get_env(:podium_ex, :api_key, "")
 
   @spec base_url() :: String.t()
   defp base_url, do: Application.get_env(:podium_ex, :base_url, @default_base_url)
 
+  @spec timeout :: integer()
+  defp timeout, do: Application.get_env(:podium_ex, :timeout, 15_000)
+
+  @spec recv_timeout :: integer()
+  defp recv_timeout, do: Application.get_env(:podium_ex, :recv_timeout, 15_000)
+
   @spec application_uid() :: String.t()
   defp application_uid, do: Application.get_env(:podium_ex, :application_uid, "")
 end

mix.exs

@@ -5,7 +5,7 @@ defmodule PodiumEx.MixProject do
     [
       app: :podium_ex,
       description: "HTTP client for interfacing with the Podium API",
-      version: "0.6.0",
+      version: "0.7.0",
       elixir: "~> 1.7",
       start_permanent: Mix.env() == :prod,
       deps: deps(),