doorkeeper 1.4.1 → 2.0.0

data/lib/doorkeeper/{models → orm}/mongo_mapper/access_token.rb

@@ -1,21 +1,22 @@
 module Doorkeeper
   class AccessToken
     include MongoMapper::Document
+
+    include AccessTokenMixin
+
     safe
     timestamps!
 
     set_collection_name 'oauth_access_tokens'
 
     key :resource_owner_id, ObjectId
+    key :application_id,    ObjectId
     key :token,             String
+    key :refresh_token,     String
     key :expires_in,        Integer
     key :revoked_at,        DateTime
     key :scopes,            String
 
-    def scopes=(value)
-      write_attribute :scopes, value if value.present?
-    end
-
     def self.last
       self.sort(:created_at).last
     end
@@ -26,23 +27,17 @@ module Doorkeeper
     end
     private_class_method :delete_all_for
 
-    def self.last_authorized_token_for(application_id, resource_owner_id)
-      where(application_id: application_id,
-            resource_owner_id: resource_owner_id,
-            revoked_at: nil).
-        sort(:created_at.desc).
-        limit(1).
-        first
+    def self.create_indexes
+      ensure_index :token, unique: true
+      ensure_index [[:refresh_token, 1]], unique: true, sparse: true
     end
-    private_class_method :last_authorized_token_for
 
-    def refresh_token
-      self[:refresh_token]
+    def self.order_method
+      :sort
     end
 
-    def self.create_indexes
-      ensure_index :token, unique: true
-      ensure_index [[:refresh_token, 1]], unique: true, sparse: true
+    def self.created_at_desc
+      :created_at.desc
     end
   end
 end

data/lib/doorkeeper/{models → orm}/mongo_mapper/application.rb

@@ -1,6 +1,9 @@
 module Doorkeeper
   class Application
     include MongoMapper::Document
+
+    include ApplicationMixin
+
     safe
     timestamps!
 
@@ -14,10 +17,6 @@ module Doorkeeper
     key :redirect_uri, String
     key :scopes,       String
 
-    def scopes=(value)
-      write_attribute :scopes, value if value.present?
-    end
-
     def self.authorized_for(resource_owner)
       ids = AccessToken.where(resource_owner_id: resource_owner.id, revoked_at: nil).map(&:application_id)
       find(ids)

data/lib/doorkeeper/orm/mongo_mapper.rb

@@ -0,0 +1,11 @@
+module Doorkeeper
+  module Orm
+    module MongoMapper
+      def self.initialize_models!
+        require 'doorkeeper/orm/mongo_mapper/access_grant'
+        require 'doorkeeper/orm/mongo_mapper/access_token'
+        require 'doorkeeper/orm/mongo_mapper/application'
+      end
+    end
+  end
+end

data/lib/doorkeeper/{models → orm}/mongoid2/access_grant.rb

@@ -1,15 +1,17 @@
-require 'doorkeeper/models/mongoid/scopes'
+require 'doorkeeper/orm/mongoid2/concerns/scopes'
 
 module Doorkeeper
   class AccessGrant
     include Mongoid::Document
     include Mongoid::Timestamps
-    include Models::Mongoid::Scopes
+
+    include AccessGrantMixin
+    include Models::Mongoid2::Scopes
 
     self.store_in :oauth_access_grants
 
     field :resource_owner_id, type: Integer
-    field :application_id, type: Hash
+    field :application_id, type: BSON::ObjectId
     field :token, type: String
     field :expires_in, type: Integer
     field :redirect_uri, type: String

data/lib/doorkeeper/{models → orm}/mongoid2/access_token.rb

@@ -1,15 +1,19 @@
-require 'doorkeeper/models/mongoid/scopes'
+require 'doorkeeper/orm/mongoid2/concerns/scopes'
 
 module Doorkeeper
   class AccessToken
     include Mongoid::Document
     include Mongoid::Timestamps
-    include Models::Mongoid::Scopes
+
+    include AccessTokenMixin
+    include Models::Mongoid2::Scopes
 
     self.store_in :oauth_access_tokens
 
     field :resource_owner_id, type: Integer
+    field :application_id, type: BSON::ObjectId
     field :token, type: String
