doorkeeper 3.1.0 → 4.4.3

data/spec/lib/doorkeeper_spec.rb

@@ -1,28 +1,150 @@
 require 'spec_helper_integration'
 
 describe Doorkeeper do
-  describe 'authenticate' do
-    let(:token) { double('Token') }
-    let(:request) { double('ActionDispatch::Request') }
+  describe "#authenticate" do
+    let(:request) { double }
+
+    it "calls OAuth::Token#authenticate" do
+      token_strategies = Doorkeeper.configuration.access_token_methods
+
+      expect(Doorkeeper::OAuth::Token).to receive(:authenticate).
+        with(request, *token_strategies)
+
+      Doorkeeper.authenticate(request)
+    end
+
+    it "accepts custom token strategies" do
+      token_strategies = [:first_way, :second_way]
+
+      expect(Doorkeeper::OAuth::Token).to receive(:authenticate).
+        with(request, *token_strategies)
+
+      Doorkeeper.authenticate(request, token_strategies)
+    end
+  end
+
+  describe "#configured?" do
+    after do
+      Doorkeeper.remove_instance_variable(:@config)
+    end
+
+    context "@config is set" do
+      it "returns true" do
+        Doorkeeper.instance_variable_set(:@config, "hi")
+
+        expect(Doorkeeper.configured?).to eq(true)
+      end
+    end
+
+    context "@config is not set" do
+      it "returns false" do
+        Doorkeeper.instance_variable_set(:@config, nil)
+
+        expect(Doorkeeper.configured?).to eq(false)
+      end
+    end
+
+    it "is deprecated" do
+      expect(ActiveSupport::Deprecation).to receive(:warn).
+        with("Method `Doorkeeper#configured?` has been deprecated without replacement.")
+
+      Doorkeeper.configured?
+    end
+  end
+
+  describe "#database_installed?" do
     before do
-      allow(Doorkeeper::OAuth::Token).to receive(:authenticate).
-        with(request, *token_strategies) { token }
+      ["AccessToken", "AccessGrant", "Application"].each do |klass|
+        @original_classes ||= {}
+        @original_classes[klass] = Doorkeeper.const_get(klass)
+        Doorkeeper.send(:remove_const, klass)
+      end
+    end
+
+    after do
+      ["AccessToken", "AccessGrant", "Application"].each do |klass|
+        Doorkeeper.send(:remove_const, klass)
+        Doorkeeper.const_set(klass, @original_classes[klass])
+      end
     end
 
-    context 'with specific access token strategies' do
-      let(:token_strategies) { [:first_way, :second_way] }
+    context "all tables exist" do
+      before do
+        klass = double table_exists?: true
+
+        Doorkeeper.const_set(:AccessToken, klass)
+        Doorkeeper.const_set(:AccessGrant, klass)
+        Doorkeeper.const_set(:Application, klass)
+      end
 
-      it 'authenticates the token from the request' do
-        expect(Doorkeeper.authenticate(request, token_strategies)).to eq(token)
+      it "returns true" do
+        expect(Doorkeeper.database_installed?).to eq(true)
+      end
+
+      it "is deprecated" do
+        expect(ActiveSupport::Deprecation).to receive(:warn).
+          with("Method `Doorkeeper#database_installed?` has been deprecated without replacement.")
+
+        Doorkeeper.database_installed?
       end
     end
 
-    context 'with default access token strategies' do
-      let(:token_strategies) { Doorkeeper.configuration.access_token_methods }
+    context "all tables do not exist" do
+      before do
+        klass = double table_exists?: false
+
+        Doorkeeper.const_set(:AccessToken, klass)
+        Doorkeeper.const_set(:AccessGrant, klass)
+        Doorkeeper.const_set(:Application, klass)
+      end
+
+      it "returns false" do
+        expect(Doorkeeper.database_installed?).to eq(false)
+      end
+
+      it "is deprecated" do
+        expect(ActiveSupport::Deprecation).to receive(:warn).
+          with("Method `Doorkeeper#database_installed?` has been deprecated without replacement.")
 
-      it 'authenticates the token from the request' do
-        expect(Doorkeeper.authenticate(request)).to eq(token)
+        Doorkeeper.database_installed?
       end
     end
   end
