doorkeeper 0.3.0 → 0.4.0

data/spec/dummy/config/initializers/doorkeeper.rb

@@ -0,0 +1,41 @@
+Doorkeeper.configure do
+  # This block will be called to check whether the
+  # resource owner is authenticated or not
+  resource_owner_authenticator do |routes|
+    # Put your resource owner authentication logic here.
+    # If you want to use named routes from your app you need
+    # to call them on routes object eg.
+    # routes.new_user_session_path
+    # e.g. User.find_by_id(session[:user_id]) || redirect_to(routes.new_user_session_url)
+    User.find_by_id(session[:user_id]) || redirect_to(routes.root_url, :alert => "Needs sign in.")
+  end
+
+  # If you want to restrict the access to the web interface for
+  # adding oauth authorized applications you need to declare the
+  # block below
+  # admin_authenticator do |routes|
+  #   # Put your admin authentication logic here.
+  #   # If you want to use named routes from your app you need
+  #   # to call them on routes object eg.
+  #   # routes.new_admin_session_path
+  #   Admin.find_by_id(session[:admin_id]) || redirect_to(routes.new_admin_session_url)
+  # end
+
+  # 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
+
+  # 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 `HTTP_AUTHORIZATION` header and
+  # fallsback to `:client_id` and `:client_secret` from `params` object
+  # Check out the wiki for mor information on customization
+  # client_credentials :from_basic, :from_params
+end

data/spec/dummy/config/initializers/secret_token.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+Dummy::Application.config.secret_token = 'c00157b5a1bb6181792f0f4a8a080485de7bab9987e6cf159dc74c4f0573345c1bfa713b5d756e1491fc0b098567e8a619e2f8d268eda86a20a720d05d633780'

data/spec/dummy/config/initializers/session_store.rb

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+
+Dummy::Application.config.session_store :cookie_store, :key => '_dummy_session'
+
+# Use the database for sessions instead of the cookie-based default,
+# which shouldn't be used to store highly confidential information
+# (create the session table with "rails generate session_migration")
+# Dummy::Application.config.session_store :active_record_store

data/spec/dummy/config/initializers/wrap_parameters.rb

@@ -0,0 +1,14 @@
+# Be sure to restart your server when you modify this file.
+#
+# This file contains settings for ActionController::ParamsWrapper which
+# is enabled by default.
+
+# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters :format => [:json]
+end
+
+# Disable root element in JSON by default.
+ActiveSupport.on_load(:active_record) do
+  self.include_root_in_json = false
+end

data/spec/dummy/config/locales/doorkeeper.en.yml

@@ -0,0 +1,5 @@
+en:
+  doorkeeper:
+    scopes:
+      public: "Access your public data"
+      write:  "Update your data"

data/spec/dummy/config/routes.rb

@@ -0,0 +1,8 @@
+Rails.application.routes.draw do
+  mount Doorkeeper::Engine => "/oauth"
+  get '/callback', :to => "home#callback"
+  get '/sign_in',  :to => "home#sign_in"
+  resources :semi_protected_resources
+  resources :full_protected_resources
+  root :to => "home#index"
+end

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/spec/dummy/db/migrate/20111122132257_create_users.rb

@@ -0,0 +1,9 @@
+class CreateUsers < ActiveRecord::Migration
+  def change
+    create_table :users do |t|
+      t.string :name
+
+      t.timestamps
+    end
+  end
+end

data/spec/dummy/db/migrate/20120312140401_add_password_to_users.rb

@@ -0,0 +1,5 @@
+class AddPasswordToUsers < ActiveRecord::Migration
+  def change
+    add_column :users, :password_digest, :string
+  end
+end

data/spec/dummy/db/migrate/20120524202412_create_doorkeeper_tables.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/spec/dummy/db/schema.rb

@@ -0,0 +1,62 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+
+ActiveRecord::Schema.define(:version => 20120524202412) do
+
+  create_table "oauth_access_grants", :force => true 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"], :name => "index_oauth_access_grants_on_token", :unique => true
+
+  create_table "oauth_access_tokens", :force => true 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", ["refresh_token"], :name => "index_oauth_access_tokens_on_refresh_token", :unique => true
+  add_index "oauth_access_tokens", ["resource_owner_id"], :name => "index_oauth_access_tokens_on_resource_owner_id"
+  add_index "oauth_access_tokens", ["token"], :name => "index_oauth_access_tokens_on_token", :unique => true
+
+  create_table "oauth_applications", :force => true do |t|
+    t.string   "name",         :null => false
+    t.string   "uid",          :null => false
+    t.string   "secret",       :null => false
+    t.string   "redirect_uri", :null => false
+    t.datetime "created_at",   :null => false
+    t.datetime "updated_at",   :null => false
+  end
+
+  add_index "oauth_applications", ["uid"], :name => "index_oauth_applications_on_uid", :unique => true
+
+  create_table "users", :force => true do |t|
+    t.string   "name"
+    t.datetime "created_at",      :null => false
+    t.datetime "updated_at",      :null => false
+    t.string   "password_digest"
+  end
+
+end

data/spec/dummy/public/404.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <h1>The page you were looking for doesn't exist.</h1>
+    <p>You may have mistyped the address or the page may have moved.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/422.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <h1>The change you wanted was rejected.</h1>
+    <p>Maybe you tried to change something you didn't have access to.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/500.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <h1>We're sorry, but something went wrong.</h1>
+    <p>We've been notified about this issue and we'll take a look at it shortly.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/script/rails

@@ -0,0 +1,6 @@
+#!/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.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/spec/factories/access_grant.rb

@@ -0,0 +1,9 @@
+FactoryGirl.define do
+  factory :access_grant, :class => Doorkeeper::AccessGrant do
+    sequence(:resource_owner_id) { |n| n }
+    application
+    redirect_uri "https://app.com/callback"
+    expires_in 100
+    scopes "public write"
+  end
+end

data/spec/factories/access_token.rb

@@ -0,0 +1,7 @@
+FactoryGirl.define do
+  factory :access_token, :class => Doorkeeper::AccessToken do
+    sequence(:resource_owner_id) { |n| n }
+    application
+    expires_in 2.hours
+  end
+end

data/spec/factories/application.rb

@@ -0,0 +1,6 @@
+FactoryGirl.define do
+  factory :application, :class => Doorkeeper::Application do
+    sequence(:name){ |n| "Application #{n}" }
+    redirect_uri "https://app.com/callback"
+  end
+end

data/spec/generators/install_generator_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper_integration'
+require 'generators/doorkeeper/install_generator'
+
+
+describe 'Doorkeeper::InstallGenerator' do
+  include GeneratorSpec::TestCase
+
+  tests Doorkeeper::InstallGenerator
+  destination ::File.expand_path("../tmp/dummy", __FILE__)
+
+  describe "after running the generator" do
+    before :each do
+      prepare_destination
+      FileUtils.mkdir(::File.expand_path("config", Pathname(destination_root)))
+      FileUtils.copy_file(::File.expand_path("../templates/routes.rb", __FILE__), ::File.expand_path("config/routes.rb", Pathname.new(destination_root)))
+      run_generator
+    end
+
+    it "creates a migration" do
+      assert_migration "db/migrate/create_doorkeeper_tables.rb"
+    end
+
+    it "creates an initializer file" do
+      assert_file 'config/initializers/doorkeeper.rb'
+    end
+
+    it "copies the locale file" do
+      assert_file 'config/locales/doorkeeper.en.yml'
+    end
+
+    it "adds sample route" do
+      assert_file "config/routes.rb", /mount Doorkeeper::Engine/
+    end
+  end
+end

data/spec/generators/templates/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+
+end

data/spec/generators/views_generator_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper_integration'
+require 'generators/doorkeeper/views_generator'
+
+describe Doorkeeper::Generators::ViewsGenerator do
+  include GeneratorSpec::TestCase
+
+  tests Doorkeeper::Generators::ViewsGenerator
+  destination File.expand_path('../tmp/dummy', __FILE__)
+
+  before :each do
+    prepare_destination
+  end
+
+  it 'create all views' do
+    run_generator
+    assert_file 'app/views/doorkeeper/applications/_form.html.erb'
+    assert_file 'app/views/doorkeeper/applications/edit.html.erb'
+    assert_file 'app/views/doorkeeper/applications/index.html.erb'
+    assert_file 'app/views/doorkeeper/applications/new.html.erb'
+    assert_file 'app/views/doorkeeper/applications/show.html.erb'
+
+    assert_file 'app/views/doorkeeper/authorizations/error.html.erb'
+    assert_file 'app/views/doorkeeper/authorizations/new.html.erb'
+
+    assert_file 'app/views/doorkeeper/authorized_applications/index.html.erb'
+  end
+end

data/spec/lib/config_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper_integration'
+
+describe Doorkeeper, "configuration" do
+  subject { Doorkeeper.configuration }
+
+  describe "resource_owner_authenticator" do
+    it "sets the block that is accessible via authenticate_resource_owner" do
+      block = proc do end
+      Doorkeeper.configure do
+        resource_owner_authenticator &block
+      end
+      subject.authenticate_resource_owner.should == block
+    end
+  end
+
+  describe "admin_authenticator" do
+    it "sets the block that is accessible via authenticate_admin" do
+      block = proc do end
+      Doorkeeper.configure do
+        admin_authenticator &block
+      end
+      subject.authenticate_admin.should == block
+    end
+  end
+
+  describe "access_token_expires_in" do
+    it "has 2 hours by default" do
+      subject.access_token_expires_in.should == 2.hours
+    end
+
+    it "can change the value" do
+      Doorkeeper.configure do
+        access_token_expires_in 4.hours
+      end
+      subject.access_token_expires_in.should == 4.hours
+    end
+
+    it "can be set to nil" do
+      Doorkeeper.configure do
+        access_token_expires_in nil
+      end
+      subject.access_token_expires_in.should be_nil
+    end
+  end
+
+  describe "scopes" do
+    it "has default scopes" do
+      Doorkeeper.configure { default_scopes :public }
+      subject.default_scopes.should include(:public)
+    end
+
+    it 'has optional scopes' do
+      Doorkeeper.configure { optional_scopes :write, :update }
+      subject.optional_scopes.should include(:write, :update)
+    end
+
+    it 'has all scopes' do
+      Doorkeeper.configure do
+        default_scopes  :normal
+        optional_scopes :admin
+      end
+      subject.scopes.should include(:normal, :admin)
+    end
+  end
+
+  describe "use_refresh_token" do
+    it "is false by default" do
+      subject.refresh_token_enabled?.should be_false
+    end
+
+    it "can change the value" do
+      Doorkeeper.configure { use_refresh_token }
+      subject.refresh_token_enabled?.should be_true
+    end
+  end
+
+  describe 'client_credentials' do
+    it 'has defaults order' do
+      subject.client_credentials_methods.should == [:from_basic, :from_params]
+    end
+
+    it "can change the value" do
+      Doorkeeper.configure { client_credentials :from_digest, :from_params }
+      subject.client_credentials_methods.should == [:from_digest, :from_params]
+    end
+  end
+end

data/spec/lib/models/expirable_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+require 'timecop'
+require 'active_support/time'
+require 'doorkeeper/models/expirable'
+
+describe 'Expirable' do
+  subject do
+    Class.new do
+      include Doorkeeper::Models::Expirable
+    end.new
+  end
+
+  before do
+    subject.stub :created_at => 1.minute.ago
+  end
+
+  describe :expired? do
+    it "is not expired if time has not passed" do
+      subject.stub :expires_in => 2.minutes
+      subject.should_not be_expired
+    end
+
+    it "is expired if time has passed" do
+      subject.stub :expires_in => 10.seconds
+      subject.should be_expired
+    end
+
+    it "is not expired if expires_in is not set" do
+      subject.stub :expires_in => nil
+      subject.should_not be_expired
+    end
+  end
+
+  describe :time_left do
+    it "returns the time in seconds since it was created" do
+      Timecop.freeze(Time.now) do
+        subject.stub :created_at => Time.now, :expires_in => 10.seconds
+        subject.time_left.should == 10.seconds
+      end
+    end
+
+    it "returns 0 if token has expired" do
+      Timecop.freeze(Time.now + 1.minute) do
+        subject.stub :created_at => 1.minutes.ago, :expires_in => 10.seconds
+        subject.time_left.should == 0
+      end
+    end
+  end
+end

data/spec/lib/models/revocable_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+require 'active_support/core_ext/object/blank'
+require 'doorkeeper/models/revocable'
+
+describe 'Revocable' do
+  subject do
+    Class.new do
+      include Doorkeeper::Models::Revocable
+    end.new
+  end
+
+  describe :revoke do
+    it "updates :revoked_at attribute with current time" do
+      clock = double :now => stub
+      subject.should_receive(:update_attribute).with(:revoked_at, clock.now)
+      subject.revoke(clock)
+    end
+  end
+
+  describe :revoked? do
+    it "is revoked if :revoked_at is set" do
+      subject.stub :revoked_at => stub
+      subject.should be_revoked
+    end
+
+    it "is not revoked if :revoked_at is not set" do
+      subject.stub :revoked_at => nil
+      subject.should_not be_revoked
+    end
+  end
+end

data/spec/lib/models/scopes_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require 'active_support/core_ext/module/delegation'
+require 'doorkeeper/oauth/scopes'
+require 'doorkeeper/models/scopes'
+
+describe 'Doorkeeper::Models::Scopes' do
+  subject do
+    Class.new(Hash) do
+      include Doorkeeper::Models::Scopes
+    end.new
+  end
+
+  before do
+    subject[:scopes] = 'public admin'
+  end
+
+  describe :scopes do
+    it 'is a `Scopes` class' do
+      subject.scopes.should be_a(Doorkeeper::OAuth::Scopes)
+    end
+
+    it 'includes scopes' do
+      subject.scopes.should include(:public)
+    end
+  end
+
+  describe :scopes_string do
+    it 'is a `Scopes` class' do
+      subject.scopes_string.should == 'public admin'
+    end
+  end
+end