doorkeeper 0.4.2 → 0.5.0.rc1

data/lib/doorkeeper/oauth/client.rb

@@ -4,8 +4,8 @@ require 'doorkeeper/oauth/client/credentials'
 module Doorkeeper
   module OAuth
     class Client
-      def self.find(uid)
-        if application = Doorkeeper::Application.find_by_uid(uid)
+      def self.find(uid, method = Doorkeeper::Application.method(:by_uid))
+        if application = method.call(uid)
           new(application)
         end
       end

data/lib/doorkeeper/oauth/client_credentials_request.rb

@@ -27,13 +27,16 @@ module Doorkeeper
       end
 
       def authorize
-        @response = if issuer.create(client, scopes)
+        status = issuer.create(client, scopes)
+        @response = if status
           Response.new(issuer.token)
         else
           ErrorResponse.from_request(self)
         end
+        status
       end
 
+      # TODO: duplicated code in all flows
       def scopes
         @scopes ||= if @original_scopes.present?
           Doorkeeper::OAuth::Scopes.from_string(@original_scopes)

data/lib/doorkeeper/oauth/helpers/unique_token.rb

@@ -2,13 +2,10 @@ module Doorkeeper
   module OAuth
     module Helpers
       module UniqueToken
-        def self.generate_for(attribute, klass, options = {})
+        def self.generate(options = {})
           generator_method = options.delete(:generator) || SecureRandom.method(:hex)
           token_size       = options.delete(:size)      || 32
-          loop do
-            token = generator_method.call(token_size)
-            break token unless klass.send("find_by_#{attribute}", token)
-          end
+          generator_method.call(token_size)
         end
       end
     end

data/lib/doorkeeper/oauth/password_access_token_request.rb

@@ -51,7 +51,8 @@ module Doorkeeper::OAuth
     end
 
     def access_token
-      @access_token
+      return unless client.present? && resource_owner.present?
+      @access_token ||= Doorkeeper::AccessToken.matching_token_for client, resource_owner.id, scopes
     end
 
     def token_type
@@ -85,10 +86,6 @@ module Doorkeeper::OAuth
       create_access_token
     end
 
