doorkeeper 5.2.2 → 5.3.0

data/spec/lib/oauth/token_spec.rb

@@ -7,152 +7,150 @@ module Doorkeeper
     class AccessToken
     end
   end
+end
 
-  module OAuth
-    describe Token do
-      describe :from_request do
-        let(:request) { double.as_null_object }
+describe Doorkeeper::OAuth::Token do
+  describe ".from_request" do
+    let(:request) { double.as_null_object }
 
-        let(:method) do
-          ->(*) { "token-value" }
-        end
+    let(:method) do
+      ->(*) { "token-value" }
+    end
 
-        it "accepts anything that responds to #call" do
-          expect(method).to receive(:call).with(request)
-          Token.from_request request, method
-        end
+    it "accepts anything that responds to #call" do
+      expect(method).to receive(:call).with(request)
+      described_class.from_request request, method
+    end
 
-        it "delegates methods received as symbols to Token class" do
-          expect(Token).to receive(:from_params).with(request)
-          Token.from_request request, :from_params
-        end
+    it "delegates methods received as symbols to described_class class" do
+      expect(described_class).to receive(:from_params).with(request)
+      described_class.from_request request, :from_params
+    end
 
-        it "stops at the first credentials found" do
-          not_called_method = double
-          expect(not_called_method).not_to receive(:call)
-          Token.from_request request, ->(_r) {}, method, not_called_method
-        end
+    it "stops at the first credentials found" do
+      not_called_method = double
+      expect(not_called_method).not_to receive(:call)
+      described_class.from_request request, ->(_r) {}, method, not_called_method
+    end
 
-        it "returns the credential from extractor method" do
-          credentials = Token.from_request request, method
-          expect(credentials).to eq("token-value")
-        end
-      end
+    it "returns the credential from extractor method" do
+      credentials = described_class.from_request request, method
+      expect(credentials).to eq("token-value")
+    end
+  end
 
-      describe :from_access_token_param do
-        it "returns token from access_token parameter" do
-          request = double parameters: { access_token: "some-token" }
-          token   = Token.from_access_token_param(request)
-          expect(token).to eq("some-token")
-        end
-      end
+  describe ".from_access_token_param" do
+    it "returns token from access_token parameter" do
+      request = double parameters: { access_token: "some-token" }
+      token   = described_class.from_access_token_param(request)
+      expect(token).to eq("some-token")
+    end
+  end
 
-      describe :from_bearer_param do
-        it "returns token from bearer_token parameter" do
-          request = double parameters: { bearer_token: "some-token" }
-          token   = Token.from_bearer_param(request)
-          expect(token).to eq("some-token")
-        end
-      end
+  describe ".from_bearer_param" do
+    it "returns token from bearer_token parameter" do
+      request = double parameters: { bearer_token: "some-token" }
+      token   = described_class.from_bearer_param(request)
+      expect(token).to eq("some-token")
+    end
+  end
 
-      describe :from_bearer_authorization do
-        it "returns token from capitalized authorization bearer" do
-          request = double authorization: "Bearer SomeToken"
-          token   = Token.from_bearer_authorization(request)
-          expect(token).to eq("SomeToken")
-        end
+  describe ".from_bearer_authorization" do
+    it "returns token from capitalized authorization bearer" do
+      request = double authorization: "Bearer SomeToken"
+      token   = described_class.from_bearer_authorization(request)
+      expect(token).to eq("SomeToken")
+    end
 
-        it "returns token from lowercased authorization bearer" do
-          request = double authorization: "bearer SomeToken"
-          token   = Token.from_bearer_authorization(request)
-          expect(token).to eq("SomeToken")
-        end
+    it "returns token from lowercased authorization bearer" do
+      request = double authorization: "bearer SomeToken"
+      token   = described_class.from_bearer_authorization(request)
+      expect(token).to eq("SomeToken")
+    end
 
-        it "does not return token if authorization is not bearer" do
-          request = double authorization: "MAC SomeToken"
-          token   = Token.from_bearer_authorization(request)
-          expect(token).to be_blank
-        end
-      end
+    it "does not return token if authorization is not bearer" do
+      request = double authorization: "MAC SomeToken"
+      token   = described_class.from_bearer_authorization(request)
+      expect(token).to be_blank
+    end
+  end
 
