Add type spec

Author: danschultzer

lib/phoenix_oauth2_provider.ex

@@ -13,10 +13,13 @@ defmodule PhoenixOauth2Provider do
   library.
   """
   alias Mix.Phoenix
+  alias Plug.Conn
+  alias Ecto.Schema
 
   @doc """
   Will get current resource owner from endpoint
   """
+  @spec current_resource_owner(Conn.t()) :: Schema.t() | no_return
   def current_resource_owner(conn) do
     resource_owner_key = Keyword.get(config(), :current_resource_owner, :current_user)
 
@@ -27,11 +30,13 @@ defmodule PhoenixOauth2Provider do
   end
 
   @doc false
+  @spec config :: Keyword.t()
   def config do
     Application.get_env(:phoenix_oauth2_provider, PhoenixOauth2Provider, [])
   end
 
   @doc false
+  @spec router_helpers :: module()
   def router_helpers do
     module = Keyword.get(config(), :router, router_module())
 

lib/phoenix_oauth2_provider/view_helpers.ex

@@ -3,19 +3,23 @@ defmodule PhoenixOauth2Provider.ViewHelpers do
   Helper functions for PhoenixOauth2Provider Views.
   """
   use Phoenix.HTML
+  alias Ecto.Changeset
+  alias Phoenix.HTML
 
   @doc """
   Generates tag for inlined form input errors.
   """
+  @spec error_tag(Changeset.t(), atom()) :: HTML.safe() | nil
   def error_tag(form, field) do
     if error = form.errors[field] do
-      content_tag :span, translate_error(error), class: "help-block"
+      content_tag(:span, translate_error(error), class: "help-block")
     end
   end
 
   @doc """
   Translates an error message using gettext.
   """
+  @spec translate_error({binary(), Keyword.t()}) :: binary()
   def translate_error({msg, opts}) do
     # Because error messages were defined within Ecto, we must
     # call the Gettext module passing our Gettext backend. We
@@ -28,6 +32,7 @@ defmodule PhoenixOauth2Provider.ViewHelpers do
     Gettext.dngettext(PhoenixOauth2Provider.Web.Gettext, "errors", msg, msg, opts[:count] || 0, opts)
   end
 
+  @spec translate_error(binary()) :: binary()
   def translate_error(msg) do
     Gettext.dgettext(PhoenixOauth2Provider.Web.Gettext, "errors", msg)
   end

lib/phoenix_oauth2_provider/web/controllers/application_controller.ex

@@ -3,7 +3,9 @@ defmodule PhoenixOauth2Provider.ApplicationController do
   use PhoenixOauth2Provider.Web, :controller
 
   alias ExOauth2Provider.OauthApplications
+  alias Plug.Conn
 
+  @spec index(Conn.t(), map()) :: Conn.t()
   def index(conn, _params) do
     applications = conn
                    |> PhoenixOauth2Provider.current_resource_owner()
@@ -12,12 +14,14 @@ defmodule PhoenixOauth2Provider.ApplicationController do
     render(conn, "index.html", applications: applications)
   end
 
+  @spec new(Conn.t(), map()) :: Conn.t()
   def new(conn, _params) do
     changeset = OauthApplications.change_application(%OauthApplications.OauthApplication{})
 
     render(conn, "new.html", changeset: changeset)
   end
 
+  @spec create(Conn.t(), map()) :: Conn.t()
   def create(conn, %{"oauth_application" => application_params}) do
     conn
     |> PhoenixOauth2Provider.current_resource_owner()
@@ -33,19 +37,22 @@ defmodule PhoenixOauth2Provider.ApplicationController do
     end
   end
 
+  @spec show(Conn.t(), map()) :: Conn.t()
   def show(conn, %{"uid" => uid}) do
     application = get_application_for!(conn, uid)
 
     render(conn, "show.html", application: application)
   end
 
+  @spec edit(Conn.t(), map()) :: Conn.t()
   def edit(conn, %{"uid" => uid}) do
     application = get_application_for!(conn, uid)
     changeset = OauthApplications.change_application(application)
 
     render(conn, "edit.html", application: application, changeset: changeset)
   end
 
