doorkeeper 5.1.0.rc2 → 5.1.0

data/lib/doorkeeper/config/option.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Doorkeeper
+  class Config
+    # Doorkeeper configuration option DSL
+    module Option
+      # Defines configuration option
+      #
+      # When you call option, it defines two methods. One method will take place
+      # in the +Config+ class and the other method will take place in the
+      # +Builder+ class.
+      #
+      # The +name+ parameter will set both builder method and config attribute.
+      # If the +:as+ option is defined, the builder method will be the specified
+      # option while the config attribute will be the +name+ parameter.
+      #
+      # If you want to introduce another level of config DSL you can
+      # define +builder_class+ parameter.
+      # Builder should take a block as the initializer parameter and respond to function +build+
+      # that returns the value of the config attribute.
+      #
+      # ==== Options
+      #
+      # * [:+as+] Set the builder method that goes inside +configure+ block
+      # * [+:default+] The default value in case no option was set
+      # * [+:builder_class+] Configuration option builder class
+      #
+      # ==== Examples
+      #
+      #    option :name
+      #    option :name, as: :set_name
+      #    option :name, default: 'My Name'
+      #    option :scopes builder_class: ScopesBuilder
+      #
+      def option(name, options = {})
+        attribute = options[:as] || name
+        attribute_builder = options[:builder_class]
+
+        Builder.instance_eval do
+          remove_method name if method_defined?(name)
+          define_method name do |*args, &block|
+            value = if attribute_builder
+                      attribute_builder.new(&block).build
+                    else
+                      block || args.first
+                    end
+
+            @config.instance_variable_set(:"@#{attribute}", value)
+          end
+        end
+
+        define_method attribute do |*_args|
+          if instance_variable_defined?(:"@#{attribute}")
+            instance_variable_get(:"@#{attribute}")
+          else
+            options[:default]
+          end
+        end
+
+        public attribute
+      end
+    end
+  end
+end

data/lib/doorkeeper/engine.rb

@@ -18,7 +18,7 @@ module Doorkeeper
     end
 
     if defined?(Sprockets) && Sprockets::VERSION.chr.to_i >= 4
-      initializer 'doorkeeper.assets.precompile' do |app|
+      initializer "doorkeeper.assets.precompile" do |app|
         # Force users to use:
         #    //= link doorkeeper/admin/application.css
         # in Doorkeeper 5 for Sprockets 4 instead of precompile.

data/lib/doorkeeper/grape/authorization_decorator.rb

@@ -9,10 +9,10 @@ module Doorkeeper
 
       def authorization
         env = __getobj__.env
-        env['HTTP_AUTHORIZATION'] ||
-          env['X-HTTP_AUTHORIZATION'] ||
-          env['X_HTTP_AUTHORIZATION'] ||
-          env['REDIRECT_X_HTTP_AUTHORIZATION']
+        env["HTTP_AUTHORIZATION"] ||
+          env["X-HTTP_AUTHORIZATION"] ||
+          env["X_HTTP_AUTHORIZATION"] ||
+          env["REDIRECT_X_HTTP_AUTHORIZATION"]
       end
     end
   end

data/lib/doorkeeper/grape/helpers.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'doorkeeper/grape/authorization_decorator'
+require "doorkeeper/grape/authorization_decorator"
 
 module Doorkeeper
   module Grape
@@ -29,7 +29,7 @@ module Doorkeeper
       private
 
       def endpoint
-        env['api.endpoint']
+        env["api.endpoint"]
       end
 
       def doorkeeper_token
@@ -46,7 +46,7 @@ module Doorkeeper
       def error_status_codes
         {
           unauthorized: 401,
-          forbidden: 403
+          forbidden: 403,
         }
       end
     end

data/lib/doorkeeper/helpers/controller.rb

@@ -55,7 +55,7 @@ module Doorkeeper
       end
 
       def enforce_content_type
