doorkeeper 5.0.0 → 5.1.0

data/spec/dummy/config/initializers/doorkeeper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Doorkeeper.configure do
   # Change the ORM that doorkeeper will use.
   orm DOORKEEPER_ORM
@@ -5,7 +7,7 @@ Doorkeeper.configure do
   # This block will be called to check whether the resource owner is authenticated or not.
   resource_owner_authenticator do
     # Put your resource owner authentication logic here.
-    User.where(id: session[:user_id]).first || redirect_to(root_url, alert: 'Needs sign in.')
+    User.where(id: session[:user_id]).first || redirect_to(root_url, alert: "Needs sign in.")
   end
 
   # If you didn't skip applications controller from Doorkeeper routes in your application routes.rb
@@ -64,8 +66,10 @@ Doorkeeper.configure do
   # access_token_methods :from_bearer_authorization, :from_access_token_param, :from_bearer_param
 
   # Change the native redirect uri for client apps
-  # When clients register with the following redirect uri, they won't be redirected to any server and the authorization code will be displayed within the provider
-  # The value can be any string. Use nil to disable this feature. When disabled, clients must provide a valid URL
+  # When clients register with the following redirect uri, they won't be redirected to any server and
+  # the authorization code will be displayed within the provider
+  # The value can be any string. Use nil to disable this feature.
+  # When disabled, clients must provide a valid URL
   # (Similar behaviour: https://developers.google.com/accounts/docs/OAuth2InstalledApp#choosingredirecturi)
   #
   # native_redirect_uri 'urn:ietf:wg:oauth:2.0:oob'

data/spec/dummy/config/initializers/secret_token.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Be sure to restart your server when you modify this file.
 
 # Your secret key for verifying the integrity of signed cookies.
@@ -5,4 +7,4 @@
 # Make sure the secret is at least 30 characters and all random,
 # no regular words or you'll be exposed to dictionary attacks.
 Dummy::Application.config.secret_key_base =
-  'c00157b5a1bb6181792f0f4a8a080485de7bab9987e6cf159dc74c4f0573345c1bfa713b5d756e1491fc0b098567e8a619e2f8d268eda86a20a720d05d633780'
+  "c00157b5a1bb6181792f0f4a8a080485de7bab9987e6cf159"

data/spec/dummy/config/initializers/session_store.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 # Be sure to restart your server when you modify this file.
 
-Dummy::Application.config.session_store :cookie_store, key: '_dummy_session'
+Dummy::Application.config.session_store :cookie_store, key: "_dummy_session"
 
 # Use the database for sessions instead of the cookie-based default,
 # which shouldn't be used to store highly confidential information

data/spec/dummy/config/initializers/wrap_parameters.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Be sure to restart your server when you modify this file.
 #
 # This file contains settings for ActionController::ParamsWrapper which

data/spec/dummy/config.ru

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 # This file is used by Rack-based servers to start the application.
 
-require ::File.expand_path('../config/environment',  __FILE__)
+require ::File.expand_path("../config/environment", __FILE__)
 run Dummy::Application

data/spec/dummy/db/migrate/20151223192035_create_doorkeeper_tables.rb

@@ -3,18 +3,22 @@
 class CreateDoorkeeperTables < ActiveRecord::Migration[4.2]
   def change
     create_table :oauth_applications do |t|
-      t.string  :name,         null: false
-      t.string  :uid,          null: false
-      t.string  :secret,       null: false
+      t.string  :name,    null: false
+      t.string  :uid,     null: false
+      t.string  :secret,  null: false
+
+      # Remove `null: false` if you are planning to use grant flows
+      # that doesn't require redirect URI to be used during authorization
+      # like Client Credentials flow or Resource Owner Password.
       t.text    :redirect_uri, null: false
-      t.string  :scopes,       null: false, default: ''
+      t.string  :scopes,       null: false, default: ""
       t.timestamps             null: false
     end
 
     add_index :oauth_applications, :uid, unique: true
 
     create_table :oauth_access_grants do |t|
