doorkeeper 2.1.4 → 3.1.0

data/lib/doorkeeper/server.rb

@@ -8,12 +8,12 @@ module Doorkeeper
 
     def authorization_request(strategy)
       klass = Request.authorization_strategy strategy
-      klass.build self
+      klass.new self
     end
 
     def token_request(strategy)
       klass = Request.token_strategy strategy
-      klass.build self
+      klass.new self
     end
 
     # TODO: context should be the request

data/lib/doorkeeper/version.rb

@@ -1,3 +1,3 @@
 module Doorkeeper
-  VERSION = '2.1.4'
+  VERSION = "3.1.0"
 end

data/lib/doorkeeper.rb

@@ -47,10 +47,6 @@ require 'doorkeeper/rails/routes'
 require 'doorkeeper/rails/helpers'
 
 require 'doorkeeper/orm/active_record'
-require 'doorkeeper/orm/mongo_mapper'
-require 'doorkeeper/orm/mongoid2'
-require 'doorkeeper/orm/mongoid3'
-require 'doorkeeper/orm/mongoid4'
 
 module Doorkeeper
   def self.configured?

data/lib/generators/doorkeeper/templates/README

@@ -17,26 +17,6 @@ And run
 
   rake db:migrate
 
-If you want to use Mongoid, configure the orm in initializers/doorkeeper.rb:
-
-# Mongoid
-Doorkeeper.configure do
-  orm :mongoid
-end
-
-If you want to use MongoMapper, configure the orm in
-initializers/doorkeeper.rb:
-
-# MongoMapper
-Doorkeeper.configure do
-  orm :mongo_mapper
-end
-
-And run
-
-  rails generate doorkeeper:mongo_mapper:indexes
-  rake db:index
-
 Step 3.
 That's it, that's all. Enjoy!
 

data/lib/generators/doorkeeper/templates/initializer.rb

@@ -1,7 +1,5 @@
 Doorkeeper.configure do
-  # Change the ORM that doorkeeper will use.
-  # Currently supported options are :active_record, :mongoid2, :mongoid3,
-  # :mongoid4, :mongo_mapper
+  # Change the ORM that doorkeeper will use (needs plugins)
   orm :active_record
 
   # This block will be called to check whether the resource owner is authenticated or not.
@@ -31,6 +29,10 @@ Doorkeeper.configure do
   #   oauth_client.application.additional_settings.implicit_oauth_expiration
   # end
 
+  # Use a custom class for generating the access token.
+  # https://github.com/doorkeeper-gem/doorkeeper#custom-access-token-generator
+  # access_token_generator "::Doorkeeper::JWT"
+
   # Reuse access token for the same resource owner within an application (disabled by default)
   # Rationale: https://github.com/doorkeeper-gem/doorkeeper/issues/383
   # reuse_access_token

data/lib/generators/doorkeeper/templates/migration.rb

@@ -27,7 +27,15 @@ class CreateDoorkeeperTables < ActiveRecord::Migration
     create_table :oauth_access_tokens do |t|
       t.integer  :resource_owner_id
       t.integer  :application_id
+
+      # 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.string   :refresh_token
       t.integer  :expires_in
       t.datetime :revoked_at

data/spec/controllers/applications_controller_spec.rb

@@ -54,6 +54,5 @@ module Doorkeeper
         expect(application.reload.name).to eq 'Example'
       end
     end
-
   end
 end

data/spec/controllers/protected_resources_controller_spec.rb

@@ -126,7 +126,17 @@ describe 'doorkeeper authorize filter' do
 
     context 'with a JSON custom render', token: :invalid do
       before do
-        expect(controller).to receive(:doorkeeper_unauthorized_render_options).and_return(json: ActiveSupport::JSON.encode(error: 'Unauthorized'))
+        module ControllerActions
+          def doorkeeper_unauthorized_render_options(error: nil)
+            { json: ActiveSupport::JSON.encode(error_message: error.description) }
+          end
+        end
+      end
+      after do
+        module ControllerActions
+          def doorkeeper_unauthorized_render_options(error: nil)
+          end
+        end
       end
 
       it 'it renders a custom JSON response', token: :invalid do