-        if (request.put? || request.post? || request.patch?) && request.content_type != 'application/x-www-form-urlencoded'
+        if (request.put? || request.post? || request.patch?) && request.content_type != "application/x-www-form-urlencoded"
           render json: {}, status: :unsupported_media_type
         end
       end

data/lib/doorkeeper/models/access_grant_mixin.rb

@@ -86,10 +86,12 @@ module Doorkeeper
 
       # @param code_verifier [#to_s] a one time use value (any object that responds to `#to_s`)
       #
-      # @return [#to_s] An encoded code challenge based on the provided verifier suitable for PKCE validation
+      # @return [#to_s] An encoded code challenge based on the provided verifier
+      # suitable for PKCE validation
+      #
       def generate_code_challenge(code_verifier)
         padded_result = Base64.urlsafe_encode64(Digest::SHA256.digest(code_verifier))
-        padded_result.split('=')[0] # Remove any trailing '='
+        padded_result.split("=")[0] # Remove any trailing '='
       end
 
       def pkce_supported?

data/lib/doorkeeper/models/access_token_mixin.rb

@@ -127,14 +127,14 @@ module Doorkeeper
         if Doorkeeper.configuration.reuse_access_token
           access_token = matching_token_for(application, resource_owner_id, scopes)
 
-          return access_token if access_token && access_token.reusable?
+          return access_token if access_token&.reusable?
         end
 
         create!(
-          application_id:    application.try(:id),
+          application_id: application.try(:id),
           resource_owner_id: resource_owner_id,
-          scopes:            scopes.to_s,
-          expires_in:        expires_in,
+          scopes: scopes.to_s,
+          expires_in: expires_in,
           use_refresh_token: use_refresh_token
         )
       end
@@ -191,7 +191,7 @@ module Doorkeeper
     #   The OAuth 2.0 Authorization Framework: Bearer Token Usage
     #
     def token_type
-      'Bearer'
+      "Bearer"
     end
 
     def use_refresh_token?
@@ -204,11 +204,11 @@ module Doorkeeper
     # @return [Hash] hash with token data
     def as_json(_options = {})
       {
-        resource_owner_id:  resource_owner_id,
-        scope:              scopes,
-        expires_in:         expires_in_seconds,
-        application:        { uid: application.try(:uid) },
-        created_at:         created_at.to_i
+        resource_owner_id: resource_owner_id,
+        scope: scopes,
+        expires_in: expires_in_seconds,
+        application: { uid: application.try(:uid) },
+        created_at: created_at.to_i,
       }
     end
 

data/lib/doorkeeper/models/application_mixin.rb

@@ -28,6 +28,7 @@ module Doorkeeper
         return unless app
         return app if secret.blank? && !app.confidential?
         return unless app.secret_matches?(secret)
+
         app
       end
 

data/lib/doorkeeper/models/concerns/expirable.rb

@@ -17,6 +17,7 @@ module Doorkeeper
       #   or nil if object never expires.
       def expires_in_seconds
         return nil if expires_in.nil?
+
         expires = expires_at - Time.now.utc
         expires_sec = expires.seconds.round(0)
         expires_sec > 0 ? expires_sec : 0

data/lib/doorkeeper/models/concerns/ownership.rb

@@ -6,12 +6,7 @@ module Doorkeeper
       extend ActiveSupport::Concern
 
       included do
-        belongs_to_options = { polymorphic: true }
-        if defined?(ActiveRecord::Base) && ActiveRecord::VERSION::MAJOR >= 5
-          belongs_to_options[:optional] = true
-        end
-
-        belongs_to :owner, belongs_to_options
+        belongs_to :owner, polymorphic: true, optional: true
         validates :owner, presence: true, if: :validate_owner?
       end
 

data/lib/doorkeeper/models/concerns/revocable.rb

@@ -25,7 +25,8 @@ module Doorkeeper
       #
       def revoke_previous_refresh_token!
         return unless refresh_token_revoked_on_use?
-        old_refresh_token.revoke if old_refresh_token
+
+        old_refresh_token&.revoke
         update_attribute :previous_refresh_token, ""
       end
 