+
+  describe "#installed?" do
+    context "methods return true" do
+      before do
+        allow(Doorkeeper).to receive(:configured?).and_return(true).once
+        allow(Doorkeeper).to receive(:database_installed?).and_return(true).once
+      end
+
+      it "returns true" do
+        expect(Doorkeeper.installed?).to eq(true)
+      end
+    end
+
+    context "methods return false" do
+      before do
+        allow(Doorkeeper).to receive(:configured?).and_return(false).once
+        allow(Doorkeeper).to receive(:database_installed?).and_return(false).once
+      end
+
+      it "returns false" do
+        expect(Doorkeeper.installed?).to eq(false)
+      end
+    end
+
+    it "is deprecated" do
+      expect(ActiveSupport::Deprecation).to receive(:warn).
+        with("Method `Doorkeeper#configured?` has been deprecated without replacement.")
+
+      expect(ActiveSupport::Deprecation).to receive(:warn).
+        with("Method `Doorkeeper#database_installed?` has been deprecated without replacement.")
+
+      expect(ActiveSupport::Deprecation).to receive(:warn).
+        with("Method `Doorkeeper#installed?` has been deprecated without replacement.")
+
+      Doorkeeper.installed?
+    end
+  end
 end

data/spec/lib/models/expirable_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'timecop'
 require 'active_support/time'
 require 'doorkeeper/models/concerns/expirable'
 

data/spec/lib/models/revocable_spec.rb

@@ -11,20 +11,21 @@ describe 'Revocable' do
 
   describe :revoke do
     it 'updates :revoked_at attribute with current time' do
-      clock = double now: double
-      expect(subject).to receive(:update_attribute).with(:revoked_at, clock.now)
+      utc = double utc: double
+      clock = double now: utc
+      expect(subject).to receive(:update_attribute).with(:revoked_at, clock.now.utc)
       subject.revoke(clock)
     end
   end
 
   describe :revoked? do
     it 'is revoked if :revoked_at has passed' do
-      allow(subject).to receive(:revoked_at).and_return(Time.now - 1000)
+      allow(subject).to receive(:revoked_at).and_return(Time.now.utc - 1000)
       expect(subject).to be_revoked
     end
 
     it 'is not revoked if :revoked_at has not passed' do
-      allow(subject).to receive(:revoked_at).and_return(Time.now + 1000)
+      allow(subject).to receive(:revoked_at).and_return(Time.now.utc + 1000)
       expect(subject).not_to be_revoked
     end
 
@@ -33,4 +34,26 @@ describe 'Revocable' do
       expect(subject).not_to be_revoked
     end
   end
+
+  describe :revoke_previous_refresh_token! do
+    it "revokes the previous token if existing, and resets the
+      `previous_refresh_token` attribute" do
+      previous_token = FactoryBot.create(
+        :access_token,
+        refresh_token: "refresh_token"
+      )
+      current_token = FactoryBot.create(
+        :access_token,
+        previous_refresh_token: previous_token.refresh_token
+      )
+
+      expect_any_instance_of(
+        Doorkeeper::AccessToken
+      ).to receive(:revoke).and_call_original
+      current_token.revoke_previous_refresh_token!
+
+      expect(current_token.previous_refresh_token).to be_empty
+      expect(previous_token.reload).to be_revoked
+    end
+  end
 end

data/spec/lib/oauth/authorization/uri_builder_spec.rb

@@ -6,8 +6,7 @@ require 'doorkeeper/oauth/authorization/uri_builder'
 
 module Doorkeeper::OAuth::Authorization
   describe URIBuilder do
-
-    subject { Object.new.class.send :include, URIBuilder }
+    subject { URIBuilder }
 
     describe :uri_with_query do
       it 'returns the uri with query' do

data/spec/lib/oauth/authorization_code_request_spec.rb

@@ -8,17 +8,20 @@ module Doorkeeper::OAuth
              refresh_token_enabled?: false,
              custom_access_token_expires_in: ->(_app) { nil }
     end
-    let(:grant)  { FactoryGirl.create :access_grant }
+
+    let(:grant)  { FactoryBot.create :access_grant }
     let(:client) { grant.application }
+    let(:redirect_uri) { client.redirect_uri }
+    let(:params) { { redirect_uri: redirect_uri } }
 
     subject do
