exvo-auth 0.13.0 → 0.14.0

data/README.md

@@ -78,6 +78,50 @@ class SessionsController < ApplicationController
 end
 ```
 
+It's good to have your SessionsController#create action a little more extended, so that each time the user logs in into the app, his user data (like email, nickname) is updated from auth (his profile):
+
+```ruby
+def create
+  auth = request.env["omniauth.auth"]
+
+  if user = User.find_by_uid(auth["uid"])
+    user.update_attributes!(auth["user_info"])
+  else
+    user = User.create(:uid => auth["uid"], :nickname => auth["user_info"]["nickname"], :email => auth["user_info"]["email"])
+  end
+
+  sign_in_and_redirect!
+end
+```
+
+This is what you get (and what you can use/save for the local user) from auth (example data as of 2011-12):
+
+```ruby
+request.env["omniauth.auth"].inspect
+
+  { "provider" => "exvo",
+    "uid" => 1,
+    "credentials" => {
+      "token" => "a2d09701559b9f26a8284d6f94670477d882ad6d9f3d92ce9917262a6b54085fa3fb99e111340459"
+    },
+    "user_info" => {
+      "nickname" => "Pawel",
+      "email" => "pawel@exvo.com"
+    },
+    "extra" => {
+      "user_hash" => {
+        "id" => 1,
+        "nickname" => "Pawel",
+        "country_code" => nil,
+        "plan" => "admin",
+        "language" => "en",
+        "email" => "pawel@exvo.com",
+        "referring_user_id" => nil
+      }
+    }
+  }
+```
+
 
 ## Implement `#find_or_create_user_by_uid(uid)` in your Application Controller
 
