Merge pull request #23 from danschultzer/ex-oauth2-provider-0-5-1

danschultzer · web-flow · commit 1c736a1022ae · 2019-05-08T21:02:47.000-07:00
Update to use ExOauth2Provider 0.5.1
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Changelog
 
+## v0.5.1 (TBA)
+
+* Require ExOauth2Provider v0.5.1
+* Pass configuration to all ExOauth2Provider methods
+
 ## v0.5.0 (2019-05-08)
 
 This is a full rewrite of the library, and are several breaking changes. You're encouraged to test your app well if you upgrade from 0.4.x.
diff --git a/README.md b/README.md
@@ -35,7 +35,7 @@ Set up routes:
 ```elixir
 defmodule MyAppWeb.Router do
   use MyAppWeb, :router
-  use PhoenixOauth2Provider.Router
+  use PhoenixOauth2Provider.Router, otp_app: :my_app
 
   # ...
 
diff --git a/lib/mix/phoenix_oauth2_provider/template.ex b/lib/mix/phoenix_oauth2_provider/template.ex
@@ -1,8 +1,7 @@
 defmodule Mix.PhoenixOauth2Provider.Template do
   @moduledoc false
 
-  alias ExOauth2Provider.Config
-  alias Mix.{Generator, Phoenix}
+  alias Mix.{ExOauth2Provider, Generator, Phoenix}
 
   @views ["application", "authorization", "authorized_application"]
   @view_template """
@@ -54,7 +53,7 @@ defmodule Mix.PhoenixOauth2Provider.Template do
   defp web_path(context_app), do: Phoenix.web_path(context_app)
 
   defp web_app(ctx_app) do
-    this_app = Config.otp_app()
+    this_app = ExOauth2Provider.otp_app()
 
     if ctx_app == this_app do
       "#{ctx_app}_web"
diff --git a/lib/mix/tasks/phoenix_oauth2_provider.gen.templates.ex b/lib/mix/tasks/phoenix_oauth2_provider.gen.templates.ex
@@ -12,7 +12,6 @@ defmodule Mix.Tasks.PhoenixOauth2Provider.Gen.Templates do
   """
   use Mix.Task
 
-  alias ExOauth2Provider.Config
   alias Mix.ExOauth2Provider
   alias Mix.PhoenixOauth2Provider.Template
 
@@ -35,7 +34,7 @@ defmodule Mix.Tasks.PhoenixOauth2Provider.Gen.Templates do
   defp create_template_files(config) do
     config
     |> Map.get(:context_app)
-    |> Kernel.||(Config.otp_app())
+    |> Kernel.||(ExOauth2Provider.otp_app())
     |> Template.create_view_and_template_files()
   end
 end
diff --git a/lib/phoenix_oauth2_provider/config.ex b/lib/phoenix_oauth2_provider/config.ex
@@ -1,18 +1,18 @@
 defmodule PhoenixOauth2Provider.Config do
   @moduledoc false
 
-  alias ExOauth2Provider.Config
-
   @spec current_resource_owner(keyword()) :: atom()
   def current_resource_owner(config), do: get(config, :current_resource_owner, :current_user)
 
   @spec web_module(keyword()) :: atom()
   def web_module(config), do: get(config, :web_module)
 
   defp get(config, key, value \\ nil) do
+    otp_app = Keyword.get(config, :otp_app)
+
     config
     |> get_from_config(key)
-    |> get_from_app_env(key)
+    |> get_from_app_env(otp_app, key)
     |> get_from_global_env(key)
     |> case do
       :not_found -> value
@@ -22,14 +22,13 @@ defmodule PhoenixOauth2Provider.Config do
 
   defp get_from_config(config, key), do: Keyword.get(config, key, :not_found)
 
-  defp get_from_app_env(:not_found, key) do
-    app = Config.otp_app()
-
-    app
+  defp get_from_app_env(:not_found, nil, _key), do: :not_found
+  defp get_from_app_env(:not_found, otp_app, key) do
+    otp_app
     |> Application.get_env(PhoenixOauth2Provider, [])
     |> Keyword.get(key, :not_found)
   end
-  defp get_from_app_env(value, _key), do: value
+  defp get_from_app_env(value, _otp_app, _key), do: value
 
   defp get_from_global_env(:not_found, key) do
     :phoenix_oauth2_provider
diff --git a/lib/phoenix_oauth2_provider/controller.ex b/lib/phoenix_oauth2_provider/controller.ex
@@ -16,7 +16,8 @@ defmodule PhoenixOauth2Provider.Controller do
       defdelegate put_web_module_view(conn, type), to: unquote(__MODULE__), as: :__put_web_module_view__
 
       def action(conn, _opts) do
-        params = unquote(__MODULE__).__action_params__(conn, unquote(type))
+        config = conn.private[:phoenix_oauth2_provider_config]
+        params = unquote(__MODULE__).__action_params__(conn, config, unquote(type))
 
         apply(__MODULE__, action_name(conn), params)
       end
@@ -74,8 +75,8 @@ defmodule PhoenixOauth2Provider.Controller do
   defp load_config(conn), do: Map.get(conn.private, :phoenix_oauth2_provider_config, [])
 
   @doc false
-  def __action_params__(conn, :api), do: [conn, conn.params]
-  def __action_params__(conn, _any), do: [conn, conn.params, current_resource_owner(conn)]
+  def __action_params__(conn, config, :api), do: [conn, conn.params, config]
+  def __action_params__(conn, config, _any), do: [conn, conn.params, current_resource_owner(conn), config]
 
   defp current_resource_owner(conn) do
     resource_owner_key = Config.current_resource_owner([])
diff --git a/lib/phoenix_oauth2_provider/controllers/application_controller.ex b/lib/phoenix_oauth2_provider/controllers/application_controller.ex
@@ -5,27 +5,27 @@ defmodule PhoenixOauth2Provider.ApplicationController do
   alias ExOauth2Provider.Applications
   alias Plug.Conn
 
-  @spec index(Conn.t(), map(), map()) :: Conn.t()
-  def index(conn, _params, resource_owner) do
-    applications = Applications.get_applications_for(resource_owner)
+  @spec index(Conn.t(), map(), map(), keyword()) :: Conn.t()
+  def index(conn, _params, resource_owner, config) do
+    applications = Applications.get_applications_for(resource_owner, config)
 
     render(conn, "index.html", applications: applications)
   end
 
-  @spec new(Conn.t(), map(), map()) :: Conn.t()
-  def new(conn, _params, _resource_owner) do
+  @spec new(Conn.t(), map(), map(), keyword()) :: Conn.t()
+  def new(conn, _params, _resource_owner, config) do
     changeset =
-      ExOauth2Provider.Config.application([])
+      ExOauth2Provider.Config.application(config)
       |> struct()
-      |> Applications.change_application()
+      |> Applications.change_application(%{}, config)
 
     render(conn, "new.html", changeset: changeset)
   end
 
-  @spec create(Conn.t(), map(), map()) :: Conn.t()
-  def create(conn, %{"oauth_application" => application_params}, resource_owner) do
+  @spec create(Conn.t(), map(), map(), keyword()) :: Conn.t()
+  def create(conn, %{"oauth_application" => application_params}, resource_owner, config) do
     resource_owner
-    |> Applications.create_application(application_params)
+    |> Applications.create_application(application_params, config)
     |> case do
       {:ok, application} ->
         conn
@@ -37,26 +37,26 @@ defmodule PhoenixOauth2Provider.ApplicationController do
     end
   end
 
-  @spec show(Conn.t(), map(), map()) :: Conn.t()
-  def show(conn, %{"uid" => uid}, resource_owner) do
-    application = get_application_for!(resource_owner, uid)
+  @spec show(Conn.t(), map(), map(), keyword()) :: Conn.t()
+  def show(conn, %{"uid" => uid}, resource_owner, config) do
+    application = get_application_for!(resource_owner, uid, config)
 
     render(conn, "show.html", application: application)
   end
 
-  @spec edit(Conn.t(), map(), map()) :: Conn.t()
-  def edit(conn, %{"uid" => uid}, resource_owner) do
-    application = get_application_for!(resource_owner, uid)
-    changeset   = Applications.change_application(application)
+  @spec edit(Conn.t(), map(), map(), keyword()) :: Conn.t()
+  def edit(conn, %{"uid" => uid}, resource_owner, config) do
+    application = get_application_for!(resource_owner, uid, config)
+    changeset   = Applications.change_application(application, %{}, config)
 
     render(conn, "edit.html", application: application, changeset: changeset)
   end
 
-  @spec update(Conn.t(), map(), map()) :: Conn.t()
-  def update(conn, %{"uid" => uid, "oauth_application" => application_params}, resource_owner) do
-    application = get_application_for!(resource_owner, uid)
+  @spec update(Conn.t(), map(), map(), keyword()) :: Conn.t()
+  def update(conn, %{"uid" => uid, "oauth_application" => application_params}, resource_owner, config) do
+    application = get_application_for!(resource_owner, uid, config)
 
-    case Applications.update_application(application, application_params) do
+    case Applications.update_application(application, application_params, config) do
       {:ok, application} ->
         conn
         |> put_flash(:info, "Application updated successfully.")
@@ -67,19 +67,19 @@ defmodule PhoenixOauth2Provider.ApplicationController do
     end
   end
 
-  @spec delete(Conn.t(), map(), map()) :: Conn.t()
-  def delete(conn, %{"uid" => uid}, resource_owner) do
+  @spec delete(Conn.t(), map(), map(), keyword()) :: Conn.t()
+  def delete(conn, %{"uid" => uid}, resource_owner, config) do
     {:ok, _application} =
       resource_owner
-      |> get_application_for!(uid)
-      |> Applications.delete_application()
+      |> get_application_for!(uid, config)
+      |> Applications.delete_application(config)
 
     conn
     |> put_flash(:info, "Application deleted successfully.")
     |> redirect(to: Routes.oauth_application_path(conn, :index))
   end
 
-  defp get_application_for!(resource_owner, uid) do
-    Applications.get_application_for!(resource_owner, uid)
+  defp get_application_for!(resource_owner, uid, config) do
+    Applications.get_application_for!(resource_owner, uid, config)
   end
 end
diff --git a/lib/phoenix_oauth2_provider/controllers/authorization_controller.ex b/lib/phoenix_oauth2_provider/controllers/authorization_controller.ex
@@ -5,10 +5,10 @@ defmodule PhoenixOauth2Provider.AuthorizationController do
   alias ExOauth2Provider.Authorization
   alias Plug.Conn
 
-  @spec new(Conn.t(), map(), map()) :: Conn.t()
-  def new(conn, params, resource_owner) do
+  @spec new(Conn.t(), map(), map(), keyword()) :: Conn.t()
+  def new(conn, params, resource_owner, config) do
     resource_owner
-    |> Authorization.preauthorize(params)
+    |> Authorization.preauthorize(params, config)
     |> case do
       {:ok, client, scopes} ->
         render(conn, "new.html", params: params, client: client, scopes: scopes)
@@ -26,22 +26,22 @@ defmodule PhoenixOauth2Provider.AuthorizationController do
     end
   end
 
-  @spec create(Conn.t(), map(), map()) :: Conn.t()
-  def create(conn, params, resource_owner) do
+  @spec create(Conn.t(), map(), map(), keyword()) :: Conn.t()
+  def create(conn, params, resource_owner, config) do
     resource_owner
-    |> Authorization.authorize(params)
+    |> Authorization.authorize(params, config)
     |> redirect_or_render(conn)
   end
 
-  @spec delete(Conn.t(), map(), map()) :: Conn.t()
-  def delete(conn, params, resource_owner) do
+  @spec delete(Conn.t(), map(), map(), keyword()) :: Conn.t()
+  def delete(conn, params, resource_owner, config) do
     resource_owner
-    |> Authorization.deny(params)
+    |> Authorization.deny(params, config)
     |> redirect_or_render(conn)
   end
 
-  @spec show(Conn.t(), map(), map()) :: Conn.t()
-  def show(conn, %{"code" => code}, _resource_owner) do
+  @spec show(Conn.t(), map(), map(), keyword()) :: Conn.t()
+  def show(conn, %{"code" => code}, _resource_owner, _config) do
     render(conn, "show.html", code: code)
   end
 
diff --git a/lib/phoenix_oauth2_provider/controllers/authorized_application_controller.ex b/lib/phoenix_oauth2_provider/controllers/authorized_application_controller.ex
@@ -3,19 +3,19 @@ defmodule PhoenixOauth2Provider.AuthorizedApplicationController do
   use PhoenixOauth2Provider.Controller
   alias ExOauth2Provider.Applications
 
-  @spec index(Conn.t(), map(), map()) :: Conn.t()
-  def index(conn, _params, resource_owner) do
-    applications = Applications.get_authorized_applications_for(resource_owner)
+  @spec index(Conn.t(), map(), map(), keyword()) :: Conn.t()
+  def index(conn, _params, resource_owner, config) do
+    applications = Applications.get_authorized_applications_for(resource_owner, config)
 
     render(conn, "index.html", applications: applications)
   end
 
-  @spec delete(Conn.t(), map(), map()) :: Conn.t()
-  def delete(conn, %{"uid" => uid}, resource_owner) do
+  @spec delete(Conn.t(), map(), map(), keyword()) :: Conn.t()
+  def delete(conn, %{"uid" => uid}, resource_owner, config) do
     {:ok, _application} =
       uid
-      |> Applications.get_application!()
-      |> Applications.revoke_all_access_tokens_for(resource_owner)
+      |> Applications.get_application!(config)
+      |> Applications.revoke_all_access_tokens_for(resource_owner, config)
 
     conn
     |> put_flash(:info, "Application revoked.")
diff --git a/lib/phoenix_oauth2_provider/controllers/token_controller.ex b/lib/phoenix_oauth2_provider/controllers/token_controller.ex
@@ -4,10 +4,10 @@ defmodule PhoenixOauth2Provider.TokenController do
 
   alias ExOauth2Provider.Token
 
-  @spec create(Conn.t(), map()) :: Conn.t()
-  def create(conn, params) do
+  @spec create(Conn.t(), map(), keyword()) :: Conn.t()
+  def create(conn, params, config) do
     params
-    |> Token.grant()
+    |> Token.grant(config)
     |> case do
       {:ok, access_token} ->
         json(conn, access_token)
@@ -19,10 +19,10 @@ defmodule PhoenixOauth2Provider.TokenController do
     end
   end
 
-  @spec revoke(Conn.t(), map()) :: Conn.t()
-  def revoke(conn, params) do
+  @spec revoke(Conn.t(), map(), keyword()) :: Conn.t()
+  def revoke(conn, params, config) do
     params
-    |> Token.revoke()
+    |> Token.revoke(config)
     |> case do
       {:ok, response} ->
         json(conn, response)
diff --git a/lib/phoenix_oauth2_provider/router.ex b/lib/phoenix_oauth2_provider/router.ex
@@ -42,8 +42,9 @@ defmodule PhoenixOauth2Provider.Router do
       end
   """
 
-  defmacro __using__(_opts \\ []) do
+  defmacro __using__(config \\ []) do
     quote do
+      @phoenix_oauth2_provider_config unquote(config)
       import unquote(__MODULE__)
     end
   end
@@ -63,7 +64,7 @@ defmodule PhoenixOauth2Provider.Router do
   """
   defmacro oauth_routes(options \\ []) do
     quote location: :keep do
-      oauth_scope unquote(options) do
+      oauth_scope unquote(options), @phoenix_oauth2_provider_config do
         scope "/authorize" do
           get "/", AuthorizationController, :new
           post "/", AuthorizationController, :create
@@ -92,19 +93,19 @@ defmodule PhoenixOauth2Provider.Router do
   """
   defmacro oauth_api_routes(options \\ []) do
     quote location: :keep do
-      oauth_scope unquote(options) do
+      oauth_scope unquote(options), @phoenix_oauth2_provider_config do
         post "/token", TokenController, :create
         post "/revoke", TokenController, :revoke
       end
     end
   end
 
   @doc false
-  defmacro oauth_scope(options \\ [], do: context) do
+  defmacro oauth_scope(options \\ [], config \\ [], do: context) do
     quote do
       path = Keyword.get(unquote(options), :path, "oauth")
 
-      scope "/#{path}", PhoenixOauth2Provider, as: "oauth" do
+      scope "/#{path}", PhoenixOauth2Provider, as: "oauth", private: %{phoenix_oauth2_provider_config: unquote(config)} do
         unquote(context)
       end
     end
diff --git a/mix.exs b/mix.exs
@@ -35,7 +35,7 @@ defmodule PhoenixOauth2Provider.Mixfile do
 
   defp deps do
     [
-      {:ex_oauth2_provider, "~> 0.5.0"},
+      {:ex_oauth2_provider, "~> 0.5.1"},
       {:phoenix, "~> 1.4"},
       {:phoenix_html, "~> 2.0"},
 
diff --git a/mix.lock b/mix.lock
@@ -10,7 +10,7 @@
   "ecto": {:hex, :ecto, "3.0.9", "f01922a0b91a41d764d4e3a914d7f058d99a03460d3082c61dd2dcadd724c934", [:mix], [{:decimal, "~> 1.6", [hex: :decimal, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: true]}, {:poison, "~> 2.2 or ~> 3.0", [hex: :poison, repo: "hexpm", optional: true]}], "hexpm"},
   "ecto_sql": {:hex, :ecto_sql, "3.0.0", "8d1883376bee02a0e76b5ef797e39d04333c34b9935d0b4785dbf3cbdb571e2a", [:mix], [{:db_connection, "~> 2.0", [hex: :db_connection, repo: "hexpm", optional: false]}, {:ecto, "~> 3.0.0", [hex: :ecto, repo: "hexpm", optional: false]}, {:mariaex, "~> 0.9.0", [hex: :mariaex, repo: "hexpm", optional: true]}, {:postgrex, "~> 0.14.0", [hex: :postgrex, repo: "hexpm", optional: true]}, {:telemetry, "~> 0.2.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm"},
   "ex_doc": {:hex, :ex_doc, "0.20.2", "1bd0dfb0304bade58beb77f20f21ee3558cc3c753743ae0ddbb0fd7ba2912331", [:mix], [{:earmark, "~> 1.3", [hex: :earmark, repo: "hexpm", optional: false]}, {:makeup_elixir, "~> 0.10", [hex: :makeup_elixir, repo: "hexpm", optional: false]}], "hexpm"},
-  "ex_oauth2_provider": {:hex, :ex_oauth2_provider, "0.5.0", "230bc7739c22c0b6c552255bab0be62a297d798c4be398d7506b419235c872a5", [:mix], [{:ecto, "~> 3.0", [hex: :ecto, repo: "hexpm", optional: false]}, {:plug, ">= 1.0.0 and < 1.8.0", [hex: :plug, repo: "hexpm", optional: false]}], "hexpm"},
+  "ex_oauth2_provider": {:hex, :ex_oauth2_provider, "0.5.1", "4c806c7f996e9f54a76b2078b70a0dfc749ffd684fb397d158aca43d05be1ec5", [:mix], [{:ecto, "~> 3.0", [hex: :ecto, repo: "hexpm", optional: false]}, {:plug, ">= 1.5.0 and < 2.0.0", [hex: :plug, repo: "hexpm", optional: false]}], "hexpm"},
   "jason": {:hex, :jason, "1.1.2", "b03dedea67a99223a2eaf9f1264ce37154564de899fd3d8b9a21b1a6fd64afe7", [:mix], [{:decimal, "~> 1.0", [hex: :decimal, repo: "hexpm", optional: true]}], "hexpm"},
   "makeup": {:hex, :makeup, "0.8.0", "9cf32aea71c7fe0a4b2e9246c2c4978f9070257e5c9ce6d4a28ec450a839b55f", [:mix], [{:nimble_parsec, "~> 0.5.0", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm"},
   "makeup_elixir": {:hex, :makeup_elixir, "0.13.0", "be7a477997dcac2e48a9d695ec730b2d22418292675c75aa2d34ba0909dcdeda", [:mix], [{:makeup, "~> 0.8", [hex: :makeup, repo: "hexpm", optional: false]}], "hexpm"},
diff --git a/test/support/fixtures.ex b/test/support/fixtures.ex
diff --git a/test/support/lib/dummy/oauth_access_grants/oauth_access_grant.ex b/test/support/lib/dummy/oauth_access_grants/oauth_access_grant.ex
diff --git a/test/support/lib/dummy/oauth_access_tokens/oauth_access_token.ex b/test/support/lib/dummy/oauth_access_tokens/oauth_access_token.ex
diff --git a/test/support/lib/dummy/oauth_applications/oauth_application.ex b/test/support/lib/dummy/oauth_applications/oauth_application.ex
diff --git a/test/support/lib/dummy_web/router.ex b/test/support/lib/dummy_web/router.ex