-      describe :from_basic_authorization do
-        it "returns token from capitalized authorization basic" do
-          request = double authorization: "Basic #{Base64.encode64 "SomeToken:"}"
-          token   = Token.from_basic_authorization(request)
-          expect(token).to eq("SomeToken")
-        end
+  describe ".from_basic_authorization" do
+    it "returns token from capitalized authorization basic" do
+      request = double authorization: "Basic #{Base64.encode64 "SomeToken:"}"
+      token   = described_class.from_basic_authorization(request)
+      expect(token).to eq("SomeToken")
+    end
 
-        it "returns token from lowercased authorization basic" do
-          request = double authorization: "basic #{Base64.encode64 "SomeToken:"}"
-          token   = Token.from_basic_authorization(request)
-          expect(token).to eq("SomeToken")
-        end
+    it "returns token from lowercased authorization basic" do
+      request = double authorization: "basic #{Base64.encode64 "SomeToken:"}"
+      token   = described_class.from_basic_authorization(request)
+      expect(token).to eq("SomeToken")
+    end
 
-        it "does not return token if authorization is not basic" do
-          request = double authorization: "MAC #{Base64.encode64 "SomeToken:"}"
-          token   = Token.from_basic_authorization(request)
-          expect(token).to be_blank
+    it "does not return token if authorization is not basic" do
+      request = double authorization: "MAC #{Base64.encode64 "SomeToken:"}"
+      token   = described_class.from_basic_authorization(request)
+      expect(token).to be_blank
+    end
+  end
+
+  describe ".authenticate" do
+    context "refresh tokens are disabled (default)" do
+      context "refresh tokens are enabled" do
+        it "does not revoke previous refresh_token if token was found" do
+          token = ->(_r) { "token" }
+          expect(
+            Doorkeeper::AccessToken,
+          ).to receive(:by_token).with("token").and_return(token)
+          expect(token).not_to receive(:revoke_previous_refresh_token!)
+          described_class.authenticate double, token
         end
       end
 
-      describe :authenticate do
-        context "refresh tokens are disabled (default)" do
-          context "refresh tokens are enabled" do
-            it "does not revoke previous refresh_token if token was found" do
-              token = ->(_r) { "token" }
-              expect(
-                AccessToken
-              ).to receive(:by_token).with("token").and_return(token)
-              expect(token).not_to receive(:revoke_previous_refresh_token!)
-              Token.authenticate double, token
-            end
-          end
-
-          it "calls the finder if token was returned" do
-            token = ->(_r) { "token" }
-            expect(AccessToken).to receive(:by_token).with("token")
-            Token.authenticate double, token
-          end
-        end
+      it "calls the finder if token was returned" do
+        token = ->(_r) { "token" }
+        expect(Doorkeeper::AccessToken).to receive(:by_token).with("token")
+        described_class.authenticate double, token
+      end
+    end
 
-        context "token hashing is enabled" do
-          include_context "with token hashing enabled"
+    context "token hashing is enabled" do
+      include_context "with token hashing enabled"
 
-          let(:hashed_token) { hashed_or_plain_token_func.call("token") }
-          let(:token) { ->(_r) { "token" } }
+      let(:hashed_token) { hashed_or_plain_token_func.call("token") }
+      let(:token) { ->(_r) { "token" } }
 
-          it "searches with the hashed token" do
-            expect(
-              AccessToken
-            ).to receive(:find_by).with(token: hashed_token).and_return(token)
-            Token.authenticate double, token
-          end
-        end
+      it "searches with the hashed token" do
+        expect(
+          Doorkeeper::AccessToken,
+        ).to receive(:find_by).with(token: hashed_token).and_return(token)
+        described_class.authenticate double, token
+      end
+    end
 
-        context "refresh tokens are enabled" do
-          before do
-            Doorkeeper.configure do
-              orm DOORKEEPER_ORM
-              use_refresh_token
-            end
-          end
-
-          it "revokes previous refresh_token if token was found" do
-            token = ->(_r) { "token" }
-            expect(
-              AccessToken
-            ).to receive(:by_token).with("token").and_return(token)
-            expect(token).to receive(:revoke_previous_refresh_token!)
-            Token.authenticate double, token
-          end
-
-          it "calls the finder if token was returned" do
-            token = ->(_r) { "token" }
-            expect(AccessToken).to receive(:by_token).with("token")
-            Token.authenticate double, token
-          end
+    context "refresh tokens are enabled" do
+      before do
+        Doorkeeper.configure do
+          orm DOORKEEPER_ORM
+          use_refresh_token
         end
       end