@@ -136,16 +146,26 @@ describe 'doorkeeper authorize filter' do
         expect(response.header['WWW-Authenticate']).to match(/^Bearer/)
         parsed_body = JSON.parse(response.body)
         expect(parsed_body).not_to be_nil
-        expect(parsed_body['error']).to eq('Unauthorized')
+        expect(parsed_body['error_message']).to match('token is invalid')
       end
     end
 
     context 'with a text custom render', token: :invalid do
       before do
-        expect(controller).to receive(:doorkeeper_unauthorized_render_options).and_return(text: 'Unauthorized')
+        module ControllerActions
+          def doorkeeper_unauthorized_render_options(error: nil)
+            { text: 'Unauthorized' }
+          end
+        end
+      end
+      after do
+        module ControllerActions
+          def doorkeeper_unauthorized_render_options(error: nil)
+          end
+        end
       end
 
-      it 'it renders a custom JSON response', token: :invalid do
+      it 'it renders a custom text response', token: :invalid do
         get :index, access_token: token_string
         expect(response.status).to eq 401
         expect(response.content_type).to eq('text/html')
@@ -155,16 +175,97 @@ describe 'doorkeeper authorize filter' do
     end
   end
 
-  context 'defined for all actions' do
-    controller {}
-
-    it 'it renders a custom JSON response', token: :invalid do
-      expect do
-        controller.class.doorkeeper_for
-      end.to raise_error(
-        Doorkeeper::Errors::DoorkeeperError,
-        /`doorkeeper_for` no longer available/
-      )
+  context 'when custom forbidden render options are configured' do
+    before do
+      expect(Doorkeeper::AccessToken).to receive(:by_token).with(token_string).and_return(token)
+      expect(token).to receive(:acceptable?).with([:write]).and_return(false)
+    end
+
+    after do
+      module ControllerActions
+        def doorkeeper_forbidden_render_options(*)
+        end
+      end
+    end
+
+    controller do
+      before_filter -> { doorkeeper_authorize! :write }
+
+      include ControllerActions
+    end
+
+    let(:token) do
+      double(Doorkeeper::AccessToken,
+             accessible?: true, scopes: ['public'], revoked?: false, expired?: false)
+    end
+    let(:token_string) { '1A2DUWE' }
+
+    context 'with a JSON custom render' do
+      before do
+        module ControllerActions
+          def doorkeeper_forbidden_render_options(*)
+            { json: { error_message: 'Forbidden' } }
+          end
+        end
+      end
+
+      it 'renders a custom JSON response' do
+        get :index, access_token: token_string
+        expect(response.header).to_not include('WWW-Authenticate')
+        expect(response.content_type).to eq('application/json')
+        expect(response.status).to eq 403
+        parsed_body = JSON.parse(response.body)
+        expect(parsed_body).not_to be_nil
+        expect(parsed_body['error_message']).to match('Forbidden')
+      end
+    end
+
+    context 'with a status and JSON custom render' do
+      before do
+        module ControllerActions
+          def doorkeeper_forbidden_render_options(*)
+            { json: { error_message: 'Not Found' },
+              respond_not_found_when_forbidden: true }
+          end
+        end
+      end
+
+      it 'overrides the default status code' do
+        get :index, access_token: token_string
+        expect(response.status).to eq 404
+      end
+    end
+
+    context 'with a text custom render' do
+      before do
+        module ControllerActions
+          def doorkeeper_forbidden_render_options(*)
+            { text: 'Forbidden' }
+          end
+        end
+      end
+
+      it 'renders a custom status code and text response' do
+        get :index, access_token: token_string
+        expect(response.header).to_not include('WWW-Authenticate')
+        expect(response.status).to eq 403
+        expect(response.body).to eq('Forbidden')
+      end
+    end
+
+    context 'with a status and text custom render' do
+      before do
+        module ControllerActions
+          def doorkeeper_forbidden_render_options(*)
+            { respond_not_found_when_forbidden: true, text: 'Not Found' }
+          end
+        end
+      end
+
+      it 'overrides the default status code' do
+        get :index, access_token: token_string
+        expect(response.status).to eq 404
+      end
     end
   end
 end

data/spec/controllers/token_info_controller_spec.rb

@@ -1,9 +1,7 @@
 require 'spec_helper_integration'
 
 describe Doorkeeper::TokenInfoController do
-
   describe 'when requesting tokeninfo with valid token' do
