doorkeeper 4.2.0 → 4.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9886d44f18692bd1207493bc04efbad8ccab4e46
-  data.tar.gz: 56c74dd71ce5473c11e1ce3a5c6aeb7a264c0ee8
+  metadata.gz: 990a2d9feaf3dd9945bac2a76742b719521e12c8
+  data.tar.gz: 6a9e2f52ad07979a02040219f7a1f25c9768e353
 SHA512:
-  metadata.gz: 25db8a95095afb722206d05f2e42cf98964126329686363c5d17afd6f0a9bbe4ba0cfc224ba60544b6c3c7939351a6396aac7789394b2bb2fddc2c60b9814fa5
-  data.tar.gz: 007df96482ad0b1240ae3bd9089eaefa8a9b5d7fc90c40817dfde978baed97051042233980f2762735eae2b2cda1bba8c033774ecb00cbd01a8bcb27f6fb2fbf
+  metadata.gz: 641cb1c261a315bd330719a00ba622dbfd61c973f30124698db92ee33b3ff88314d4636e459fd367b73fffdd49da945307e3947a243bdbaf710f9a76a9c1759f
+  data.tar.gz: cb2ff264f9e2e175bd3ed311d54ea24603d16f36b51bf4cdbb56fe4fe855e3785f668b9f0e8a5692ae85bc8057daaa47f14fde8c7cca367c6f08a6dce97bfb54

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -12,3 +12,8 @@ spec/generators/tmp
 .rvmrc
 *.swp
 .idea
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+coverage

data/.travis.yml

@@ -4,17 +4,22 @@ sudo: false
 
 rvm:
   - 2.1
-  - 2.2.4
-  - 2.3.0
+  - 2.2.6
+  - 2.3.3
 
 before_install:
   - gem install bundler -v '~> 1.10'
 
-env:
-  - rails=4.2.0
-  - rails=5.0.0
+gemfile:
+  - gemfiles/rails_4_2.gemfile
+  - gemfiles/rails_5_0.gemfile
+  - gemfiles/rails_5_1.gemfile
 
 matrix:
   exclude:
-    - env: rails=5.0.0
+    - gemfile: gemfiles/rails_5_0.gemfile
       rvm: 2.1
+    - gemfile: gemfiles/rails_5_1.gemfile
+      rvm: 2.1
+  allowed_failures:
+    - gemfile: gemfiles/rails_5_1.gemfile

data/Appraisals

@@ -0,0 +1,14 @@
+appraise "rails-4-2" do
+  gem "rails", "~> 4.2.0"
+end
+
+appraise "rails-5-0" do
+  gem "rails", "~> 5.0.0"
+  gem "rspec-rails", "~> 3.5"
+end
+
+appraise "rails-5-1" do
+  gem "rails", github: "rails/rails"
+  gem "arel", github: "rails/arel"
+  gem "rspec-rails", "~> 3.5"
+end

data/Gemfile

@@ -1,14 +1,10 @@
-ENV["rails"] ||= "4.2.0"
-
 source "https://rubygems.org"
 
-gem "rails", "~> #{ENV["rails"]}"
+gem "rails", "~> 4.2.0"
 
-if ENV['rails'].start_with?('5')
-  gem "rspec-rails", "3.5.1"
-end
+gem "appraisal"
 
 gem "activerecord-jdbcsqlite3-adapter", platform: :jruby
-gem "sqlite3", platform: [:ruby, :mswin, :mingw]
-
+gem "sqlite3", platform: [:ruby, :mswin, :mingw, :x64_mingw]
+gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw]
 gemspec

data/NEWS.md

@@ -2,7 +2,16 @@
 
 User-visible changes worth mentioning.
 
-## master
+## 4.2.5
+
+- [#936] Deprecate `Doorkeeper#configured?`, `Doorkeeper#database_installed?`, and
+  `Doorkeeper#installed?`
+- [#909] Add `InvalidTokenResponse#reason` reader method to allow read the kind
+  of invalid token error.
+- [#928] Test against more recent Ruby versions
+- Small refactorings within the codebase
+- [#921] Switch to Appraisal, and test against Rails master
+- [#892] Add minimum Ruby version requirement
 
 ## 4.2.0
 

data/README.md

@@ -176,7 +176,7 @@ You can pass any option `before_action` accepts, such as `if`, `only`,
 
 ### Protect your API with OAuth when using Grape
 
-As of [PR 567] doorkeeper has helpers for Grape. One of them is
+As of [PR 567] doorkeeper has helpers for Grape >= 0.10. One of them is
 `doorkeeper_authorize!` and can be used in a similar way as an example above.
 Note that you have to use `require 'doorkeeper/grape/helpers'` and
 `helpers Doorkeeper::Grape::Helpers`.
@@ -198,6 +198,11 @@ module API
         doorkeeper_authorize!
       end
 
+      route_setting :scopes, ['user:email']
+      get :emails do
+        [{'email' => current_user.email}]
+      end
+
       # ...
     end
   end

data/app/controllers/doorkeeper/applications_controller.rb

@@ -44,11 +44,7 @@ module Doorkeeper
     end
 
     def application_params
-      if params.respond_to?(:permit)
-        params.require(:doorkeeper_application).permit(:name, :redirect_uri, :scopes)
-      else
-        params[:doorkeeper_application].slice(:name, :redirect_uri, :scopes) rescue nil
-      end
+      params.require(:doorkeeper_application).permit(:name, :redirect_uri, :scopes)
     end
   end
 end

data/app/views/doorkeeper/applications/_delete_form.html.erb

@@ -1,5 +1,4 @@
 <%- submit_btn_css ||= 'btn btn-link' %>
-<%= form_tag oauth_application_path(application) do %>
-  <input type="hidden" name="_method" value="delete">
+<%= form_tag oauth_application_path(application), method: :delete do %>
   <%= submit_tag t('doorkeeper.applications.buttons.destroy'), onclick: "return confirm('#{ t('doorkeeper.applications.confirmations.destroy') }')", class: submit_btn_css %>
 <% end %>

data/app/views/doorkeeper/authorized_applications/_delete_form.html.erb

@@ -1,5 +1,4 @@
 <%- submit_btn_css ||= 'btn btn-link' %>
-<%= form_tag oauth_authorized_application_path(application) do %>
-  <input type="hidden" name="_method" value="delete">
+<%= form_tag oauth_authorized_application_path(application), method: :delete do %>
   <%= submit_tag t('doorkeeper.authorized_applications.buttons.revoke'), onclick: "return confirm('#{ t('doorkeeper.authorized_applications.confirmations.revoke') }')", class: submit_btn_css %>
 <% end %>

data/config/locales/en.yml

@@ -82,9 +82,9 @@ en:
         server_error: 'The authorization server encountered an unexpected condition which prevented it from fulfilling the request.'
         temporarily_unavailable: 'The authorization server is currently unable to handle the request due to a temporary overloading or maintenance of the server.'
 
-        #configuration error messages
+        # Configuration error messages
         credential_flow_not_configured: 'Resource Owner Password Credentials flow failed due to Doorkeeper.configure.resource_owner_from_credentials being unconfigured.'
-        resource_owner_authenticator_not_configured: 'Resource Owner find failed due to Doorkeeper.configure.resource_owner_authenticator being unconfiged.'
+        resource_owner_authenticator_not_configured: 'Resource Owner find failed due to Doorkeeper.configure.resource_owner_authenticator being unconfigured.'
 
         # Access grant errors
         unsupported_response_type: 'The authorization server does not support this response type.'

data/doorkeeper.gemspec

@@ -5,8 +5,8 @@ require "doorkeeper/version"
 Gem::Specification.new do |s|
   s.name        = "doorkeeper"
   s.version     = Doorkeeper::VERSION
-  s.authors     = ["Felipe Elias Philipp", "Tute Costa"]
-  s.email       = %w(tutecosta@gmail.com)
+  s.authors     = ["Felipe Elias Philipp", "Tute Costa", "Jon Moss"]
+  s.email       = %w(me@jonathanmoss.me)
   s.homepage    = "https://github.com/doorkeeper-gem/doorkeeper"
   s.summary     = "OAuth 2 provider for Rails and Grape"
   s.description = "Doorkeeper is an OAuth 2 provider for Rails and Grape."
@@ -17,12 +17,14 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency "railties", ">= 4.2"
+  s.required_ruby_version = ">= 2.1"
 
   s.add_development_dependency "capybara"
-  s.add_development_dependency "database_cleaner", "~> 1.3.0"
-  s.add_development_dependency "factory_girl", "~> 4.5.0"
-  s.add_development_dependency "generator_spec", "~> 0.9.0"
-  s.add_development_dependency "rake", "> 10.5.0"
+  s.add_development_dependency "coveralls"
+  s.add_development_dependency "database_cleaner", "~> 1.5.3"
+  s.add_development_dependency "factory_girl", "~> 4.7.0"
+  s.add_development_dependency "generator_spec", "~> 0.9.3"
+  s.add_development_dependency "rake", ">= 11.3.0"
   s.add_development_dependency "rspec-rails"
-  s.add_development_dependency "timecop", "~> 0.7.0"
+  s.add_development_dependency "timecop", "~> 0.8.1"
 end

data/gemfiles/rails_4_2.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.2.0"
+gem "appraisal"
+gem "activerecord-jdbcsqlite3-adapter", :platform => :jruby
+gem "sqlite3", :platform => [:ruby, :mswin, :mingw, :x64_mingw]
+gem "tzinfo-data", :platforms => [:mingw, :mswin, :x64_mingw]
+
+gemspec :path => "../"

data/gemfiles/rails_5_0.gemfile

@@ -0,0 +1,12 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 5.0.0"
+gem "appraisal"
+gem "activerecord-jdbcsqlite3-adapter", :platform => :jruby
+gem "sqlite3", :platform => [:ruby, :mswin, :mingw, :x64_mingw]
+gem "tzinfo-data", :platforms => [:mingw, :mswin, :x64_mingw]
+gem "rspec-rails", "~> 3.5"
+
+gemspec :path => "../"

data/gemfiles/rails_5_1.gemfile

@@ -0,0 +1,13 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", :github => "rails/rails"
+gem "appraisal"
+gem "activerecord-jdbcsqlite3-adapter", :platform => :jruby
+gem "sqlite3", :platform => [:ruby, :mswin, :mingw, :x64_mingw]
+gem "tzinfo-data", :platforms => [:mingw, :mswin, :x64_mingw]
+gem "arel", :github => "rails/arel"
+gem "rspec-rails", "~> 3.5"
+
+gemspec :path => "../"

data/lib/doorkeeper.rb

@@ -16,11 +16,12 @@ require 'doorkeeper/oauth/helpers/unique_token'
 
 require 'doorkeeper/oauth/scopes'
 require 'doorkeeper/oauth/error'
+require 'doorkeeper/oauth/base_response'
 require 'doorkeeper/oauth/code_response'
 require 'doorkeeper/oauth/token_response'
 require 'doorkeeper/oauth/error_response'
 require 'doorkeeper/oauth/pre_authorization'
-require 'doorkeeper/oauth/request_concern'
+require 'doorkeeper/oauth/base_request'
 require 'doorkeeper/oauth/authorization_code_request'
 require 'doorkeeper/oauth/refresh_token_request'
 require 'doorkeeper/oauth/password_access_token_request'
@@ -48,16 +49,21 @@ require 'doorkeeper/rails/helpers'
 
 require 'doorkeeper/orm/active_record'
 
+require 'active_support/deprecation'
+
 module Doorkeeper
   def self.configured?
+    ActiveSupport::Deprecation.warn "Method `Doorkeeper#configured?` has been deprecated without replacement."
     @config.present?
   end
 
   def self.database_installed?
+    ActiveSupport::Deprecation.warn "Method `Doorkeeper#database_installed?` has been deprecated without replacement."
     [AccessToken, AccessGrant, Application].all?(&:table_exists?)
   end
 
   def self.installed?
+    ActiveSupport::Deprecation.warn "Method `Doorkeeper#installed?` has been deprecated without replacement."
     configured? && database_installed?
   end
 

data/lib/doorkeeper/config.rb

@@ -1,5 +1,7 @@
 module Doorkeeper
   class MissingConfiguration < StandardError
+    # Defines a MissingConfiguration error for a missing Doorkeeper
+    # configuration
     def initialize
       super('Configuration for doorkeeper missing. Do you have doorkeeper initializer?')
     end
@@ -47,6 +49,15 @@ doorkeeper.
         @config
       end
 
+      # 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
+      #
+      # @param opts [Hash] the options to confirm if an application owner
+      #   is present
+      # @option opts[Boolean] :confirmation (false)
+      #   Set confirm_application_owner variable
       def enable_application_owner(opts = {})
         @config.instance_variable_set('@enable_application_owner', true)
         confirm_application_owner if opts[:confirmation].present? && opts[:confirmation]
@@ -56,44 +67,88 @@ doorkeeper.
         @config.instance_variable_set('@confirm_application_owner', true)
       end
 
+      # Define default access token scopes for your provider
+      #
+      # @param scopes [Array] Default set of access (OAuth::Scopes.new)
+      # token scopes
       def default_scopes(*scopes)
         @config.instance_variable_set('@default_scopes', OAuth::Scopes.from_array(scopes))
       end
 
+      # Define default access token scopes for your provider
+      #
+      # @param scopes [Array] Optional set of access (OAuth::Scopes.new)
+      # token scopes
       def optional_scopes(*scopes)
         @config.instance_variable_set('@optional_scopes', OAuth::Scopes.from_array(scopes))
       end
 
+      # Change the way client credentials are retrieved from the request object.
+      # 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.
+      #
+      # @param methods [Array] Define client credentials
       def client_credentials(*methods)
         @config.instance_variable_set('@client_credentials', methods)
       end
 
+      # 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.
+      #
+      # @param methods [Array] Define access token methods
       def access_token_methods(*methods)
         @config.instance_variable_set('@access_token_methods', methods)
       end
 
+      # Issue access tokens with refresh token (disabled by default)
       def use_refresh_token
         @config.instance_variable_set('@refresh_token_enabled', true)
       end
 
+      # WWW-Authenticate Realm (default "Doorkeeper").
+      #
+      # @param realm [String] ("Doorkeeper") Authentication realm
       def realm(realm)
         @config.instance_variable_set('@realm', realm)
       end
 
+      # Reuse access token for the same resource owner within an application
+      # (disabled by default)
+      # Rationale: https://github.com/doorkeeper-gem/doorkeeper/issues/383
       def reuse_access_token
         @config.instance_variable_set("@reuse_access_token", true)
       end
 
+      # Forces the usage of the HTTPS protocol in non-native redirect uris
+      # (enabled by default in non-development environments). OAuth2
+      # delegates security in communication to the HTTPS protocol so it is
+      # wise to keep this enabled.
+      #
+      # @param [Boolean] boolean value for the parameter, true by default in
+      # non-development environment
       def force_ssl_in_redirect_uri(boolean)
         @config.instance_variable_set("@force_ssl_in_redirect_uri", boolean)
       end
 
+      # Use a custom class for generating the access token.
+      # https://github.com/doorkeeper-gem/doorkeeper#custom-access-token-generator
+      #
+      # @param access_token_generator [String]
+      #   the name of the access token generator class
       def access_token_generator(access_token_generator)
         @config.instance_variable_set(
           '@access_token_generator', access_token_generator
         )
       end
 
+      # The controller Doorkeeper::ApplicationController inherits from.
+      # Defaults to ActionController::Base.
+      # https://github.com/doorkeeper-gem/doorkeeper#custom-base-controller
+      #
+      # @param base_controller [String] the name of the base controller
       def base_controller(base_controller)
         @config.instance_variable_set('@base_controller', base_controller)
       end

data/lib/doorkeeper/grape/helpers.rb

@@ -3,12 +3,13 @@ require 'doorkeeper/grape/authorization_decorator'
 module Doorkeeper
   module Grape
     module Helpers
+      # These helpers are for grape >= 0.10
       extend ::Grape::API::Helpers
       include Doorkeeper::Rails::Helpers
 
       # endpoint specific scopes > parameter scopes > default scopes
       def doorkeeper_authorize!(*scopes)
-        endpoint_scopes = env['api.endpoint'].options[:route_options][:scopes]
+        endpoint_scopes = env["api.endpoint"].route_setting(:scopes)
         scopes = if endpoint_scopes
                    Doorkeeper::OAuth::Scopes.from_array(endpoint_scopes)
                  elsif scopes && !scopes.empty?

data/lib/doorkeeper/helpers/controller.rb

@@ -1,15 +1,15 @@
+# Define methods that can be called in any controller that inherits from
+# Doorkeeper::ApplicationMetalController or Doorkeeper::ApplicationController
 module Doorkeeper
   module Helpers
     module Controller
-      extend ActiveSupport::Concern
-
       private
 
-      def authenticate_resource_owner!
+      def authenticate_resource_owner! # :doc:
         current_resource_owner
       end
 
-      def current_resource_owner
+      def current_resource_owner # :doc:
         instance_eval(&Doorkeeper.configuration.authenticate_resource_owner)
       end
 
@@ -17,7 +17,7 @@ module Doorkeeper
         instance_eval(&Doorkeeper.configuration.resource_owner_from_credentials)
       end
 
-      def authenticate_admin!
+      def authenticate_admin! # :doc:
         instance_eval(&Doorkeeper.configuration.authenticate_admin)
       end
 
@@ -25,7 +25,7 @@ module Doorkeeper
         @server ||= Server.new(self)
       end
 
-      def doorkeeper_token
+      def doorkeeper_token # :doc:
         @token ||= OAuth::Token.authenticate request, *config_methods
       end