-      AuthorizationCodeRequest.new server, grant, client, redirect_uri: client.redirect_uri
+      AuthorizationCodeRequest.new server, grant, client, params
     end
 
     it 'issues a new token for the client' do
       expect do
         subject.authorize
-      end.to change { client.access_tokens.count }.by(1)
+      end.to change { client.reload.access_tokens.count }.by(1)
     end
 
     it "issues the token with same grant's scopes" do
@@ -27,9 +30,7 @@ module Doorkeeper::OAuth
     end
 
     it 'revokes the grant' do
-      expect do
-        subject.authorize
-      end.to change { grant.reload.accessible? }
+      expect { subject.authorize }.to change { grant.reload.accessible? }
     end
 
     it 'requires the grant to be accessible' do
@@ -63,18 +64,60 @@ module Doorkeeper::OAuth
     end
 
     it "matches the client with grant's one" do
-      subject.client = FactoryGirl.create :application
+      subject.client = FactoryBot.create :application
       subject.validate
       expect(subject.error).to eq(:invalid_grant)
     end
 
     it 'skips token creation if there is a matching one' do
-      allow(Doorkeeper.configuration).to receive(:reuse_access_token).and_return(true)
-      FactoryGirl.create(:access_token, application_id: client.id,
+      Doorkeeper.configure do
+        orm DOORKEEPER_ORM
+        reuse_access_token
+      end
+
+      FactoryBot.create(:access_token, application_id: client.id,
         resource_owner_id: grant.resource_owner_id, scopes: grant.scopes.to_s)
-      expect do
-        subject.authorize
-      end.to_not change { Doorkeeper::AccessToken.count }
+
+      expect { subject.authorize }.to_not change { Doorkeeper::AccessToken.count }
+    end
+
+    it "calls configured request callback methods" do
+      expect(Doorkeeper.configuration.before_successful_strategy_response).to receive(:call).with(subject).once
+      expect(Doorkeeper.configuration.after_successful_strategy_response).to receive(:call).with(subject, instance_of(Doorkeeper::OAuth::TokenResponse)).once
+      subject.authorize
+    end
+
+    context "when redirect_uri contains some query params" do
+      let(:redirect_uri) { client.redirect_uri + "?query=q" }
+
+      it "compares only host part with grant's redirect_uri" do
+        subject.validate
+        expect(subject.error).to eq(nil)
+      end
+    end
+
+    context "when redirect_uri is not an URI" do
+      let(:redirect_uri) { '123d#!s' }
+
+      it "responds with invalid_grant" do
+        subject.validate
+        expect(subject.error).to eq(:invalid_grant)
+      end
+    end
+
+    context "when redirect_uri is the native one" do
+      let(:redirect_uri) { 'urn:ietf:wg:oauth:2.0:oob' }
+
+      it "invalidates when redirect_uri of the grant is not native" do
+        subject.validate
+        expect(subject.error).to eq(:invalid_grant)
+      end
+
+      it "validates when redirect_uri of the grant is also native" do
+        allow(grant).to receive(:redirect_uri) { redirect_uri }
+        subject.validate
+        expect(subject.error).to eq(nil)
+      end
     end
   end
 end

data/spec/lib/oauth/base_request_spec.rb

@@ -0,0 +1,155 @@
+require 'spec_helper_integration'
+
+module Doorkeeper::OAuth
+  describe BaseRequest do
+    let(:access_token) do
+      double :access_token,
+        token:              "some-token",
+        expires_in:         "3600",
+        expires_in_seconds: "300",
+        scopes_string:      "two scopes",
+        refresh_token:      "some-refresh-token",
+        token_type:         "bearer",
+        created_at:         0
+    end
+
+    let(:client) { double :client, id: '1' }
+
+    let(:scopes_array) { %w[public write] }
+
+    let(:server) do
+      double :server,
+        access_token_expires_in: 100,
+        custom_access_token_expires_in: ->(_) { nil },
+        refresh_token_enabled?: false
+    end
+
+    subject do
+      BaseRequest.new
+    end
+
+    describe "#authorize" do
+      before do
+        allow(subject).to receive(:access_token).and_return(access_token)
+      end
+
+      it "validates itself" do
+        expect(subject).to receive(:validate).once
+        subject.authorize
+      end
+
+      context "valid" do
+        before do
+          allow(subject).to receive(:valid?).and_return(true)
+        end
+
+        it "calls callback methods" do
+          expect(subject).to receive(:before_successful_response).once
+          expect(subject).to receive(:after_successful_response).once
+          subject.authorize
+        end
+
+        it "returns a TokenResponse object" do
+          result = subject.authorize
+
+          expect(result).to be_an_instance_of(TokenResponse)
+          expect(result.body).to eq(
+            TokenResponse.new(access_token).body
+          )
+        end
+      end
+
+      context "invalid" do
+        before do
+          allow(subject).to receive(:valid?).and_return(false)
+          allow(subject).to receive(:error).and_return("server_error")
+          allow(subject).to receive(:state).and_return("hello")
+        end
+
+        it "returns an ErrorResponse object" do
+          error_description = I18n.translate(
+            "server_error",
+            scope: %i[doorkeeper errors messages]
+          )
+
+          result = subject.authorize
+
+          expect(result).to be_an_instance_of(ErrorResponse)
+
+          expect(result.body).to eq(
+            error: "server_error",
+            error_description: error_description,
+            state: "hello"
+          )
+        end
+      end
+    end
+
+    describe "#default_scopes" do
+      it "delegates to the server" do
+        expect(subject).to receive(:server).and_return(server).once
+        expect(server).to receive(:default_scopes).once
+
+        subject.default_scopes
+      end
+    end
+
+    describe "#find_or_create_access_token" do
+      it "returns an instance of AccessToken" do
+        result = subject.find_or_create_access_token(
+          client,
+          "1",
+          "public",
+          server
+        )
+
+        expect(result).to be_an_instance_of(Doorkeeper::AccessToken)
+      end
+    end
+
+    describe "#scopes" do
+      context "@original_scopes is present" do
+        before do
+          subject.instance_variable_set(:@original_scopes, "public write")
+        end
+
+        it "returns array of @original_scopes" do
+          result = subject.scopes
+
+          expect(result).to eq(scopes_array)
+        end
+      end
+
+      context "@original_scopes is not present" do
+        before do
+          subject.instance_variable_set(:@original_scopes, "")
+        end
+
+        it "calls #default_scopes" do
+          allow(subject).to receive(:server).and_return(server).once
+          allow(server).to receive(:default_scopes).and_return(scopes_array).once
+
+          result = subject.scopes
+
+          expect(result).to eq(scopes_array)
+        end
+      end
+    end
+
+    describe "#valid?" do
+      context "error is nil" do
+        it "returns true" do
+          allow(subject).to receive(:error).and_return(nil).once
+          expect(subject.valid?).to eq(true)
+        end
+      end
+
+      context "error is not nil" do
+        it "returns false" do
+          allow(subject).to receive(:error).and_return(Object.new).once
+          expect(subject.valid?).to eq(false)
+        end
+      end
+    end
+  end
+end

data/spec/lib/oauth/base_response_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper_integration'
+
+module Doorkeeper::OAuth
+  describe BaseResponse do
+    subject do
+      BaseResponse.new
+    end
+
+    describe "#body" do
+      it "returns an empty Hash" do
+        expect(subject.body).to eq({})
+      end
+    end
+
+    describe "#description" do
+      it "returns an empty String" do
+        expect(subject.description).to eq("")
+      end
+    end
+
+    describe "#headers" do
+      it "returns an empty Hash" do
+        expect(subject.headers).to eq({})
+      end
+    end
+
+    describe "#redirectable?" do
+      it "returns false" do
+        expect(subject.redirectable?).to eq(false)
+      end
+    end
+
+    describe "#redirect_uri" do
+      it "returns an empty String" do
+        expect(subject.redirect_uri).to eq("")
+      end
+    end
+
+    describe "#status" do
+      it "returns :ok" do
+        expect(subject.status).to eq(:ok)
+      end
+    end
+  end
+end

data/spec/lib/oauth/client/credentials_spec.rb

@@ -4,9 +4,14 @@ require 'doorkeeper/oauth/client'
 
 class Doorkeeper::OAuth::Client
   describe Credentials do
-    it 'is blank when any of the credentials is blank' do
+    let(:client_id) { 'some-uid' }
+    let(:client_secret) { 'some-secret' }
+
+    it 'is blank when the uid in credentials is blank' do
+      expect(Credentials.new(nil, nil)).to be_blank
       expect(Credentials.new(nil, 'something')).to be_blank
-      expect(Credentials.new('something', nil)).to be_blank
+      expect(Credentials.new('something', nil)).to be_present
+      expect(Credentials.new('something', 'something')).to be_present
     end
 
     describe :from_request do
@@ -43,5 +48,43 @@ class Doorkeeper::OAuth::Client
         expect(credentials.secret).to eq('secret')
       end
     end
+
+    describe :from_params do
+      it 'returns credentials from parameters when Authorization header is not available' do
+        request     = double parameters: { client_id: client_id, client_secret: client_secret }
+        uid, secret = Credentials.from_params(request)
+
+        expect(uid).to    eq('some-uid')
+        expect(secret).to eq('some-secret')
+      end
+
+      it 'is blank when there are no credentials' do
+        request     = double parameters: {}
+        uid, secret = Credentials.from_params(request)
+
+        expect(uid).to    be_blank
+        expect(secret).to be_blank
+      end
+    end
+
+    describe :from_basic do
+      let(:credentials) { Base64.encode64("#{client_id}:#{client_secret}") }
+
+      it 'decodes the credentials' do
+        request     = double authorization: "Basic #{credentials}"
+        uid, secret = Credentials.from_basic(request)
+
+        expect(uid).to    eq('some-uid')
+        expect(secret).to eq('some-secret')
+      end
+
+      it 'is blank if Authorization is not Basic' do
+        request     = double authorization: "#{credentials}"
+        uid, secret = Credentials.from_basic(request)
+
+        expect(uid).to    be_blank
+        expect(secret).to be_blank
+      end
+    end
   end
 end

data/spec/lib/oauth/client_credentials/creator_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper_integration'
 
 class Doorkeeper::OAuth::ClientCredentialsRequest
   describe Creator do
-    let(:client) { FactoryGirl.create :application }
+    let(:client) { FactoryBot.create :application }
     let(:scopes) { Doorkeeper::OAuth::Scopes.from_string('public') }
 
     it 'creates a new token' do

data/spec/lib/oauth/client_credentials_integration_spec.rb

@@ -5,7 +5,7 @@ module Doorkeeper::OAuth
     let(:server) { Doorkeeper.configuration }
 
     context 'with a valid request' do
-      let(:client) { FactoryGirl.create :application }
+      let(:client) { FactoryBot.create :application }
 
       it 'issues an access token' do
         request = ClientCredentialsRequest.new(server, client, {})

data/spec/lib/oauth/client_credentials_request_spec.rb

@@ -11,6 +11,7 @@ module Doorkeeper::OAuth
         custom_access_token_expires_in: ->(_app) { nil }
       )
     end