data/lib/doorkeeper/models/concerns/scopes.rb

@@ -8,7 +8,7 @@ module Doorkeeper
       end
 
       def scopes=(value)
-        super Array(value).join(' ')
+        super Array(value).join(" ")
       end
 
       def scopes_string

data/lib/doorkeeper/models/concerns/secret_storable.rb

@@ -66,6 +66,8 @@ module Doorkeeper
           # Use the previous strategy to look up
           stored_token = fallback_secret_strategy.transform_secret(plain_secret)
           find_by(attr => stored_token).tap do |resource|
+            return nil unless resource
+
             upgrade_fallback_value resource, attr, plain_secret
           end
         end

data/lib/doorkeeper/oauth.rb

@@ -3,11 +3,11 @@
 module Doorkeeper
   module OAuth
     GRANT_TYPES = [
-      AUTHORIZATION_CODE = 'authorization_code'.freeze,
-      IMPLICIT = 'implicit'.freeze,
-      PASSWORD = 'password'.freeze,
-      CLIENT_CREDENTIALS = 'client_credentials'.freeze,
-      REFRESH_TOKEN = 'refresh_token'.freeze
+      AUTHORIZATION_CODE = "authorization_code",
+      IMPLICIT = "implicit",
+      PASSWORD = "password",
+      CLIENT_CREDENTIALS = "client_credentials",
+      REFRESH_TOKEN = "refresh_token",
     ].freeze
   end
 end

data/lib/doorkeeper/oauth/authorization/code.rb

@@ -42,7 +42,7 @@ module Doorkeeper
 
           {
             code_challenge: pre_auth.code_challenge,
-            code_challenge_method: pre_auth.code_challenge_method
+            code_challenge_method: pre_auth.code_challenge_method,
           }
         end
 

data/lib/doorkeeper/oauth/authorization/token.rb

@@ -23,11 +23,14 @@ module Doorkeeper
             )
           end
 
-          def access_token_expires_in(server, context)
-            if (expiration = server.custom_access_token_expires_in.call(context))
-              expiration
+          def access_token_expires_in(configuration, context)
+            if configuration.option_defined?(:custom_access_token_expires_in)
+              expiration = configuration.custom_access_token_expires_in.call(context)
+              return nil if expiration == Float::INFINITY
+
+              expiration || configuration.access_token_expires_in
             else
-              server.access_token_expires_in
+              configuration.access_token_expires_in
             end
           end
 
@@ -64,7 +67,7 @@ module Doorkeeper
           {
             controller: controller,
             action: :show,
-            access_token: token.plaintext_token
+            access_token: token.plaintext_token,
           }
         end
 
@@ -77,7 +80,7 @@ module Doorkeeper
         def controller
           @controller ||= begin
             mapping = Doorkeeper::Rails::Routes.mapping[:token_info] || {}
-            mapping[:controllers] || 'doorkeeper/token_info'
+            mapping[:controllers] || "doorkeeper/token_info"
           end
         end
       end

data/lib/doorkeeper/oauth/authorization/uri_builder.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'rack/utils'
+require "rack/utils"
 
 module Doorkeeper
   module OAuth

data/lib/doorkeeper/oauth/authorization_code_request.rb

@@ -43,8 +43,9 @@ module Doorkeeper
       end
 
       def validate_attributes
-        return false if grant && grant.uses_pkce? && code_verifier.blank?
+        return false if grant&.uses_pkce? && code_verifier.blank?
         return false if grant && !grant.pkce_supported? && !code_verifier.blank?
+
         redirect_uri.present?
       end
 
@@ -54,6 +55,7 @@ module Doorkeeper
 
       def validate_grant
         return false unless grant && grant.application_id == client.id
+
         grant.accessible?
       end
 
@@ -70,9 +72,9 @@ module Doorkeeper
         return true unless grant.uses_pkce? || code_verifier
         return false unless grant.pkce_supported?
 
