doorkeeper 1.4.2 → 2.0.0.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2d7cab21593e8a332814e94eb9a6ea9dec17a4e
-  data.tar.gz: 36510e1c2ba3eb2d251b673cd255a55658bac713
+  metadata.gz: d4bc922834f77e390385c6b9ff4284dc7f68cf0b
+  data.tar.gz: 23f9d1f65f3fe87e7c5f603d6b107230e142b79a
 SHA512:
-  metadata.gz: fae688f8c62919746f491bf310785b8e7ae2d7af3095cb2b09fcab1bc6ac73bc8dfdb57d67c474369a27a5c1135876f98a15bd18a2feb7e7c39d62953e23a9bd
-  data.tar.gz: 10c7f4395f915b88982a93f9bb5a6e8f5f57e6577752281b971be705707af84af2ae6ab2caf7d191a06deb3efbf4878ac66fd187e7427a14354b279e2db20c8b
+  metadata.gz: 494114035eb4172c2ade7e380566e5e28707348a54c71d396028dac19fd4a6746c1f5f1272e916921cda0faa8f22bec6900e3af649fc0ae720bc39671ef63b28
+  data.tar.gz: 0288945e46c7b2b90db5a7e75e3db6405331c1dd2830cf46f88ef2154d139530dc60f7ed587c2f2bc56078645d89a64bb7b1efeaf0ce24b2bc96807a27062170

data/.hound.yml

@@ -4,3 +4,6 @@ LineLength:
 
 StringLiterals:
   Enabled: false
+
+TrailingBlankLines:
+  Enabled: true

data/CHANGELOG.md

@@ -1,16 +1,23 @@
 # Changelog
 
-## master
-
-## 1.4.2
-
-- [#576] Backported to 1.4.X branch. Filters out sensitive parameters from logs.
-
-
-## 1.4.1
-
-- Fixes CSRF vulnerability
-
+## master (preparation for 2.0.0)
+
+- Removes deprecated option `test_redirect_uri`. Now called
+  `native_redirect_uri`.
+- [#446] Removes deprecated `mount Doorkeeper::Engine`. Now we use
+  `use_doorkeeper`.
+- [#448] Removes `doorkeeper_for` helper. Now we use
+  `before_action :doorkeeper_authorize!`. This change didn't go through the
+  deprecation cycle.
+- [#450] When password is invalid in Password Credentials Grant, Doorkeeper
+  returned 'invalid_resource_owner' instead of 'invalid_grant', as the spec
+  declares. Fixes #444.
+- [#452] Allows `revoked_at` to be set in the future, for future expiry.
+  Rationale: https://github.com/doorkeeper-gem/doorkeeper/pull/452#issuecomment-51431459
+- [#480] For Implicit grant flow, access tokens can now be reused. Fixes #421.
+- [#491] Reworks of @jasl's #454 and #478. ORM refactor that allows doorkeeper
+  to be extended more easily with unsupported ORMs. It also marks the boundaries
+  between shared model code and ORM specifics inside of the gem.
 
 ## 1.4.0
 

data/Gemfile

@@ -1,31 +1,31 @@
 # Defaults. For supported versions check .travis.yml
-ENV['rails'] ||= ENV['orm'] == "mongoid4" ? '4.0.2' : '3.2.13'
+ENV['rails'] ||= ENV['orm'] == "mongoid4" ? '4.1.0' : '3.2.0'
 ENV['orm']   ||= 'active_record'
 
 source 'https://rubygems.org'
 
 # Define Rails version
-gem 'rails', ENV['rails']
+gem 'rails', "~> #{ENV['rails']}"
 
-gem 'database_cleaner', '~> 1.0.0.RC1' if ENV['rails'][0] == '4'
+gem 'database_cleaner' if ENV['rails'][0] == '4'
 
 case ENV['orm']
 when 'active_record'
   gem 'activerecord'
 
 when 'mongoid2'
-  gem 'mongoid', '2.5.1'
+  gem 'mongoid', '~> 2'
   gem 'bson_ext', '~> 1.7'
 
 when 'mongoid3'
-  gem 'mongoid', '3.0.10'
+  gem 'mongoid', '~> 3'
 
 when 'mongoid4'
-  gem 'mongoid', '4.0.0.beta1'
+  gem 'mongoid', '~> 4'
   gem 'moped'
 
 when 'mongo_mapper'
-  gem 'mongo_mapper', '0.12.0'
+  gem 'mongo_mapper', '~> 0.12'
   gem 'bson_ext', '~> 1.7'
 
 end

data/README.md

@@ -1,12 +1,17 @@
 # Doorkeeper - awesome oauth provider for your Rails app.
 
-[![Build Status](https://travis-ci.org/doorkeeper-gem/doorkeeper.png?branch=master)](https://travis-ci.org/doorkeeper-gem/doorkeeper)
-[![Dependency Status](https://gemnasium.com/applicake/doorkeeper.png?travis)](https://gemnasium.com/applicake/doorkeeper)
-[![Code Climate](https://codeclimate.com/github/applicake/doorkeeper.png)](https://codeclimate.com/github/applicake/doorkeeper)
-[![Gem Version](https://badge.fury.io/rb/doorkeeper.png)](https://rubygems.org/gems/doorkeeper)
+[![Build Status](https://travis-ci.org/doorkeeper-gem/doorkeeper.svg?branch=master)](https://travis-ci.org/doorkeeper-gem/doorkeeper)
+[![Dependency Status](https://gemnasium.com/applicake/doorkeeper.svg?travis)](https://gemnasium.com/applicake/doorkeeper)
+[![Code Climate](https://codeclimate.com/github/applicake/doorkeeper.svg)](https://codeclimate.com/github/applicake/doorkeeper)
+[![Gem Version](https://badge.fury.io/rb/doorkeeper.svg)](https://rubygems.org/gems/doorkeeper)
 
 Doorkeeper is a gem that makes it easy to introduce OAuth 2 provider functionality to your application.
 
+## Documentation valid for `master` branch
+
+Please check the documentation for the version of doorkeeper you are using in:
+https://github.com/doorkeeper-gem/doorkeeper/releases.
+
 ## Table of Contents
 
 - [Useful links](#useful-links)
@@ -164,48 +169,20 @@ authentication
 
 ## Protecting resources with OAuth (a.k.a your API endpoint)
 
-To protect your API with OAuth, doorkeeper only requires you to call
-`doorkeeper_for` helper, specifying the actions you want to protect.
-
-For example, if you have a products controller under api/v1, you can require
-the OAuth authentication with:
+To protect your API with OAuth, you just need to setup `before_action`s
+specifying the actions you want to protect. For example:
 
 ``` ruby
 class Api::V1::ProductsController < Api::V1::ApiController
-  doorkeeper_for :all                 # Require access token for all actions
-  doorkeeper_for :all, except: :index # All actions except index
-  doorkeeper_for :index, :show        # Only for index and show action
+  before_action :doorkeeper_authorize! # Require access token for all actions
 
   # your actions
 end
 ```
 
-You don't need to setup any before filter, `doorkeeper_for` will handle that
-for you.
-
-You can pass `if` or `unless` blocks that would specify when doorkeeper has to
-guard the access.
-
-``` ruby
-class Api::V1::ProductsController < Api::V1::ApiController
-  doorkeeper_for :all, :if => lambda { request.xhr? }
-end
-```
-
-### ActionController::Metal integration
-
-The `doorkeeper_for` filter is intended to work with ActionController::Metal
-too. You only need to include the required `ActionController` modules:
-
-```ruby
-class MetalController < ActionController::Metal
-  include AbstractController::Callbacks
-  include ActionController::Head
-  include Doorkeeper::Helpers::Filter
+You can pass any option `before_action` accepts, such as `if`, `only`,
+`except`, and others.
 
-  doorkeeper_for :all
-end
-```
 
 ### Route Constraints and other integrations
 
@@ -248,8 +225,10 @@ And in your controllers:
 
 ```ruby
 class Api::V1::ProductsController < Api::V1::ApiController
-  doorkeeper_for :index, :show,    :scopes => [:public]
-  doorkeeper_for :update, :create, :scopes => [:admin, :write]
+  before_action -> { doorkeeper_authorize! :public }, only: :index
+  before_action only: [:create, :update, :destroy] do
+    doorkeeper_authorize! :admin, :write
+  end
 end
 ```
 
@@ -265,8 +244,8 @@ controller that returns the resource owner instance:
 
 ``` ruby
 class Api::V1::CredentialsController < Api::V1::ApiController
-  doorkeeper_for :all
-  respond_to     :json
+  before_action :doorkeeper_authorize!
+  respond_to    :json
 
   # GET /me.json
   def me

data/app/controllers/doorkeeper/application_controller.rb

@@ -2,12 +2,6 @@ module Doorkeeper
   class ApplicationController < ActionController::Base
     include Helpers::Controller
 
-    helper 'doorkeeper/form_errors'
-
-    if ::Rails.version.to_i < 4
-      protect_from_forgery
-    else
-      protect_from_forgery with: :exception
-    end
+    helper 'doorkeeper/dashboard'
   end
 end

data/app/controllers/doorkeeper/applications_controller.rb

@@ -1,7 +1,6 @@
 module Doorkeeper
   class ApplicationsController < Doorkeeper::ApplicationController
     layout 'doorkeeper/admin'
-    respond_to :html
 
     before_filter :authenticate_admin!
     before_filter :set_application, only: [:show, :edit, :update, :destroy]
@@ -18,7 +17,7 @@ module Doorkeeper
       @application = Application.new(application_params)
       if @application.save
         flash[:notice] = I18n.t(:notice, scope: [:doorkeeper, :flash, :applications, :create])
-        respond_with [:oauth, @application]
+        redirect_to oauth_application_url(@application)
       else
         render :new
       end
@@ -27,7 +26,7 @@ module Doorkeeper
     def update
       if @application.update_attributes(application_params)
         flash[:notice] = I18n.t(:notice, scope: [:doorkeeper, :flash, :applications, :update])
-        respond_with [:oauth, @application]
+        redirect_to oauth_application_url(@application)
       else
         render :edit
       end
@@ -46,9 +45,9 @@ module Doorkeeper
 
     def application_params
       if params.respond_to?(:permit)
-        params.require(:application).permit(:name, :redirect_uri)
+        params.require(:doorkeeper_application).permit(:name, :redirect_uri)
       else
-        params[:application].slice(:name, :redirect_uri) rescue nil
+        params[:doorkeeper_application].slice(:name, :redirect_uri) rescue nil
       end
     end
   end

data/app/controllers/doorkeeper/tokens_controller.rb

@@ -18,14 +18,14 @@ module Doorkeeper
         revoke_token(request.POST['token']) if request.POST['token']
       end
       # The authorization server responds with HTTP status code 200 if the
-      # token has been revoked sucessfully or if the client submitted an invalid token
+      # token has been revoked successfully or if the client submitted an invalid token
       render json: {}, status: 200
     end
 
     private
 
     def revoke_token(token)
-      token = AccessToken.authenticate(token) || AccessToken.by_refresh_token(token)
+      token = AccessToken.by_token(token) || AccessToken.by_refresh_token(token)
       if token && doorkeeper_token.same_credential?(token)
         token.revoke
         true

data/app/helpers/doorkeeper/{form_errors_helper.rb → dashboard_helper.rb}

@@ -1,4 +1,4 @@
-module Doorkeeper::FormErrorsHelper
+module Doorkeeper::DashboardHelper
   def doorkeeper_errors_for(object, method)
     if object.errors[method].present?
       object.errors[method].map do |msg|
@@ -8,4 +8,8 @@ module Doorkeeper::FormErrorsHelper
       end.reduce(&:join).html_safe
     end
   end
+
+  def doorkeeper_submit_path(application)
+    application.persisted? ? oauth_application_path(application) : oauth_applications_path
+  end
 end

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

@@ -1,5 +1,5 @@
 <%- submit_btn_css ||= 'btn btn-link' %>
-<%= form_tag [:oauth, application] do %>
+<%= form_tag oauth_application_path(application) do %>
   <input type="hidden" name="_method" value="delete">
   <%= submit_tag 'Destroy', onclick: "return confirm('Are you sure?')", class: submit_btn_css %>
 <% end %>

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

@@ -1,4 +1,4 @@
-<%= form_for [:oauth, application], html: {class: 'form-horizontal', role: 'form'} do |f| %>
+<%= form_for application, url: doorkeeper_submit_path(application), html: {class: 'form-horizontal', role: 'form'} do |f| %>
   <% if application.errors.any? %>
     <div class="alert alert-danger" data-alert><p>Whoops! Check your form for possible errors</p></div>
   <% end %>

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

@@ -16,7 +16,7 @@
   <tbody>
   <% @applications.each do |application| %>
     <tr id="application_<%= application.id %>">
-      <td><%= link_to application.name, [:oauth, application] %></td>
+      <td><%= link_to application.name, oauth_application_path(application) %></td>
       <td><%= application.redirect_uri %></td>
       <td><%= link_to 'Edit', edit_oauth_application_path(application), class: 'btn btn-link' %></td>
       <td><%= render 'delete_form', application: application %></td>

data/config/locales/en.yml

@@ -2,7 +2,7 @@ en:
   activerecord:
     errors:
       models:
-        application:
+        doorkeeper/application:
           attributes:
             redirect_uri:
               fragment_present: 'cannot contain a fragment.'
@@ -11,7 +11,7 @@ en:
   mongoid:
     errors:
       models:
-        application:
+        doorkeeper/application:
           attributes:
             redirect_uri:
               fragment_present: 'cannot contain a fragment.'
@@ -20,7 +20,7 @@ en:
   mongo_mapper:
     errors:
       models:
-        application:
+        doorkeeper/application:
           attributes:
             redirect_uri:
               fragment_present: 'cannot contain a fragment.'

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/doorkeeper/config.rb

@@ -15,26 +15,28 @@ module Doorkeeper
     @config || (fail MissingConfiguration.new)
   end
 
-  def self.orm_model_dir
-    case configuration.orm
-    when :mongoid3, :mongoid4
-      'mongoid3_4'
+  def self.enable_orm
+    class_name = "doorkeeper/orm/#{configuration.orm}".classify
+    class_name.constantize.initialize_models!
+  rescue NameError => e
+    if e.instance_of?(NameError)
+      fail e, "ORM adapter not found (#{configuration.orm})", <<-error_msg
+[doorkeeper] ORM adapter not found (#{configuration.orm}), or there was an error
+trying to load it.
+
+You probably need to add the related gem for this adapter to work with
+doorkeeper.
+
+If you are working on the adapter itself, double check that the constant exists,
+and that your `initialize_models!` method doesn't raise any errors.\n
+      error_msg
     else
-      configuration.orm
+      raise e
     end
   end
 
-  def self.enable_orm
-    require "doorkeeper/models/#{orm_model_dir}/access_grant"
-    require "doorkeeper/models/#{orm_model_dir}/access_token"
-    require "doorkeeper/models/#{orm_model_dir}/application"
-    require 'doorkeeper/models/access_grant'
-    require 'doorkeeper/models/access_token'
-    require 'doorkeeper/models/application'
-  end
-
   def self.setup_application_owner
-    require File.join(File.dirname(__FILE__), 'models', 'ownership')
+    require File.join(File.dirname(__FILE__), 'models', 'concerns', 'ownership')
     Application.send :include, Models::Ownership
   end
 
@@ -85,14 +87,6 @@ module Doorkeeper
       def reuse_access_token
         @config.instance_variable_set("@reuse_access_token", true)
       end
-
-      def test_redirect_uri(uri)
-        warn <<-TEXT
-          DEPRECATION: test_redirect_uri has renamed to native_redirect_uri. use "native_redirect_uri '#{uri}'".
-        TEXT
-
-        @config.instance_variable_set('@native_redirect_uri', uri)
-      end
     end
 
     module Option
@@ -233,7 +227,7 @@ module Doorkeeper
       @token_grant_types ||= calculate_token_grant_types
     end
 
-  private
+    private
 
     # Determines what values are acceptable for 'response_type' param in
     # authorization request endpoint, and return them as an array of strings.

data/lib/doorkeeper/engine.rb

@@ -1,17 +1,12 @@
 module Doorkeeper
   class Engine < Rails::Engine
-    initializer "doorkeeper.params.filter" do |app|
-      app.config.filter_parameters += [:client_secret, :code, :token]
-    end
-
     initializer 'doorkeeper.routes' do
-      Doorkeeper::Rails::Routes.warn_if_using_mount_method!
       Doorkeeper::Rails::Routes.install!
     end
 
     initializer 'doorkeeper.helpers' do
       ActiveSupport.on_load(:action_controller) do
-        include Doorkeeper::Helpers::Filter
+        include Doorkeeper::Rails::Helpers
       end
     end
   end