rack-oauth2_utils 0.0.1 → 0.0.3

data/Gemfile

@@ -1,28 +1,9 @@
 source "http://rubygems.org"
 
 # Specify your gem's dependencies in rack-oauth2_utils.gemspec
-#gemspec
-
-gem 'rack'
+gemspec
 
 group :test do
   gem 'minitest'
   gem "rack-test"
 end
-
-# use Rack::OAuth2::Access::Middleware, :store => Rack::OAuth2::Access::MemoryStore
-# 
-# 
-# run App
-# 
-# before do
-#   
-# end
-# 
-# Rack::OAuth2::Access::AppHelpers
-# 
-# before do
-#   account = Account.find(oauth.identity)
-# end
-# 
-# get '/' do

data/README.mkd

@@ -5,46 +5,54 @@ Simple Rack middleware that catches OAuth2 access tokens and validates identity
 This gem only covers the simple use of "using a token". You must implement the authorization and "getting a token" part in your app.
 
 ## USAGE
-
-    class API < Sinatra::Base
-      use Rack::OAuth2Utils::Middleware, :store => SomeKeyValueStore
-      
-      helpers do
-          
-        def authorized?
-          !!identity
-        end
-        
-        def identity
-         requets.env['oauth.identity']
-        end
-        
-        def current_account
-         Account.find(identity) if authorized?
-        end
-         
-      end
-      
-      get '/private' do
-        if authorized?
-          content_type 'application/json'
-          current_account.to_json
-        else
-          halt 403, 'Access forbidden'
-        end
-      end
+```ruby
+class API < Sinatra::Base
+
+  use Rack::OAuth2Utils::Middleware do |access_token|
+    AccessToken.find_by_token(access_token).try :account_id
+  end
+  
+  helpers do
       
+    def authorized?
+      !!identity
     end
     
-:store is anything that responds to [], []= and delete. Can be Redis, PStore, some ORM wrapper, etc.
-
-Store is expected to store access_tokens mapped to some identity string (for example account IDs).
+    def identity
+     requets.env['oauth.identity']
+    end
+    
+    def current_account
+     Account.find(identity) if authorized?
+    end
+     
+  end
+  
+  get '/private' do
+    if authorized?
+      content_type 'application/json'
+      current_account.to_json
+    else
+      halt 403, 'Access forbidden'
+    end
+  end
+  
+end
+```
+    
+Rack::OAuth2Utils::Middleware takes a block with the request's access token. YOu can use it to resolve it to an identity string (ie a user or account id).
 
 There is a test store based on PStore (filesystem. Do no use in production):
 
-    store = Rack::OAuth2Utils::TestStore.new('tmp/access_tokens.store')
-    
-    store['some_access_token'] = 'some_account_id'
+```ruby
+STORE = Rack::OAuth2Utils::TestStore.new('tmp/access_tokens.store')
+
+STORE['foobar'] = 'some_identity'
+
+use Rack::OAuth2Utils::Middleware do |access_token|
+  STORE[access_token]
+end
+```
 
 It is up to you how you store tokens and identities. 
 

data/lib/rack-oauth2_utils/middleware.rb

@@ -3,13 +3,11 @@ module Rack
     
     class Middleware
       
-      attr_reader :store
-      
-      def initialize(app, options = {})
+      def initialize(app, options = {}, &resolver)
         @app = app
-        @store = options[:store] || {}
         @realm = options[:realm]
         @logger = options[:logger]
+        @resolver = resolver
       end
       
       def call(env)
@@ -20,7 +18,7 @@ module Rack
         return @app.call(env) unless request.oauth?
         
         # Fetch identity
-        if identity = store[request.access_token] # identity found, forward to backend
+        if identity = @resolver.call(request.access_token) # identity found, forward to backend
           env["oauth.identity"] = identity
           logger.info "RO2U: Authorized #{identity}" if logger
         else # invalid token

data/lib/rack-oauth2_utils/oauth_request.rb

@@ -22,7 +22,7 @@ module Rack
       end
       
       def authorization_param
-        @authorization_param ||= self.GET['oauth_token']
+        @authorization_param ||= self.GET['access_token']
       end
 
       # True if authentication scheme is OAuth.

data/lib/rack-oauth2_utils/version.rb

@@ -1,5 +1,5 @@
 module Rack
   module OAuth2Utils
-    VERSION = "0.0.1"
+    VERSION = "0.0.3"
   end
 end

data/test/middleware_test.rb

@@ -7,14 +7,19 @@ describe Rack::OAuth2Utils::Middleware do
   OK_RESPONSE = [200, {'Content-Type' => 'text/plain'}, ['Hello world']]
   FORBIDDEN_RESPONSE = [403, {'Content-Type' => 'text/plain'}, ['Nono']]
   
+  IDENTITIES = {
+    # token      # identity
+    'aaaaa'   => 'ismasan',
+    'bbbbb'   => 'sachi'
+  }
+  
   def app
     @app ||= Rack::Builder.new do
       # Simple token / identity store
-      use Rack::OAuth2Utils::Middleware, :store => {
-        # token      # identity
-        'aaaaa'   => 'ismasan',
-        'bbbbb'   => 'sachi'
-      }
+      use Rack::OAuth2Utils::Middleware do |access_token|
+        IDENTITIES[access_token]
+      end
+      
       # Public endpoint
       map('/public'){
         run lambda {|env| OK_RESPONSE } 
@@ -122,7 +127,7 @@ describe Rack::OAuth2Utils::Middleware do
   end
   
   describe 'with valid token as query param' do
-    before {get '/private', 'oauth_token' => 'aaaaa'}
+    before {get '/private', 'access_token' => 'aaaaa'}
     
     it 'should return 200 Ok' do
       last_response.status.must_equal 200

metadata

@@ -1,61 +1,57 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rack-oauth2_utils
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.0.3
   prerelease: 
-  version: 0.0.1
 platform: ruby
-authors: 
+authors:
 - Ismael Celis
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-07-07 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-12-03 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rack
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2152747200 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.2.2
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: bundler
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2152747200
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2152738640 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: minitest
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2152738640
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &2152737980 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-description: Simple Rack middleware that catches OAuth2 access tokens and validates identity
-email: 
+  prerelease: false
+  version_requirements: *2152737980
+description: Simple Rack middleware that catches OAuth2 access tokens and validates
+  identity
+email:
 - ismaelct@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - README.mkd
@@ -68,34 +64,30 @@ files:
 - rack-oauth2_utils.gemspec
 - test/middleware_test.rb
 - test/test_helper.rb
-has_rdoc: true
-homepage: ""
+homepage: ''
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: rack-oauth2_utils
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Middleware for catching OAuth2 access tokens in Rack apps
-test_files: 
+test_files:
 - test/middleware_test.rb
 - test/test_helper.rb