-      t.integer  :resource_owner_id, null: false
+      t.references :resource_owner,  null: false
       t.references :application,     null: false
       t.string   :token,             null: false
       t.integer  :expires_in,        null: false
@@ -28,35 +32,38 @@ class CreateDoorkeeperTables < ActiveRecord::Migration[4.2]
     add_foreign_key(
       :oauth_access_grants,
       :oauth_applications,
-      column: :application_id,
+      column: :application_id
     )
 
     create_table :oauth_access_tokens do |t|
-      t.integer  :resource_owner_id
-      t.references :application
+      t.references :resource_owner, index: true
+      t.references :application,    null: false
 
       # If you use a custom token generator you may need to change this column
       # from string to text, so that it accepts tokens larger than 255
       # characters. More info on custom token generators in:
       # https://github.com/doorkeeper-gem/doorkeeper/tree/v3.0.0.rc1#custom-access-token-generator
       #
-      # t.text     :token,             null: false
-      t.string   :token,             null: false
+      # t.text :token, null: false
+      t.string :token, null: false
 
       t.string   :refresh_token
       t.integer  :expires_in
       t.datetime :revoked_at
-      t.datetime :created_at,        null: false
+      t.datetime :created_at, null: false
       t.string   :scopes
     end
 
     add_index :oauth_access_tokens, :token, unique: true
-    add_index :oauth_access_tokens, :resource_owner_id
     add_index :oauth_access_tokens, :refresh_token, unique: true
     add_foreign_key(
       :oauth_access_tokens,
       :oauth_applications,
-      column: :application_id,
+      column: :application_id
     )
+
+    # Uncomment below to ensure a valid reference to the resource owner's table
+    add_foreign_key :oauth_access_grants, :users, column: :resource_owner_id
+    add_foreign_key :oauth_access_tokens, :users, column: :resource_owner_id
   end
 end

data/spec/dummy/db/migrate/20151223200000_add_owner_to_application.rb

@@ -4,6 +4,6 @@ class AddOwnerToApplication < ActiveRecord::Migration[4.2]
   def change
     add_column :oauth_applications, :owner_id, :integer, null: true
     add_column :oauth_applications, :owner_type, :string, null: true
-    add_index :oauth_applications, [:owner_id, :owner_type]
+    add_index :oauth_applications, %i[owner_id owner_type]
   end
 end

data/spec/dummy/db/migrate/20170822064514_enable_pkce.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class EnablePkce < ActiveRecord::Migration[4.2]
   def change
     add_column :oauth_access_grants, :code_challenge, :string, null: true

data/spec/dummy/db/schema.rb

@@ -47,7 +47,7 @@ ActiveRecord::Schema.define(version: 20180210183654) do
     t.string "name", null: false
     t.string "uid", null: false
     t.string "secret", null: false
-    t.text "redirect_uri", null: false
+    t.text "redirect_uri"
     t.string "scopes", default: "", null: false
     t.datetime "created_at", null: false
     t.datetime "updated_at", null: false

data/spec/dummy/script/rails

@@ -1,6 +1,9 @@
 #!/usr/bin/env ruby
-# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+# frozen_string_literal: true
 
-APP_PATH = File.expand_path('../../config/application',  __FILE__)
-require File.expand_path('../../config/boot',  __FILE__)
-require 'rails/commands'
+# This command will automatically be run when you run "rails" with Rails 3 gems
+# installed from the root of your application.
+
+APP_PATH = File.expand_path("../config/application", __dir__)
+require File.expand_path("../config/boot", __dir__)
+require "rails/commands"

data/spec/factories.rb

@@ -1,25 +1,27 @@
+# frozen_string_literal: true
+
 FactoryBot.define do
-  factory :access_grant, class: Doorkeeper::AccessGrant do
+  factory :access_grant, class: "Doorkeeper::AccessGrant" do
     sequence(:resource_owner_id) { |n| n }
     application
-    redirect_uri 'https://app.com/callback'
-    expires_in 100
-    scopes 'public write'
+    redirect_uri { "https://app.com/callback" }
+    expires_in { 100 }
+    scopes { "public write" }
   end
 
