couchkeeper 0.6.7

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/indexes.rb

@@ -0,0 +1,3 @@
+Doorkeeper::Application.create_indexes
+Doorkeeper::AccessGrant.create_indexes
+Doorkeeper::AccessToken.create_indexes

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

@@ -0,0 +1,67 @@
+Doorkeeper.configure do
+  # Change the ORM that doorkeeper will use.
+  # Currently supported options are :active_record, :mongoid2, :mongoid3, :mongo_mapper
+  orm :active_record
+
+  # This block will be called to check whether the resource owner is authenticated or not.
+  resource_owner_authenticator do
+    raise "Please configure doorkeeper resource_owner_authenticator block located in #{__FILE__}"
+    # Put your resource owner authentication logic here.
+    # Example implementation:
+    #   User.find_by_id(session[:user_id]) || redirect_to(new_user_session_url)
+  end
+
+  # 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
+  #   # Put your admin authentication logic here.
+  #   # Example implementation:
+  #   Admin.find_by_id(session[:admin_id]) || redirect_to(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
+
+  # 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 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
+
+  # Change the test redirect uri for client apps
+  # When clients register with the following redirect uri, they won't be redirected to any server and the authorization code 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
+  # (Similar behaviour: https://developers.google.com/accounts/docs/OAuth2InstalledApp#choosingredirecturi)
+  #
+  # test_redirect_uri 'urn:ietf:wg:oauth:2.0:oob'
+
+  # Under some circumstances you might want to have applications auto-approved,
+  # so that the user skips the authorization step.
+  # For example if dealing with trusted a application.
+  # skip_authorization do |resource_owner, client|
+  #   client.superapp? or resource_owner.admin?
+  # end
+end

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

@@ -0,0 +1,42 @@
+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.timestamps
+    end
+
+    add_index :oauth_applications, :uid, :unique => true
+
+    create_table :oauth_access_grants do |t|
+      t.integer  :resource_owner_id, :null => false
+      t.integer  :application_id,    :null => false
+      t.string   :token,             :null => false
+      t.integer  :expires_in,        :null => false
+      t.string   :redirect_uri,      :null => false
+      t.datetime :created_at,        :null => false
+      t.datetime :revoked_at
+      t.string   :scopes
+    end
+
+    add_index :oauth_access_grants, :token, :unique => true
+
+    create_table :oauth_access_tokens do |t|
+      t.integer  :resource_owner_id
+      t.integer  :application_id,    :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.string   :scopes
+    end
+
+    add_index :oauth_access_tokens, :token, :unique => true
+    add_index :oauth_access_tokens, :resource_owner_id
+    add_index :oauth_access_tokens, :refresh_token, :unique => true
+
+  end
+end

data/lib/generators/doorkeeper/views_generator.rb

@@ -0,0 +1,15 @@
+module Doorkeeper
+  module Generators
+    class ViewsGenerator < ::Rails::Generators::Base
+      source_root File.expand_path('../../../../app/views/doorkeeper', __FILE__)
+
+      desc "Copies default Doorkeeper views to your application."
+
+      def manifest
+        directory 'applications', 'app/views/doorkeeper/applications'
+        directory 'authorizations', 'app/views/doorkeeper/authorizations'
+        directory 'authorized_applications', 'app/views/doorkeeper/authorized_applications'
+      end
+    end
+  end
+end

data/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_PATH = File.expand_path('../..',  __FILE__)
+load File.expand_path('../../spec/dummy/script/rails',  __FILE__)

data/script/run_all

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+set -e
+
+rails=3.2.8 orm=active_record bundle install --quiet
+rails=3.2.8 orm=active_record bundle exec rake
+
+rails=3.2.8 orm=mongoid2 bundle install --quiet
+rails=3.2.8 orm=mongoid2 bundle exec rake
+
+rails=3.2.8 orm=mongoid3 bundle install --quiet
+rails=3.2.8 orm=mongoid3 bundle exec rake
+
+rails=3.2.8 orm=mongo_mapper bundle install --quiet
+rails=3.2.8 orm=mongo_mapper bundle exec rake

data/spec/controllers/applications_controller_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper_integration'
+
+module Doorkeeper
+  describe ApplicationsController do
+    context "when admin is not authenticated" do
+      before(:each) do
+        Doorkeeper.configuration.stub(:authenticate_admin => proc do
+          redirect_to main_app.root_url
+        end)
+      end
+
+      it "redirects as set in Doorkeeper.authenticate_admin" do
+        get :index
+        expect(response).to redirect_to(controller.main_app.root_url)
+      end
+    end
+  end
+end

