Clean up a few dialyzer errors

Author: begedin

lib/code_corps/emails/emails.ex

@@ -44,7 +44,7 @@ defmodule CodeCorps.Emails do
     case charge |> Transmissions.Receipt.build(invoice) do
       %SparkPost.Transmission{} = transmission ->
         transmission |> API.send_transmission
-      build_failure -> build_failure
+      {:error, reason} -> {:error, reason}
     end
   end
 

lib/code_corps/emails/extended_api.ex

@@ -1,5 +1,5 @@
 defmodule CodeCorps.Emails.ExtendedAPI do
-  @moduledoc """
+  @moduledoc ~S"""
   Serves as an extension of the SparkPost API provided by the elixir-sparkpost
   library, for features the external package does not support yet
 
@@ -9,31 +9,41 @@ defmodule CodeCorps.Emails.ExtendedAPI do
 
   use HTTPoison.Base
 
+  alias SparkPost.{Transmission, Endpoint}
+
   @base_url "https://api.sparkpost.com/api/v1"
 
+  @spec process_url(String.t) :: String.t
   def process_url(url), do: @base_url <> url
 
+  @spec process_request_headers(list) :: list
   def process_request_headers(headers) do
     [
       {"Content-Type", "application/json"},
       {"Authorization", System.get_env("SPARKPOST_API_KEY")}
     ] ++ headers
   end
 
+  @spec process_request_body(String.t) :: map
   def process_request_body(body), do: body |> Poison.encode!
+
+  @spec process_response_body(String.t) :: map
   def process_response_body(body), do: body |> Poison.decode!
 
+  @spec create_template(map, list, list) :: {:ok, HTTPoison.Response.t} | {:error, HTTPoison.Error.t}
   def create_template(body \\ %{}, headers \\ [], options \\ []) do
     start()
     post("/templates", body, headers, options)
   end
 
+  @spec update_template(String.t, map, list, list) :: {:ok, HTTPoison.Response.t} | {:error, HTTPoison.Error.t}
   def update_template(id, body \\ %{}, headers \\ [], options \\ []) do
     start()
     put("/templates/#{id}", body, headers, options)
   end
 
-  def send_transmission(content) do
-    SparkPost.Transmission.send(content)
+  @spec send_transmission(%Transmission{}) :: %Transmission.Response{} | %Endpoint.Error{}
+  def send_transmission(%Transmission{} = transmission) do
+    transmission |> SparkPost.Transmission.send
   end
 end

lib/code_corps/emails/recipient.ex

@@ -1,6 +1,6 @@
 defmodule CodeCorps.Emails.Recipient do
   @moduledoc ~S"""
-  In charge of adapting `CodeCorps.User` data into SparkPost recipient data.
+  In charge of adapting CodeCorps data into SparkPost recipient data.
   """
 
   alias CodeCorps.{OrganizationInvite, User}

lib/code_corps/emails/transmissions/message_initiated_by_project.ex

@@ -9,7 +9,7 @@ defmodule CodeCorps.Emails.Transmissions.MessageInitiatedByProject do
     WebClient
   }
 
-  @spec build(User.t, String.t) :: %Transmission{}
+  @spec build(Message.t, Conversation.t) :: %Transmission{}
   def build(
     %Message{project: %Project{} = project},
     %Conversation{user: %User{} = user} = conversation) do

lib/code_corps/emails/transmissions/receipt.ex

@@ -20,7 +20,7 @@ defmodule CodeCorps.Emails.Transmissions.Receipt do
     "https://d3pgew4wbk2vb1.cloudfront.net/emails/images/emoji-1f64c-1f3ff@2x.png"
   ]
 
-  @spec build(StripeConnectCharge.t, Stripe.Invoice.t) :: %Transmission{}
+  @spec build(StripeConnectCharge.t, Stripe.Invoice.t) :: %Transmission{} | {:error, atom}
   def build(%StripeConnectCharge{} = charge, %Stripe.Invoice{} = invoice) do
     with %StripeConnectCharge{user: %User{} = user} = charge <- Repo.preload(charge, :user),
          %Project{} = project <- invoice.subscription |> get_project(),
@@ -45,7 +45,9 @@ defmodule CodeCorps.Emails.Transmissions.Receipt do
       }
     else
       nil -> {:error, :project_not_found}
-      other -> other
+      {:error, :donation_goal_not_found} -> {:error, :donation_goal_not_found}
+      {:error, :subscription_not_found} -> {:error, :subscription_not_found}
+      %StripeConnectCharge{user: nil} -> {:error, :charge_not_associated_to_user}
     end
   end
 

lib/code_corps/messages/conversation_parts.ex

@@ -12,12 +12,15 @@ defmodule CodeCorps.Messages.ConversationParts do
     Repo
   }
   alias CodeCorpsWeb.ConversationChannel
+  alias Ecto.Changeset
 
-  @spec create(map) :: ConversationPart.t | Ecto.Changeset.t
+  @spec create(map) :: {:ok, ConversationPart.t} | {:error, Changeset.t}
   def create(attrs) do
     with {:ok, %ConversationPart{} = conversation_part} <- %ConversationPart{} |> create_changeset(attrs) |> Repo.insert() do
       ConversationChannel.broadcast_new_conversation_part(conversation_part)
       {:ok, conversation_part}
+    else
+      {:error, %Changeset{} = changeset} -> {:error, changeset}
     end
   end
 

lib/code_corps/messages/emails.ex

@@ -6,7 +6,8 @@ defmodule CodeCorps.Messages.Emails do
     ConversationPart,
     Emails,
     Message,
-    Repo
+    Repo,
+    User
   }
 
   @message_preloads [:project, [conversations: :user]]
@@ -44,8 +45,9 @@ defmodule CodeCorps.Messages.Emails do
   """
   @spec notify_of_new_reply(ConversationPart.t) :: :ok
   def notify_of_new_reply(%ConversationPart{} = part) do
-    part = part |> Repo.preload(@part_preloads)
-    part |> send_reply_to_conversation_emails()
+    part
+    |> Repo.preload(@part_preloads)
+    |> send_reply_to_conversation_emails()
   end
 
   @spec send_reply_to_conversation_emails(ConversationPart.t) :: :ok

lib/code_corps/policy/conversation_part.ex

@@ -39,18 +39,16 @@ defmodule CodeCorps.Policy.ConversationPart do
   @spec authorize(User.t, ConversationPart.t | map) :: boolean
   defp authorize(%User{} = user, attrs) do
     %Conversation{} = conversation = attrs |> get_conversation()
-    is_target? = conversation |> conversation_target?(user)
 
-    is_admin? =
-      conversation
-      |> get_message()
-      |> get_project()
-      |> administered_by?(user)
-
-    is_target? or is_admin?
+    cond do
+      conversation |> conversation_target?(user) -> true
+      conversation |> get_message() |> get_project() |> administered_by?(user) -> false
+      true -> false
+    end
   end
 
-  defp conversation_target?(%Conversation{user_id: target_id}, %User{id: user_id}) do
-    target_id == user_id
-  end
+  @spec conversation_target?(Conversation.t, User.t) :: boolean
+  defp conversation_target?(%Conversation{user_id: target_id}, %User{id: user_id})
+    when target_id == user_id, do: true
+  defp conversation_target?(%Conversation{}, %User{}), do: false
 end

lib/code_corps/policy/helpers.ex

@@ -104,7 +104,7 @@ defmodule CodeCorps.Policy.Helpers do
   @doc """
   Retrieves conversation from associated record
   """
-  @spec get_conversation(Changeset.t() | ConversationPart.t() | map) :: Message.t()
+  @spec get_conversation(Changeset.t() | ConversationPart.t() | map) :: Conversation.t()
   def get_conversation(%ConversationPart{conversation_id: conversation_id}), do: Repo.get(Conversation, conversation_id)
   def get_conversation(%{"conversation_id" => conversation_id}), do: Repo.get(Conversation, conversation_id)
   def get_conversation(%Changeset{changes: %{conversation_id: conversation_id}}), do: Repo.get(Conversation, conversation_id)