-  factory :access_token, class: Doorkeeper::AccessToken do
+  factory :access_token, class: "Doorkeeper::AccessToken" do
     sequence(:resource_owner_id) { |n| n }
     application
-    expires_in 2.hours
+    expires_in { 2.hours }
 
     factory :clientless_access_token do
-      application nil
+      application { nil }
     end
   end
 
-  factory :application, class: Doorkeeper::Application do
+  factory :application, class: "Doorkeeper::Application" do
     sequence(:name) { |n| "Application #{n}" }
-    redirect_uri 'https://app.com/callback'
+    redirect_uri { "https://app.com/callback" }
   end
 
   # do not name this factory :user, otherwise it will conflict with factories

data/spec/generators/application_owner_generator_spec.rb

@@ -1,40 +1,27 @@
-require 'spec_helper'
-require 'generators/doorkeeper/application_owner_generator'
+# frozen_string_literal: true
 
-describe 'Doorkeeper::ApplicationOwnerGenerator' do
+require "spec_helper"
+require "generators/doorkeeper/application_owner_generator"
+
+describe "Doorkeeper::ApplicationOwnerGenerator" do
   include GeneratorSpec::TestCase
 
   tests Doorkeeper::ApplicationOwnerGenerator
-  destination ::File.expand_path('../tmp/dummy', __FILE__)
+  destination ::File.expand_path("../tmp/dummy", __FILE__)
 
-  describe 'after running the generator' do
+  describe "after running the generator" do
     before :each do
       prepare_destination
     end
 
-    context 'pre Rails 5.0.0' do
-      it 'creates a migration with no version specifier' do
-        stub_const("ActiveRecord::VERSION::MAJOR", 4)
-        stub_const("ActiveRecord::VERSION::MINOR", 2)
-
-        run_generator
-
-        assert_migration 'db/migrate/add_owner_to_application.rb' do |migration|
-          assert migration.include?("ActiveRecord::Migration\n")
-        end
-      end
-    end
-
-    context 'post Rails 5.0.0' do
-      it 'creates a migration with a version specifier' do
-        stub_const("ActiveRecord::VERSION::MAJOR", 5)
-        stub_const("ActiveRecord::VERSION::MINOR", 0)
+    it "creates a migration with a version specifier" do
+      stub_const("ActiveRecord::VERSION::MAJOR", 5)
+      stub_const("ActiveRecord::VERSION::MINOR", 0)
 
-        run_generator
+      run_generator
 
-        assert_migration 'db/migrate/add_owner_to_application.rb' do |migration|
-          assert migration.include?("ActiveRecord::Migration[5.0]\n")
-        end
+      assert_migration "db/migrate/add_owner_to_application.rb" do |migration|
+        assert migration.include?("ActiveRecord::Migration[5.0]\n")
       end
     end
   end

data/spec/generators/confidential_applications_generator_spec.rb

@@ -1,44 +1,28 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-require 'generators/doorkeeper/confidential_applications_generator'
+require "spec_helper"
+require "generators/doorkeeper/confidential_applications_generator"
 
-describe 'Doorkeeper::ConfidentialApplicationsGenerator' do
+describe "Doorkeeper::ConfidentialApplicationsGenerator" do
   include GeneratorSpec::TestCase
 
   tests Doorkeeper::ConfidentialApplicationsGenerator
-  destination ::File.expand_path('../tmp/dummy', __FILE__)
+  destination ::File.expand_path("../tmp/dummy", __FILE__)
 
-  describe 'after running the generator' do
+  describe "after running the generator" do
     before :each do
       prepare_destination
     end
 
-    context 'pre Rails 5.0.0' do
-      it 'creates a migration with no version specifier' do
-        stub_const("ActiveRecord::VERSION::MAJOR", 4)
-        stub_const("ActiveRecord::VERSION::MINOR", 2)
+    it "creates a migration with a version specifier" do
+      stub_const("ActiveRecord::VERSION::MAJOR", 5)
+      stub_const("ActiveRecord::VERSION::MINOR", 0)
 
-        run_generator
+      run_generator
 