+
+      it "revokes previous refresh_token if token was found" do
+        token = ->(_r) { "token" }
+        expect(
+          Doorkeeper::AccessToken,
+        ).to receive(:by_token).with("token").and_return(token)
+        expect(token).to receive(:revoke_previous_refresh_token!)
+        described_class.authenticate double, token
+      end
+
+      it "calls the finder if token was returned" do
+        token = ->(_r) { "token" }
+        expect(Doorkeeper::AccessToken).to receive(:by_token).with("token")
+        described_class.authenticate double, token
+      end
     end
   end
 end

data/spec/models/doorkeeper/access_grant_spec.rb

@@ -81,9 +81,7 @@ describe Doorkeeper::AccessGrant do
             )
 
           # Not all the ORM support :id PK
-          if grant.respond_to?(:id)
-            expect(clazz.by_token(plain_text_token).id).to eq(grant.id)
-          end
+          expect(clazz.by_token(plain_text_token).id).to eq(grant.id) if grant.respond_to?(:id)
 
           # And it modifies the token value
           grant.reload
@@ -141,7 +139,7 @@ describe Doorkeeper::AccessGrant do
     it "matches application" do
       access_grant_for_different_app = FactoryBot.create(
         :access_grant,
-        default_attributes.merge(application: FactoryBot.create(:application))
+        default_attributes.merge(application: FactoryBot.create(:application)),
       )
 
       described_class.revoke_all_for(application.id, resource_owner)
@@ -152,7 +150,7 @@ describe Doorkeeper::AccessGrant do
     it "matches resource owner" do
       access_grant_for_different_owner = FactoryBot.create(
         :access_grant,
-        default_attributes.merge(resource_owner_id: 90)
+        default_attributes.merge(resource_owner_id: 90),
       )
 
       described_class.revoke_all_for application.id, resource_owner

data/spec/models/doorkeeper/access_token_spec.rb

@@ -212,7 +212,7 @@ module Doorkeeper
         end
 
         expect { FactoryBot.create :access_token }.to(
-          raise_error(Doorkeeper::Errors::UnableToGenerateToken)
+          raise_error(Doorkeeper::Errors::UnableToGenerateToken),
         )
       end
 
@@ -234,7 +234,7 @@ module Doorkeeper
         end
 
         expect { FactoryBot.create :access_token }.to(
-          raise_error(LoadError)
+          raise_error(LoadError),
         )
       end
 
@@ -245,7 +245,7 @@ module Doorkeeper
         end
 
         expect { FactoryBot.create :access_token }.to(
-          raise_error(Doorkeeper::Errors::TokenGeneratorNotFound, /NotReal/)
+          raise_error(Doorkeeper::Errors::TokenGeneratorNotFound, /NotReal/),
         )
       end
     end
@@ -468,7 +468,7 @@ module Doorkeeper
       it "matches application" do
         access_token_for_different_app = FactoryBot.create(
           :access_token,
-          default_attributes.merge(application: FactoryBot.create(:application))
+          default_attributes.merge(application: FactoryBot.create(:application)),
         )
 
         AccessToken.revoke_all_for application.id, resource_owner
@@ -479,7 +479,7 @@ module Doorkeeper
       it "matches resource owner" do
         access_token_for_different_owner = FactoryBot.create(
           :access_token,
-          default_attributes.merge(resource_owner_id: 90)
+          default_attributes.merge(resource_owner_id: 90),
         )
 
         AccessToken.revoke_all_for application.id, resource_owner
@@ -561,7 +561,7 @@ module Doorkeeper
 
       it "excludes tokens with scopes that are not present in server scopes" do
         FactoryBot.create :access_token, default_attributes.merge(
-          application: application, scopes: "public read"
+          application: application, scopes: "public read",
         )
         last_token = AccessToken.matching_token_for(application, resource_owner_id, scopes)
         expect(last_token).to be_nil
