doorkeeper 5.1.0.rc2 → 5.1.0

data/lib/doorkeeper/request.rb

@@ -33,7 +33,7 @@ module Doorkeeper
       end
 
       def build_strategy_class(grant_or_request_type)
-        strategy_class_name = grant_or_request_type.to_s.tr(' ', '_').camelize
+        strategy_class_name = grant_or_request_type.to_s.tr(" ", "_").camelize
         "Doorkeeper::Request::#{strategy_class_name}".constantize
       end
     end

data/lib/doorkeeper/secret_storing/base.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   module SecretStoring
-
     ##
     # Base class for secret storing, including common helpers
     class Base
@@ -8,7 +9,7 @@ module Doorkeeper
       # Return the value to be stored by the database
       # used for looking up a database value.
       # @param plain_secret The plain secret input / generated
-      def self.transform_secret(plain_secret)
+      def self.transform_secret(_plain_secret)
         raise NotImplementedError
       end
 
@@ -19,8 +20,8 @@ module Doorkeeper
       # @param attribute The secret attribute
       # @param plain_secret The plain secret input / generated
       def self.store_secret(resource, attribute, plain_secret)
-        transformed_value = self.transform_secret plain_secret
-        resource.public_send :"#{attribute}=", transformed_value
+        transformed_value = transform_secret(plain_secret)
+        resource.public_send(:"#{attribute}=", transformed_value)
 
         transformed_value
       end
@@ -30,7 +31,7 @@ module Doorkeeper
       # @param resource The resource instance to act on
       # @param attribute The secret attribute to restore
       # as retrieved from the database.
-      def self.restore_secret(resource, attribute)
+      def self.restore_secret(_resource, _attribute)
         raise NotImplementedError
       end
 
@@ -60,4 +61,4 @@ module Doorkeeper
       end
     end
   end
-end
+end

data/lib/doorkeeper/secret_storing/bcrypt.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   module SecretStoring
-
     ##
     # Plain text secret storing, which is the default
     # but also provides fallback lookup if
@@ -49,11 +50,11 @@ module Doorkeeper
       ##
       # Test if we can require the BCrypt gem
       def self.bcrypt_present?
-        require 'bcrypt'
+        require "bcrypt"
         true
       rescue LoadError
         false
       end
     end
   end
-end
+end

data/lib/doorkeeper/secret_storing/plain.rb

@@ -1,12 +1,12 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   module SecretStoring
-
     ##
     # Plain text secret storing, which is the default
     # but also provides fallback lookup if
     # other secret storing mechanisms are enabled.
     class Plain < Base
-
       ##
       # Return the value to be stored by the database
       # @param plain_secret The plain secret input / generated
@@ -20,7 +20,7 @@ module Doorkeeper
       # @param attribute The secret attribute to restore
       # as retrieved from the database.
       def self.restore_secret(resource, attribute)
-        resource.public_send attribute
+        resource.public_send(attribute)
       end
 
       ##
@@ -30,4 +30,4 @@ module Doorkeeper
       end
     end
   end
-end
+end

data/lib/doorkeeper/secret_storing/sha256_hash.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module Doorkeeper
   module SecretStoring
-
     ##
     # Plain text secret storing, which is the default
     # but also provides fallback lookup if
@@ -22,4 +23,4 @@ module Doorkeeper
       end
     end
   end
-end
+end

data/lib/doorkeeper/stale_records_cleaner.rb

@@ -2,7 +2,7 @@
 
 module Doorkeeper
   class StaleRecordsCleaner
-    CLEANER_CLASS = 'StaleRecordsCleaner'.freeze
+    CLEANER_CLASS = "StaleRecordsCleaner"
 
     def self.for(base_scope)
       orm_adapter = "doorkeeper/orm/#{Doorkeeper.configuration.orm}".classify

data/lib/doorkeeper/version.rb

@@ -10,9 +10,9 @@ module Doorkeeper
     MAJOR = 5
     MINOR = 1
     TINY = 0
-    PRE = 'rc2'
+    PRE = nil
 
     # Full version number
