doorkeeper 0.1.0 → 0.1.1

data/README.md

@@ -2,20 +2,19 @@
 
 [![Build Status](https://secure.travis-ci.org/applicake/doorkeeper.png)](http://travis-ci.org/applicake/doorkeeper)
 
-Doorkeeper is a gem that makes it easy to introduce oauth2 provider
-functionality to your application.
+Doorkeeper is a gem that makes it easy to introduce OAuth 2 provider functionality to your application.
 
-So far it supports only Authorization Code
-flow, but we will gradually introduce other flows.
+So far it supports only Authorization Code flow, but we will [gradually introduce other flows](https://github.com/applicake/doorkeeper/wiki/Supported-Features).
 
-For more information about Oauth2 go to
-[Oauth2 Specs (Draft)](http://tools.ietf.org/html/draft-ietf-oauth-v2-22)
+For more information about OAuth 2 go to [OAuth 2 Specs (Draft)](http://tools.ietf.org/html/draft-ietf-oauth-v2-22).
 
 ## Installation
 
 Put this in your Gemfile:
 
-    gem 'doorkeeper'
+``` ruby
+gem 'doorkeeper'
+```
 
 Run the installation generator with:
 
@@ -29,10 +28,12 @@ This will generate the doorkeeper initializer and the oauth tables migration. Do
 
 The installation will mount the Doorkeeper routes to your app like this:
 
-    Rails.application.routes.draw do
-      mount Doorkeeper::Engine => "/oauth"
-      # your routes
-    end
+``` ruby
+Rails.application.routes.draw do
+  mount Doorkeeper::Engine => "/oauth"
+  # your routes
+end
+```
 
 This will mount following routes:
 
@@ -44,63 +45,77 @@ This will mount following routes:
 
 You need to configure Doorkeeper in order to provide resource_owner model and authentication block `initializers/doorkeeper.rb`
 
-    Doorkeeper.configure do
-      resource_owner_authenticator do |routes|
-        current_user || redirect_to('/sign_in', :alert => "Needs sign in.") # returns nil if current_user is not logged in
-      end
-    end
+``` ruby
+Doorkeeper.configure do
+  resource_owner_authenticator do |routes|
+    current_user || redirect_to('/sign_in', :alert => "Needs sign in.") # returns nil if current_user is not logged in
+  end
+end
+```
 
 If you use devise, you may want to use warden to authenticate the block:
 
-    resource_owner_authenticator do |routes|
-      current_user || warden.authenticate!(:scope => :user)
-    end
+``` ruby
+resource_owner_authenticator do |routes|
+  current_user || warden.authenticate!(:scope => :user)
+end
+```
 
 ## Protecting resources (a.k.a your API endpoint)
 
-In the controller add the before_filter to authorize the token
+In your api controller, add the `doorkeeper_for` to require the oauth token:
 
-    class ProtectedResourcesController < ApplicationController
-      doorkeeper_for :all # For all actions
-      doorkeeper_for :only   => :index # Require token only for index action
-      doorkeeper_for :except => :show  # Require token for all actions except show
-    end
+``` ruby
+class Api::V1::ProtectedResourcesController < Api::V1::ApiController
+  doorkeeper_for :all              # Require access token for all actions
+  doorkeeper_for :only   => :index # Only for index action
+  doorkeeper_for :except => :show  # All actions except show
 
-## Creating and using client applications
+  # your actions
+end
+```
 
-To start using OAuth 2 as a client first fire up the server with `rails server`, go to `/oauth/applications` and create an application for your client.
+You don't need to setup any before filter, `doorkeeper_for` will handle that for you.
 
-Choose a name and a callback url for it. If you use oauth2 gem you can specify your just generated client as:
+## Authenticated resource owner
 
-    require 'oauth2'
-    client_id     = '...' # your client's id
-    client_secret = '...' # your client's secret
-    redirect_uri  = '...' # your client's redirect uri
-    client = OAuth2::Client.new(
-      client_id,
-      client_secret,
-      :site => "http://localhost:3000"
-    )
+If you want to return data based on the current resource owner for example, the access token user credentials, you'll need to define a method in your controller to return the resource owner instance:
 
-If you changed the default mount path `/oauth` in your `routes.rb` you need to specify it in the oauth client as `:authorize_url` and `:token_url`. For more information, check the oauth2 gem documentation.
+``` ruby
+class Api::V1::CredentialsController < Api::V1::ApiController
+  doorkeeper_for :all
+  respond_to     :json
 
-After that you can try to request an authorization code with the oauth2 gem as follow:
+  # GET /api/v1/me.json
+  def me
+    respond_with current_resource_owner
+  end
 
-    client.auth_code.authorize_url(:redirect_uri => redirect_uri)
-    # => http://localhost:3000/oauth/authorize?response_type=code&client_id=...&redirect_uri=...
+  private
 
-If you visit the returned url, you'll see a screen to authorize your app. Click on `authorize` and you'll be redirected to your client redirect url.
+  # Find the user that owns the access token
+  def current_resource_owner
+    User.find(doorkeeper_token.resource_owner_id) if doorkeeper_token
+  end
+end
+```
 
-Grab the code from the redirect url and request a access token with the following:
+## Other resources
 
-    token = client.auth_code.get_token(parms[:code], :redirect_uri => redirect_uri)
+### Live demo
 
-You now have an access token to access you protected resources.
+Check out this [live demo](http://doorkeeper-provider.herokuapp.com) hosted on heroku. For more demos check out [the wiki](https://github.com/applicake/doorkeeper/wiki/Example-Applications).
 
-## Contributing/Development
+### Client applications
 
-Check our [contributing guidelines page in the wiki](https://github.com/applicake/doorkeeper/wiki/Contributing)
+After you set up the provider, you may want to create a client application to test the integration. Check out these [client examples](https://github.com/applicake/doorkeeper/wiki/Example-Applications) in our wiki or follow this [tutorial here](https://github.com/applicake/doorkeeper/wiki/Testing-your-provider-with-OAuth2-gem).
 
-## Supported ruby versions
+### Contributing/Development
+
+Want to contribute and don't know where to start? Check out [features we're missing](https://github.com/applicake/doorkeeper/wiki/Supported-Features), create [example apps](https://github.com/applicake/doorkeeper/wiki/Example-Applications), integrate the gem with your app and let us know!
+
+Also, check out our [contributing guidelines page](https://github.com/applicake/doorkeeper/wiki/Contributing).
+
+### Supported ruby versions
 
 All supported ruby versions are [listed here](https://github.com/applicake/doorkeeper/wiki/Supported-Ruby-versions)

data/app/assets/stylesheets/doorkeeper/application.css

@@ -3,5 +3,13 @@
  * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
  * the top of the compiled file, but it's generally better to create a new file per style scope.
  *= require_self
- *= require_tree . 
-*/
+ *= require_tree .
+*/
+
+body {
+  padding-top: 60px;
+}
+
+.inline_block {
+  display: inline-block;
+}

data/app/controllers/doorkeeper/application_controller.rbc

@@ -0,0 +1,663 @@
+!RBIX
+9595534255132031488
+x
+M
+1
+n
+n
+x
+10
+__script__
+i
+28
+99
+7
+0
+65
+49
+1
+2
+13
+99
+12
+7
+2
+12
+7
+3
+12
+65
+12
+49
+4
+4
+15
+49
+2
+0
+15
+2
+11
+I
+6
+I
+0
+I
+0
+I
+0
+n
+p
+5
+x
+10
+Doorkeeper
+x
+11
+open_module
+x
+15
+__module_init__
+M
+1
+n
+n
+x
+10
+Doorkeeper
+i
+33
+5
+66
+99
+7
+0
+45
+1
+2
+43
+3
+65
+49
+4
+3
+13
+99
+12
+7
+5
+12
+7
+6
+12
+65
+12
+49
+7
+4
+15
+49
+5
+0
+11
+I
+6
+I
+0
+I
+0
+I
+0
+n
+p
+8
+x
+21
+ApplicationController
+x
+16
+ActionController
+n
+x
+4
+Base
+x
+10
+open_class
+x
+14
+__class_init__
+M
+1
+n
+n
+x
+21
+ApplicationController
+i
+62
+5
+66
+5
+48
+0
+15
+99
+7
+1
+7
+2
+65
+67
+49
+3
+0
+49
+4
+4
+15
+99
+7
+5
+7
+6
+65
+67
+49
+3
+0
+49
+4
+4
+15
+99
+7
+7
+7
+8
+65
+67
+49
+3
+0
+49
+4
+4
+15
+99
+7
+9
+7
+10
+65
+67
+49
+3
+0
+49
+4
+4
+11
+I
+5
+I
+0
+I
+0
+I
+0
+n
+p
+11
+x
+7
+private
+x
+28
+authenticate_resource_owner!
+M
+1
+n
+n
+x
+28
+authenticate_resource_owner!
+i
+4
+5
+48
+0
+11
+I
+1
+I
+0
+I
+0
+I
+0
+n
+p
+1
+x
+22
+current_resource_owner
+p
+5
+I
+-1
+I
+5
+I
+0
+I
+6
+I
+4
+x
+92
+/Users/felipeelias/Applicake/doorkeeper/app/controllers/doorkeeper/application_controller.rb
+p
+0
+x
+17
+method_visibility
+x
+15
+add_defn_method
+x
+22
+current_resource_owner
+M
+1
+n
+n
+x
+22
+current_resource_owner
+i
+26
+5
+5
+48
+0
+45
+1
+2
+49
+3
+0
+13
+70
+10
+21
+44
+43
+4
+12
+49
+5
+1
+47
+50
+6
+1
+11
+I
+4
+I
+0
+I
+0
+I
+0
+n
+p
+7
+x
+8
+main_app
+x
+10
+Doorkeeper
+n
+x
+27
+authenticate_resource_owner
+x
+4
+Proc
+x
+14
+__from_block__
+x
+13
+instance_exec
+p
+5
+I
+-1
+I
+9
+I
+0
+I
+a
+I
+1a
+x
+92
+/Users/felipeelias/Applicake/doorkeeper/app/controllers/doorkeeper/application_controller.rb
+p
+0
+x
+19
+authenticate_admin!
+M
+1
+n
+n
+x
+19
+authenticate_admin!
+i
+35
+45
+0
+1
+49
+2
+0
+19
+0
+9
+33
+5
+5
+48
+3
+20
+0
+13
+70
+10
+27
+44
+43
+4
+12
+49
+5
+1
+47
+50
+6
+1
+8
+34
+1
+11
+I
+5
+I
+1
+I
+0
+I
+0
+n
+p
+7
+x
+10
+Doorkeeper
+n
+x
+18
+authenticate_admin
+x
+8
+main_app
+x
+4
+Proc
+x
+14
+__from_block__
+x
+13
+instance_exec
+p
+11
+I
+-1
+I
+d
+I
+0
+I
+e
+I
+a
+I
+f
+I
+21
+I
+e
+I
+22
+I
+0
+I
+23
+x
+92
+/Users/felipeelias/Applicake/doorkeeper/app/controllers/doorkeeper/application_controller.rb
+p
+1
+x
+5
+block
+x
+14
+method_missing
+M
+1
+n
+n
+x
+14
+method_missing
+i
+51
+95
+19
+2
+15
+20
+0
+7
+0
+13
+70
+9
+24
+15
+44
+43
+1
+7
+2
+78
+49
+3
+2
+6
+0
+49
+4
+1
+9
+47
+5
+7
+5
+20
+0
+47
+101
+6
+7
+7
+63
+3
+47
+49
+8
+1
+8
+50
+54
+89
+9
+11
+I
+7
+I
+3
+I
+1
+I
+1
+I
+1
+p
+10
+n
+x
+6
+Regexp
+s
+12
+_(url|path)$
+x
+3
+new
+x
+2
+=~
+s
+61
+Your path has not been found. Didn't you mean to call routes.
+x
+4
+to_s
+s
+36
+ in doorkeeper configuration blocks?
+x
+5
+raise
+x
+14
+method_missing
+p
+11
+I
+-1
+I
+13
+I
+4
+I
+14
+I
+1d
+I
+15
+I
+2f
+I
+17
+I
+32
+I
+0
+I
+33
+x
+92
+/Users/felipeelias/Applicake/doorkeeper/app/controllers/doorkeeper/application_controller.rb
+p
+3
+x
+6
+method
+x
+4
+args
+x
+5
+block
+p
+11
+I
+2
+I
+3
+I
+6
+I
+5
+I
+14
+I
+9
+I
+22
+I
+d
+I
+30
+I
+13
+I
+3e
+x
+92
+/Users/felipeelias/Applicake/doorkeeper/app/controllers/doorkeeper/application_controller.rb
+p
+0
+x
+13
+attach_method
+p
+3
+I
+2
+I
+2
+I
+21
+x
+92
+/Users/felipeelias/Applicake/doorkeeper/app/controllers/doorkeeper/application_controller.rb
+p
+0
+x
+13
+attach_method
+p
+3
+I
+0
+I
+1
+I
+1c
+x
+92
+/Users/felipeelias/Applicake/doorkeeper/app/controllers/doorkeeper/application_controller.rb
+p
+0