@@ -570,7 +570,7 @@ module Doorkeeper
       it "excludes tokens with scopes that are not present in application scopes" do
         application = FactoryBot.create :application, scopes: "private read"
         FactoryBot.create :access_token, default_attributes.merge(
-          application: application
+          application: application,
         )
         last_token = AccessToken.matching_token_for(application, resource_owner_id, scopes)
         expect(last_token).to be_nil

data/spec/models/doorkeeper/application_spec.rb

@@ -13,6 +13,78 @@ module Doorkeeper
     let(:uid) { SecureRandom.hex(8) }
     let(:secret) { SecureRandom.hex(8) }
 
+    it "is invalid without a name" do
+      new_application.name = nil
+      expect(new_application).not_to be_valid
+    end
+
+    it "is invalid without determining confidentiality" do
+      new_application.confidential = nil
+      expect(new_application).not_to be_valid
+    end
+
+    it "generates uid on create" do
+      expect(new_application.uid).to be_nil
+      new_application.save
+      expect(new_application.uid).not_to be_nil
+    end
+
+    it "generates uid on create if an empty string" do
+      new_application.uid = ""
+      new_application.save
+      expect(new_application.uid).not_to be_blank
+    end
+
+    it "generates uid on create unless one is set" do
+      new_application.uid = uid
+      new_application.save
+      expect(new_application.uid).to eq(uid)
+    end
+
+    it "is invalid without uid" do
+      new_application.save
+      new_application.uid = nil
+      expect(new_application).not_to be_valid
+    end
+
+    it "checks uniqueness of uid" do
+      app1 = FactoryBot.create(:application)
+      app2 = FactoryBot.create(:application)
+      app2.uid = app1.uid
+      expect(app2).not_to be_valid
+    end
+
+    it "expects database to throw an error when uids are the same" do
+      app1 = FactoryBot.create(:application)
+      app2 = FactoryBot.create(:application)
+      app2.uid = app1.uid
+      expect { app2.save!(validate: false) }.to raise_error(uniqueness_error)
+    end
+
+    it "generate secret on create" do
+      expect(new_application.secret).to be_nil
+      new_application.save
+      expect(new_application.secret).not_to be_nil
+    end
+
+    it "generate secret on create if is blank string" do
+      new_application.secret = ""
+      new_application.save
+      expect(new_application.secret).not_to be_blank
+    end
+
+    it "generate secret on create unless one is set" do
+      new_application.secret = secret
+      new_application.save
+      expect(new_application.secret).to eq(secret)
+    end
+
+    it "is invalid without secret" do
+      new_application.save
+      new_application.secret = nil
+      expect(new_application).not_to be_valid
+    end
+
     context "application_owner is enabled" do
       before do
         Doorkeeper.configure do
@@ -48,40 +120,6 @@ module Doorkeeper
       end
     end
 
-    it "is invalid without a name" do
-      new_application.name = nil
-      expect(new_application).not_to be_valid
-    end
-
-    it "is invalid without determining confidentiality" do
-      new_application.confidential = nil
-      expect(new_application).not_to be_valid
-    end
-
-    it "generates uid on create" do
-      expect(new_application.uid).to be_nil
-      new_application.save
-      expect(new_application.uid).not_to be_nil
-    end
-
-    it "generates uid on create if an empty string" do
-      new_application.uid = ""
-      new_application.save
-      expect(new_application.uid).not_to be_blank
-    end
-
-    it "generates uid on create unless one is set" do
-      new_application.uid = uid
-      new_application.save
-      expect(new_application.uid).to eq(uid)
-    end
-
-    it "is invalid without uid" do
-      new_application.save
-      new_application.uid = nil
-      expect(new_application).not_to be_valid
-    end
-
     context "redirect URI" do
       context "when grant flows allow blank redirect URI" do
         before do
@@ -127,44 +165,6 @@ module Doorkeeper
       end
     end
 