+  @spec update(Conn.t(), map()) :: Conn.t()
   def update(conn, %{"uid" => uid, "oauth_application" => application_params}) do
     application = get_application_for!(conn, uid)
 
@@ -60,6 +67,7 @@ defmodule PhoenixOauth2Provider.ApplicationController do
     end
   end
 
+  @spec delete(Conn.t(), map()) :: Conn.t()
   def delete(conn, %{"uid" => uid}) do
     {:ok, _application} = conn
                           |> get_application_for!(uid)

lib/phoenix_oauth2_provider/web/controllers/authorization_controller.ex

@@ -3,7 +3,9 @@ defmodule PhoenixOauth2Provider.AuthorizationController do
   use PhoenixOauth2Provider.Web, :controller
 
   alias ExOauth2Provider.Authorization
+  alias Plug.Conn
 
+  @spec new(Conn.t(), map()) :: Conn.t()
   def new(conn, params) do
     conn
     |> PhoenixOauth2Provider.current_resource_owner()
@@ -22,20 +24,23 @@ defmodule PhoenixOauth2Provider.AuthorizationController do
     end
   end
 
+  @spec create(Conn.t(), map()) :: Conn.t()
   def create(conn, params) do
     conn
     |> PhoenixOauth2Provider.current_resource_owner()
     |> Authorization.authorize(params)
     |> redirect_or_render(conn)
   end
 
+  @spec delete(Conn.t(), map()) :: Conn.t()
   def delete(conn, params) do
     conn
     |> PhoenixOauth2Provider.current_resource_owner()
     |> Authorization.deny(params)
     |> redirect_or_render(conn)
   end
 
+  @spec show(Conn.t(), map()) :: Conn.t()
   def show(conn, %{"code" => code}) do
     render(conn, "show.html", code: code)
   end
@@ -44,7 +49,7 @@ defmodule PhoenixOauth2Provider.AuthorizationController do
     redirect(conn, external: redirect_uri)
   end
   defp redirect_or_render({:native_redirect, payload}, conn) do
-    json conn, payload
+    json(conn, payload)
   end
   defp redirect_or_render({:error, error, status}, conn) do
     conn

lib/phoenix_oauth2_provider/web/controllers/authorized_application_controller.ex

@@ -3,6 +3,7 @@ defmodule PhoenixOauth2Provider.AuthorizedApplicationController do
   use PhoenixOauth2Provider.Web, :controller
   alias ExOauth2Provider.OauthApplications
 
+  @spec index(Conn.t(), map()) :: Conn.t()
   def index(conn, _params) do
     applications = conn
                    |> PhoenixOauth2Provider.current_resource_owner()
@@ -11,6 +12,7 @@ defmodule PhoenixOauth2Provider.AuthorizedApplicationController do
                    render(conn, "index.html", applications: applications)
   end
 
+  @spec delete(Conn.t(), map()) :: Conn.t()
   def delete(conn, %{"uid" => uid}) do
     application = OauthApplications.get_application!(uid)
     {:ok, _application} = OauthApplications.revoke_all_access_tokens_for(application, PhoenixOauth2Provider.current_resource_owner(conn))

lib/phoenix_oauth2_provider/web/controllers/token_controller.ex

@@ -1,27 +1,28 @@
 defmodule PhoenixOauth2Provider.TokenController do
   @moduledoc false
   use PhoenixOauth2Provider.Web, :controller
-
   alias ExOauth2Provider.Token
 
+  @spec create(Conn.t(), map()) :: Conn.t()
   def create(conn, params) do
     case Token.grant(params) do
       {:ok, access_token} ->
-        conn
-        |> json(access_token)
-      {:error, error, status} ->
+        json(conn, access_token)
+
+        {:error, error, status} ->
         conn
         |> put_status(status)
         |> json(error)
     end
   end
 
+  @spec revoke(Conn.t(), map()) :: Conn.t()
   def revoke(conn, params) do
     case Token.revoke(params) do
       {:ok, response} ->
-        conn
-        |> json(response)
-      {:error, error, status} ->
+        json(conn, response)
+
+        {:error, error, status} ->
         conn
         |> put_status(status)
         |> json(error)