data/spec/controllers/authorizations_controller_spec.rb

@@ -0,0 +1,154 @@
+require 'spec_helper_integration'
+
+describe Doorkeeper::AuthorizationsController, "implicit grant flow" do
+  include AuthorizationRequestHelper
+
+  def fragments(param)
+    fragment = URI.parse(response.location).fragment
+    Rack::Utils.parse_query(fragment)[param]
+  end
+
+  def translated_error_message(key)
+    I18n.translate key, :scope => [:doorkeeper, :errors, :messages]
+  end
+
+  let(:client) { FactoryGirl.create :application }
+  let(:user)   { User.create!(:name => "Joe", :password => "sekret") }
+
+  before do
+    controller.stub :current_resource_owner => user
+  end
+
+  describe "POST #create" do
+    before do
+      post :create, :client_id => client.uid, :response_type => "token", :redirect_uri => client.redirect_uri
+    end
+
+    it "redirects after authorization" do
+      expect(response).to be_redirect
+    end
+
+    it "redirects to client redirect uri" do
+      expect(response.location).to match(%r[^#{client.redirect_uri}])
+    end
+
+    it "includes access token in fragment" do
+      expect(fragments("access_token")).to eq(Doorkeeper::AccessToken.first.token)
+    end
+
+    it "includes token type in fragment" do
+      expect(fragments("token_type")).to eq('bearer')
+    end
+
+    it "includes token expiration in fragment" do
+      expect(fragments("expires_in").to_i).to eq(2.hours.to_i)
+    end
+
+    it "issues the token for the current client" do
+      expect(Doorkeeper::AccessToken.first.application_id).to eq(client.id)
+    end
+
+    it "issues the token for the current resource owner" do
+      expect(Doorkeeper::AccessToken.first.resource_owner_id).to eq(user.id)
+    end
+  end
+
+  describe "POST #create with errors" do
+    before do
+      default_scopes_exist :public
+      post :create, :client_id => client.uid, :response_type => "token", :scope => "invalid", :redirect_uri => client.redirect_uri
+    end
+
+    it "redirects after authorization" do
+      expect(response).to be_redirect
+    end
+
+    it "redirects to client redirect uri" do
+      expect(response.location).to match(%r[^#{client.redirect_uri}])
+    end
+
+    it "does not include access token in fragment" do
+      expect(fragments("access_token")).to be_nil
+    end
+
+    it "includes error in fragment" do
+      expect(fragments("error")).to eq('invalid_scope')
+    end
+
+    it "includes error description in fragment" do
+      expect(fragments("error_description")).to eq(translated_error_message(:invalid_scope))
+    end
+
+    it "does not issue any access token" do
+      expect(Doorkeeper::AccessToken.all).to be_empty
+    end
+  end
+
+  describe "POST #create with application already authorized" do
+    it "returns the existing access token in a fragment"
+  end
+
+  describe "GET #new" do
+    before do
+      get :new, :client_id => client.uid, :response_type => "token", :redirect_uri => client.redirect_uri
+    end
+
+    it 'renders new template' do
+      expect(response).to render_template(:new)
+    end
+  end
+
+  describe "GET #new with skip_authorization true" do
+    before do
+      Doorkeeper.configuration.stub(:skip_authorization => proc do
+          true
+        end)
+      get :new, :client_id => client.uid, :response_type => "token", :redirect_uri => client.redirect_uri
+    end
+
+    it "should redirect immediately" do
+      response.should be_redirect
+      response.location.should =~ %r[^#{client.redirect_uri}]
+    end
+
+    it "should issue a token" do
+      Doorkeeper::AccessToken.count.should be 1
+    end
+
+    it "includes token type in fragment" do
+      fragments("token_type").should == "bearer"
+    end
+
+    it "includes token expiration in fragment" do
+      fragments("expires_in").to_i.should == 2.hours.to_i
+    end
+
+    it "issues the token for the current client" do
+      Doorkeeper::AccessToken.first.application_id.should == client.id
+    end
+
+    it "issues the token for the current resource owner" do
+      Doorkeeper::AccessToken.first.resource_owner_id.should == user.id
+    end
+  end
+
+  describe "GET #new with errors" do
+    before do
+      default_scopes_exist :public
+      get :new, :an_invalid => 'request'
+    end
+
+    it "does not redirect" do
+      expect(response).to_not be_redirect
+    end
+
+    it 'renders error template' do
+      expect(response).to render_template(:error)
+    end
+
+    it 'does not issue any token' do
+      expect(Doorkeeper::AccessGrant.count).to eq 0
+      expect(Doorkeeper::AccessToken.count).to eq 0
+    end
+  end
+end

data/spec/controllers/protected_resources_controller_spec.rb

@@ -0,0 +1,304 @@
+require 'spec_helper_integration'
+
+module ControllerActions
+  def index
+    render :text => "index"
+  end
+
+  def show
+    render :text => "show"
+  end
+end
+
+shared_examples "specified for particular actions" do
+  context "with valid token", :token => :valid do
+    it "allows into index action" do
+      get :index, :access_token => token_string
+      expect(response).to be_success
+    end
+
+    it "allows into show action" do
+      get :show, :id => "3", :access_token => token_string
+      expect(response).to be_success
+    end
+  end
+
+  context "with invalid token", :token => :invalid do
+    include_context "invalid token"
+
+    it "does not allow into index action" do
+      get :index, :access_token => token_string
+      expect(response.status).to eq 401
+    end
+
+    it "allows into show action" do
+      get :show, :id => "5", :access_token => token_string
+      expect(response).to be_success
+    end
+  end
+end
+
+shared_examples "specified with except" do
+  context "with valid token", :token => :valid do
+    it "allows into index action" do
+      get :index, :access_token => token_string
+      expect(response).to be_success
+    end
+
+    it "allows into show action" do
+      get :show, :id => "4", :access_token => token_string
+      expect(response).to be_success
+    end
+  end
+
+  context "with invalid token", :token => :invalid do
+    it "allows into index action" do
+      get :index, :access_token => token_string
+      expect(response).to be_success
+    end
+
+    it "does not allow into show action" do
+      get :show, :id => "14", :access_token => token_string
+      expect(response.status).to eq 401
+    end
+  end
+end
+
+describe "Doorkeeper_for helper" do
+  context "accepts token code specified as" do
+    controller do
+      doorkeeper_for :all
+
+      def index
+        render :text => "index"
+      end
+    end
+
+    let(:token_string) { "1A2BC3" }
+
+    it "access_token param" do
+      Doorkeeper::AccessToken.should_receive(:authenticate).with(token_string)
+      get :index, :access_token => token_string
+    end
+
+    it "bearer_token param" do
+      Doorkeeper::AccessToken.should_receive(:authenticate).with(token_string)
+      get :index, :bearer_token => token_string
+    end
+
+    it "Authorization header" do
+      Doorkeeper::AccessToken.should_receive(:authenticate).with(token_string)
+      request.env["HTTP_AUTHORIZATION"] = "Bearer #{token_string}"
+      get :index
+    end
+
+    it "different kind of Authorization header" do
+      Doorkeeper::AccessToken.should_not_receive(:authenticate)
+      request.env["HTTP_AUTHORIZATION"] = "Basic #{Base64.encode64("foo:bar")}"
+      get :index
+    end
+
+    it "doesn't change Authorization header value" do
+      Doorkeeper::AccessToken.should_receive(:authenticate).exactly(2).times
+      request.env["HTTP_AUTHORIZATION"] = "Bearer #{token_string}"
+      get :index
+      get :index
+    end
+  end
+
+  context "defined for all actions" do
+    controller do
+      doorkeeper_for :all
+
+      include ControllerActions
+    end
+
+    context "with valid token", :token => :valid do
+      it "allows into index action" do
+        get :index, :access_token => token_string
+        expect(response).to be_success
+      end
+
+      it "allows into show action" do
+        get :show, :id => "4", :access_token => token_string
+        expect(response).to be_success
+      end
+    end
+
+    context "with invalid token", :token => :invalid do
+      it "does not allow into index action" do
+        get :index, :access_token => token_string
+        expect(response.status).to eq 401
+      end
+
+      it "does not allow into show action" do
+        get :show, :id => "4", :access_token => token_string
+        expect(response.status).to eq 401
+      end
+    end
+  end
+
+  context "defined only for index action" do
+    controller do
+      doorkeeper_for :index
+
+      include ControllerActions
+    end
+    include_examples "specified for particular actions"
+  end
+
+  context "defined for actions except index" do
+    controller do
+      doorkeeper_for :all, :except => :index
+
+      include ControllerActions
+    end
+
+    include_examples "specified with except"
+  end
+
+  context "defined with scopes" do
+    controller do
+      doorkeeper_for :all, :scopes => [:write]
+
+      include ControllerActions
+    end
+
+    let(:token_string) { "1A2DUWE" }
+
+    it "allows if the token has particular scopes" do
+      token = double(Doorkeeper::AccessToken, :accessible? => true, :scopes => [:write, :public])
+      Doorkeeper::AccessToken.should_receive(:authenticate).with(token_string).and_return(token)
+      get :index, :access_token => token_string
+      expect(response).to be_success
+    end
+
+    it "does not allow if the token does not include given scope" do
+      token = double(Doorkeeper::AccessToken, :accessible? => true, :scopes => [:public])
+      Doorkeeper::AccessToken.should_receive(:authenticate).with(token_string).and_return(token)
+      get :index, :access_token => token_string
+      expect(response.status).to eq 401
+    end
+  end
+
+  context "when custom unauthorized render options are configured" do
+    controller do
+      doorkeeper_for :all
+
+      include ControllerActions
+    end
+
+    context "with a JSON custom render", :token => :invalid do
+      before do
+        controller.should_receive(:doorkeeper_unauthorized_render_options).and_return({ :json => ActiveSupport::JSON.encode({ :error => "Unauthorized" })  } )
+      end
+
+      it "it renders a custom JSON response", :token => :invalid do
+        get :index, :access_token => token_string
+        expect(response.status).to eq 401
+        expect(response.content_type).to eq('application/json')
+        parsed_body = JSON.parse(response.body)
+        expect(parsed_body).not_to be_nil
+        expect(parsed_body['error']).to eq('Unauthorized')
+      end
+
+    end
+
+    context "with a text custom render", :token => :invalid do
+      before do
+        controller.should_receive(:doorkeeper_unauthorized_render_options).and_return({ :text => "Unauthorized"  } )
+      end
+
+      it "it renders a custom JSON response", :token => :invalid do
+        get :index, :access_token => token_string
+        expect(response.status).to eq 401
+        expect(response.content_type).to eq('text/html')
+        expect(response.body.should).to eq('Unauthorized')
+      end
+    end
+  end
+
+  context "when defined with conditional if block" do
+    controller do
+      doorkeeper_for :index, :if => lambda { the_false }
+      doorkeeper_for :show, :if => lambda { the_true }
+
+      include ControllerActions
+
+      private
+      def the_true
+        true
+      end
+
+      def the_false
+        false
+      end
+    end
+
+    context "with valid token", :token => :valid do
+      it "enables access if passed block evaluates to false" do
+        get :index, :access_token => token_string
+        expect(response).to be_success
+      end
+
+      it "enables access if passed block evaluates to true" do
+        get :show, :id => 1, :access_token => token_string
+        expect(response).to be_success
+      end
+    end
+
+    context "with invalid token", :token => :invalid do
+      it "enables access if passed block evaluates to false" do
+        get :index, :access_token => token_string
+        expect(response).to be_success
+      end
+
+      it "does not enable access if passed block evaluates to true" do
+        get :show, :id => 3, :access_token => token_string
+        expect(response.status).to eq 401
+      end
+    end
+  end
+
+  context "when defined with conditional unless block" do
+    controller do
+      doorkeeper_for :index, :unless => lambda { the_false }
+      doorkeeper_for :show, :unless => lambda { the_true }
+
+      include ControllerActions
+
+      def the_true
+        true
+      end
+
+      private
+
+      def the_false
+        false
+      end
+    end
+
+    context "with valid token", :token => :valid do
+      it "allows access if passed block evaluates to false" do
+        get :index, :access_token => token_string
+        expect(response).to be_success
+      end
+
+      it "allows access if passed block evaluates to true" do
+        get :show, :id => 1, :access_token => token_string
+        expect(response).to be_success
+      end
+    end
+
+    context "with invalid token", :token => :invalid do
+      it "does not allow access if passed block evaluates to false" do
+        get :index, :access_token => token_string
+      end
+
+      it "allows access if passed block evaluates to true" do
+        get :show, :id => 3, :access_token => token_string
+        expect(response).to be_success
+      end
+    end
+  end
+end