-    STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
   end
 end

data/lib/generators/doorkeeper/application_owner_generator.rb

@@ -1,18 +1,21 @@
 # frozen_string_literal: true
 
-require 'rails/generators'
-require 'rails/generators/active_record'
+require "rails/generators"
+require "rails/generators/active_record"
 
 module Doorkeeper
+  # Generates migration to add reference to owner of the
+  # Doorkeeper application.
+  #
   class ApplicationOwnerGenerator < ::Rails::Generators::Base
     include ::Rails::Generators::Migration
-    source_root File.expand_path('templates', __dir__)
-    desc 'Provide support for client application ownership.'
+    source_root File.expand_path("templates", __dir__)
+    desc "Provide support for client application ownership."
 
     def application_owner
       migration_template(
-        'add_owner_to_application_migration.rb.erb',
-        'db/migrate/add_owner_to_application.rb',
+        "add_owner_to_application_migration.rb.erb",
+        "db/migrate/add_owner_to_application.rb",
         migration_version: migration_version
       )
     end
@@ -24,9 +27,7 @@ module Doorkeeper
     private
 
     def migration_version
-      if ActiveRecord::VERSION::MAJOR >= 5
-        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
-      end
+      "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
     end
   end
 end

data/lib/generators/doorkeeper/confidential_applications_generator.rb

@@ -1,18 +1,21 @@
 # frozen_string_literal: true
 
-require 'rails/generators'
-require 'rails/generators/active_record'
+require "rails/generators"
+require "rails/generators/active_record"
 
 module Doorkeeper
+  # Generates migration to add confidential column to Doorkeeper
+  # applications table.
+  #
   class ConfidentialApplicationsGenerator < ::Rails::Generators::Base
     include ::Rails::Generators::Migration
-    source_root File.expand_path('templates', __dir__)
-    desc 'Add confidential column to Doorkeeper applications'
+    source_root File.expand_path("templates", __dir__)
+    desc "Add confidential column to Doorkeeper applications"
 
     def pkce
       migration_template(
-        'add_confidential_to_applications.rb.erb',
-        'db/migrate/add_confidential_to_applications.rb',
+        "add_confidential_to_applications.rb.erb",
+        "db/migrate/add_confidential_to_applications.rb",
         migration_version: migration_version
       )
     end
@@ -24,9 +27,7 @@ module Doorkeeper
     private
 
     def migration_version
-      if ActiveRecord::VERSION::MAJOR >= 5
-        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
-      end
+      "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
     end
   end
 end

data/lib/generators/doorkeeper/install_generator.rb

@@ -1,20 +1,22 @@
 # frozen_string_literal: true
 
-require 'rails/generators'
-require 'rails/generators/active_record'
+require "rails/generators"
+require "rails/generators/active_record"
 
 module Doorkeeper
+  # Setup doorkeeper into Rails application: locales, routes, etc.
+  #
   class InstallGenerator < ::Rails::Generators::Base
     include ::Rails::Generators::Migration
-    source_root File.expand_path('templates', __dir__)
-    desc 'Installs Doorkeeper.'
+    source_root File.expand_path("templates", __dir__)
+    desc "Installs Doorkeeper."
 
     def install
-      template 'initializer.rb', 'config/initializers/doorkeeper.rb'
-      copy_file File.expand_path('../../../config/locales/en.yml', __dir__),
-                'config/locales/doorkeeper.en.yml'
-      route 'use_doorkeeper'
-      readme 'README'
+      template "initializer.rb", "config/initializers/doorkeeper.rb"
+      copy_file File.expand_path("../../../config/locales/en.yml", __dir__),
+                "config/locales/doorkeeper.en.yml"
+      route "use_doorkeeper"
+      readme "README"
     end
   end
 end

data/lib/generators/doorkeeper/migration_generator.rb

@@ -1,18 +1,20 @@
 # frozen_string_literal: true
 
-require 'rails/generators'
-require 'rails/generators/active_record'
+require "rails/generators"
+require "rails/generators/active_record"
 
 module Doorkeeper
