grosser-rpx_now 0.2 → 0.3

data/CHANGELOG

@@ -0,0 +1 @@
+0.3 -- RPXNow::ServerError will be thrown when something is invalid/goes wrong, so watch out (not for invalid tokens in user_data)...

data/README.markdown

@@ -36,7 +36,7 @@ Controller
 ----------
     # simple: use defaults
     def rpx_token
-      data = RPXNew.user_data(params[:token],'YOUR RPX API KEY') # :name=>'John Doe',:email=>'john@doe.com',:identifier=>'blug.google.com/openid/dsdfsdfs3f3'
+      data = RPXNow.user_data(params[:token],'YOUR RPX API KEY') # :name=>'John Doe',:email=>'john@doe.com',:identifier=>'blug.google.com/openid/dsdfsdfs3f3'
       #when no user_data was found, data is empty, you may want to handle that seperatly...
       #your user model must have an identifier column
       self.current_user = User.find_by_identifier(data[:identifier]) || User.create!(data)
@@ -44,10 +44,31 @@ Controller
     end
 
     # process the raw response yourself:
-    RPXNew.user_data(params[:token],'YOUR RPX API KEY'){|raw| {:email=>raw['profile']['verifiedEmail']}}
+    RPXNow.user_data(params[:token],'YOUR RPX API KEY'){|raw| {:email=>raw['profile']['verifiedEmail']}}
 
     # request extended parameters (most users and APIs do not supply them)
-    RPXNew.user_data(params[:token],'YOUR RPX API KEY',:extended=>'true'){|raw| ...have a look at the RPX API DOCS...}
+    RPXNow.user_data(params[:token],'YOUR RPX API KEY',:extended=>'true'){|raw| ...have a look at the RPX API DOCS...}
+
+Advanced: 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
+    RPXNow.map(identifier,primary_key,'YOUR RPX API KEY')
+
+    #remove a mapping
+    RPXNow.unmap(identifier,primary_key,'YOUR RPX API KEY')
+
+    #show mappings
+    RPXNow.mappings(primary_key,'YOUR RPX API KEY') # [identifier1,identifier2,...]
+
+After a primary key is mapped to an identifier, when a user logs in with this identifier,  
+`RPXNow.user_data` will contain his `primaryKey` as `:id`.
+
+TODO
+====
+ - remove activesupport dependency, use something smaller (json gem looks good but: JSON.parse("{x:1}")==BOOM)
+ - validate RPXNow.com SSL certificate
 
 Author
 ======

data/Rakefile

@@ -10,7 +10,7 @@ end
 
 #Gemspec
 porject_name = 'rpx_now'
-Echoe.new(porject_name , '0.2') do |p|
+Echoe.new(porject_name , '0.3') do |p|
   p.description    = "Helper to simplify RPX Now user login/creation"
   p.url            = "http://github.com/grosser/#{porject_name}"
   p.author         = "Michael Grosser"

data/lib/rpx_now.rb

@@ -1,14 +1,34 @@
 require 'activesupport'
 module RPXNow
   extend self
+
+  # retrieve the users data, or return nil when nothing could be read/token was invalid or data was not found
   def user_data(token,api_key,parameters={})
-    raise "NO API KEY" if api_key.blank?
-    data = post('https://rpxnow.com/api/v2/auth_info',{:token=>token,:apiKey=>api_key}.merge(parameters))
-    data = ActiveSupport::JSON.decode(data)
-    return if data['err']
+    begin
+      data = secure_json_post('https://rpxnow.com/api/v2/auth_info',{:token=>token,:apiKey=>api_key}.merge(parameters))
+    rescue ServerError
+      return nil if $!.to_s =~ /token/ or $!.to_s=~/Data not found/
+      raise
+    end
     if block_given? then yield(data) else read_user_data_from_response(data) end
   end
 
+  # maps an identifier to an primary-key (e.g. user.id)
+  def map(identifier,primary_key,api_key,options={})
+    secure_json_post('https://rpxnow.com/api/v2/map',{:identifier=>identifier,:primaryKey=>primary_key,:apiKey=>api_key}.merge(options))
+  end
+
+  # un-maps an identifier to an primary-key (e.g. user.id)
+  def unmap(identifier,primary_key,api_key)
+    secure_json_post('https://rpxnow.com/api/v2/unmap',{:identifier=>identifier,:primaryKey=>primary_key,:apiKey=>api_key})
+  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)
+    data = secure_json_post('https://rpxnow.com/api/v2/mappings',{:primaryKey=>primary_key,:apiKey=>api_key})
+    data['identifiers']
+  end
+
   def embed_code(subdomain,url)
 <<EOF
 <iframe src="https://#{subdomain}.rpxnow.com/openid/embed?token_url=#{url}"
@@ -19,7 +39,7 @@ EOF
 
   def popup_code(text,subdomain,url,options={})
 <<EOF
-<a class="rpxnow" onclick="return false;" href="https://rathershort.rpxnow.com/openid/v2/signin?token_url=#{url}">
+<a class="rpxnow" onclick="return false;" href="https://#{subdomain}.rpxnow.com/openid/v2/signin?token_url=#{url}">
   #{text}
 </a>
 <script src="https://rpxnow.com/openid/v2/widget" type="text/javascript"></script>
@@ -43,6 +63,14 @@ private
     data[:identifier] = user_data['identifier']
     data[:email] = user_data['verifiedEmail'] || user_data['email']
     data[:name] = user_data['displayName'] || user_data['preferredUsername'] || data[:email].sub(/@.*/,'')
+    data[:id] = user_data['primaryKey'].to_i unless user_data['primaryKey'].to_s.empty?
+    data
+  end
+
+  def secure_json_post(url,data={})
+    data = ActiveSupport::JSON.decode(post(url,data))
+    raise ServerError.new(data['err']) if data['err']
+    raise ServerError.new(data.inspect) unless data['stat']=='ok'
     data
   end
 
@@ -53,9 +81,18 @@ private
     if url.scheme == 'https'
       require 'net/https'
       http.use_ssl = true
+      #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)
     raise "POST FAILED:"+resp.inspect unless resp.is_a? Net::HTTPOK
-    return data
+    data
+  end
+
+  class ServerError < Exception
+    #to_s returns message(which is a hash...)
+    def to_s
+      super.to_s
+    end
   end
 end

data/rpx_now.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rpx_now}
-  s.version = "0.2"
+  s.version = "0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Michael Grosser"]
-  s.date = %q{2009-01-24}
+  s.date = %q{2009-01-28}
   s.description = %q{Helper to simplify RPX Now user login/creation}
   s.email = %q{grosser.michael@gmail.com}
-  s.extra_rdoc_files = ["lib/rpx_now.rb", "README.markdown"]
-  s.files = ["Manifest", "lib/rpx_now.rb", "init.rb", "Rakefile", "README.markdown", "rpx_now.gemspec"]
+  s.extra_rdoc_files = ["CHANGELOG", "lib/rpx_now.rb", "README.markdown"]
+  s.files = ["Manifest", "CHANGELOG", "lib/rpx_now.rb", "spec/rpx_now_spec.rb", "spec/spec_helper.rb", "rpx_now.gemspec", "init.rb", "Rakefile", "README.markdown"]
   s.has_rdoc = true
   s.homepage = %q{http://github.com/grosser/rpx_now}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Rpx_now", "--main", "README.markdown"]

data/spec/rpx_now_spec.rb

@@ -0,0 +1,135 @@
+require File.expand_path("spec_helper", File.dirname(__FILE__))
+
+API_KEY = '4b339169026742245b754fa338b9b0aebbd0a733'
+
+describe RPXNow do
+  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 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
+  end
+
+  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"}'
+    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.user_data('','x')[:id].should == 2
+    end
+    it "hands JSON response to supplied block" do
+      RPXNow.expects(:post).returns "{x:1,stat:'ok'}"
+      response = nil
+      RPXNow.user_data('','x'){|data| response = data}
+      response.should == {'x'=>1,'stat'=>'ok'}
+    end
+    it "returns what the supplied block returned" do
+      RPXNow.expects(:post).returns "{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'
+      }.returns fake_response
+      RPXNow.user_data('','x',:extended=>'true')
+    end
+  end
+
+  describe :read_user_data_from_response 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
+  end
+
+  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'
+    end
+    it "raises when there is a communication error" do
+      RPXNow.expects(:post).returns '{"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"}'
+      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.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.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.unmap('http://test.myopenid.com', 1, "x")
+    end
+  end
+
+  describe :mapping_integration do
+    before do
+      @k1 = 'http://test.myopenid.com'
+      RPXNow.unmap(@k1, 1, API_KEY)
+      @k2 = 'http://test-2.myopenid.com'
+      RPXNow.unmap(@k2, 1, API_KEY)
+    end
+
+    it "has no mappings when nothing was mapped" do
+      RPXNow.mappings(1,API_KEY).should == []
+    end
+
+    it "unmaps mapped keys" do
+      RPXNow.map(@k2, 1, API_KEY)
+      RPXNow.unmap(@k2, 1, API_KEY)
+      RPXNow.mappings(1, API_KEY).should == []
+    end
+
+    it "maps keys to a primary key and then retrieves them" do
+      RPXNow.map(@k1, 1, API_KEY)
+      RPXNow.map(@k2, 1, API_KEY)
+      RPXNow.mappings(1,API_KEY).sort.should == [@k2,@k1]
+    end
+
+    it "does not add duplicate mappings" do
+      RPXNow.map(@k1, 1, API_KEY)
+      RPXNow.map(@k1, 1, API_KEY)
+      RPXNow.mappings(1,API_KEY).should == [@k1]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+# ---- requirements
+require 'rubygems'
+require 'spec'
+require 'mocha'
+
+$LOAD_PATH << File.expand_path("../lib", File.dirname(__FILE__))
+
+
+# ---- rspec
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end
+
+
+# ---- bugfix
+#`exit?': undefined method `run?' for Test::Unit:Module (NoMethodError)
+#can be solved with require test/unit but this will result in extra test-output
+module Test
+  module Unit
+    def self.run?
+      true
+    end
+  end
+end
+
+
+# ---- setup environment/plugin
+require File.expand_path("../init", File.dirname(__FILE__))
+
+
+# ---- Helpers
+def pending_it(text,&block)
+  it text do
+    pending(&block)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: grosser-rpx_now
 version: !ruby/object:Gem::Version 
-  version: "0.2"
+  version: "0.3"
 platform: ruby
 authors: 
 - Michael Grosser
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-24 00:00:00 -08:00
+date: 2009-01-28 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -37,15 +37,19 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
+- CHANGELOG
 - lib/rpx_now.rb
 - README.markdown
 files: 
 - Manifest
+- CHANGELOG
 - lib/rpx_now.rb
+- spec/rpx_now_spec.rb
+- spec/spec_helper.rb
+- rpx_now.gemspec
 - init.rb
 - Rakefile
 - README.markdown
-- rpx_now.gemspec
 has_rdoc: true
 homepage: http://github.com/grosser/rpx_now
 post_install_message: