Merge pull request #1250 from code-corps/fix-more-dialyzer

Update stripity_stripe, refactor, fix dialyzer errors

Author: joshsmith

lib/code_corps/cloudex/cloudex_test.ex

@@ -14,13 +14,12 @@ defmodule CloudexTest do
     end
   end
 
-  @spec upload(String.t) :: {:ok, %Cloudex.UploadedImage{}}
+  @spec upload(String.t) :: {:ok, Cloudex.UploadedImage.t}
   def upload(_url) do
     {:ok, %Cloudex.UploadedImage{public_id: fake_cloudinary_id()}}
   end
 
   defp fake_cloudinary_id do
-    :crypto.strong_rand_bytes(5)
-    |> Base.encode64
+    :crypto.strong_rand_bytes(5) |> Base.encode64()
   end
 end

lib/code_corps/cloudex/uploader.ex

@@ -2,7 +2,8 @@ defmodule CodeCorps.Cloudex.Uploader do
 
   @cloudex Application.get_env(:code_corps, :cloudex)
 
-  def upload(url) do
-    @cloudex.upload(url)
+  @spec upload(list | String.t) :: Cloudex.upload_result()
+  def upload(list_or_url) do
+    @cloudex.upload(list_or_url)
   end
 end

lib/code_corps/emails/receipt_email.ex

@@ -30,7 +30,7 @@ defmodule CodeCorps.Emails.ReceiptEmail do
     end
   end
 
-  @spec get_subscription(String.t) :: Subscription.t | nil
+  @spec get_subscription(String.t) :: StripeConnectSubscription.t | nil
   defp get_subscription(subscription_id_from_stripe) do
     StripeConnectSubscription
     |> Repo.get_by(id_from_stripe: subscription_id_from_stripe)

lib/code_corps/model/organization_invite.ex

@@ -5,6 +5,8 @@ defmodule CodeCorps.OrganizationInvite do
 
   use CodeCorps.Model
 
+  @type t :: %__MODULE__{}
+
   schema "organization_invites" do
     field :code, :string
     field :email, :string

lib/code_corps/model/stripe_connect_subscription.ex

@@ -63,7 +63,7 @@ defmodule CodeCorps.StripeConnectSubscription do
     :quantity, :stripe_connect_plan_id, :user_id
   ]
 
-  @spec create_changeset(CodeCorps.StripeConnectPlan.t, map) :: Ecto.Changeset.t
+  @spec create_changeset(CodeCorps.StripeConnectSubscription.t, map) :: Ecto.Changeset.t
   def create_changeset(struct, params \\ %{}) do
     struct
     |> cast(params, @permitted_params)
@@ -75,7 +75,7 @@ defmodule CodeCorps.StripeConnectSubscription do
 
   @update_params [:cancelled_at, :current_period_end, :current_period_start, :ended_at, :quantity, :start, :status]
 
-  @spec webhook_update_changeset(CodeCorps.StripeConnectPlan.t, map) :: Ecto.Changeset.t
+  @spec webhook_update_changeset(CodeCorps.StripeConnectSubscription.t, map) :: Ecto.Changeset.t
   def webhook_update_changeset(struct, params \\ %{}) do
     struct
     |> cast(params, @update_params)

lib/code_corps/services/markdown_renderer_service.ex

@@ -5,25 +5,34 @@ defmodule CodeCorps.Services.MarkdownRendererService do
 
   alias Ecto.Changeset
 
-  @spec render_markdown_to_html(Changeset.t, atom, atom) :: Changeset.t
+  @spec render_markdown_to_html(Changeset.t(), atom, atom) :: Changeset.t()
   def render_markdown_to_html(%Changeset{valid?: false} = changeset, _, _), do: changeset
   def render_markdown_to_html(changeset, source_field, destination_field) do
-    case Changeset.get_change(changeset, source_field) do
-      "" -> Changeset.put_change(changeset, destination_field, nil)
-      nil -> changeset
-      markdown -> markdown |> convert_into_html() |> put_into(changeset, destination_field)
-    end
+    change = changeset |> Changeset.get_change(source_field)
+    changeset |> handle_change(change, destination_field)
   end
 
-  @spec convert_into_html(String.t) :: String.t
-  defp convert_into_html(markdown) do
-    # Prism.js requires a `language-` prefix in code classes
-    # See: https://github.com/pragdave/earmark#syntax-highlightning
-    Earmark.as_html!(markdown, %Earmark.Options{code_class_prefix: "language-"})
+  @spec handle_change(Changeset.t(), String.t() | nil, atom) :: Changeset.t()
+  defp handle_change(changeset, nil, _), do: changeset
+  defp handle_change(changeset, "", destination_field) do
+    Changeset.put_change(changeset, destination_field, nil)
+  end
+  defp handle_change(changeset, lines, destination_field) when is_binary(lines) do
+    lines
+    |> convert_into_html()
+    |> put_into(changeset, destination_field)
+  end
+
+  # Prism.js requires a `language-` prefix in code classes
+  # See: https://github.com/pragdave/earmark#syntax-highlightning
+  @spec convert_into_html(String.t()) :: String.t()
+  defp convert_into_html(lines) do
+    lines
+    |> Earmark.as_html!(%Earmark.Options{code_class_prefix: "language-"})
   end
 
-  @spec put_into(String.t, Changeset.t, atom) :: Changeset.t
+  @spec put_into(String.t(), Changeset.t(), atom) :: Changeset.t()
   defp put_into(html, changeset, destination_field) do
-    Changeset.put_change(changeset, destination_field, html)
+    changeset |> Changeset.put_change(destination_field, html)
   end
 end

lib/code_corps/services/user_service.ex

@@ -83,15 +83,15 @@ defmodule CodeCorps.Services.UserService do
     end
   end
 
-  @spec do_update_connect_customers(%StripePlatformCustomer{}, map) :: [%StripeConnectCustomer{}]
+  @spec do_update_connect_customers(StripePlatformCustomer.t, map) :: [{:ok, StripeConnectCustomer.t}] | [{:error, Stripe.Error.t}]
   defp do_update_connect_customers(stripe_platform_customer, attributes) do
     stripe_platform_customer
     |> Repo.preload([stripe_connect_customers: :stripe_connect_account])
     |> Map.get(:stripe_connect_customers)
     |> Enum.map(&do_update_connect_customer(&1, attributes))
   end
 
-  @spec do_update_connect_customer(%StripeConnectCustomer{}, map) :: [%StripeConnectCustomer{}]
+  @spec do_update_connect_customer(StripeConnectCustomer.t, map) :: {:ok, StripeConnectCustomer.t} | {:error, Stripe.Error.t}
   defp do_update_connect_customer(%StripeConnectCustomer{} = stripe_connect_customer, attributes) do
     StripeConnectCustomerService.update(stripe_connect_customer, attributes)
   end

lib/code_corps/stripe_service/events/connect_charge_succeeded.ex

@@ -9,23 +9,19 @@ defmodule CodeCorps.StripeService.Events.ConnectChargeSucceeded do
   @api Application.get_env(:code_corps, :stripe)
 
   def handle(%{data: %{object: %{id: id_from_stripe}}, user_id: connect_account_id_from_stripe}) do
-    with {:ok, charge} <- create_charge(id_from_stripe, connect_account_id_from_stripe) do
-      charge |> track_created
+    with {:ok, %StripeConnectCharge{} = charge} <- StripeConnectChargeService.create(id_from_stripe, connect_account_id_from_stripe) do
+      charge |> track_created()
 
       charge
       |> try_create_receipt(connect_account_id_from_stripe)
-      |> maybe_send_receipt
+      |> maybe_send_receipt()
     else
       failure -> failure
     end
   end
 
-  defp create_charge(id_from_stripe, account_id_from_stripe) do
-    StripeConnectChargeService.create(id_from_stripe, account_id_from_stripe)
-  end
-
   defp try_create_receipt(%StripeConnectCharge{invoice_id_from_stripe: invoice_id} = charge, account_id) do
-    with {:ok, %Stripe.Invoice{} = invoice} <- retrieve_invoice(invoice_id, account_id),
+    with {:ok, %Stripe.Invoice{} = invoice} <- @api.Invoice.retrieve(invoice_id, connect_account: account_id),
          %Bamboo.Email{} = receipt <- Emails.ReceiptEmail.create(charge, invoice)
     do
       {:ok, charge, receipt}
@@ -34,10 +30,6 @@ defmodule CodeCorps.StripeService.Events.ConnectChargeSucceeded do
     end
   end
 
-  defp retrieve_invoice(invoice_id, account_id) do
-    @api.Invoice.retrieve(invoice_id, connect_account: account_id)
-  end
-
   defp maybe_send_receipt({:ok, charge, receipt}) do
     with %Bamboo.Email{} = email <- receipt |> Mailer.deliver_now do
       {:ok, charge, email}

lib/code_corps/stripe_service/stripe_connect_charge_service.ex

@@ -6,15 +6,15 @@ defmodule CodeCorps.StripeService.StripeConnectChargeService do
 
   @api Application.get_env(:code_corps, :stripe)
 
-  @spec create(String.t, String.t) :: Ecto.Changeset.t
+  @spec create(String.t, String.t) :: {:ok, StripeConnectCharge.t} | {:error, Ecto.Changeset.t}
   def create(id_from_stripe, connect_account_id_from_stripe) do
     with {:ok, %StripeConnectAccount{} = stripe_connect_account} <- get_connect_account(connect_account_id_from_stripe),
          {:ok, %Stripe.Charge{} = api_charge} <- @api.Charge.retrieve(id_from_stripe, connect_account: connect_account_id_from_stripe),
          {:ok, params} = StripeConnectChargeAdapter.to_params(api_charge, stripe_connect_account)
     do
       %StripeConnectCharge{}
       |> StripeConnectCharge.create_changeset(params)
-      |> Repo.insert
+      |> Repo.insert()
     end
   end
 

lib/code_corps/stripe_service/stripe_connect_plan.ex

@@ -25,12 +25,12 @@ defmodule CodeCorps.StripeService.StripeConnectPlanService do
          {:ok, %Project{}} <- ProjectCanEnableDonations.validate(project),
          %{} = create_attributes <- get_create_attributes(project_id),
          connect_account_id <- project.organization.stripe_connect_account.id_from_stripe,
-         {:ok, plan} <- @api.Plan.create(create_attributes, connect_account: connect_account_id),
+         {:ok, %Stripe.Plan{} = plan} <- @api.Plan.create(create_attributes, connect_account: connect_account_id),
          {:ok, params} <- StripeConnectPlanAdapter.to_params(plan, attributes)
     do
       %StripeConnectPlan{}
       |> StripeConnectPlan.create_changeset(params)
-      |> Repo.insert
+      |> Repo.insert()
     else
       failure -> failure
     end