+    field :refresh_token, type: String
     field :expires_in, type: Integer
     field :revoked_at, type: DateTime
 
@@ -22,18 +26,12 @@ module Doorkeeper
     end
     private_class_method :delete_all_for
 
-    def self.last_authorized_token_for(application_id, resource_owner_id)
-      where(application_id: application_id,
-            resource_owner_id: resource_owner_id,
-            revoked_at: nil).
-        order_by([:created_at, :desc]).
-        limit(1).
-        first
+    def self.order_method
+      :order_by
     end
-    private_class_method :last_authorized_token_for
 
-    def refresh_token
-      self[:refresh_token]
+    def self.created_at_desc
+      [:created_at, :desc]
     end
   end
 end

data/lib/doorkeeper/{models → orm}/mongoid2/application.rb

@@ -2,6 +2,9 @@ module Doorkeeper
   class Application
     include Mongoid::Document
     include Mongoid::Timestamps
+    include Models::Mongoid2::Scopes
+
+    include ApplicationMixin
 
     self.store_in :oauth_applications
 

data/lib/doorkeeper/orm/mongoid2/concerns/scopes.rb

@@ -0,0 +1,30 @@
+module Doorkeeper
+  module Models
+    module Mongoid2
+      module Scopes
+        extend ActiveSupport::Concern
+
+        # It's strange that if not define these after included will raise error
+        # in Mongoid 2 and 3, but 4 works well see:
+        # https://travis-ci.org/jasl/doorkeeper/builds/31586902
+        included do
+          def scopes
+            OAuth::Scopes.from_string(self[:scopes])
+          end
+
+          def scopes_string
+            self[:scopes]
+          end
+
+          def includes_scope?(*required_scopes)
+            required_scopes.blank? || required_scopes.any? { |s| scopes.exists?(s.to_s) }
+          end
+
+          def scopes=(value)
+            write_attribute :scopes, value if value.present?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/doorkeeper/orm/mongoid2.rb

@@ -0,0 +1,11 @@
+module Doorkeeper
+  module Orm
+    module Mongoid2
+      def self.initialize_models!
+        require 'doorkeeper/orm/mongoid2/access_grant'
+        require 'doorkeeper/orm/mongoid2/access_token'
+        require 'doorkeeper/orm/mongoid2/application'
+      end
+    end
+  end
+end

data/lib/doorkeeper/orm/mongoid3/access_grant.rb

@@ -0,0 +1,22 @@
+require 'doorkeeper/orm/mongoid3/concerns/scopes'
+
+module Doorkeeper
+  class AccessGrant
+    include Mongoid::Document
+    include Mongoid::Timestamps
+
+    include AccessGrantMixin
+    include Models::Mongoid3::Scopes
+
+    self.store_in collection: :oauth_access_grants
+
+    field :resource_owner_id, type: Moped::BSON::ObjectId
+    field :application_id, type: Moped::BSON::ObjectId
+    field :token, type: String
+    field :expires_in, type: Integer
+    field :redirect_uri, type: String
+    field :revoked_at, type: DateTime
+
+    index({ token: 1 }, { unique: true })
+  end
+end

data/lib/doorkeeper/orm/mongoid3/access_token.rb

@@ -0,0 +1,37 @@
+require 'doorkeeper/orm/mongoid3/concerns/scopes'
+
+module Doorkeeper
+  class AccessToken
+    include Mongoid::Document
+    include Mongoid::Timestamps
+
+    include AccessTokenMixin
+    include Models::Mongoid3::Scopes
+
+    self.store_in collection: :oauth_access_tokens
+
+    field :resource_owner_id, type: Moped::BSON::ObjectId
+    field :application_id, type: Moped::BSON::ObjectId
+    field :token, type: String
+    field :refresh_token, type: String
+    field :expires_in, type: Integer
+    field :revoked_at, type: DateTime
+
+    index({ token: 1 }, { unique: true })
+    index({ refresh_token: 1 }, { unique: true, sparse: true })
+
+    def self.delete_all_for(application_id, resource_owner)
+      where(application_id: application_id,
+            resource_owner_id: resource_owner.id).delete_all
+    end
+    private_class_method :delete_all_for
+
+    def self.order_method
+      :order_by
+    end
+
+    def self.created_at_desc
+      [:created_at, :desc]
+    end
+  end
+end