-    it "checks uniqueness of uid" do
-      app1 = FactoryBot.create(:application)
-      app2 = FactoryBot.create(:application)
-      app2.uid = app1.uid
-      expect(app2).not_to be_valid
-    end
-
-    it "expects database to throw an error when uids are the same" do
-      app1 = FactoryBot.create(:application)
-      app2 = FactoryBot.create(:application)
-      app2.uid = app1.uid
-      expect { app2.save!(validate: false) }.to raise_error(uniqueness_error)
-    end
-
-    it "generate secret on create" do
-      expect(new_application.secret).to be_nil
-      new_application.save
-      expect(new_application.secret).not_to be_nil
-    end
-
-    it "generate secret on create if is blank string" do
-      new_application.secret = ""
-      new_application.save
-      expect(new_application.secret).not_to be_blank
-    end
-
-    it "generate secret on create unless one is set" do
-      new_application.secret = secret
-      new_application.save
-      expect(new_application.secret).to eq(secret)
-    end
-
-    it "is invalid without secret" do
-      new_application.save
-      new_application.secret = nil
-      expect(new_application).not_to be_valid
-    end
-
     context "with hashing enabled" do
       include_context "with application hashing enabled"
       let(:app) { FactoryBot.create :application }
@@ -238,7 +238,7 @@ module Doorkeeper
       end
     end
 
-    describe :ordered_by do
+    describe "#ordered_by" do
       let(:applications) { FactoryBot.create_list(:application, 5) }
 
       context "when a direction is not specified" do
@@ -281,7 +281,7 @@ module Doorkeeper
       end
     end
 
-    describe :authorized_for do
+    describe "#authorized_for" do
       let(:resource_owner) { double(:resource_owner, id: 10) }
 
       it "is empty if the application is not authorized for anyone" do
@@ -313,7 +313,7 @@ module Doorkeeper
       end
     end
 
-    describe :revoke_tokens_and_grants_for do
+    describe "#revoke_tokens_and_grants_for" do
       it "revokes all access tokens and access grants" do
         application_id = 42
         resource_owner = double
@@ -326,7 +326,7 @@ module Doorkeeper
       end
     end
 
-    describe :by_uid_and_secret do
+    describe "#by_uid_and_secret" do
       context "when application is private/confidential" do
         it "finds the application via uid/secret" do
           app = FactoryBot.create :application
@@ -360,7 +360,7 @@ module Doorkeeper
       end
     end
 
-    describe :confidential? do
+    describe "#confidential?" do
       subject { FactoryBot.create(:application, confidential: confidential).confidential? }
 
       context "when application is private/confidential" do
@@ -373,5 +373,32 @@ module Doorkeeper
         it { expect(subject).to eq(false) }
       end
     end
+
+    describe "#as_json" do
+      let(:app) { FactoryBot.create :application, secret: "123123123" }
+
+      before do
+        allow(Doorkeeper.configuration)
+          .to receive(:application_secret_strategy).and_return(Doorkeeper::SecretStoring::Plain)
+      end
+
+      it "includes plaintext secret" do
+        expect(app.as_json).to include("secret" => "123123123")
+      end
+
+      it "respects custom options" do
+        expect(app.as_json(except: :secret)).not_to include("secret")
+        expect(app.as_json(only: :id)).to match("id" => app.id)
+      end
+
+      # AR specific
+      if DOORKEEPER_ORM == :active_record
+        it "correctly works with #to_json" do
+          ActiveRecord::Base.include_root_in_json = true
+          expect(app.to_json(include_root_in_json: true)).to match(/application.+?:\{/)
+          ActiveRecord::Base.include_root_in_json = false
+        end
+      end
+    end
   end
 end

data/spec/requests/applications/applications_request_spec.rb

@@ -91,7 +91,7 @@ feature "Adding applications" do
       i_should_see "Whoops! Check your form for possible errors"
       i_should_see Regexp.new(
         I18n.t("activerecord.errors.models.doorkeeper/application.attributes.scopes.not_match_configured"),
-        true
+        true,
       )
     end
 

data/spec/requests/endpoints/authorization_spec.rb

@@ -79,9 +79,11 @@ feature "Authorization endpoint" do
     scenario "raises exception on forged requests" do
       allowing_forgery_protection do
         expect do
-          page.driver.post authorization_endpoint_url(client_id: @client.uid,
-                                                      redirect_uri: @client.redirect_uri,
-                                                      response_type: "code")
+          page.driver.post authorization_endpoint_url(
+            client_id: @client.uid,
+            redirect_uri: @client.redirect_uri,
+            response_type: "code",
+          )
         end.to raise_error(ActionController::InvalidAuthenticityToken)
       end
     end