-        if grant.code_challenge_method == 'S256'
+        if grant.code_challenge_method == "S256"
           grant.code_challenge == AccessGrant.generate_code_challenge(code_verifier)
-        elsif grant.code_challenge_method == 'plain'
+        elsif grant.code_challenge_method == "plain"
           grant.code_challenge == code_verifier
         else
           false

data/lib/doorkeeper/oauth/client_credentials/validation.rb

@@ -30,7 +30,7 @@ module Doorkeeper
           application_scopes = if @client.present?
                                  @client.application.scopes
                                else
-                                 ''
+                                 ""
                                end
 
           ScopeChecker.valid?(

data/lib/doorkeeper/oauth/client_credentials_request.rb

@@ -7,7 +7,7 @@ module Doorkeeper
       attr_reader :response
       attr_writer :issuer
 
-      alias_method :error_response, :response
+      alias error_response response
 
       delegate :error, to: :issuer
 

data/lib/doorkeeper/oauth/error_response.rb

@@ -27,7 +27,7 @@ module Doorkeeper
         {
           error: name,
           error_description: description,
-          state: state
+          state: state,
         }.reject { |_, v| v.blank? }
       end
 
@@ -54,10 +54,10 @@ module Doorkeeper
 
       def headers
         {
-          'Cache-Control' => 'no-store',
-          'Pragma' => 'no-cache',
-          'Content-Type' => 'application/json; charset=utf-8',
-          'WWW-Authenticate' => authenticate_info
+          "Cache-Control" => "no-store",
+          "Pragma" => "no-cache",
+          "Content-Type" => "application/json; charset=utf-8",
+          "WWW-Authenticate" => authenticate_info,
         }
       end
 

data/lib/doorkeeper/oauth/forbidden_token_response.rb

@@ -18,7 +18,7 @@ module Doorkeeper
 
       def headers
         headers = super
-        headers.delete 'WWW-Authenticate'
+        headers.delete "WWW-Authenticate"
         headers
       end
 

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

@@ -38,7 +38,7 @@ module Doorkeeper
             return true unless @scopes_by_grant_type
 
             OAuth::Scopes.from_array(@scopes_by_grant_type)
-                         .has_scopes?(parsed_scopes)
+              .has_scopes?(parsed_scopes)
           end
         end
 

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

@@ -5,7 +5,8 @@ module Doorkeeper
     module Helpers
       module UniqueToken
         def self.generate(options = {})
-          # Access Token value must be 1*VSCHAR or 1*( ALPHA / DIGIT / "-" / "." / "_" / "~" / "+" / "/" ) *"="
+          # Access Token value must be 1*VSCHAR or
+          # 1*( ALPHA / DIGIT / "-" / "." / "_" / "~" / "+" / "/" ) *"="
           #
           # @see https://tools.ietf.org/html/rfc6749#appendix-A.12
           # @see https://tools.ietf.org/html/rfc6750#section-2.1

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

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
-require 'ipaddr'
+
+require "ipaddr"
 
 module Doorkeeper
   module IPAddrLoopback
@@ -25,6 +26,7 @@ module Doorkeeper
       module URIChecker
         def self.valid?(url)
           return true if native_uri?(url)
+
           uri = as_uri(url)
           uri.fragment.nil? && !uri.host.nil? && !uri.scheme.nil?
         rescue URI::InvalidURIError
@@ -37,6 +39,7 @@ module Doorkeeper
 
           unless client_url.query.nil?
             return false unless query_matches?(url.query, client_url.query)
+
             # Clear out queries so rest of URI can be tested. This allows query
             # params to be in the request but order not mattering.
             client_url.query = nil
@@ -70,8 +73,9 @@ module Doorkeeper
         def self.query_matches?(query, client_query)
           return true if client_query.blank? && query.blank?
           return false if client_query.nil? || query.nil?
+
           # Will return true independent of query order
-          client_query.split('&').sort == query.split('&').sort
+          client_query.split("&").sort == query.split("&").sort
         end
 
         def self.native_uri?(url)