Rewrite to functional configuration, separate mix tasks, and built in templates

Author: danschultzer

.gitignore

@@ -5,7 +5,6 @@
 /.fetch
 erl_crash.dump
 *.ez
-
-/priv/test/migrations/*
-!/priv/test/migrations/20170320052040_create_user.exs
-/priv/test/tmp
+/tmp
+.DS_Store
+/.elixir_ls

.travis.yml

@@ -2,23 +2,13 @@ language: elixir
 sudo: false
 matrix:
   include:
-    - elixir: 1.4
-      otp_release: 19.0
+    - elixir: 1.8
+      otp_release: 21.0
       env: MIX_ENV=test
-    - elixir: 1.5
-      otp_release: 19.0
-      env: MIX_ENV=test
-    - elixir: 1.6
-      otp_release: 20.0
-      env: MIX_ENV=test
-    - elixir: 1.7
-      otp_release: 20.0
-      env: MIX_ENV=test UUID=resource_owners
-    - elixir: 1.7
-      otp_release: 20.0
-      env: MIX_ENV=test UUID=all
+    - elixir: 1.8
+      otp_release: 21.0
+      env: MIX_ENV=test UUID=true
 script:
-  - mix deps.compile
   - mix test
 after_script:
   - mix credo

CHANGELOG.md

@@ -0,0 +1,44 @@
+# Changelog
+
+## v0.5.0 (TBA)
+
+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.
+
+### 1. ExOauth2Provider
+
+Read the [ExOauth2Provider CHANGELOG.md](https://github.com/danschultzer/ex_oauth2_provider) for upgrade instructions.
+
+### 2. Routes
+
+Routes are now separated into api and non api routes. Update your routes like so:
+
+```elixir
+defmodule MyAppWeb.Router do
+  use MyAppWeb, :router
+  use PhoenixOauth2Provider.Router
+
+  # ...
+
+  pipeline :protected do
+    # Require user authentication
+  end
+
+  scope "/" do
+    pipe_through :api
+
+    oauth_api_routes()
+  end
+
+  scope "/" do
+    pipe_through [:browser, :protected]
+
+    oauth_routes()
+  end
+
+  # ...
+end
+```
+
+### 3. Templates and views
+
+Update `:module` to `:web_module` in your configuration. Templates and views are no longer required to be generated so you can remove them entirely if the default ones work for you.

README.md

@@ -2,9 +2,7 @@
 
 [![Build Status](https://travis-ci.org/danschultzer/phoenix_oauth2_provider.svg?branch=master)](https://travis-ci.org/danschultzer/phoenix_oauth2_provider) [![hex.pm](http://img.shields.io/hexpm/v/phoenix_oauth2_provider.svg?style=flat)](https://hex.pm/packages/phoenix_oauth2_provider) [![hex.pm downloads](https://img.shields.io/hexpm/dt/phoenix_oauth2_provider.svg?style=flat)](https://hex.pm/packages/phoenix_oauth2_provider)
 
-Get an OAuth 2 provider running in your Phoenix app with controllers, views and models in just two minutes.
-
-> This version requires Phoenix 1.3 or higher. If you use a previous Phoenix version, please use v0.2.0 instead.
+Get an OAuth 2.0 provider running in your Phoenix app with schema modules and templates in just two minutes.
 
 ## Installation
 
@@ -22,12 +20,16 @@ end
 
 Run `mix deps.get` to install it.
 
-Add migrations and set up `config/config.exs`:
+## Getting started
+
+Install ExOauthProvider first:
 
 ```bash
-mix phoenix_oauth2_provider.install
+mix ex_oauth2_provider.install
 ```
 
+Follow the instructions to update `config/config.exs`.
+
 Set up routes:
 
 ```elixir
@@ -41,18 +43,16 @@ defmodule MyAppWeb.Router do
     # Require user authentication
   end
 
-  pipeline :oauth_public do
-    plug :put_secure_browser_headers
-  end
+  scope "/" do
+    pipe_through :api
 
-  scope "/", MyAppWeb do
-    pipe_through :oauth_public
-    oauth_routes :public
+    oauth_api_routes()
   end
 
-  scope "/", MyAppWeb do
-    pipe_through :protected
-    oauth_routes :protected
+  scope "/" do
+    pipe_through [:browser, :protected]
+
+    oauth_routes()
   end
 
   # ...
@@ -61,7 +61,7 @@ end
 
 That's it! The following OAuth 2.0 routes will now be available in your app:
 
-```
+```text
 oauth_authorize_path  GET    /oauth/authorize         AuthorizationController :new
 oauth_authorize_path  POST   /oauth/authorize         AuthorizationController :create
 oauth_authorize_path  GET    /oauth/authorize/:code   AuthorizationController :show
@@ -70,33 +70,34 @@ oauth_token_path      POST   /oauth/token             TokenController :create
 oauth_token_path      POST   /oauth/revoke            TokenController :revoke
 ```
 
-Please read the [ex_oauth2_provider](https://github.com/danschultzer/ex_oauth2_provider) documentation for further customization.
+Please read the [ExOauth2Provider](https://github.com/danschultzer/ex_oauth2_provider) documentation for further customization.
 
 ## Configuration
 
-### Resource owner schema
+### Templates
 
-By default `MyApp.User` is used as the `resource_owner`, you can change that in the following way:
+To generate views and templates run:
+
+```bash
+mix phoenix_oauth2_provider.gen.templates
+```
+
+Set up the PhoenixOauth2Provider configuration with `:web_module`:
 
 ```elixir
-config :phoenix_oauth2_provider, PhoenixOauth2Provider,
-  repo: MyApp.Repo,
-  resource_owner: MyApp.CustomUser
+config :my_app, PhoenixOauth2Provider,
+  web_module: MyAppWeb
 ```
 
-### Resource owner
+### Current resource owner
 
-Set up what `assigns` in the plug that PhoenixOauth2Provider should gather the authorized user from.
+Set up what key in the plug conn `assigns` that PhoenixOauth2Provider should use to fetch the current resource owner.
 
 ```elixir
-config :phoenix_oauth2_provider, PhoenixOauth2Provider,
+config :my_app, PhoenixOauth2Provider,
   current_resource_owner: :current_user
 ```
 
-## Acknowledgement
-
-This library was made thanks to [coherence](https://github.com/smpallen99/coherence) that gave the conceptual building blocks.
-
 ## LICENSE
 
 (The MIT License)

config/test.exs

@@ -1,30 +1,23 @@
 use Mix.Config
 
-config :phoenix_oauth2_provider, PhoenixOauth2Provider,
-  module: PhoenixOauth2Provider.Test,
-  current_resource_owner: :current_test_user,
-  repo: PhoenixOauth2Provider.Test.Repo,
-  resource_owner: PhoenixOauth2Provider.Test.User,
-  scopes: ~w(read write),
-  router: PhoenixOauth2Provider.Test.Router,
-  use_refresh_token: true
+config :phoenix, :json_library, Jason
+
+config :phoenix_oauth2_provider, namespace: Dummy
+
+config :phoenix_oauth2_provider, DummyWeb.Endpoint,
+  secret_key_base: "1lJGFCaor+gPGc21GCvn+NE0WDOA5ujAMeZoy7oC5un7NPUXDir8LAE+Iba5bpGH",
+  render_errors: [view: DummyWeb.ErrorView, accepts: ~w(html json)]
 
-config :phoenix_oauth2_provider, ecto_repos: [PhoenixOauth2Provider.Test.Repo]
-config :phoenix_oauth2_provider, PhoenixOauth2Provider.Test.Repo,
-  adapter: Ecto.Adapters.Postgres,
+config :phoenix_oauth2_provider, Dummy.Repo,
   database: "phoenix_oauth2_provider_test",
   pool: Ecto.Adapters.SQL.Sandbox,
-  priv: "priv/test"
-config :phoenix_oauth2_provider, PhoenixOauth2Provider.Test.Endpoint,
-  secret_key_base: "1lJGFCaor+gPGc21GCvn+NE0WDOA5ujAMeZoy7oC5un7NPUXDir8LAE+Iba5bpGH",
-  render_errors: [view: PhoenixOauth2Provider.Test.ErrorView, accepts: ~w(html json)]
+  priv: "test/support/priv"
 
-unless is_nil(System.get_env("UUID")) do
-config :phoenix_oauth2_provider, PhoenixOauth2Provider,
-  resource_owner: {PhoenixOauth2Provider.Test.User, :binary_id}
-end
+config :phoenix_oauth2_provider, ExOauth2Provider,
+  repo: Dummy.Repo,
+  resource_owner: Dummy.Users.User,
+  scopes: ~w(read write),
+  use_refresh_token: true
 
-if System.get_env("UUID") == "all" do
 config :phoenix_oauth2_provider, PhoenixOauth2Provider,
-  app_schema: ExOauth2Provider.Schema.UUID
-end
+  current_resource_owner: :current_test_user

lib/mix/phoenix_oauth2_provider/template.ex

@@ -0,0 +1,65 @@
+defmodule Mix.PhoenixOauth2Provider.Template do
+  @moduledoc false
+
+  alias ExOauth2Provider.Config
+  alias Mix.{Generator, Phoenix}
+
+  @views ["application", "authorization", "authorized_application"]
+  @view_template """
+  defmodule <%= inspect view_module %> do
+    use <%= inspect web_module %>, :view
+  end
+  """
+
+  @spec create_view_and_template_files(binary()) :: map()
+  def create_view_and_template_files(context_app) do
+    web_module =
+      context_app
+      |> web_app()
+      |> Macro.camelize()
+      |> List.wrap()
+      |> Module.concat()
+    web_path = web_path(context_app)
+
+    for name <- @views do
+      create_view_file(web_module, web_path, name)
+      create_template_files(web_path, name)
+    end
+  end
+
+  defp create_view_file(web_module, web_path, name) do
+    view_name   = "#{name}_view"
+    dir         = Path.join([web_path, "views", "phoenix_oauth2_provider"])
+    path        = Path.join(dir, "#{view_name}.ex")
+    view_module = Module.concat([web_module, PhoenixOauth2Provider, Macro.camelize(view_name)])
+    content     = EEx.eval_string(@view_template, view_module: view_module, web_module: web_module)
+
+    Generator.create_directory(dir)
+    Generator.create_file(path, content)
+  end
+
+  defp create_template_files(web_path, name) do
+    view_module = Module.concat([PhoenixOauth2Provider, Macro.camelize("#{name}_view")])
+
+    for template <- view_module.templates() do
+      content = view_module.html(template)
+      dir     = Path.join([web_path, "templates", "phoenix_oauth2_provider", name])
+      path    = Path.join(dir, "#{template}.eex")
+
+      Generator.create_directory(dir)
+      Generator.create_file(path, content)
+    end
+  end
+
+  defp web_path(context_app), do: Phoenix.web_path(context_app)
+
+  defp web_app(ctx_app) do
+    this_app = Config.otp_app()
+
+    if ctx_app == this_app do
+      "#{ctx_app}_web"
+    else
+      ctx_app
+    end
+  end
+end

lib/mix/tasks/phoenix_oauth2_provider.gen.templates.ex

@@ -0,0 +1,41 @@
+defmodule Mix.Tasks.PhoenixOauth2Provider.Gen.Templates do
+  @shortdoc "Generates PhoenixOauth2Provider templates"
+
+  @moduledoc """
+  Generates views and templates.
+
+      mix phoenix_oauth2_provider.gen.templates
+
+  ## Arguments
+
+    * `--context-app` - context app to use for path and module names
+  """
+  use Mix.Task
+
+  alias ExOauth2Provider.Config
+  alias Mix.ExOauth2Provider
+  alias Mix.PhoenixOauth2Provider.Template
+
+  @switches     [context_app: :string]
+  @default_opts []
+  @mix_task     "phoenix_oauth2_provider.gen.templates"
+
+  @impl true
+  def run(args) do
+    ExOauth2Provider.no_umbrella!(@mix_task)
+
+    args
+    |> ExOauth2Provider.parse_options(@switches, @default_opts)
+    |> parse()
+    |> create_template_files()
+  end
+
+  defp parse({config, _parsed, _invalid}), do: config
+
+  defp create_template_files(config) do
+    config
+    |> Map.get(:context_app)
+    |> Kernel.||(Config.otp_app())
+    |> Template.create_view_and_template_files()
+  end
+end