data/lib/doorkeeper/{models/mongoid3_4 → orm/mongoid3}/application.rb

@@ -2,6 +2,9 @@ module Doorkeeper
   class Application
     include Mongoid::Document
     include Mongoid::Timestamps
+    include Models::Mongoid3::Scopes
+
+    include ApplicationMixin
 
     self.store_in collection: :oauth_applications
 

data/lib/doorkeeper/orm/mongoid3/concerns/scopes.rb

@@ -0,0 +1,30 @@
+module Doorkeeper
+  module Models
+    module Mongoid3
+      module Scopes
+        extend ActiveSupport::Concern
+
+        # It's strange that if not define these after included will raise error
+        # in Mongoid 2 and 3, but 4 works well see:
+        # https://travis-ci.org/jasl/doorkeeper/builds/31586902
+        included do
+          def scopes
+            OAuth::Scopes.from_string(self[:scopes])
+          end
+
+          def scopes_string
+            self[:scopes]
+          end
+
+          def includes_scope?(*required_scopes)
+            required_scopes.blank? || required_scopes.any? { |s| scopes.exists?(s.to_s) }
+          end
+
+          def scopes=(value)
+            write_attribute :scopes, value if value.present?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/doorkeeper/orm/mongoid3.rb

@@ -0,0 +1,11 @@
+module Doorkeeper
+  module Orm
+    module Mongoid3
+      def self.initialize_models!
+        require 'doorkeeper/orm/mongoid3/access_grant'
+        require 'doorkeeper/orm/mongoid3/access_token'
+        require 'doorkeeper/orm/mongoid3/application'
+      end
+    end
+  end
+end

data/lib/doorkeeper/orm/mongoid4/access_grant.rb

@@ -0,0 +1,22 @@
+require 'doorkeeper/orm/mongoid4/concerns/scopes'
+
+module Doorkeeper
+  class AccessGrant
+    include Mongoid::Document
+    include Mongoid::Timestamps
+
+    include AccessGrantMixin
+    include Models::Mongoid4::Scopes
+
+    self.store_in collection: :oauth_access_grants
+
+    field :resource_owner_id, type: BSON::ObjectId
+    field :application_id, type: BSON::ObjectId
+    field :token, type: String
+    field :expires_in, type: Integer
+    field :redirect_uri, type: String
+    field :revoked_at, type: DateTime
+
+    index({ token: 1 }, { unique: true })
+  end
+end

data/lib/doorkeeper/orm/mongoid4/access_token.rb

@@ -0,0 +1,37 @@
+require 'doorkeeper/orm/mongoid4/concerns/scopes'
+
+module Doorkeeper
+  class AccessToken
+    include Mongoid::Document
+    include Mongoid::Timestamps
+
+    include AccessTokenMixin
+    include Models::Mongoid4::Scopes
+
+    self.store_in collection: :oauth_access_tokens
+
+    field :resource_owner_id, type: BSON::ObjectId
+    field :application_id, type: BSON::ObjectId
+    field :token, type: String
+    field :refresh_token, type: String
+    field :expires_in, type: Integer
+    field :revoked_at, type: DateTime
+
+    index({ token: 1 }, { unique: true })
+    index({ refresh_token: 1 }, { unique: true, sparse: true })
+
+    def self.delete_all_for(application_id, resource_owner)
+      where(application_id: application_id,
+            resource_owner_id: resource_owner.id).delete_all
+    end
+    private_class_method :delete_all_for
+
+    def self.order_method
+      :order_by
+    end
+
+    def self.created_at_desc
+      [:created_at, :desc]
+    end
+  end
+end

data/lib/doorkeeper/orm/mongoid4/application.rb

@@ -0,0 +1,25 @@
+module Doorkeeper
+  class Application
+    include Mongoid::Document
+    include Mongoid::Timestamps
+    include Models::Mongoid4::Scopes
+
+    include ApplicationMixin
+
+    self.store_in collection: :oauth_applications
+
+    field :name, type: String
+    field :uid, type: String
+    field :secret, type: String
+    field :redirect_uri, type: String
+
+    index({ uid: 1 }, { unique: true })
+
+    has_many :authorized_tokens, class_name: 'Doorkeeper::AccessToken'
+
+    def self.authorized_for(resource_owner)
+      ids = AccessToken.where(resource_owner_id: resource_owner.id, revoked_at: nil).map(&:application_id)
+      find(ids)
+    end
+  end
+end