-
     let(:doorkeeper_token) { FactoryGirl.create(:access_token) }
 
     before(:each) do
@@ -50,7 +48,5 @@ describe Doorkeeper::TokenInfoController do
         expect(response.body).to eq(Doorkeeper::OAuth::ErrorResponse.new(name: :invalid_request, status: :unauthorized).body.to_json)
       end
     end
-
   end
-
 end

data/spec/controllers/tokens_controller_spec.rb

@@ -12,7 +12,9 @@ describe Doorkeeper::TokensController do
 
     it 'returns the authorization' do
       skip 'verify need of these specs'
+
       expect(token).to receive(:authorization)
+
       post :create
     end
   end
@@ -29,6 +31,36 @@ describe Doorkeeper::TokensController do
     end
   end
 
+  describe 'when there is a failure due to a custom error' do
+    it 'returns the error response with a custom message' do
+      # I18n looks for `doorkeeper.errors.messages.custom_message` in locale files
+      custom_message = "my_message"
+      allow(I18n).to receive(:translate).
+        with(
+          custom_message,
+          hash_including(scope: [:doorkeeper, :errors, :messages]),
+        ).
+        and_return('Authorization custom message')
+
+      doorkeeper_error = Doorkeeper::Errors::DoorkeeperError.new(custom_message)
+
+      strategy = double(:strategy)
+      request = double(token_request: strategy)
+      allow(strategy).to receive(:authorize).and_raise(doorkeeper_error)
+      allow(controller).to receive(:server).and_return(request)
+
+      post :create
+
+      expected_response_body = {
+        "error"             => custom_message,
+        "error_description" => "Authorization custom message"
+      }
+      expect(response.status).to eq 401
+      expect(response.headers['WWW-Authenticate']).to match(/Bearer/)
+      expect(JSON.load(response.body)).to eq expected_response_body
+    end
+  end
+
   describe 'when revoke authorization has failed' do
     # http://tools.ietf.org/html/rfc7009#section-2.2
     it 'returns no error response' do
@@ -46,11 +78,10 @@ describe Doorkeeper::TokensController do
       strategy = double(:strategy, authorize: true)
       expect(strategy).to receive(:authorize).once
       allow(controller).to receive(:strategy) { strategy }
-
-      controller.stub(:create) do
-        controller.send :authorize_response
+      allow(controller).to receive(:create) do
         controller.send :authorize_response
       end
+
       post :create
     end
   end

data/spec/dummy/app/models/user.rb

@@ -1,27 +1,5 @@
-case DOORKEEPER_ORM.to_s
-when "active_record"
-  class User < ActiveRecord::Base
-  end
-when /mongoid/
-  class User
-    include Mongoid::Document
-    include Mongoid::Timestamps
-
-    field :name, type: String
-    field :password, type: String
-  end
-when "mongo_mapper"
-  class User
-    include MongoMapper::Document
-    timestamps!
-
-    key :name,     String
-    key :password, String
-  end
-end
-
-class User
-  if ::Rails.version.to_i < 4 || defined?(::ProtectedAttributes)
+class User < ActiveRecord::Base
+  if respond_to?(:attr_accessible)
     attr_accessible :name, :password
   end
 

data/spec/dummy/config/application.rb

@@ -5,13 +5,14 @@ require 'sprockets/railtie'
 
 Bundler.require :default
 
+require 'yaml'
+
 orm = if DOORKEEPER_ORM =~ /mongoid/
         Mongoid.load!(File.join(File.dirname(File.expand_path(__FILE__)), "#{DOORKEEPER_ORM}.yml"))
         :mongoid
       else
         DOORKEEPER_ORM
       end
-
 require "#{orm}/railtie"
 
 module Dummy

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

@@ -1,7 +1,5 @@
 Doorkeeper.configure do
   # Change the ORM that doorkeeper will use.
-  # Currently supported options are :active_record, :mongoid2, :mongoid3,
-  # :mongoid4, :mongo_mapper
   orm DOORKEEPER_ORM
 
   # This block will be called to check whether the resource owner is authenticated or not.