-    def revoke_base_token
-      base_token.revoke
-    end
-
     def create_access_token
       @access_token = Doorkeeper::AccessToken.create!({
         :application_id     => client.id,

data/lib/doorkeeper/oauth/token.rb

@@ -0,0 +1,36 @@
+module Doorkeeper
+  module OAuth
+    class Token
+      module Methods
+        def from_access_token_param(request)
+          request.parameters[:access_token]
+        end
+
+        def from_bearer_param(request)
+          request.parameters[:bearer_token]
+        end
+
+        def from_bearer_authorization(request)
+          pattern = /^Bearer /
+          header  = request.authorization
+          header.gsub pattern, '' if header && header.match(pattern)
+        end
+      end
+
+      extend Methods
+
+      def self.from_request(request, *methods)
+        methods.inject(nil) do |credentials, method|
+          method = self.method(method) if method.is_a?(Symbol)
+          credentials = method.call(request)
+          break credentials unless credentials.blank?
+        end
+      end
+
+      def self.authenticate(request, *methods)
+        token = from_request request, *methods
+        Doorkeeper::AccessToken.authenticate(token) if token
+      end
+    end
+  end
+end

data/lib/doorkeeper/rails/routes.rb

@@ -0,0 +1,77 @@
+require 'doorkeeper/rails/routes/mapping'
+require 'doorkeeper/rails/routes/mapper'
+
+module Doorkeeper
+  module Rails
+    class Routes
+      module Helper
+        # TODO: options hash is not being used
+        def use_doorkeeper(options = {}, &block)
+          Doorkeeper::Rails::Routes.new(self, &block).generate_routes!(options)
+        end
+      end
+
+      def self.install!
+        ActionDispatch::Routing::Mapper.send :include, Doorkeeper::Rails::Routes::Helper
+      end
+
+      def self.warn_if_using_mount_method!
+        if File.read(::Rails.root + 'config/routes.rb') =~ %r[mount Doorkeeper::Engine]
+          warn "\n[DOORKEEPER] `mount Doorkeeper::Engine` is not being used anymore. Please replace it with `use_doorkeeper` in your /config/routes.rb file\n"
+        end
+      end
+
+      attr_accessor :routes
+
+      def initialize(routes, &options)
+        @routes, @options = routes, options
+      end
+
+      def generate_routes!(options)
+        @mapping = Mapper.new.map(&@options)
+        routes.scope 'oauth', :as => 'oauth' do
+          map_route(:authorizations, :authorization_routes)
+          map_route(:tokens, :token_routes)
+          map_route(:applications, :application_routes)
+          map_route(:authorized_applications, :authorized_applications_routes)
+          map_route(:token_info, :token_info_routes)
+        end
+      end
+
+    private
+      def map_route(name, method)
+        unless @mapping.skipped?(name)
+          send method, @mapping[name]
+        end
+      end
+
+      def authorization_routes(mapping)
+        routes.scope :controller => mapping[:controllers] do
+          routes.match 'authorize', :via => :get,    :action => :new, :as => mapping[:as]
+          routes.match 'authorize', :via => :post,   :action => :create, :as => mapping[:as]
+          routes.match 'authorize', :via => :delete, :action => :destroy, :as => mapping[:as]
+        end
+      end
+
+      def token_routes(mapping)
+        routes.scope :controller => mapping[:controllers] do
+          routes.match 'token', :via => :post, :action => :create, :as => mapping[:as]
+        end
+      end
+
+      def token_info_routes(mapping)
+        routes.scope :controller => mapping[:controllers] do
+          routes.match 'token/info', :via => :get, :action => :show, :as => mapping[:as]
+        end
+      end
+
+      def application_routes(mapping)
+        routes.resources :applications, :controller => mapping[:controllers]
+      end
+
+      def authorized_applications_routes(mapping)
+        routes.resources :authorized_applications, :only => [:index, :destroy], :controller => mapping[:controllers]
+      end
+    end
+  end
+end

data/lib/doorkeeper/rails/routes/mapper.rb

@@ -0,0 +1,28 @@
+module Doorkeeper
+  module Rails
+    class Routes
+      class Mapper
+        def initialize(mapping = Mapping.new)
+          @mapping = mapping
+        end
+
+        def map(&block)
+          self.instance_eval(&block) if block
+          @mapping
+        end
+
+        def controllers(controller_names = {})
+          @mapping.controllers.merge!(controller_names)
+        end
+
+        def skip_controllers(*controller_names)
+          @mapping.skips = controller_names
+        end
+
+        def as(alias_names = {})
+          @mapping.as.merge!(alias_names)
+        end
+      end
+    end
+  end
+end

data/lib/doorkeeper/rails/routes/mapping.rb

@@ -0,0 +1,39 @@
+module Doorkeeper
+  module Rails
+    class Routes
+      class Mapping
+        attr_accessor :controllers, :as, :skips
+
+        def initialize
+          @controllers = {
+            :authorizations => 'doorkeeper/authorizations',
+            :applications => 'doorkeeper/applications',
+            :authorized_applications => 'doorkeeper/authorized_applications',
+            :tokens => 'doorkeeper/tokens',
+            :token_info => 'doorkeeper/token_info'
+          }
+
+          @as = {
+            :authorizations => :authorization,
+            :tokens => :token,
+            :token_info => :token_info
+          }
+
+          @skips = []
+
+        end
+
+        def [](routes)
+          {
+            :controllers => @controllers[routes],
+            :as => @as[routes]
+          }
+        end
+
+        def skipped?(controller)
+          return @skips.include?(controller)
+        end
+      end
+    end
+  end
+end

data/lib/doorkeeper/version.rb

@@ -1,3 +1,3 @@
 module Doorkeeper
-  VERSION = "0.4.2"
+  VERSION = "0.5.0.rc1"
 end

data/lib/generators/doorkeeper/application_owner_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators/active_record'
+
+class Doorkeeper::ApplicationOwnerGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  source_root File.expand_path('../templates', __FILE__)
+  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'
+  end
+
+  def self.next_migration_number(dirname)
+    ActiveRecord::Generators::Base.next_migration_number(dirname)
+  end
+end

data/lib/generators/doorkeeper/install_generator.rb

@@ -1,19 +1,12 @@
-require 'rails/generators/active_record'
-
-class Doorkeeper::InstallGenerator < Rails::Generators::Base
+class Doorkeeper::InstallGenerator < ::Rails::Generators::Base
   include Rails::Generators::Migration
   source_root File.expand_path('../templates', __FILE__)
   desc "Installs Doorkeeper."
 
   def install
-    migration_template 'migration.rb', 'db/migrate/create_doorkeeper_tables.rb'
     template "initializer.rb", "config/initializers/doorkeeper.rb"
     copy_file "../../../../config/locales/en.yml", "config/locales/doorkeeper.en.yml"
-    route "mount Doorkeeper::Engine => '/oauth'"
+    route "use_doorkeeper"
     readme "README"
   end
-
-  def self.next_migration_number(dirname)
-    ActiveRecord::Generators::Base.next_migration_number(dirname)
-  end
 end

data/lib/generators/doorkeeper/migration_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators/active_record'
+
+class Doorkeeper::MigrationGenerator < ::Rails::Generators::Base
+  include Rails::Generators::Migration
+  source_root File.expand_path('../templates', __FILE__)
+  desc "Installs Doorkeeper migration file."
+
+  def install
+    migration_template 'migration.rb', 'db/migrate/create_doorkeeper_tables.rb'
+  end
+
+  def self.next_migration_number(dirname)
+    ActiveRecord::Generators::Base.next_migration_number(dirname)
+  end
+end

data/lib/generators/doorkeeper/templates/README

@@ -7,7 +7,21 @@ Go to config/initializers/doorkeeper.rb and configure
 resource_owner_authenticator block.
 
 Step 2.
-Migrate your database
+Choose the ORM:
+
+If you want to use ActiveRecord run:
+
+  rails generate doorkeeper:migration
+
+And run
+
+  rake db:migrate
+
+If you want to use Mongoid, configure the orm in initializers/doorkeeper.rb
+
+Doorkeeper.configure do
+  orm :mongoid
+end
 
 Step 3.
 That's it, that's all. Enjoy!

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

@@ -0,0 +1,7 @@
+class AddOwnerToApplication < ActiveRecord::Migration
+  def change
+    add_column :oauth_applications, :owner_id, :integer, :null => true
+    add_column :oauth_applications, :owner_type, :string, :null => true
+    add_index :oauth_applications, [:owner_id, :owner_type]
+  end
+end

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

@@ -1,26 +1,30 @@
 Doorkeeper.configure do
-  # This block will be called to check whether the
-  # resource owner is authenticated or not
+  # Change the ORM that doorkeeper will use.
+  # Currently supported options are :active_record and :mongoid
+  orm :active_record
+
+  # This block will be called to check whether the resource owner is authenticated or not.
   resource_owner_authenticator do |routes|
     raise "Please configure doorkeeper resource_owner_authenticator block located in #{__FILE__}"
     # Put your resource owner authentication logic here.
-    # If you want to use named routes from your app you need
-    # to call them on routes object eg.
-    # routes.new_user_session_path
-    # e.g. User.find_by_id(session[:user_id]) || redirect_to(routes.new_user_session_url)
+    # If you want to use named routes from your app, you need to call them on the routes object.
+    # For example:
+    #   routes.new_user_session_path
+    # Example implementation:
+    #   User.find_by_id(session[:user_id]) || redirect_to(routes.new_user_session_url)
   end
 
-  # If you want to restrict the access to the web interface for
-  # adding oauth authorized applications you need to declare the
-  # block below
+  # If you want to restrict access to the web interface for adding oauth authorized applications, you need to declare the block below.
   # admin_authenticator do |routes|
   #   # Put your admin authentication logic here.
-  #   # If you want to use named routes from your app you need
-  #   # to call them on routes object eg.
-  #   # routes.new_admin_session_path
+  #   # If you want to use named routes from your app, you need to call them on routes object, e.g., routes.new_admin_session_path
+  #   # Example implementation:
   #   Admin.find_by_id(session[:admin_id]) || redirect_to(routes.new_admin_session_url)
   # end
 
+  # Authorization Code expiration time (default 10 minutes).
+  # authorization_code_expires_in 10.minutes
+
   # Access token expiration time (default 2 hours).
   # If you want to disable expiration, set this to nil.
   # access_token_expires_in 2.hours
@@ -28,14 +32,26 @@ Doorkeeper.configure do
   # Issue access tokens with refresh token (disabled by default)
   # use_refresh_token
 
+  # Provide support for an owner to be assigned to each registered application (disabled by default)
+  # Optional parameter :confirmation => true (default false) if you want to enforce ownership of
+  # a registered application
+  # Note: you must also run the rails g doorkeeper:application_owner generator to provide the necessary support
+  # enable_application_owner :confirmation => false
+
   # Define access token scopes for your provider
   # For more information go to https://github.com/applicake/doorkeeper/wiki/Using-Scopes
   # default_scopes  :public
   # optional_scopes :write, :update
 
   # Change the way client credentials are retrieved from the request object.
-  # By default it retrieves first from `HTTP_AUTHORIZATION` header and
-  # fallsback to `:client_id` and `:client_secret` from `params` object
-  # Check out the wiki for mor information on customization
+  # By default it retrieves first from the `HTTP_AUTHORIZATION` header, then
+  # falls back to the `:client_id` and `:client_secret` params from the `params` object.
+  # Check out the wiki for more information on customization
   # client_credentials :from_basic, :from_params
+
+  # Change the way access token is authenticated from the request object.
+  # By default it retrieves first from the `HTTP_AUTHORIZATION` header, then
+  # falls back to the `:access_token` or `:bearer_token` params from the `params` object.
+  # Check out the wiki for mor information on customization
+  # access_token_methods :from_bearer_authorization, :from_access_token_param, :from_bearer_param
 end

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

@@ -1,14 +1,17 @@
 class CreateDoorkeeperTables < ActiveRecord::Migration
   def change
     create_table :oauth_applications do |t|
-      t.string :name,         :null => false
-      t.string :uid,          :null => false
-      t.string :secret,       :null => false
-      t.string :redirect_uri, :null => false
+      t.string  :name,         :null => false
+      t.string  :uid,          :null => false
+      t.string  :secret,       :null => false
+      t.string  :redirect_uri, :null => false
+      t.integer :owner_id,    :null => true
+      t.string  :owner_type, :null => true
       t.timestamps
     end
 
     add_index :oauth_applications, :uid, :unique => true
+    add_index :oauth_applications, [:owner_id, :owner_type]
 
     create_table :oauth_access_grants do |t|
       t.integer  :resource_owner_id, :null => false