@@ -91,9 +135,7 @@ def find_or_create_user_by_uid(uid)
 end
 ```
 
-Additional info (emails, etc) can be obtained using auth api (`/users/uid.json` path).
-
-In short: you get `params[:auth]`. Do what you want to do with it: store the data, create session, etc.
+It's best to leave this method as it is (without updating any user data inside this method, better to do this in the SessionsController#create action). Updating user in this method might lead to some very hard to debug cyclic executions possibly leading to stack-level too deep errors and/or general slowness, so please proceed with extreme caution.
 
 
 ## Sign up and sign in paths for use in links
@@ -107,6 +149,19 @@ sign in path with a return address: "/auth/interactive?state=url"      # using O
 You have a handy methods available in controllers (and views in Rails): `sign_in_path` and `sign_up_path`.
 
 
+## Require authentication in your controllers
+
+In `application_controller` (for all controllers) or in some controller just add:
+
+```ruby
+before_filter :authenticate_user!
+```
+
+## Fetching user information
+
+All info about any particular user ca be obtained using auth api (`/users/uid.json` path).
+
+
 ## Read the source, there are few features not mentioned in this README
 
 

data/exvo-auth.gemspec

@@ -14,10 +14,10 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = ">= 1.3.6"
   s.rubyforge_project         = "exvo-auth"
 
-  s.add_dependency "oa-oauth",    "~> 0.0.4"
-  s.add_dependency "httparty",    "~> 0.6.1"
-  s.add_dependency "activemodel", "~> 3.0.0"
-  s.add_dependency "actionpack",  "~> 3.0.0"
+  s.add_dependency "oa-oauth", "~> 0.3.2"
+  s.add_dependency "httparty"
+  s.add_dependency "activemodel", "~> 3.0"
+  s.add_dependency "actionpack",  "~> 3.0"
 
   s.add_development_dependency "mocha"
   s.add_development_dependency "test-unit"

data/lib/exvo_auth/config.rb

@@ -66,10 +66,6 @@ module ExvoAuth::Config
     @@env = env
   end
 
-  def self.cfs_id
-    "fb0e7bd5864aa0186630212d800af8a6"
-  end
-
   private
 
   def self.default_opts

data/lib/exvo_auth/controllers/base.rb

@@ -17,7 +17,7 @@ module ExvoAuth::Controllers::Base
 
   # Usually this method is called from your sessions#create.
   def sign_in_and_redirect!
-    session[:user_uid] = request.env["rack.request.query_hash"]["auth"]["uid"]
+    session[:user_uid] = request.env["omniauth.auth"]["uid"]
 
     url = if params[:state] == "popup"
       ExvoAuth::Config.uri + "/close_popup.html"

data/lib/exvo_auth/strategies/base.rb

@@ -3,7 +3,8 @@ class ExvoAuth::Strategies::Base < OmniAuth::Strategies::OAuth2
     options[:site]          ||= ExvoAuth::Config.uri
     options[:client_id]     ||= ExvoAuth::Config.client_id
     options[:client_secret] ||= ExvoAuth::Config.client_secret
-    
+    options[:token_url]     ||= "/oauth/access_token"
+
     if options[:site].nil? || options[:client_id].nil? || options[:client_secret].nil?
       raise(ArgumentError, "Please configure uri, client_id and client_secret")
     end
@@ -12,7 +13,8 @@ class ExvoAuth::Strategies::Base < OmniAuth::Strategies::OAuth2
   end
   
   def user_data
-    @data ||= MultiJson.decode(@access_token.get('/user.json'))
+    @access_token.options.merge!({:param_name => :access_token, :mode => :query})
+    @data ||= MultiJson.decode(@access_token.get('/user.json').body)
   end
 
   def user_info
@@ -30,11 +32,4 @@ class ExvoAuth::Strategies::Base < OmniAuth::Strategies::OAuth2
       'extra'     => { 'user_hash' => user_data }
     })
   end
-  
-  protected
-  
-  # Have a better name? Let me know!
-  def unicorns_and_rainbows(hash)
-    hash.reject{|k, v| v.nil?}
-  end
 end

data/lib/exvo_auth/strategies/interactive.rb

@@ -3,11 +3,10 @@ class ExvoAuth::Strategies::Interactive < ExvoAuth::Strategies::Base
     super(app, :interactive, options)
   end
   
-  def request_phase(options = {})
-    super(unicorns_and_rainbows(
-      :scope     => request["scope"],
-      :state     => request["state"],
-      :x_sign_up => request["x_sign_up"]
-    ))
+  def request_phase
+    options[:scope] = request["scope"] if request["scope"]
+    options[:state] = request["state"] if request["state"]
+    options[:x_sign_up] = request["x_sign_up"] if request["x_sign_up"]
+    super
   end
 end

data/lib/exvo_auth/strategies/non_interactive.rb

@@ -3,12 +3,12 @@ class ExvoAuth::Strategies::NonInteractive < ExvoAuth::Strategies::Base
     super(app, :non_interactive, options)
   end
   
-  def request_phase(options = {})
-    redirect @client.non_interactive.authorize_url(unicorns_and_rainbows(
-      :redirect_uri => callback_url, 
-      :scope        => request["scope"], 
-      :state        => request["state"]
-    ))
+  def request_phase
+    options[:redirect_uri] = callback_url if callback_url
+    options[:scope] = request["scope"] if request["scope"]
+    options[:state] = request["state"] if request["state"]
+
+    redirect @client.non_interactive.authorize_url(options)
   end
   
   def callback_url

data/lib/exvo_auth/version.rb

@@ -1,3 +1,3 @@
 module ExvoAuth
-  VERSION = "0.13.0"
+  VERSION = "0.14.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: exvo-auth
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,55 +9,55 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-03 00:00:00.000000000Z
+date: 2011-12-09 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oa-oauth
-  requirement: &83727760 !ruby/object:Gem::Requirement
+  requirement: &85705040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 0.3.2
   type: :runtime
   prerelease: false
-  version_requirements: *83727760
+  version_requirements: *85705040
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &83727530 !ruby/object:Gem::Requirement
+  requirement: &85704480 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.6.1
+        version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *83727530
+  version_requirements: *85704480
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &83727300 !ruby/object:Gem::Requirement
+  requirement: &85703260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *83727300
+  version_requirements: *85703260
 - !ruby/object:Gem::Dependency
   name: actionpack
-  requirement: &83727070 !ruby/object:Gem::Requirement
+  requirement: &85702120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *83727070
+  version_requirements: *85702120
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &83726880 !ruby/object:Gem::Requirement
+  requirement: &85701560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *83726880
+  version_requirements: *85701560
 - !ruby/object:Gem::Dependency
   name: test-unit
-  requirement: &83726650 !ruby/object:Gem::Requirement
+  requirement: &85700790 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *83726650
+  version_requirements: *85700790
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &83726440 !ruby/object:Gem::Requirement
+  requirement: &85700500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *83726440
+  version_requirements: *85700500
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &83726230 !ruby/object:Gem::Requirement
+  requirement: &85699890 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *83726230
+  version_requirements: *85699890
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &83726020 !ruby/object:Gem::Requirement
+  requirement: &85698850 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *83726020
+  version_requirements: *85698850
 - !ruby/object:Gem::Dependency
   name: guard-test
-  requirement: &83725810 !ruby/object:Gem::Requirement
+  requirement: &85691120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *83725810
+  version_requirements: *85691120
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
-  requirement: &83725600 !ruby/object:Gem::Requirement
+  requirement: &85690210 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,10 +131,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *83725600
+  version_requirements: *85690210
 - !ruby/object:Gem::Dependency
   name: rb-inotify
-  requirement: &83725390 !ruby/object:Gem::Requirement
+  requirement: &85689050 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,7 +142,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *83725390
+  version_requirements: *85689050
 description: Sign in with Exvo account
 email:
 - jacek.becela@gmail.com
@@ -169,7 +169,6 @@ files:
 - lib/exvo_auth/dejavu.rb
 - lib/exvo_auth/middleware.rb
 - lib/exvo_auth/models/message.rb
-- lib/exvo_auth/models/sharing.rb
 - lib/exvo_auth/oauth2.rb
 - lib/exvo_auth/session_store.rb
 - lib/exvo_auth/strategies/base.rb

data/lib/exvo_auth/models/sharing.rb

@@ -1,20 +0,0 @@
-# TODO: activemodel with validations
-class ExvoAuth::Models::Sharing
-  def self.create(attrs = {})
-    new(attrs).save
-  end
-
-  protected
-  
-  def save
-    if true
-      cfs.post("/sharings", :query => { :document_id => attrs[:document_id], :sharing => { :email => attrs[:email], :user_uid => attrs[:user_uid] } })
-    else
-      # TODO: append errors on errors from cfs too.
-    end
-  end
-
-  def cfs
-    @cfs ||= Autonomous::Consumer.new(:app_id => Config.cfs_id)
-  end
-end