rpx_now 0.6.17 → 0.6.18

data/README.markdown

@@ -1,23 +1,19 @@
-Problem
-=======
- - OpenID is complex, limited and hard to use for users
- - Facebook / Twitter / Myspace / Google / MS-LiveId / AOL connections require different libraries and knowledge
- - Multiple heterogenouse providers are hard to map to a single user
+[RPX](http://rpxnow.com) allows users to login to your page through Facebook / Twitter / Myspace / Google / OpenId / MS-LiveId / AOL / ...
 
-Solution
-========
- - Use [RPX](http://rpxnow.com) for universal and usable user login
- - Use view/controller helpers for easy integration
+ - Simpler then OpenId/OAuth/xxx for developers AND users
+ - Publish user activity to facebook/twitter/myspace/.../-stream
+ - Returning users are greeted by their provider
 
-![Single Interface for all providers](https://rpxnow.com/images/how_diagram.png)
-![Visitors choose from providers they already have](https://rpxnow.com/images/6providers.png?2)
+![Single Interface for all providers](https://s3.amazonaws.com/static.rpxnow.com/rel/img/a481ed2afccd255350cccd738050f873.png)
+![Share comments and activities](https://s3.amazonaws.com/static.rpxnow.com/rel/img/50bdccdb32b6ae68d46908a531492b28.png)
+![Visitors choose from providers they already have](https://s3.amazonaws.com/static.rpxnow.com/rel/img/f4a6e65808eefcf8754588c71f84c142.png)
 
 Usage
 =====
  - Get an API key @ [RPX](http://rpxnow.com)
  - run [MIGRATION](http://github.com/grosser/rpx_now/raw/master/MIGRATION)
  - Build login view
- - Communicate with RPX API in controller to create or login User
+ - Receive user-data from RPX to create or login User
  - for more advanced features have a look at the [RPX API Docs](https://rpxnow.com/docs)
 
 Install
@@ -71,25 +67,25 @@ Controller
       redirect_to '/'
     end
 
-    # getting additional fields (these fields are rarely filled)
+    # getting additional profile fields (these fields are rarely filled)
     # all possibilities: https://rpxnow.com/docs#profile_data
     data = RPXNow.user_data(params[:token], :additional => [:gender, :birthday, :photo, :providerName, ...])
 
-    # including raw profile data
-    RPXNow.user_data(params[:token], :additional => [:raw])[:raw]['verifiedEmail']
+    # normal + raw data
+    RPXNow.user_data(params[:token], :additional => [:raw_response])[:raw_response]['profile]['verifiedEmail']
 
-    # raw request processing
-    RPXNow.user_data(params[:token]){|raw| {:email=>raw['profile']['verifiedEmail']} }
+    # only raw data
+    email = RPXNow.user_data(params[:token], :raw_response => true)['profile']['verifiedEmail']
 
-    # raw request with extended parameters (most users and APIs do not supply them)
-    RPXNow.user_data(params[:token], :extended=>'true'){|raw| ...have a look at the RPX API DOCS...}
+    # raw response with extended parameters (most users and APIs do not supply them)
+    RPXNow.user_data(params[:token], :extended => true, :raw_response => true)[ ...have a look at the RPX API DOCS... ]
 
 Advanced
 --------
-###Versions
+### Versions
     RPXNow.api_version = 2
 
-###Mappings
+### Mappings (PRX Plus/Pro)
 You can map your primary keys (e.g. user.id) to identifiers, so that  
 users can login to the same account with multiple identifiers.
     RPXNow.map(identifier, primary_key) #add a mapping
@@ -101,7 +97,7 @@ After a primary key is mapped to an identifier, when a user logs in with this id
 `RPXNow.user_data` will contain his `primaryKey` as `:id`.  
 A identifyer can only belong to one user (in doubt the last one it was mapped to)
 
-###User integration (e.g. ActiveRecord)
+### User integration (e.g. ActiveRecord)
     class User < ActiveRecord::Base
       include RPXNow::UserIntegration
     end
@@ -110,17 +106,22 @@ A identifyer can only belong to one user (in doubt the last one it was mapped to
     user.rpx.map(identifier) == RPXNow.map(identifier, user.id)
     user.rpx.unmap(identifier) == RPXNow.unmap(identifier, user.id)
 
-###Contacts (PRX Pro)
+### Contacts (PRX Pro)
 Retrieve all contacts for a given user:
     RPXNow.contacts(identifier).each {|c| puts "#{c['displayName']}: #{c['emails']}}
 
-###Status updates (PRX Pro)
+### Status updates (PRX Plus/Pro)
 Send a status update to provider (a tweet/facebook-status/...) :
     RPXNow.set_status(identifier, "I just registered at yourdomain.com ...")
 
-TODO
-====
- - add provider / credentials helpers ?
+### Activity (RPX Plus/Pro)
+Post a users activity, on their e.g. Facebook profile, complete with images, titels, rating, additional media, customized links and so on ...
+    RPXNow.activity( identifier,
+      :url=>href, :action=>'Im loving my new', :user_generated_content=>'Im loving my new ... ',
+      :title=>product.title, :description=>product.description,
+      :action_links=>[{:text=>'view >>', :href=>product_url(product, :only_path => false)}],
+      :media=>[{:type=>:image, :src=>product.image_url, :href=>product_url(product, :only_path => false)}]
+    }
 
 
 Author

data/VERSION

@@ -1 +1 @@
-0.6.17
+0.6.18

data/lib/rpx_now.rb

@@ -16,14 +16,18 @@ module RPXNow
   # - complete/unclean response when block was given user_data{|response| ...; return hash }
   # - nil when token was invalid / data was not found
   def user_data(token, options={})
-    begin
-      data = Api.call("auth_info", options.merge(:token => token))
-      result = (block_given? ? yield(data) : parse_user_data(data, options))
-      result.respond_to?(:with_indifferent_access) ? result.with_indifferent_access : result
+    options = options.dup
+    return_raw = options.delete(:raw_response)
+
+    data = begin
+      Api.call("auth_info", options.merge(:token => token))
     rescue ServerError
       return nil if $!.to_s=~/Data not found/
       raise
     end
+
+    result = (block_given? ? yield(data) : (return_raw ? data : parse_user_data(data, options)))
+    result.respond_to?(:with_indifferent_access) ? result.with_indifferent_access : result
   end
 
   # set the users status
@@ -137,7 +141,10 @@ module RPXNow
     data[:id] = user_data['primaryKey'] unless user_data['primaryKey'].to_s.empty?
     (options[:additional] || []).each do |key|
       if key == :raw
+        warn "RPXNow :raw is deprecated, please use :raw_response + e.g. data['raw_response']['profile']['verifiedEmail']"
         data[key] = user_data
+      elsif key == :raw_response
+        data[key] = response
       else
         data[key] = user_data[key.to_s]
       end

data/rpx_now.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rpx_now}
-  s.version = "0.6.17"
+  s.version = "0.6.18"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Michael Grosser"]
-  s.date = %q{2010-03-07}
+  s.date = %q{2010-04-10}
   s.email = %q{grosser.michael@gmail.com}
   s.extra_rdoc_files = [
     "README.markdown"

data/spec/rpx_now_spec.rb

@@ -222,10 +222,16 @@ describe RPXNow do
       RPXNow.user_data('').should == expected
     end
 
-    it "adds raw if i want it" do
+    it "deprecated: adds raw profile data if i want it" do
       RPXNow::Api.should_receive(:request).and_return @response
+      RPXNow.should_receive(:warn)
       RPXNow.user_data('',:additional => [:raw])[:raw]["verifiedEmail"].should == "grosser.michael@googlemail.com"
     end
+
+    it "adds raw data if i want it" do
+      RPXNow::Api.should_receive(:request).and_return @response
+      RPXNow.user_data('',:additional => [:raw_response])[:raw_response]['profile']["verifiedEmail"].should == "grosser.michael@googlemail.com"
+    end
     
     it "adds a :id when primaryKey was returned" do
       @response_body['profile']['primaryKey'] = "2"
@@ -263,9 +269,21 @@ describe RPXNow do
     
     it "can send additional parameters" do
       RPXNow::Api.should_receive(:request).
-        with(anything, hash_including(:extended => 'true')).
+        with(anything, hash_including(:extended => true)).
+        and_return @response
+      RPXNow.user_data('', :extended=>true)
+    end
+
+    it "does not pass raw_response to RPX" do
+      RPXNow::Api.should_receive(:request).
+        with(anything, hash_not_including(:raw_response => true)).
         and_return @response
-      RPXNow.user_data('',:extended=>'true')
+      RPXNow.user_data('', :raw_response=>true)
+    end
+
+    it "can return a raw_response" do
+      RPXNow::Api.should_receive(:request).and_return @response
+      RPXNow.user_data('', :raw_response=>true).should == @response_body.merge('stat' => 'ok')
     end
 
     # these 2 tests are kind of duplicates of the api_version/key tests,

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 6
-  - 17
-  version: 0.6.17
+  - 18
+  version: 0.6.18
 platform: ruby
 authors: 
 - Michael Grosser
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-07 00:00:00 +01:00
+date: 2010-04-10 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency