grosser-rpx_now 0.3.1 → 0.4.1

data/README.markdown

@@ -2,11 +2,13 @@ Problem
 =======
  - OpenID is complex
  - OpenID is not universally used
+ - Facebook / Myspace / MS-LiveId / AOL connections require different libraries and knowledge
+ - Multiple heterogenouse providers are hard to map to a single user
 
 Solution
 ========
  - Use [RPX](http://rpxnow.com) for universal and usable user login
- - Make view/controller helpers for easy integration
+ - Use view/controller helpers for easy integration
 
 Usage
 =====
@@ -19,7 +21,7 @@ Install
 =======
  - As Rails plugin: `script/plugin install git://github.com/grosser/rpx_now.git `
  - As gem: `sudo gem install grosser-rpx_now --source http://gems.github.com/`
- - As gem from source: `git clone git://github.com/grosser/rpx_now.git`,`cd rpx_now`,`rake manifest`,`rake install`
+ - As gem from source: `git clone git://github.com/grosser/rpx_now.git`,`cd rpx_now && rake install`
 
 Examples
 ========
@@ -32,6 +34,8 @@ View
     OR
     <%=RPXNow.popup_code('Login here...','mywebsite',rpx_token_sessions_url,:language=>'de')%>
 
+    (`popup_code` can also be called with `:unobstrusive=>true`)
+
 Controller
 ----------
     # simple: use defaults
@@ -54,8 +58,15 @@ Controller
     RPXNow.api_key = 'YOUR RPX API KEY'
     RPXNow.user_data(params[:token],:extended=>'true')
 
-Advanced: Mappings
-------------------
+Advanced
+--------
+###Versions
+The version of RPXNow api can be set globally:
+    RPXNow.api_version = 2
+Or local on each call:
+    RPXNow.mappings(primary_key, :api_version=>1)
+
+###Mappings
 You can map your primary keys (e.g. user.id) to identifiers, so that  
 users can login to the same account with multiple identifiers.
     #add a mapping
@@ -72,11 +83,13 @@ After a primary key is mapped to an identifier, when a user logs in with this id
 
 TODO
 ====
- - remove activesupport dependency, use something smaller (json gem looks good but: JSON.parse("{x:1}")==BOOM)
  - validate RPXNow.com SSL certificate
 
 Author
 ======
-Michael Grosser  
+###Contributors
+ - [DBA](http://github.com/DBA)
+
+[Michael Grosser](http://pragmatig.wordpress.com)  
 grosser.michael@gmail.com  
 Hereby placed under public domain, do what you want, just do not hold me accountable...  

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :patch: 1
 :major: 0
-:minor: 3
+:minor: 4

data/lib/rpx_now.rb

@@ -1,14 +1,20 @@
-require 'activesupport'
+require 'json'
+
 module RPXNow
   extend self
 
   attr_writer :api_key
+  attr_accessor :api_version
+  self.api_version = 2
+
+  # retrieve the users data, or return nil when nothing could be read/token was invalid
+  # or data was not found
+  def user_data(token, *args)
+    api_key, version, options = extract_key_version_and_options!(args)
+    options = {:token=>token,:apiKey=>api_key}.merge options
 
-  # retrieve the users data, or return nil when nothing could be read/token was invalid or data was not found
-  def user_data(token,*args)
-    api_key, parameters = extract_key_and_options(args)
     begin
-      data = secure_json_post('https://rpxnow.com/api/v2/auth_info',{:token=>token,:apiKey=>api_key||@api_key}.merge(parameters))
+      data = secure_json_post("https://rpxnow.com/api/v#{version}/auth_info", options)
     rescue ServerError
       return nil if $!.to_s =~ /token/ or $!.to_s=~/Data not found/
       raise
@@ -17,19 +23,24 @@ module RPXNow
   end
 
   # maps an identifier to an primary-key (e.g. user.id)
-  def map(identifier,primary_key,*args)
-    api_key, options = extract_key_and_options(args)
-    secure_json_post('https://rpxnow.com/api/v2/map',{:identifier=>identifier,:primaryKey=>primary_key,:apiKey=>api_key||@api_key}.merge(options))
+  def map(identifier, primary_key, *args)
+    api_key, version, options = extract_key_version_and_options!(args)
+    options = {:identifier=>identifier,:primaryKey=>primary_key,:apiKey=>api_key}.merge options
+    secure_json_post("https://rpxnow.com/api/v#{version}/map", options)
   end
 
   # un-maps an identifier to an primary-key (e.g. user.id)
-  def unmap(identifier,primary_key,api_key=nil)
-    secure_json_post('https://rpxnow.com/api/v2/unmap',{:identifier=>identifier,:primaryKey=>primary_key,:apiKey=>api_key||@api_key})
+  def unmap(identifier, primary_key, *args)
+    api_key, version, options = extract_key_version_and_options!(args)
+    options = {:identifier=>identifier,:primaryKey=>primary_key,:apiKey=>api_key}.merge options
+    secure_json_post("https://rpxnow.com/api/v#{version}/unmap", options)
   end
 
   # returns an array of identifiers which are mapped to one of your primary-keys (e.g. user.id)
-  def mappings(primary_key,api_key=nil)
-    data = secure_json_post('https://rpxnow.com/api/v2/mappings',{:primaryKey=>primary_key,:apiKey=>api_key||@api_key})
+  def mappings(primary_key, *args)
+    api_key, version, options = extract_key_version_and_options!(args)
+    options = {:primaryKey=>primary_key,:apiKey=>api_key}.merge options
+    data = secure_json_post("https://rpxnow.com/api/v#{version}/mappings", options)
     data['identifiers']
   end
 
@@ -41,12 +52,28 @@ module RPXNow
 EOF
   end
 
-  def popup_code(text,subdomain,url,options={})
-<<EOF
-<a class="rpxnow" onclick="return false;" href="https://#{subdomain}.rpxnow.com/openid/v2/signin?token_url=#{url}">
+  def popup_code(text, subdomain, url, options = {})
+    if options[:unobtrusive]
+      unobtrusive_popup_code(text, subdomain, url, options)
+    else
+      obtrusive_popup_code(text, subdomain, url, options)
+    end
+  end
+
+  private
+
+  def unobtrusive_popup_code(text, subdomain, url, options={})
+    version = extract_version! options
+    "<a class=\"rpxnow\" href=\"https://#{subdomain}.rpxnow.com/openid/v#{version}/signin?token_url=#{url}\">#{text}</a>"
+  end
+
+  def obtrusive_popup_code(text, subdomain, url, options = {})
+    version = extract_version! options
+    <<EOF
+<a class="rpxnow" onclick="return false;" href="https://#{subdomain}.rpxnow.com/openid/v#{version}/signin?token_url=#{url}">
   #{text}
 </a>
-<script src="https://rpxnow.com/openid/v2/widget" type="text/javascript"></script>
+<script src="https://rpxnow.com/openid/v#{version}/widget" type="text/javascript"></script>
 <script type="text/javascript">
   //<![CDATA[
   RPXNOW.token_url = "#{url}";
@@ -59,7 +86,12 @@ EOF
 EOF
   end
 
-private
+  def extract_key_version_and_options!(args)
+    key, options = extract_key_and_options(args)
+    version = extract_version! options
+    [key, version, options]
+  end
+
   # [API_KEY,{options}] or
   # [{options}] or
   # []
@@ -74,6 +106,10 @@ private
     end
   end
 
+  def extract_version!(options)
+    options.delete(:api_version) || api_version
+  end
+
   def read_user_data_from_response(response)
     user_data = response['profile']
     data = {}
@@ -85,7 +121,7 @@ private
   end
 
   def secure_json_post(url,data={})
-    data = ActiveSupport::JSON.decode(post(url,data))
+    data = JSON.parse(post(url,data))
     raise ServerError.new(data['err']) if data['err']
     raise ServerError.new(data.inspect) unless data['stat']=='ok'
     data
@@ -101,11 +137,24 @@ private
       #TODO do we really want to verify the certificate? http://notetoself.vrensk.com/2008/09/verified-https-in-ruby/
       http.verify_mode = OpenSSL::SSL::VERIFY_NONE
     end
-    resp, data = http.post(url.path, data.to_query)
+    resp, data = http.post(url.path, to_query(data))
     raise "POST FAILED:"+resp.inspect unless resp.is_a? Net::HTTPOK
     data
   end
 
+  def to_query(data = {})
+    return data.to_query if Hash.respond_to? :to_query
+    return "" if data.empty?
+
+    #simpler to_query
+    query_data = []
+    data.each do |k, v|
+      query_data << "#{k}=#{v}"
+    end
+    
+    return query_data.join('&')
+  end
+
   class ServerError < Exception
     #to_s returns message(which is a hash...)
     def to_s

data/spec/rpx_now_spec.rb

@@ -1,33 +1,61 @@
 require File.expand_path("spec_helper", File.dirname(__FILE__))
 
 API_KEY = '4b339169026742245b754fa338b9b0aebbd0a733'
+API_VERSION = RPXNow.api_version
 
 describe RPXNow do
   before do
-    RPXNow.api_key=nil
+    RPXNow.api_key = nil
+    RPXNow.api_version = API_VERSION
   end
 
   describe :api_key= do
     it "stores the api key, so i do not have to supply everytime" do
       RPXNow.api_key='XX'
-      RPXNow.expects(:post).with{|x,data|data[:apiKey]=='XX'}.returns '{"stat":"ok"}'
+      RPXNow.expects(:post).with{|x,data|data[:apiKey]=='XX'}.returns %Q({"stat":"ok"})
       RPXNow.mappings(1)
     end
   end
+  
+  describe :api_version= do
+    it "can be set to a api_version globally" do
+      RPXNow.api_version = 5
+      RPXNow.popup_code('x','y','z').should =~ %r(/openid/v5/signin)
+    end
+  end
 
   describe :embed_code do
     it "contains the subdomain" do
       RPXNow.embed_code('xxx','my_url').should =~ /xxx/
     end
+    
     it "contains the url" do
       RPXNow.embed_code('xxx','my_url').should =~ /token_url=my_url/
     end
   end
 
   describe :popup_code do
+    it "defaults to obtrusive output" do
+      RPXNow.popup_code('sign on', 'subdomain', 'http://fake.domain.com/').should =~ /script src=/
+    end
+    
+    it "can build an unobtrusive widget with specific version" do
+      expected = %Q(<a class="rpxnow" href="https://subdomain.rpxnow.com/openid/v300/signin?token_url=http://fake.domain.com/">sign on</a>)
+      RPXNow.popup_code('sign on', 'subdomain', 'http://fake.domain.com/', { :unobtrusive => true, :api_version => 300 }).should == expected
+    end
+    
+    it "allows to specify the version of the widget" do
+      RPXNow.popup_code('x','y','z', :api_version => 300).should =~ %r(/openid/v300/signin)
+    end
+    
+    it "defaults to widget version 2" do
+      RPXNow.popup_code('x','y','z').should =~ %r(/openid/v2/signin)
+    end
+
     it "defaults to english" do
       RPXNow.popup_code('x','y','z').should =~ /RPXNOW.language_preference = 'en'/
     end
+    
     it "has a changeable language" do
       RPXNow.popup_code('x','y','z',:language=>'de').should =~ /RPXNOW.language_preference = 'de'/
     end
@@ -35,32 +63,39 @@ describe RPXNow do
 
   describe :user_data do
     def fake_response
-      '{"profile":{"verifiedEmail":"grosser.michael@googlemail.com","displayName":"Michael Grosser","preferredUsername":"grosser.michael","identifier":"https:\/\/www.google.com\/accounts\/o8\/id?id=AItOawmaOlyYezg_WfbgP_qjaUyHjmqZD9qNIVM","email":"grosser.michael@gmail.com"},"stat":"ok"}'
+      %Q({"profile":{"verifiedEmail":"grosser.michael@googlemail.com","displayName":"Michael Grosser","preferredUsername":"grosser.michael","identifier":"https:\/\/www.google.com\/accounts\/o8\/id?id=AItOawmaOlyYezg_WfbgP_qjaUyHjmqZD9qNIVM","email":"grosser.michael@gmail.com"},"stat":"ok"})
     end
+    
     it "is empty when used with an invalid token" do
       RPXNow.user_data('xxxx',API_KEY).should == nil
     end
+    
     it "is empty when used with an unknown token" do
       RPXNow.user_data('60d8c6374f4e9d290a7b55f39da7cc6435aef3d3',API_KEY).should == nil
     end
+    
     it "parses JSON response to user data" do
       RPXNow.expects(:post).returns fake_response
       RPXNow.user_data('','x').should == {:name=>'Michael Grosser',:email=>'grosser.michael@googlemail.com',:identifier=>"https://www.google.com/accounts/o8/id?id=AItOawmaOlyYezg_WfbgP_qjaUyHjmqZD9qNIVM"}
     end
+    
     it "adds a :id when primaryKey was returned" do
-      RPXNow.expects(:post).returns fake_response.sub('"verifiedEmail"','primaryKey:"2","verifiedEmail"')
+      RPXNow.expects(:post).returns fake_response.sub(%Q("verifiedEmail"), %Q("primaryKey":"2","verifiedEmail"))
       RPXNow.user_data('','x')[:id].should == 2
     end
+    
     it "hands JSON response to supplied block" do
-      RPXNow.expects(:post).returns "{x:1,stat:'ok'}"
+      RPXNow.expects(:post).returns %Q({"x":"1","stat":"ok"})
       response = nil
       RPXNow.user_data('','x'){|data| response = data}
-      response.should == {'x'=>1,'stat'=>'ok'}
+      response.should == {"x" => "1", "stat" => "ok"}
     end
+    
     it "returns what the supplied block returned" do
-      RPXNow.expects(:post).returns "{x:1,stat:'ok'}"
+      RPXNow.expects(:post).returns %Q({"x":"1","stat":"ok"})
       RPXNow.user_data('','x'){|data| "x"}.should == 'x'
     end
+    
     it "can send additional parameters" do
       RPXNow.expects(:post).with{|url,data|
         data[:extended].should == 'true'
@@ -73,6 +108,7 @@ describe RPXNow do
     it "reads secondary names" do
       RPXNow.send(:read_user_data_from_response,{'profile'=>{'preferredUsername'=>'1'}})[:name].should == '1'
     end
+    
     it "parses email when no name is found" do
       RPXNow.send(:read_user_data_from_response,{'profile'=>{'email'=>'1@xxx.com'}})[:name].should == '1'
     end
@@ -80,38 +116,45 @@ describe RPXNow do
 
   describe :secure_json_post do
     it "parses json when status is ok" do
-      RPXNow.expects(:post).returns '{stat:"ok",data:"xx"}'
-      RPXNow.send(:secure_json_post,'xx')['data'].should == 'xx'
+      RPXNow.expects(:post).returns %Q({"stat":"ok","data":"xx"})
+      RPXNow.send(:secure_json_post, %Q("yy"))['data'].should == "xx"
     end
+    
     it "raises when there is a communication error" do
-      RPXNow.expects(:post).returns '{"err":"wtf",stat:"ok"}'
+      RPXNow.expects(:post).returns %Q({"err":"wtf","stat":"ok"})
       lambda{RPXNow.send(:secure_json_post,'xx')}.should raise_error RPXNow::ServerError
     end
+    
     it "raises when status is not ok" do
-      RPXNow.expects(:post).returns '{"stat":"err"}'
+      RPXNow.expects(:post).returns %Q({"stat":"err"})
       lambda{RPXNow.send(:secure_json_post,'xx')}.should raise_error RPXNow::ServerError
     end
   end
 
   describe :mappings do
     it "parses JSON response to unmap data" do
-      RPXNow.expects(:post).returns '{"stat":"ok", "identifiers": ["http://test.myopenid.com/"]}'
+      RPXNow.expects(:post).returns %Q({"stat":"ok", "identifiers": ["http://test.myopenid.com/"]})
       RPXNow.mappings(1, "x").should == ["http://test.myopenid.com/"]
     end
   end
 
   describe :map do
     it "adds a mapping" do
-      RPXNow.expects(:post).returns '{"stat":"ok"}'
+      RPXNow.expects(:post).returns %Q({"stat":"ok"})
       RPXNow.map('http://test.myopenid.com',1, API_KEY)
     end
   end
 
   describe :unmap do
     it "unmaps a indentifier" do
-      RPXNow.expects(:post).returns '{"stat":"ok"}'
+      RPXNow.expects(:post).returns %Q({"stat":"ok"})
       RPXNow.unmap('http://test.myopenid.com', 1, "x")
     end
+
+    it "can be called with a specific version" do
+      RPXNow.expects(:secure_json_post).with{|a,b|a == "https://rpxnow.com/api/v300/unmap"}
+      RPXNow.unmap('http://test.myopenid.com', 1, :api_key=>'xxx', :api_version=>300)
+    end
   end
 
   describe :mapping_integration do
@@ -144,4 +187,15 @@ describe RPXNow do
       RPXNow.mappings(1,API_KEY).should == [@k1]
     end
   end
+  
+  describe :to_query do
+    it "should not depend on active support" do
+      RPXNow.send('to_query', {:one => " abc"}).should == "one= abc"
+    end
+    
+    it "should use ActiveSupport core extensions" do
+      require 'activesupport'
+      RPXNow.send('to_query', {:one => " abc"}).should == "one=+abc"
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: grosser-rpx_now
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
+  version: 0.4.1
 platform: ruby
 authors: 
 - Michael Grosser
@@ -9,11 +9,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-13 00:00:00 -08:00
+date: 2009-04-15 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activesupport
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: