doorkeeper 5.0.0 → 5.1.0

data/spec/lib/config_spec.rb

@@ -1,10 +1,12 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
-describe Doorkeeper, 'configuration' do
+require "spec_helper"
+
+describe Doorkeeper, "configuration" do
   subject { Doorkeeper.configuration }
 
-  describe 'resource_owner_authenticator' do
-    it 'sets the block that is accessible via authenticate_resource_owner' do
+  describe "resource_owner_authenticator" do
+    it "sets the block that is accessible via authenticate_resource_owner" do
       block = proc {}
       Doorkeeper.configure do
         orm DOORKEEPER_ORM
@@ -14,20 +16,20 @@ describe Doorkeeper, 'configuration' do
       expect(subject.authenticate_resource_owner).to eq(block)
     end
 
-    it 'prints warning message by default' do
+    it "prints warning message by default" do
       Doorkeeper.configure do
         orm DOORKEEPER_ORM
       end
 
       expect(Rails.logger).to receive(:warn).with(
-        I18n.t('doorkeeper.errors.messages.resource_owner_authenticator_not_configured')
+        I18n.t("doorkeeper.errors.messages.resource_owner_authenticator_not_configured")
       )
       subject.authenticate_resource_owner.call(nil)
     end
   end
 
-  describe 'resource_owner_from_credentials' do
-    it 'sets the block that is accessible via authenticate_resource_owner' do
+  describe "resource_owner_from_credentials" do
+    it "sets the block that is accessible via authenticate_resource_owner" do
       block = proc {}
       Doorkeeper.configure do
         orm DOORKEEPER_ORM
@@ -37,37 +39,37 @@ describe Doorkeeper, 'configuration' do
       expect(subject.resource_owner_from_credentials).to eq(block)
     end
 
-    it 'prints warning message by default' do
+    it "prints warning message by default" do
       Doorkeeper.configure do
         orm DOORKEEPER_ORM
       end
 
       expect(Rails.logger).to receive(:warn).with(
-        I18n.t('doorkeeper.errors.messages.credential_flow_not_configured')
+        I18n.t("doorkeeper.errors.messages.credential_flow_not_configured")
       )
       subject.resource_owner_from_credentials.call(nil)
     end
   end
 
-  describe 'setup_orm_adapter' do
-    it 'adds specific error message to NameError exception' do
+  describe "setup_orm_adapter" do
+    it "adds specific error message to NameError exception" do
       expect do
-        Doorkeeper.configure { orm 'hibernate' }
+        Doorkeeper.configure { orm "hibernate" }
       end.to raise_error(NameError, /ORM adapter not found \(hibernate\)/)
     end
 
-    it 'does not change other exceptions' do
-      allow_any_instance_of(String).to receive(:classify) { raise NoMethodError }
+    it "does not change other exceptions" do
+      allow(Doorkeeper).to receive(:setup_orm_adapter) { raise NoMethodError }
 
       expect do
-        Doorkeeper.configure { orm 'hibernate' }
-      end.to raise_error(NoMethodError, /ORM adapter not found \(hibernate\)/)
+        Doorkeeper.configure { orm "hibernate" }
+      end.to raise_error(NoMethodError)
     end
   end
 
-  describe 'admin_authenticator' do
-    it 'sets the block that is accessible via authenticate_admin' do
-      default_behaviour = 'default behaviour'
+  describe "admin_authenticator" do
+    it "sets the block that is accessible via authenticate_admin" do
+      default_behaviour = "default behaviour"
       allow(Doorkeeper::Config).to receive(:head).and_return(default_behaviour)
 
       Doorkeeper.configure do
@@ -77,7 +79,7 @@ describe Doorkeeper, 'configuration' do
       expect(subject.authenticate_admin.call({})).to eq(default_behaviour)
     end
 
-    it 'sets the block that is accessible via authenticate_admin' do
+    it "sets the block that is accessible via authenticate_admin" do
       block = proc {}
       Doorkeeper.configure do
         orm DOORKEEPER_ORM
@@ -88,12 +90,12 @@ describe Doorkeeper, 'configuration' do
     end
   end
 
-  describe 'access_token_expires_in' do
-    it 'has 2 hours by default' do
+  describe "access_token_expires_in" do
+    it "has 2 hours by default" do
       expect(subject.access_token_expires_in).to eq(2.hours)
     end
 
-    it 'can change the value' do
+    it "can change the value" do
       Doorkeeper.configure do
         orm DOORKEEPER_ORM
         access_token_expires_in 4.hours
@@ -101,7 +103,7 @@ describe Doorkeeper, 'configuration' do
       expect(subject.access_token_expires_in).to eq(4.hours)
     end
 
-    it 'can be set to nil' do
+    it "can be set to nil" do
       Doorkeeper.configure do
         orm DOORKEEPER_ORM
         access_token_expires_in nil
@@ -111,42 +113,58 @@ describe Doorkeeper, 'configuration' do
     end
   end
 
-  describe 'scopes' do
-    it 'has default scopes' do
+  describe "scopes" do
+    it "has default scopes" do
       Doorkeeper.configure do
         orm DOORKEEPER_ORM
         default_scopes :public
       end
 
-      expect(subject.default_scopes).to include('public')
+      expect(subject.default_scopes).to include("public")
     end
 
-    it 'has optional scopes' do
+    it "has optional scopes" do
       Doorkeeper.configure do
         orm DOORKEEPER_ORM
         optional_scopes :write, :update
       end
 
-      expect(subject.optional_scopes).to include('write', 'update')
+      expect(subject.optional_scopes).to include("write", "update")
     end
 
-    it 'has all scopes' do
+    it "has all scopes" do
       Doorkeeper.configure do
         orm DOORKEEPER_ORM
         default_scopes :normal
         optional_scopes :admin
       end
 
-      expect(subject.scopes).to include('normal', 'admin')
+      expect(subject.scopes).to include("normal", "admin")
+    end
+  end
+
+  describe "scopes_by_grant_type" do
+    it "is {} by default" do
+      expect(subject.scopes_by_grant_type).to eq({})
+    end
+
+    it "has hash value" do
+      hash = {}
+      Doorkeeper.configure do
+        orm DOORKEEPER_ORM
+        scopes_by_grant_type hash
+      end
+
+      expect(subject.scopes_by_grant_type).to eq(hash)
     end
   end
 
-  describe 'use_refresh_token' do
-    it 'is false by default' do
+  describe "use_refresh_token" do
+    it "is false by default" do
       expect(subject.refresh_token_enabled?).to eq(false)
     end
 
-    it 'can change the value' do
+    it "can change the value" do
       Doorkeeper.configure do
         orm DOORKEEPER_ORM
         use_refresh_token
@@ -155,7 +173,7 @@ describe Doorkeeper, 'configuration' do
       expect(subject.refresh_token_enabled?).to eq(true)
     end
 
-    it 'can accept a boolean parameter' do
+    it "can accept a boolean parameter" do
       Doorkeeper.configure do
         orm DOORKEEPER_ORM
         use_refresh_token false
@@ -164,7 +182,7 @@ describe Doorkeeper, 'configuration' do
       expect(subject.refresh_token_enabled?).to eq(false)
     end
 
-    it 'can accept a block parameter' do
+    it "can accept a block parameter" do
       Doorkeeper.configure do
         orm DOORKEEPER_ORM
         use_refresh_token { |_context| nil }
@@ -174,29 +192,54 @@ describe Doorkeeper, 'configuration' do
     end
 
     it "does not includes 'refresh_token' in authorization_response_types" do
-      expect(subject.token_grant_types).not_to include 'refresh_token'
+      expect(subject.token_grant_types).not_to include "refresh_token"
     end
 
     context "is enabled" do
       before do
-        Doorkeeper.configure {
+        Doorkeeper.configure do
           orm DOORKEEPER_ORM
           use_refresh_token
-        }
+        end
       end
 
       it "includes 'refresh_token' in authorization_response_types" do
