exvo-auth 0.5.2 → 0.6.0

data/README

@@ -1,3 +1,6 @@
+OAuth2
+======
+
 -1. Get familiar with OmniAuth by Intridea: http://github.com/intridea/omniauth. Read about OAuth2.
 
 
@@ -14,10 +17,12 @@ There are two middlewares. Usually you will need the "interactive" one:
   ExvoAuth::Strategies::Interactive
   ExvoAuth::Strategies::NonInteractive
   
-Both middlewares need client_id and client_secret arguments.
-In Rails, the relevant line could look like this:
+Both middlewares need client_id and client_secret configured.
+In Rails, the relevant lines could look like this:
 
-  config.middleware.use ExvoAuth::Strategies::Interactive, :client_id => "client_id, :client_secret => "client_secret"
+  ExvoAuth::Config.client_id     = "foo"
+  ExvoAuth::Config.client_secret = "bar" 
+  config.middleware.use ExvoAuth::Strategies::Interactive
 
     
 3. Add routes.
@@ -33,6 +38,13 @@ You can have separate callbacks for interactive and non-interactive
 callback routes but you can also route both callbacks to the same controller method
 like shown above.
 
+You also need a root_url route defined in routes (Rails) or this little hack (Merb):
+
+Merb::Controller.class_eval do
+  def root_url
+    absolute_url("/foo") # probably a "/"
+  end
+end
 
 4. Include controller helpers into your application controller.
 
@@ -66,3 +78,28 @@ In short: you get params[:auth]. Do what you want to do with it: store the data,
 
 
 6. Read the source, there are few features not mentioned in this README.
+
+
+Inter-Application Communication
+===============================
+
+
+# Consumer side
+
+consumer = ExvoAuth::Autonomous::Consumer.new(
+  :provider_id => "this is client_id of the app you want to connect to"
+)
+consumer.access_token => "this is the access token to use along with your client_id to communicate with providing app"
+
+
+# Provider side
+
+provider = ExvoAuth::Autonomous::Provider.new(
+  :consumer_id   => "the client_id of the consuming app",
+  :access_token  => "the access_token of the consuming app"
+)
+provider.scopes => ["users", "payments"] # example access scopes defined in auth server.
+
+Scopes are used by providing app to check if a given consuming app should have access to a given resource inside a scope.
+If scopes are empty, then provider app should not present any resources to consumer.
+

data/Rakefile

@@ -10,6 +10,7 @@ begin
     gem.homepage = "http://github.com/Exvo/Auth"
     gem.authors = ["Jacek Becela"]
     gem.add_dependency "oa-oauth", "0.0.1"
+    gem.add_dependency "httparty", "0.6.1"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.5.2
+0.6.0

data/exvo-auth.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{exvo-auth}
-  s.version = "0.5.2"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jacek Becela"]
-  s.date = %q{2010-07-15}
+  s.date = %q{2010-07-19}
   s.description = %q{Sign in with Exvo account}
   s.email = %q{jacek.becela@gmail.com}
   s.extra_rdoc_files = [
@@ -26,6 +26,9 @@ Gem::Specification.new do |s|
      "VERSION",
      "exvo-auth.gemspec",
      "lib/exvo-auth.rb",
+     "lib/exvo_auth/autonomous/cache.rb",
+     "lib/exvo_auth/autonomous/consumer.rb",
+     "lib/exvo_auth/autonomous/provider.rb",
      "lib/exvo_auth/config.rb",
      "lib/exvo_auth/controllers/base.rb",
      "lib/exvo_auth/controllers/merb.rb",
@@ -53,11 +56,14 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<oa-oauth>, ["= 0.0.1"])
+      s.add_runtime_dependency(%q<httparty>, ["= 0.6.1"])
     else
       s.add_dependency(%q<oa-oauth>, ["= 0.0.1"])
+      s.add_dependency(%q<httparty>, ["= 0.6.1"])
     end
   else
     s.add_dependency(%q<oa-oauth>, ["= 0.0.1"])
+    s.add_dependency(%q<httparty>, ["= 0.6.1"])
   end
 end
 

data/lib/exvo-auth.rb

@@ -1,15 +1,10 @@
 require 'omniauth/oauth'
 require 'multi_json'
+require 'httparty'
 
 module ExvoAuth
   autoload :Config, 'exvo_auth/config'
   
-  module OAuth2
-    module Strategy
-      autoload :NonInteractive, 'exvo_auth/oauth2'
-    end
-  end
-
   module Strategies
     autoload :Base,           'exvo_auth/strategies/base'
     autoload :Interactive,    'exvo_auth/strategies/interactive'
@@ -21,6 +16,18 @@ module ExvoAuth
     autoload :Rails, 'exvo_auth/controllers/rails'
     autoload :Merb,  'exvo_auth/controllers/merb'
   end
+  
+  module Autonomous
+    autoload :Consumer, 'exvo_auth/autonomous/consumer'
+    autoload :Provider, 'exvo_auth/autonomous/provider'
+    autoload :Cache,    'exvo_auth/autonomous/cache'
+  end
+  
+  module OAuth2
+    module Strategy
+      autoload :NonInteractive, 'exvo_auth/oauth2'
+    end
+  end
 end
 
 OAuth2::Client.class_eval do