data/lib/doorkeeper/orm/mongoid4/concerns/scopes.rb

@@ -0,0 +1,17 @@
+module Doorkeeper
+  module Models
+    module Mongoid4
+      module Scopes
+        extend ActiveSupport::Concern
+
+        included do
+          field :scopes, type: String
+        end
+
+        def scopes=(value)
+          write_attribute :scopes, value if value.present?
+        end
+      end
+    end
+  end
+end

data/lib/doorkeeper/orm/mongoid4.rb

@@ -0,0 +1,11 @@
+module Doorkeeper
+  module Orm
+    module Mongoid4
+      def self.initialize_models!
+        require 'doorkeeper/orm/mongoid4/access_grant'
+        require 'doorkeeper/orm/mongoid4/access_token'
+        require 'doorkeeper/orm/mongoid4/application'
+      end
+    end
+  end
+end

data/lib/doorkeeper/rails/helpers.rb

@@ -0,0 +1,63 @@
+module Doorkeeper
+  module Rails
+    module Helpers
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def doorkeeper_for(*args, &block)
+          fail Errors::DoorkeeperError, "`doorkeeper_for` no longer available", <<-eos
+\nStarting in version 2.0.0 of doorkeeper gem, `doorkeeper_for` is no longer
+available. Please change `doorkeeper_for` calls in your application with:
+
+  before_action :doorkeeper_authorize!
+
+For more information check the README:
+https://github.com/doorkeeper-gem/doorkeeper#protecting-resources-with-oauth-aka-your-api-endpoint\n
+          eos
+        end
+      end
+
+      def doorkeeper_token
+        @_doorkeeper_token ||= OAuth::Token.authenticate request, *Doorkeeper.configuration.access_token_methods
+      end
+
+      def valid_doorkeeper_token?(*scopes)
+        doorkeeper_token && doorkeeper_token.acceptable?(scopes)
+      end
+
+      def doorkeeper_authorize!(*scopes)
+        scopes ||= Doorkeeper.configuration.default_scopes
+
+        unless valid_doorkeeper_token?(*scopes)
+          if !doorkeeper_token || !doorkeeper_token.accessible?
+            error = OAuth::InvalidTokenResponse.from_access_token(doorkeeper_token)
+            options = doorkeeper_unauthorized_render_options
+          else
+            error = OAuth::ForbiddenTokenResponse.from_scopes(scopes)
+            options = doorkeeper_forbidden_render_options
+          end
+          headers.merge!(error.headers.reject { |k| ['Content-Type'].include? k })
+          doorkeeper_error_renderer(error, options)
+        end
+      end
+
+      def doorkeeper_unauthorized_render_options
+        nil
+      end
+
+      def doorkeeper_forbidden_render_options
+        nil
+      end
+
+      def doorkeeper_error_renderer(error, options = {})
+        if options.blank?
+          head error.status
+        else
+          options[:status] = error.status
+          options[:layout] = false if options[:layout].nil?
+          render options
+        end
+      end
+    end
+  end
+end

data/lib/doorkeeper/rails/routes.rb

@@ -15,17 +15,6 @@ module Doorkeeper
         ActionDispatch::Routing::Mapper.send :include, Doorkeeper::Rails::Routes::Helper
       end
 
-      def self.warn_if_using_mount_method!
-        paths = ::Rails.application.config.paths['config/routes'] ||
-          ::Rails.application.config.paths['config/routes.rb']
-
-        paths.each do |path|
-          if File.read(::Rails.root.join(path)) =~ %r{mount Doorkeeper::Engine}
-            warn "\n[DOORKEEPER] `mount Doorkeeper::Engine` is not being used anymore. Please replace it with `use_doorkeeper` in your #{path} file\n"
-          end
-        end
-      end
-
       attr_accessor :routes
 
       def initialize(routes, &block)
@@ -88,7 +77,7 @@ module Doorkeeper
       end
 
       def application_routes(mapping)
-        routes.resources :applications, controller: mapping[:controllers]
+        routes.resources :doorkeeper_applications, controller: mapping[:controllers], as: :applications, path: 'applications'
       end
 
       def authorized_applications_routes(mapping)

data/lib/doorkeeper/request/code.rb

@@ -1,7 +1,6 @@
 module Doorkeeper
   module Request
     class Code
-      # TODO: this is so wrong!
       def self.build(server)
         new(server.context.send(:pre_auth), server)
       end

data/lib/doorkeeper/request/token.rb

@@ -1,7 +1,6 @@
 module Doorkeeper
   module Request
     class Token
-      # TODO: this is so wrong!
       def self.build(server)
         new(server.context.send(:pre_auth), server)
       end

data/lib/doorkeeper/server.rb

@@ -38,7 +38,7 @@ module Doorkeeper
     end
 
     def grant
-      AccessGrant.authenticate(parameters[:code])
+      AccessGrant.by_token(parameters[:code])
     end
 
     # TODO: Use configuration and evaluate proper context on block

data/lib/doorkeeper/version.rb

@@ -1,3 +1,3 @@
 module Doorkeeper
-  VERSION = '1.4.1'
+  VERSION = '2.0.0'
 end

data/lib/doorkeeper.rb

@@ -1,7 +1,6 @@
 require 'doorkeeper/version'
 require 'doorkeeper/engine'
 require 'doorkeeper/config'
-require 'doorkeeper/doorkeeper_for'
 
 require 'doorkeeper/errors'
 require 'doorkeeper/server'
@@ -33,15 +32,25 @@ require 'doorkeeper/oauth/token'
 require 'doorkeeper/oauth/invalid_token_response'
 require 'doorkeeper/oauth/forbidden_token_response'
 
-require 'doorkeeper/models/scopes'
-require 'doorkeeper/models/expirable'
-require 'doorkeeper/models/revocable'
-require 'doorkeeper/models/accessible'
+require 'doorkeeper/models/concerns/scopes'
+require 'doorkeeper/models/concerns/expirable'
+require 'doorkeeper/models/concerns/revocable'
+require 'doorkeeper/models/concerns/accessible'
+
+require 'doorkeeper/models/access_grant_mixin'
+require 'doorkeeper/models/access_token_mixin'
+require 'doorkeeper/models/application_mixin'
 
-require 'doorkeeper/helpers/filter'
 require 'doorkeeper/helpers/controller'
 
 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/application_owner_generator.rb

@@ -6,7 +6,10 @@ class Doorkeeper::ApplicationOwnerGenerator < Rails::Generators::Base
   desc 'Provide support for client application ownership.'
 
   def application_owner
-    migration_template 'add_owner_to_application_migration.rb', 'db/migrate/add_owner_to_application.rb'
+    migration_template(
+      'add_owner_to_application_migration.rb',
+      'db/migrate/add_owner_to_application.rb'
+    )
   end
 
   def self.next_migration_number(dirname)

data/lib/generators/doorkeeper/application_scopes_generator.rb

@@ -0,0 +1,34 @@
+require 'rails/generators/active_record'
+
+class Doorkeeper::ApplicationScopesGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  source_root File.expand_path('../templates', __FILE__)
+  desc 'Copies ActiveRecord migrations to handle upgrade to doorkeeper 2'
+
+  def self.next_migration_number(path)
+    ActiveRecord::Generators::Base.next_migration_number(path)
+  end
+
+  def application_scopes
+    if oauth_applications_exists? && !scopes_column_exists?
+      migration_template(
+        'add_scopes_to_oauth_applications.rb',
+        'db/migrate/add_scopes_to_oauth_applications.rb'
+      )
+    end
+  end
+
+  private
+
+  def scopes_column_exists?
+    ActiveRecord::Base.connection.column_exists?(
+      :oauth_applications,
+      :scopes
+    )
+  end
+
+  # Might be running this before install
+  def oauth_applications_exists?
+    ActiveRecord::Base.connection.table_exists? :oauth_applications
+  end
+end

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

@@ -0,0 +1,5 @@
+class AddScopesToOauthApplications < ActiveRecord::Migration
+  def change
+    add_column :oauth_applications, :scopes, :string, null: false, default: ''
+  end
+end