-        expect(subject.token_grant_types).to include 'refresh_token'
+        expect(subject.token_grant_types).to include "refresh_token"
+      end
+    end
+  end
+
+  describe "token_reuse_limit" do
+    it "is 100 by default" do
+      expect(subject.token_reuse_limit).to eq(100)
+    end
+
+    it "can change the value" do
+      Doorkeeper.configure do
+        token_reuse_limit 90
+      end
+
+      expect(subject.token_reuse_limit).to eq(90)
+    end
+
+    it "sets the value to 100 if invalid value is being set" do
+      expect(Rails.logger).to receive(:warn).with(/will be set to default 100/)
+
+      Doorkeeper.configure do
+        reuse_access_token
+        token_reuse_limit 110
       end
+
+      expect(subject.token_reuse_limit).to eq(100)
     end
   end
 
-  describe 'enforce_configured_scopes' do
-    it 'is false by default' do
+  describe "enforce_configured_scopes" do
+    it "is false by default" do
       expect(subject.enforce_configured_scopes?).to eq(false)
     end
 
-    it 'can change the value' do
+    it "can change the value" do
       Doorkeeper.configure do
         orm DOORKEEPER_ORM
         enforce_configured_scopes
@@ -206,27 +249,29 @@ describe Doorkeeper, 'configuration' do
     end
   end
 
-  describe 'client_credentials' do
-    it 'has defaults order' do
-      expect(subject.client_credentials_methods).to eq([:from_basic, :from_params])
+  describe "client_credentials" do
+    it "has defaults order" do
+      expect(subject.client_credentials_methods)
+        .to eq(%i[from_basic from_params])
     end
 
-    it 'can change the value' do
+    it "can change the value" do
       Doorkeeper.configure do
         orm DOORKEEPER_ORM
         client_credentials :from_digest, :from_params
       end
 
-      expect(subject.client_credentials_methods).to eq([:from_digest, :from_params])
+      expect(subject.client_credentials_methods)
+        .to eq(%i[from_digest from_params])
     end
   end
 
-  describe 'force_ssl_in_redirect_uri' do
-    it 'is true by default in non-development environments' do
+  describe "force_ssl_in_redirect_uri" do
+    it "is true by default in non-development environments" do
       expect(subject.force_ssl_in_redirect_uri).to eq(true)
     end
 
-    it 'can change the value' do
+    it "can change the value" do
       Doorkeeper.configure do
         orm DOORKEEPER_ORM
         force_ssl_in_redirect_uri(false)
@@ -235,7 +280,7 @@ describe Doorkeeper, 'configuration' do
       expect(subject.force_ssl_in_redirect_uri).to eq(false)
     end
 
-    it 'can be a callable object' do
+    it "can be a callable object" do
       block = proc { false }
       Doorkeeper.configure do
         orm DOORKEEPER_ORM
@@ -247,27 +292,29 @@ describe Doorkeeper, 'configuration' do
     end
   end
 
-  describe 'access_token_methods' do
-    it 'has defaults order' do
-      expect(subject.access_token_methods).to eq([:from_bearer_authorization, :from_access_token_param, :from_bearer_param])
+  describe "access_token_methods" do
+    it "has defaults order" do
+      expect(subject.access_token_methods)
+        .to eq(%i[from_bearer_authorization from_access_token_param from_bearer_param])
     end
 
-    it 'can change the value' do
+    it "can change the value" do
       Doorkeeper.configure do
         orm DOORKEEPER_ORM
         access_token_methods :from_access_token_param, :from_bearer_param
       end
 
-      expect(subject.access_token_methods).to eq([:from_access_token_param, :from_bearer_param])
+      expect(subject.access_token_methods)
+        .to eq(%i[from_access_token_param from_bearer_param])
     end
   end
 
-  describe 'forbid_redirect_uri' do
-    it 'is false by default' do
-      expect(subject.forbid_redirect_uri.call(URI.parse('https://localhost'))).to eq(false)
+  describe "forbid_redirect_uri" do
+    it "is false by default" do
+      expect(subject.forbid_redirect_uri.call(URI.parse("https://localhost"))).to eq(false)
     end
 
-    it 'can be a callable object' do
+    it "can be a callable object" do
       block = proc { true }
       Doorkeeper.configure do
         orm DOORKEEPER_ORM
@@ -279,12 +326,12 @@ describe Doorkeeper, 'configuration' do
     end
   end
 
-  describe 'enable_application_owner' do
-    it 'is disabled by default' do
+  describe "enable_application_owner" do
+    it "is disabled by default" do
       expect(Doorkeeper.configuration.enable_application_owner?).not_to eq(true)
     end
 
-    context 'when enabled without confirmation' do
+    context "when enabled without confirmation" do
       before do
         Doorkeeper.configure do
           orm DOORKEEPER_ORM
@@ -292,16 +339,16 @@ describe Doorkeeper, 'configuration' do
         end
       end
 
-      it 'adds support for application owner' do
+      it "adds support for application owner" do
         expect(Doorkeeper::Application.new).to respond_to :owner
       end
 
-      it 'Doorkeeper.configuration.confirm_application_owner? returns false' do
+      it "Doorkeeper.configuration.confirm_application_owner? returns false" do
         expect(Doorkeeper.configuration.confirm_application_owner?).not_to eq(true)
       end
     end
 
-    context 'when enabled with confirmation set to true' do
+    context "when enabled with confirmation set to true" do
       before do
         Doorkeeper.configure do
           orm DOORKEEPER_ORM
@@ -309,35 +356,35 @@ describe Doorkeeper, 'configuration' do
         end
       end
 
-      it 'adds support for application owner' do
+      it "adds support for application owner" do
         expect(Doorkeeper::Application.new).to respond_to :owner
       end
 
-      it 'Doorkeeper.configuration.confirm_application_owner? returns true' do
+      it "Doorkeeper.configuration.confirm_application_owner? returns true" do
         expect(Doorkeeper.configuration.confirm_application_owner?).to eq(true)
       end
     end
   end
 
-  describe 'realm' do
-    it 'is \'Doorkeeper\' by default' do
-      expect(Doorkeeper.configuration.realm).to eq('Doorkeeper')
+  describe "realm" do
+    it "is 'Doorkeeper' by default" do
+      expect(Doorkeeper.configuration.realm).to eq("Doorkeeper")
     end
 
-    it 'can change the value' do
+    it "can change the value" do
       Doorkeeper.configure do
         orm DOORKEEPER_ORM
-        realm 'Example'
+        realm "Example"
       end
 
-      expect(subject.realm).to eq('Example')
+      expect(subject.realm).to eq("Example")
     end
   end
 
   describe "grant_flows" do
     it "is set to all grant flows by default" do
-      expect(Doorkeeper.configuration.grant_flows).
-        to eq(%w[authorization_code client_credentials])
+      expect(Doorkeeper.configuration.grant_flows)
+        .to eq(%w[authorization_code client_credentials])
     end
 
     it "can change the value" do
@@ -353,16 +400,16 @@ describe Doorkeeper, 'configuration' do
       before do
         Doorkeeper.configure do
           orm DOORKEEPER_ORM
-          grant_flows ['authorization_code']
+          grant_flows ["authorization_code"]
         end
       end
 
       it "includes 'code' in authorization_response_types" do
-        expect(subject.authorization_response_types).to include 'code'
+        expect(subject.authorization_response_types).to include "code"
       end
 
       it "includes 'authorization_code' in token_grant_types" do
-        expect(subject.token_grant_types).to include 'authorization_code'
+        expect(subject.token_grant_types).to include "authorization_code"
       end
     end
 
@@ -370,12 +417,12 @@ describe Doorkeeper, 'configuration' do
       before do
         Doorkeeper.configure do
           orm DOORKEEPER_ORM
-          grant_flows ['implicit']
+          grant_flows ["implicit"]
         end
       end
 
       it "includes 'token' in authorization_response_types" do
-        expect(subject.authorization_response_types).to include 'token'
+        expect(subject.authorization_response_types).to include "token"
       end
     end
 
@@ -383,12 +430,12 @@ describe Doorkeeper, 'configuration' do
       before do
         Doorkeeper.configure do
           orm DOORKEEPER_ORM
-          grant_flows ['password']
+          grant_flows ["password"]
         end
       end
 
       it "includes 'password' in token_grant_types" do
-        expect(subject.token_grant_types).to include 'password'
+        expect(subject.token_grant_types).to include "password"
       end
     end
 
@@ -396,17 +443,17 @@ describe Doorkeeper, 'configuration' do
       before do
         Doorkeeper.configure do
           orm DOORKEEPER_ORM
-          grant_flows ['client_credentials']
+          grant_flows ["client_credentials"]
         end
       end
 
       it "includes 'client_credentials' in token_grant_types" do
-        expect(subject.token_grant_types).to include 'client_credentials'
+        expect(subject.token_grant_types).to include "client_credentials"
       end
     end
   end
 
-  it 'raises an exception when configuration is not set' do
+  it "raises an exception when configuration is not set" do
     old_config = Doorkeeper.configuration
     Doorkeeper.module_eval do
       @config = nil
@@ -421,41 +468,57 @@ describe Doorkeeper, 'configuration' do
     end
   end
 
-  describe 'access_token_generator' do
-    it 'is \'Doorkeeper::OAuth::Helpers::UniqueToken\' by default' do
+  describe "access_token_generator" do
+    it "is 'Doorkeeper::OAuth::Helpers::UniqueToken' by default" do
       expect(Doorkeeper.configuration.access_token_generator).to(
-        eq('Doorkeeper::OAuth::Helpers::UniqueToken')
+        eq("Doorkeeper::OAuth::Helpers::UniqueToken")
       )
     end
 
-    it 'can change the value' do
+    it "can change the value" do
+      Doorkeeper.configure do
+        orm DOORKEEPER_ORM
+        access_token_generator "Example"
+      end
+      expect(subject.access_token_generator).to eq("Example")
+    end
+  end
+
+  describe "default_generator_method" do
+    it "is :urlsafe_base64 by default" do
+      expect(Doorkeeper.configuration.default_generator_method)
+        .to eq(:urlsafe_base64)
+    end
+
+    it "can change the value" do
       Doorkeeper.configure do
         orm DOORKEEPER_ORM
-        access_token_generator 'Example'
+        default_generator_method :hex
       end
-      expect(subject.access_token_generator).to eq('Example')
+
+      expect(subject.default_generator_method).to eq(:hex)
     end
   end
 
-  describe 'base_controller' do
-    context 'default' do
-      it { expect(Doorkeeper.configuration.base_controller).to eq('ActionController::Base') }
+  describe "base_controller" do
+    context "default" do
+      it { expect(Doorkeeper.configuration.base_controller).to eq("ActionController::Base") }
     end
 
-    context 'custom' do
+    context "custom" do
       before do
         Doorkeeper.configure do
           orm DOORKEEPER_ORM
-          base_controller 'ApplicationController'
+          base_controller "ApplicationController"
         end
       end
 
-      it { expect(Doorkeeper.configuration.base_controller).to eq('ApplicationController') }
+      it { expect(Doorkeeper.configuration.base_controller).to eq("ApplicationController") }
     end
   end
 
   if DOORKEEPER_ORM == :active_record
-    describe 'active_record_options' do
+    describe "active_record_options" do
       let(:models) { [Doorkeeper::AccessGrant, Doorkeeper::AccessToken, Doorkeeper::Application] }
 
       before do
@@ -464,7 +527,7 @@ describe Doorkeeper, 'configuration' do
         end
       end
 
-      it 'establishes connection for Doorkeeper models based on options' do
+      it "establishes connection for Doorkeeper models based on options" do
         models.each do |model|
           expect(model).to receive(:establish_connection)
         end
@@ -494,8 +557,8 @@ describe Doorkeeper, 'configuration' do
     end
   end
 
-  describe 'strict_content_type' do
-    it 'is false by default' do
+  describe "strict_content_type" do
+    it "is false by default" do
       expect(subject.enforce_content_type).to eq(false)
     end
 