data/lib/exvo_auth/autonomous/cache.rb

@@ -0,0 +1,21 @@
+class ExvoAuth::Autonomous::Cache
+  def initialize
+    @data = {}
+  end
+  
+  def read(key)
+    @data[key]
+  end
+  
+  def write(key, value)
+    @data[key] = value
+  end
+  
+  def fetch(key)
+    if block_given?
+      read(key) || write(key, yield)
+    else
+      read(key)
+    end
+  end
+end

data/lib/exvo_auth/autonomous/consumer.rb

@@ -0,0 +1,34 @@
+class ExvoAuth::Autonomous::Consumer
+  attr_reader :options
+  @@cache = ExvoAuth::Autonomous::Cache.new
+  
+  def initialize(options = {})
+    options[:site]          ||= ExvoAuth::Config.host
+    options[:client_id]     ||= ExvoAuth::Config.client_id
+    options[:client_secret] ||= ExvoAuth::Config.client_secret
+    
+    if options[:site].nil? || options[:client_id].nil? || options[:client_secret].nil? || options[:provider_id].nil?
+      raise(ArgumentError, "Please configure site, client_id, client_secret and provider_id")
+    end
+
+    @options = options
+  end
+  
+  def access_token
+    @@cache.fetch(options) do
+      access_token!
+    end
+  end
+  
+  def access_token!
+    response = HTTParty.get("/apps/consumer/authorizations/#{options[:provider_id]}.json", 
+      :base_uri   => options[:site], 
+      :basic_auth => { 
+        :username => options[:client_id],
+        :password => options[:client_secret]
+      }
+    )
+    
+    @@cache.write(options, response["access_token"])
+  end
+end

data/lib/exvo_auth/autonomous/provider.rb

@@ -0,0 +1,35 @@
+class ExvoAuth::Autonomous::Provider
+  attr_reader :options
+  @@cache = ExvoAuth::Autonomous::Cache.new
+  
+  def initialize(options = {})
+    options[:site]          ||= ExvoAuth::Config.host
+    options[:client_id]     ||= ExvoAuth::Config.client_id
+    options[:client_secret] ||= ExvoAuth::Config.client_secret
+
+    if options[:site].nil? || options[:client_id].nil? || options[:client_secret].nil? || options[:consumer_id].nil? || options[:access_token].nil?
+      raise(ArgumentError, "Please configure site, client_id, client_secret, consumer_id and access_token")
+    end
+
+    @options = options
+  end
+  
+  def scopes
+    @@cache.fetch(options) do
+      scopes!
+    end
+  end
+  
+  def scopes!
+    response = HTTParty.get("/apps/provider/authorizations/#{options[:consumer_id]}.json",
+      :base_uri   => options[:site], 
+      :basic_auth => { 
+        :username => options[:client_id],
+        :password => options[:client_secret]
+      },
+      :query => { :access_token => options[:access_token] }
+    )
+
+    @@cache.write(options, response["scope"].to_s.split)
+  end
+end

data/lib/exvo_auth/controllers/base.rb

@@ -19,10 +19,6 @@ module ExvoAuth::Controllers::Base
     end
   end
 
-  # If there's no stored location then it's a popup login.
-  # If there's a stored location then it's a redirect login 
-  # caused by #authenticate_user! method.
-  #
   # Usually this method is called from your sessions#create.
   def sign_in_and_redirect!(user_id)
     session[:user_id] = user_id

data/lib/exvo_auth/controllers/rails.rb

@@ -7,6 +7,17 @@ module ExvoAuth::Controllers::Rails
     
   module InstanceMethods
     protected
+    
+    def authenticate_app_in_scope!(scope)
+      authenticate_or_request_with_http_basic do |consumer_id, access_token|
+        @current_scopes = ExvoAuth::Autonomous::Provider.new(
+          :consumer_id  => consumer_id, 
+          :access_token => access_token
+        ).scopes
+        
+        @current_scopes.include?(scope)
+      end
+    end
 
     def find_user_by_id(id)
       User.find(id)

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 5
-  - 2
-  version: 0.5.2
+  - 6
+  - 0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Jacek Becela
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-15 00:00:00 +02:00
+date: 2010-07-19 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -31,6 +31,20 @@ dependencies:
         version: 0.0.1
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 1
+        version: 0.6.1
+  type: :runtime
+  version_requirements: *id002
 description: Sign in with Exvo account
 email: jacek.becela@gmail.com
 executables: []
@@ -50,6 +64,9 @@ files:
 - VERSION
 - exvo-auth.gemspec
 - lib/exvo-auth.rb
+- lib/exvo_auth/autonomous/cache.rb
+- lib/exvo_auth/autonomous/consumer.rb
+- lib/exvo_auth/autonomous/provider.rb
 - lib/exvo_auth/config.rb
 - lib/exvo_auth/controllers/base.rb
 - lib/exvo_auth/controllers/merb.rb