+
     let(:application)   { double :application, scopes: Scopes.from_string('') }
     let(:client)        { double :client, application: application }
     let(:token_creator) { double :issuer, create: true, token: double }

data/spec/lib/oauth/code_request_spec.rb

@@ -32,9 +32,7 @@ module Doorkeeper::OAuth
 
     it 'does not create grant when not authorizable' do
       allow(pre_auth).to receive(:authorizable?).and_return(false)
-      expect do
-        subject.authorize
-      end.to_not change { Doorkeeper::AccessGrant.count }
+      expect { subject.authorize }.not_to change { Doorkeeper::AccessGrant.count }
     end
 
     it 'returns a error response' do

data/spec/lib/oauth/code_response_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+module Doorkeeper
+  module OAuth
+    describe CodeResponse do
+      describe '.redirect_uri' do
+        context 'when generating the redirect URI for an implicit grant' do
+          let :pre_auth do
+            double(
+              :pre_auth,
+              client: double(:application, id: 1),
+              redirect_uri: 'http://tst.com/cb',
+              state: nil,
+              scopes: Scopes.from_string('public'),
+            )
+          end
+
+          let :auth do
+            Authorization::Token.new(pre_auth, double(id: 1)).tap do |c|
+              c.issue_token
+              allow(c.token).to receive(:expires_in_seconds).and_return(3600)
+            end
+          end
+
+          subject { CodeResponse.new(pre_auth, auth, response_on_fragment: true).redirect_uri }
+
+          it 'includes the remaining TTL of the token relative to the time the token was generated' do
+            expect(subject).to include('expires_in=3600')
+          end
+        end
+      end
+    end
+  end
+end