@@ -508,4 +571,127 @@ describe Doorkeeper, 'configuration' do
       expect(subject.enforce_content_type).to eq(true)
     end
   end
+
+  describe "handle_auth_errors" do
+    it "is set to render by default" do
+      expect(Doorkeeper.configuration.handle_auth_errors).to eq(:render)
+    end
+    it "can change the value" do
+      Doorkeeper.configure do
+        orm DOORKEEPER_ORM
+        handle_auth_errors :raise
+      end
+      expect(subject.handle_auth_errors).to eq(:raise)
+    end
+  end
+
+  describe "token_secret_strategy" do
+    it "is plain by default" do
+      expect(subject.token_secret_strategy).to eq(Doorkeeper::SecretStoring::Plain)
+      expect(subject.token_secret_fallback_strategy).to eq(nil)
+    end
+
+    context "when provided" do
+      before do
+        Doorkeeper.configure do
+          hash_token_secrets
+        end
+      end
+
+      it "will enable hashing for applications" do
+        expect(subject.token_secret_strategy).to eq(Doorkeeper::SecretStoring::Sha256Hash)
+        expect(subject.token_secret_fallback_strategy).to eq(nil)
+      end
+    end
+
+    context "when manually provided with invalid constant" do
+      it "raises an exception" do
+        expect do
+          Doorkeeper.configure do
+            hash_token_secrets using: "does not exist"
+          end
+        end.to raise_error(NameError)
+      end
+    end
+
+    context "when manually provided with invalid option" do
+      it "raises an exception" do
+        expect do
+          Doorkeeper.configure do
+            hash_token_secrets using: "Doorkeeper::SecretStoring::BCrypt"
+          end
+        end.to raise_error(ArgumentError,
+                           /can only be used for storing application secrets/)
+      end
+    end
+
+    context "when provided with fallback" do
+      before do
+        Doorkeeper.configure do
+          hash_token_secrets fallback: :plain
+        end
+      end
+
+      it "will enable hashing for applications" do
+        expect(subject.token_secret_strategy).to eq(Doorkeeper::SecretStoring::Sha256Hash)
+        expect(subject.token_secret_fallback_strategy).to eq(Doorkeeper::SecretStoring::Plain)
+      end
+    end
+
+    describe "hash_token_secrets together with reuse_access_token" do
+      it "will disable reuse_access_token" do
+        expect(Rails.logger).to receive(:warn).with(/reuse_access_token will be disabled/)
+
+        Doorkeeper.configure do
+          reuse_access_token
+          hash_token_secrets
+        end
+
+        expect(subject.reuse_access_token).to eq(false)
+      end
+    end
+  end
+
+  describe "application_secret_strategy" do
+    it "is plain by default" do
+      expect(subject.application_secret_strategy).to eq(Doorkeeper::SecretStoring::Plain)
+      expect(subject.application_secret_fallback_strategy).to eq(nil)
+    end
+
+    context "when provided" do
+      before do
+        Doorkeeper.configure do
+          hash_application_secrets
+        end
+      end
+
+      it "will enable hashing for applications" do
+        expect(subject.application_secret_strategy).to eq(Doorkeeper::SecretStoring::Sha256Hash)
+        expect(subject.application_secret_fallback_strategy).to eq(nil)
+      end
+    end
+
+    context "when manually provided with invalid constant" do
+      it "raises an exception" do
+        expect do
+          Doorkeeper.configure do
+            hash_application_secrets using: "does not exist"
+          end
+        end.to raise_error(NameError)
+      end
+    end
+
+    context "when provided with fallback" do
+      before do
+        Doorkeeper.configure do
+          hash_application_secrets fallback: :plain
+        end
+      end
+
+      it "will enable hashing for applications" do
+        expect(subject.application_secret_strategy).to eq(Doorkeeper::SecretStoring::Sha256Hash)
+        expect(subject.application_secret_fallback_strategy).to eq(Doorkeeper::SecretStoring::Plain)
+      end
+    end
+  end
 end