-        assert_migration 'db/migrate/add_confidential_to_applications.rb' do |migration|
-          assert migration.include?("ActiveRecord::Migration\n")
-          assert migration.include?(':confidential')
-        end
-      end
-    end
-
-    context 'post Rails 5.0.0' do
-      it 'creates a migration with a version specifier' do
-        stub_const("ActiveRecord::VERSION::MAJOR", 5)
-        stub_const("ActiveRecord::VERSION::MINOR", 0)
-
-        run_generator
-
-        assert_migration 'db/migrate/add_confidential_to_applications.rb' do |migration|
-          assert migration.include?("ActiveRecord::Migration[5.0]\n")
-          assert migration.include?(':confidential')
-        end
+      assert_migration "db/migrate/add_confidential_to_applications.rb" do |migration|
+        assert migration.include?("ActiveRecord::Migration[5.0]\n")
+        assert migration.include?(":confidential")
       end
     end
   end

data/spec/generators/install_generator_spec.rb

@@ -1,31 +1,36 @@
-require 'spec_helper'
-require 'generators/doorkeeper/install_generator'
+# frozen_string_literal: true
 
-describe 'Doorkeeper::InstallGenerator' do
+require "spec_helper"
+require "generators/doorkeeper/install_generator"
+
+describe "Doorkeeper::InstallGenerator" do
   include GeneratorSpec::TestCase
 
   tests Doorkeeper::InstallGenerator
-  destination ::File.expand_path('../tmp/dummy', __FILE__)
+  destination ::File.expand_path("../tmp/dummy", __FILE__)
 
-  describe 'after running the generator' do
+  describe "after running the generator" do
     before :each do
       prepare_destination
-      FileUtils.mkdir(::File.expand_path('config', Pathname(destination_root)))
-      FileUtils.mkdir(::File.expand_path('db', Pathname(destination_root)))
-      FileUtils.copy_file(::File.expand_path('../templates/routes.rb', __FILE__), ::File.expand_path('config/routes.rb', Pathname.new(destination_root)))
+      FileUtils.mkdir(::File.expand_path("config", Pathname(destination_root)))
+      FileUtils.mkdir(::File.expand_path("db", Pathname(destination_root)))
+      FileUtils.copy_file(
+        ::File.expand_path("../templates/routes.rb", __FILE__),
+        ::File.expand_path("config/routes.rb", Pathname.new(destination_root))
+      )
       run_generator
     end
 
-    it 'creates an initializer file' do
-      assert_file 'config/initializers/doorkeeper.rb'
+    it "creates an initializer file" do
+      assert_file "config/initializers/doorkeeper.rb"
     end
 
-    it 'copies the locale file' do
-      assert_file 'config/locales/doorkeeper.en.yml'
+    it "copies the locale file" do
+      assert_file "config/locales/doorkeeper.en.yml"
     end
 
-    it 'adds sample route' do
-      assert_file 'config/routes.rb', /use_doorkeeper/
+    it "adds sample route" do
+      assert_file "config/routes.rb", /use_doorkeeper/
     end
   end
 end

data/spec/generators/migration_generator_spec.rb

@@ -1,40 +1,27 @@
-require 'spec_helper'
-require 'generators/doorkeeper/migration_generator'
+# frozen_string_literal: true
 
-describe 'Doorkeeper::MigrationGenerator' do
+require "spec_helper"
+require "generators/doorkeeper/migration_generator"
+
+describe "Doorkeeper::MigrationGenerator" do
   include GeneratorSpec::TestCase
 
   tests Doorkeeper::MigrationGenerator
-  destination ::File.expand_path('../tmp/dummy', __FILE__)
+  destination ::File.expand_path("../tmp/dummy", __FILE__)
 
-  describe 'after running the generator' do
+  describe "after running the generator" do
     before :each do
       prepare_destination
     end
 
-    context 'pre Rails 5.0.0' do
-      it 'creates a migration with no version specifier' do
-        stub_const('ActiveRecord::VERSION::MAJOR', 4)
-        stub_const('ActiveRecord::VERSION::MINOR', 2)
-
-        run_generator
-
-        assert_migration 'db/migrate/create_doorkeeper_tables.rb' do |migration|
-          assert migration.include?("ActiveRecord::Migration\n")
-        end
-      end
-    end
-
-    context 'post Rails 5.0.0' do
-      it 'creates a migration with a version specifier' do
-        stub_const('ActiveRecord::VERSION::MAJOR', 5)
-        stub_const('ActiveRecord::VERSION::MINOR', 0)
+    it "creates a migration with a version specifier" do
+      stub_const("ActiveRecord::VERSION::MAJOR", 5)
+      stub_const("ActiveRecord::VERSION::MINOR", 0)
 
-        run_generator
+      run_generator
 
-        assert_migration 'db/migrate/create_doorkeeper_tables.rb' do |migration|
-          assert migration.include?("ActiveRecord::Migration[5.0]\n")
-        end
+      assert_migration "db/migrate/create_doorkeeper_tables.rb" do |migration|
+        assert migration.include?("ActiveRecord::Migration[5.0]\n")
       end
     end
   end

data/spec/generators/pkce_generator_spec.rb

@@ -1,42 +1,27 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-require 'generators/doorkeeper/pkce_generator'
+require "spec_helper"
+require "generators/doorkeeper/pkce_generator"
 
-describe 'Doorkeeper::PkceGenerator' do
+describe "Doorkeeper::PkceGenerator" do
   include GeneratorSpec::TestCase
 
   tests Doorkeeper::PkceGenerator
-  destination ::File.expand_path('../tmp/dummy', __FILE__)
+  destination ::File.expand_path("../tmp/dummy", __FILE__)
 
-  describe 'after running the generator' do
+  describe "after running the generator" do
     before :each do
       prepare_destination
     end
 
-    context 'pre Rails 5.0.0' do
-      it 'creates a migration with no version specifier' do
-        stub_const("ActiveRecord::VERSION::MAJOR", 4)
-        stub_const("ActiveRecord::VERSION::MINOR", 2)
+    it "creates a migration with a version specifier" do
+      stub_const("ActiveRecord::VERSION::MAJOR", 5)
+      stub_const("ActiveRecord::VERSION::MINOR", 0)
 
-        run_generator
+      run_generator
 
-        assert_migration 'db/migrate/enable_pkce.rb' do |migration|
-          assert migration.include?("ActiveRecord::Migration\n")
-        end
-      end
-    end
-
-    context 'post Rails 5.0.0' do
-      it 'creates a migration with a version specifier' do
-        stub_const("ActiveRecord::VERSION::MAJOR", 5)
-        stub_const("ActiveRecord::VERSION::MINOR", 0)
-
-        run_generator
-
-        assert_migration 'db/migrate/enable_pkce.rb' do |migration|
-          assert migration.include?("ActiveRecord::Migration[5.0]\n")
-        end
+      assert_migration "db/migrate/enable_pkce.rb" do |migration|
+        assert migration.include?("ActiveRecord::Migration[5.0]\n")
       end
     end
   end

data/spec/generators/previous_refresh_token_generator_spec.rb

@@ -1,13 +1,15 @@
-require 'spec_helper'
-require 'generators/doorkeeper/previous_refresh_token_generator'
+# frozen_string_literal: true
 
-describe 'Doorkeeper::PreviousRefreshTokenGenerator' do
+require "spec_helper"
+require "generators/doorkeeper/previous_refresh_token_generator"
+
+describe "Doorkeeper::PreviousRefreshTokenGenerator" do
   include GeneratorSpec::TestCase
 
   tests Doorkeeper::PreviousRefreshTokenGenerator
-  destination ::File.expand_path('../tmp/dummy', __FILE__)
+  destination ::File.expand_path("../tmp/dummy", __FILE__)
 
-  describe 'after running the generator' do
+  describe "after running the generator" do
     before :each do
       prepare_destination
 
@@ -16,41 +18,26 @@ describe 'Doorkeeper::PreviousRefreshTokenGenerator' do
       )
     end
 