data/spec/helpers/doorkeeper/dashboard_helper_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper_integration'
+
+describe Doorkeeper::DashboardHelper do
+  describe '.doorkeeper_errors_for' do
+    let(:object) { double errors: { method: messages } }
+    let(:messages) { ['first message', 'second message'] }
+
+    context 'when object has errors' do
+      it 'returns error messages' do
+        messages.each do |message|
+          expect(helper.doorkeeper_errors_for(object, :method)).to include(
+            message.capitalize
+          )
+        end
+      end
+    end
+
+    context 'when object has no errors' do
+      it 'returns nil' do
+        expect(helper.doorkeeper_errors_for(object, :amonter_method)).to be_nil
+      end
+    end
+  end
+end

data/spec/lib/config_spec.rb

@@ -14,7 +14,7 @@ describe Doorkeeper, 'configuration' do
     end
   end
 
-  describe 'enable_orm' do
+  describe 'setup_orm_adapter' do
     it 'adds specific error message to NameError exception' do
       expect do
         Doorkeeper.configure { orm 'hibernate' }
@@ -22,11 +22,11 @@ describe Doorkeeper, 'configuration' do
     end
 
     it 'does not change other exceptions' do
-      String.any_instance.stub(:classify) { raise NoMethodError }
+      allow_any_instance_of(String).to receive(:classify) { raise NoMethodError }
 
       expect do
         Doorkeeper.configure { orm 'hibernate' }
-      end.to raise_error(NoMethodError, 'NoMethodError')
+      end.to raise_error(NoMethodError, /ORM adapter not found \(hibernate\)/)
     end
   end
 
@@ -35,7 +35,7 @@ describe Doorkeeper, 'configuration' do
       block = proc {}
       Doorkeeper.configure do
         orm DOORKEEPER_ORM
-        admin_authenticator &block
+        admin_authenticator(&block)
       end
       expect(subject.authenticate_admin).to eq(block)
     end
@@ -298,4 +298,20 @@ describe Doorkeeper, 'configuration' do
       @config = old_config
     end
   end
+
+  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')
+      )
+    end
+
+    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
 end

data/spec/lib/models/revocable_spec.rb

@@ -19,12 +19,12 @@ describe 'Revocable' do
 
   describe :revoked? do
     it 'is revoked if :revoked_at has passed' do
-      allow(subject).to receive(:revoked_at).and_return(DateTime.now - 1000)
+      allow(subject).to receive(:revoked_at).and_return(Time.now - 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(DateTime.now + 1000)
+      allow(subject).to receive(:revoked_at).and_return(Time.now + 1000)
       expect(subject).not_to be_revoked
     end
 

data/spec/lib/oauth/authorization_code_request_spec.rb

@@ -69,7 +69,7 @@ module Doorkeeper::OAuth
     end
 
     it 'skips token creation if there is a matching one' do
-      Doorkeeper.configuration.stub(:reuse_access_token).and_return(true)
+      allow(Doorkeeper.configuration).to receive(:reuse_access_token).and_return(true)
       FactoryGirl.create(:access_token, application_id: client.id,
         resource_owner_id: grant.resource_owner_id, scopes: grant.scopes.to_s)
       expect do

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

@@ -13,7 +13,7 @@ class Doorkeeper::OAuth::Client
       let(:request) { double.as_null_object }
 
       let(:method) do
-        ->(request) { return 'uid', 'secret' }
+        ->(_request) { return 'uid', 'secret' }
       end
 
       it 'accepts anything that responds to #call' do
@@ -29,7 +29,7 @@ class Doorkeeper::OAuth::Client
       it 'stops at the first credentials found' do
         not_called_method = double
         expect(not_called_method).not_to receive(:call)
-        credentials = Credentials.from_request request, ->(r) {}, method, not_called_method
+        Credentials.from_request request, ->(_) {}, method, not_called_method
       end
 
       it 'returns new Credentials' do

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

@@ -11,8 +11,32 @@ class Doorkeeper::OAuth::ClientCredentialsRequest
       end.to change { Doorkeeper::AccessToken.count }.by(1)
     end
 
+    context "when reuse_access_token is true" do
+      it "returns the existing valid token" do
+        allow(Doorkeeper.configuration).to receive(:reuse_access_token).and_return(true)
+        existing_token = subject.call(client, scopes)
+
+        result = subject.call(client, scopes)
+
+        expect(Doorkeeper::AccessToken.count).to eq(1)
+        expect(result).to eq(existing_token)
+      end
+    end
+
+    context "when reuse_access_token is false" do
+      it "returns a new token" do
+        allow(Doorkeeper.configuration).to receive(:reuse_access_token).and_return(false)
+        existing_token = subject.call(client, scopes)
+
+        result = subject.call(client, scopes)
+
+        expect(Doorkeeper::AccessToken.count).to eq(2)
+        expect(result).not_to eq(existing_token)
+      end
+    end
+
     it 'returns false if creation fails' do
-      expect(Doorkeeper::AccessToken).to receive(:create).and_return(false)
+      expect(Doorkeeper::AccessToken).to receive(:find_or_create_for).and_return(false)
       created = subject.call(client, scopes)
       expect(created).to be_falsey
     end

data/spec/lib/oauth/error_response_spec.rb

@@ -37,9 +37,9 @@ module Doorkeeper::OAuth
       subject { ErrorResponse.new(name: :some_error, state: :some_state).body }
 
       describe '#body' do
-        it { should have_key(:error) }
-        it { should have_key(:error_description) }
-        it { should have_key(:state) }
+        it { expect(subject).to have_key(:error) }
+        it { expect(subject).to have_key(:error_description) }
+        it { expect(subject).to have_key(:state) }
       end
     end
 
@@ -47,15 +47,15 @@ module Doorkeeper::OAuth
       let(:error_response) { ErrorResponse.new(name: :some_error, state: :some_state) }
       subject { error_response.authenticate_info }
 
-      it { should include("realm=\"#{error_response.realm}\"") }
-      it { should include("error=\"#{error_response.name}\"") }
-      it { should include("error_description=\"#{error_response.description}\"") }
+      it { expect(subject).to include("realm=\"#{error_response.realm}\"") }
+      it { expect(subject).to include("error=\"#{error_response.name}\"") }
+      it { expect(subject).to include("error_description=\"#{error_response.description}\"") }
     end
 
     describe '.headers' do
       subject { ErrorResponse.new(name: :some_error, state: :some_state).headers }
 
-      it { should include 'WWW-Authenticate' }
+      it { expect(subject).to include 'WWW-Authenticate' }
     end
   end
 end

data/spec/lib/oauth/error_spec.rb

@@ -4,15 +4,19 @@ require 'doorkeeper/oauth/error'
 
 module Doorkeeper::OAuth
   describe Error do
-    subject { Error.new(:some_error, :some_state) }
+    subject(:error) { Error.new(:some_error, :some_state) }
 
-    it { should respond_to(:name) }
-    it { should respond_to(:state) }
+    it { expect(subject).to respond_to(:name) }
+    it { expect(subject).to respond_to(:state) }
 
     describe :description do
       it 'is translated from translation messages' do
-        expect(I18n).to receive(:translate).with(:some_error, scope: [:doorkeeper, :errors, :messages])
-        subject.description
+        expect(I18n).to receive(:translate).with(
+          :some_error,
+          scope: [:doorkeeper, :errors, :messages],
+          default: :server_error
+        )
+        error.description
       end
     end
   end

data/spec/lib/oauth/helpers/scope_checker_spec.rb

@@ -41,12 +41,12 @@ module Doorkeeper::OAuth::Helpers
         Doorkeeper::OAuth::Scopes.from_string 'common svr'
       end
       let(:application_scopes) do
-        Doorkeeper::OAuth::Scopes.from_string 'common'
+        Doorkeeper::OAuth::Scopes.from_string 'app123'
       end
 
-      it 'is valid if scope is included in the server and the application' do
+      it 'is valid if scope is included in the application scope list' do
         expect(ScopeChecker.valid?(
-          'common',
+          'app123',
           server_scopes,
           application_scopes
         )).to be_truthy

data/spec/lib/oauth/password_access_token_request_spec.rb

@@ -60,7 +60,7 @@ module Doorkeeper::OAuth
     end
 
     it 'skips token creation if there is already one' do
-      Doorkeeper.configuration.stub(:reuse_access_token).and_return(true)
+      allow(Doorkeeper.configuration).to receive(:reuse_access_token).and_return(true)
       FactoryGirl.create(:access_token, application_id: client.id, resource_owner_id: owner.id)
       expect do
         subject.authorize