+  # Copies main Doorkeeper migration into parent Rails application.
+  #
   class MigrationGenerator < ::Rails::Generators::Base
     include ::Rails::Generators::Migration
-    source_root File.expand_path('templates', __dir__)
-    desc 'Installs Doorkeeper migration file.'
+    source_root File.expand_path("templates", __dir__)
+    desc "Installs Doorkeeper migration file."
 
     def install
       migration_template(
-        'migration.rb.erb',
-        'db/migrate/create_doorkeeper_tables.rb',
+        "migration.rb.erb",
+        "db/migrate/create_doorkeeper_tables.rb",
         migration_version: migration_version
       )
     end
@@ -24,9 +26,7 @@ module Doorkeeper
     private
 
     def migration_version
-      if ActiveRecord::VERSION::MAJOR >= 5
-        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
-      end
+      "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
     end
   end
 end

data/lib/generators/doorkeeper/pkce_generator.rb

@@ -1,18 +1,21 @@
 # frozen_string_literal: true
 
-require 'rails/generators'
-require 'rails/generators/active_record'
+require "rails/generators"
+require "rails/generators/active_record"
 
 module Doorkeeper
+  # Generates migration with PKCE required database columns for
+  # Doorkeeper tables.
+  #
   class PkceGenerator < ::Rails::Generators::Base
     include ::Rails::Generators::Migration
-    source_root File.expand_path('templates', __dir__)
-    desc 'Provide support for PKCE.'
+    source_root File.expand_path("templates", __dir__)
+    desc "Provide support for PKCE."
 
     def pkce
       migration_template(
-        'enable_pkce_migration.rb.erb',
-        'db/migrate/enable_pkce.rb',
+        "enable_pkce_migration.rb.erb",
+        "db/migrate/enable_pkce.rb",
         migration_version: migration_version
       )
     end
@@ -24,9 +27,7 @@ module Doorkeeper
     private
 
     def migration_version
-      if ActiveRecord::VERSION::MAJOR >= 5
-        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
-      end
+      "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
     end
   end
 end

data/lib/generators/doorkeeper/previous_refresh_token_generator.rb

@@ -1,13 +1,16 @@
 # frozen_string_literal: true
 
-require 'rails/generators'
-require 'rails/generators/active_record'
+require "rails/generators"
+require "rails/generators/active_record"
 
 module Doorkeeper
+  # Generates migration to add previous refresh token column to the
+  # database for Doorkeeper tables.
+  #
   class PreviousRefreshTokenGenerator < ::Rails::Generators::Base
     include ::Rails::Generators::Migration
-    source_root File.expand_path('templates', __dir__)
-    desc 'Support revoke refresh token on access token use'
+    source_root File.expand_path("templates", __dir__)
+    desc "Support revoke refresh token on access token use"
 
     def self.next_migration_number(path)
       ActiveRecord::Generators::Base.next_migration_number(path)
@@ -16,8 +19,8 @@ module Doorkeeper
     def previous_refresh_token
       if no_previous_refresh_token_column?
         migration_template(
-          'add_previous_refresh_token_to_access_tokens.rb.erb',
-          'db/migrate/add_previous_refresh_token_to_access_tokens.rb'
+          "add_previous_refresh_token_to_access_tokens.rb.erb",
+          "db/migrate/add_previous_refresh_token_to_access_tokens.rb"
         )
       end
     end
@@ -25,9 +28,7 @@ module Doorkeeper
     private
 
     def migration_version
-      if ActiveRecord::VERSION::MAJOR >= 5
-        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
-      end
+      "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
     end
 
     def no_previous_refresh_token_column?

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Doorkeeper.configure do
   # Change the ORM that doorkeeper will use (needs plugins)
   orm :active_record
@@ -47,7 +49,12 @@ Doorkeeper.configure do
   # access_token_expires_in 2.hours
 
   # Assign custom TTL for access tokens. Will be used instead of access_token_expires_in