-    context 'pre Rails 5.0.0' do
-      it 'creates a migration with no version specifier' do
-        stub_const('ActiveRecord::VERSION::MAJOR', 4)
-        stub_const('ActiveRecord::VERSION::MINOR', 2)
-
-        run_generator
-
-        assert_migration 'db/migrate/add_previous_refresh_token_to_access_tokens.rb' do |migration|
-          assert migration.include?("ActiveRecord::Migration\n")
-        end
-      end
-    end
-
-    context 'post Rails 5.0.0' do
-      it 'creates a migration with a version specifier' do
-        stub_const('ActiveRecord::VERSION::MAJOR', 5)
-        stub_const('ActiveRecord::VERSION::MINOR', 0)
+    it "creates a migration with a version specifier" do
+      stub_const("ActiveRecord::VERSION::MAJOR", 5)
+      stub_const("ActiveRecord::VERSION::MINOR", 0)
 
-        run_generator
+      run_generator
 
-        assert_migration 'db/migrate/add_previous_refresh_token_to_access_tokens.rb' do |migration|
-          assert migration.include?("ActiveRecord::Migration[5.0]\n")
-        end
+      assert_migration "db/migrate/add_previous_refresh_token_to_access_tokens.rb" do |migration|
+        assert migration.include?("ActiveRecord::Migration[5.0]\n")
       end
     end
 
-    context 'already exist' do
-      it 'does not create a migration' do
+    context "already exist" do
+      it "does not create a migration" do
         allow_any_instance_of(Doorkeeper::PreviousRefreshTokenGenerator).to(
           receive(:no_previous_refresh_token_column?).and_call_original
         )
 
         run_generator
 
-        assert_no_migration 'db/migrate/add_previous_refresh_token_to_access_tokens.rb'
+        assert_no_migration "db/migrate/add_previous_refresh_token_to_access_tokens.rb"
       end
     end
   end

data/spec/generators/templates/routes.rb

@@ -1,3 +1,4 @@
-Rails.application.routes.draw do
+# frozen_string_literal: true
 
+Rails.application.routes.draw do
 end

data/spec/generators/views_generator_spec.rb

@@ -1,27 +1,29 @@
-require 'spec_helper'
-require 'generators/doorkeeper/views_generator'
+# frozen_string_literal: true
+
+require "spec_helper"
+require "generators/doorkeeper/views_generator"
 
 describe Doorkeeper::Generators::ViewsGenerator do
   include GeneratorSpec::TestCase
 
   tests Doorkeeper::Generators::ViewsGenerator
-  destination File.expand_path('../tmp/dummy', __FILE__)
+  destination File.expand_path("tmp/dummy", __dir__)
 
   before :each do
     prepare_destination
   end
 
-  it 'create all views' do
+  it "create all views" do
     run_generator
-    assert_file 'app/views/doorkeeper/applications/_form.html.erb'
-    assert_file 'app/views/doorkeeper/applications/edit.html.erb'
-    assert_file 'app/views/doorkeeper/applications/index.html.erb'
-    assert_file 'app/views/doorkeeper/applications/new.html.erb'
-    assert_file 'app/views/doorkeeper/applications/show.html.erb'
+    assert_file "app/views/doorkeeper/applications/_form.html.erb"
+    assert_file "app/views/doorkeeper/applications/edit.html.erb"
+    assert_file "app/views/doorkeeper/applications/index.html.erb"
+    assert_file "app/views/doorkeeper/applications/new.html.erb"
+    assert_file "app/views/doorkeeper/applications/show.html.erb"
 
-    assert_file 'app/views/doorkeeper/authorizations/error.html.erb'
-    assert_file 'app/views/doorkeeper/authorizations/new.html.erb'
+    assert_file "app/views/doorkeeper/authorizations/error.html.erb"
+    assert_file "app/views/doorkeeper/authorizations/new.html.erb"
 
-    assert_file 'app/views/doorkeeper/authorized_applications/index.html.erb'
+    assert_file "app/views/doorkeeper/authorized_applications/index.html.erb"
   end
 end