-  # option if defined. `context` has the following properties available
+  # option if defined. In case the block returns `nil` value Doorkeeper fallbacks to
+  # `access_token_expires_in` configuration option value. If you really need to issue a
+  # non-expiring access token (which is not recommended) then you need to return
+  # Float::INFINITY from this block.
+  #
+  # `context` has the following properties available:
   #
   # `client` - the OAuth client application (see Doorkeeper::OAuth::Client)
   # `grant_type` - the grant type of the request (see Doorkeeper::OAuth)
@@ -146,7 +153,8 @@ Doorkeeper.configure do
   # 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
+  # NOTE: you must also run the rails g doorkeeper:application_owner generator
+  # to provide the necessary support
   #
   # enable_application_owner confirmation: false
 
@@ -189,9 +197,10 @@ Doorkeeper.configure do
   # access_token_methods :from_bearer_authorization, :from_access_token_param, :from_bearer_param
 
   # Change the native redirect uri for client apps
-  # When clients register with the following redirect uri, they won't be redirected to any server and
-  # the authorizationcode will be displayed within the provider
-  # The value can be any string. Use nil to disable this feature. When disabled, clients must provide a valid URL
+  # When clients register with the following redirect uri, they won't be redirected to
+  # any server and the authorizationcode will be displayed within the provider
+  # The value can be any string. Use nil to disable this feature. When disabled, clients
+  # must providea valid URL
   # (Similar behaviour: https://developers.google.com/accounts/docs/OAuth2InstalledApp#choosingredirecturi)
   #
   # native_redirect_uri 'urn:ietf:wg:oauth:2.0:oob'
@@ -216,6 +225,22 @@ Doorkeeper.configure do
   #
   # forbid_redirect_uri { |uri| uri.scheme.to_s.downcase == 'javascript' }
 
+  # Allows to set blank redirect URIs for Applications in case Doorkeeper configured
+  # to use URI-less OAuth grant flows like Client Credentials or Resource Owner
+  # Password Credentials. The option is on by default and checks configured grant
+  # types, but you **need** to manually drop `NOT NULL` constraint from `redirect_uri`
+  # column for `oauth_applications` database table.
+  #
+  # You can completely disable this feature with:
+  #
+  # allow_blank_redirect_uri false
+  #
+  # Or you can define your custom check:
+  #
+  # allow_blank_redirect_uri do |grant_flows, client|
+  #   client.superapp?
+  # end
+
   # Specify how authorization errors should be handled.
   # By default, doorkeeper renders json errors when access token
   # is invalid, expired, revoked or has invalid scopes.

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

@@ -1,9 +1,13 @@
 class CreateDoorkeeperTables < ActiveRecord::Migration<%= migration_version %>
   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  :name,    null: false
+      t.string  :uid,     null: false
+      t.string  :secret,  null: false
+
+      # Remove `null: false` if you are planning to use grant flows
+      # that doesn't require redirect URI to be used during authorization
+      # like Client Credentials flow or Resource Owner Password.
       t.text    :redirect_uri, null: false
       t.string  :scopes,       null: false, default: ''
       t.boolean :confidential, null: false, default: true
@@ -32,20 +36,20 @@ class CreateDoorkeeperTables < ActiveRecord::Migration<%= migration_version %>
 
     create_table :oauth_access_tokens do |t|
       t.references :resource_owner, index: true
-      t.references :application
+      t.references :application,    null: false
 
       # 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.text :token, null: false
+      t.string :token, null: false
 
       t.string   :refresh_token
       t.integer  :expires_in
       t.datetime :revoked_at
-      t.datetime :created_at,             null: false
+      t.datetime :created_at, null: false
       t.string   :scopes
 
       # If there is a previous_refresh_token column,
@@ -64,5 +68,9 @@ class CreateDoorkeeperTables < ActiveRecord::Migration<%= migration_version %>
       :oauth_applications,
       column: :application_id
     )
+
+    # Uncomment below to ensure a valid reference to the resource owner's table
+    # add_foreign_key :oauth_access_grants, <model>, column: :resource_owner_id
+    # add_foreign_key :oauth_access_tokens, <model>, column: :resource_owner_id
   end
 end