jackdempsey-rpx_now 0.5.8

data/CHANGELOG

@@ -0,0 +1,23 @@
+0.5.0
+----
+  * ApiError is raised when API KEY was invalid (before did only return nil)
+  * ServerError is now seperated into ApiError and ServiceUnavailableError
+
+0.4.2
+----
+  * default IDs are strings, not integers, since RPX supports both
+  * Added username field to standart parameters
+
+0.4
+----
+  * The RPXNow.api_version= can be set globally
+  * Most methods now support :api_version=>'123', so you can specify the api_version on each call
+	* Added support for unobtrusive code generation. This will make the gem play nicely with developers creating unobtrusive pages with frameworks such as jQuery;
+	* The RPXNOW JSON responses are now parsed by Florian Frank JSON gem (http://json.rubyforge.org/);
+	* Removed the dependency of ActiveSupport. However, if present, ActiveSupport will be used due to its convenience methods Array#to_query and Hash#to_query.
+	* Added support for multiple versions of the widget. By default, everything will point to version 2;
+	* The specs have been updated.
+
+0.3
+----
+	* RPXNow::ServerError will be thrown when something is invalid/goes wrong, so watch out (not for invalid tokens in user_data)...

data/MIGRATION

@@ -0,0 +1,9 @@
+class AddIdentifierToUsers < ActiveRecord::Migration
+  def self.up
+    add_column :users, :identifier, :string
+  end
+
+  def self.down
+    remove_column :users, :identifier
+  end
+end

data/README.markdown

@@ -0,0 +1,113 @@
+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
+
+Solution
+========
+ - Use [RPX](http://rpxnow.com) for universal and usable user login
+ - Use view/controller helpers for easy integration
+
+![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)
+
+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
+ - for more advanced features have a look at the [RPX API Docs](https://rpxnow.com/docs)
+
+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/`
+
+Examples
+========
+
+View
+----
+    #'mywebsite' is your subdomain/realm on RPX
+    <%=RPXNow.embed_code('mywebsite',rpx_token_sessions_url)%>
+    OR
+    <%=RPXNow.popup_code('Login here...','mywebsite',rpx_token_sessions_url,:language=>'de')%>
+
+`popup_code` can also be called with `:unobstrusive=>true`
+
+Environment
+-----------
+    Rails::Initializer.run do |config|
+      config.gem "grosser-rpx_now", :lib => "rpx_now", :source => "http://gems.github.com/"
+      ...
+    end
+    RPXNow.api_key = "YOU RPX API KEY"
+
+Controller
+----------
+    # user_data
+    # found: {:name=>'John Doe', :username => 'john', :email=>'john@doe.com', :identifier=>'blug.google.com/openid/dsdfsdfs3f3'}
+    # not found: nil (can happen with e.g. invalid tokens)
+    def rpx_token
+      raise "hackers?" unless data = RPXNow.user_data(params[:token])
+      self.current_user = User.find_by_identifier(data[:identifier]) || User.create!(data)
+      redirect_to '/'
+    end
+
+    # raw request processing
+    RPXNow.user_data(params[:token]){|raw| {:email=>raw['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...}
+
+Advanced
+--------
+###Versions
+    RPXNow.api_version = 2
+
+###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.
+    RPXNow.map(identifier, primary_key) #add a mapping
+    RPXNow.unmap(identifier, primary_key) #remove a mapping
+    RPXNow.mappings(primary_key) # [identifier1,identifier2,...]
+    RPXNow.all_mappings # [["1",['google.com/dsdas','yahoo.com/asdas']], ["2",[...]], ... ]
+
+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`.  
+A identifyer can only belong to one user (in doubt the last one it was mapped to)
+
+###User integration (e.g. ActiveRecord)
+    class User < ActiveRecord::Base
+      include RPXNow::UserIntegration
+    end
+
+    user.rpx.identifiers == RPXNow.mappings(user.id)
+    user.rpx.map(identifier) == RPXNow.map(identifier, user.id)
+    user.rpx.unmap(identifier) == RPXNow.unmap(identifier, user.id)
+
+###Contacts (PRX Pro)
+Retrieve all contacts for a given user:
+    RPXNow.contacts(identifier).each {|c| puts "#{c['displayName']}: #{c['emails']}}
+
+###Status updates (PRX 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 ?
+
+Author
+======
+###Contributors
+ - [Amunds](http://github.com/Amunds)
+ - [DBA](http://github.com/DBA)
+ - [dbalatero](http://github.com/dbalatero)
+ - [jackdempsey](http://jackndempsey.blogspot.com/)
+
+[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/Rakefile

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'echoe'
+
+desc "Run all specs in spec directory"
+task :default do |t|
+  options = "--colour --format progress --loadby --reverse"
+  files = FileList['spec/**/*_spec.rb']
+  system("spec #{options} #{files}")
+end
+
+#Gemspec
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    project_name = 'rpx_now'
+    gem.name = project_name
+    gem.summary = "Helper to simplify RPX Now user login/creation"
+    gem.email = "grosser.michael@gmail.com"
+    gem.homepage = "http://github.com/grosser/#{project_name}"
+    gem.authors = ["Michael Grosser"]
+    gem.add_dependency ['activesupport']
+    gem.files = ['**/*']
+  end
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+task :update_gemspec => [:manifest, :build_gemspec]

data/VERSION.yml

@@ -0,0 +1,4 @@
+---
+:minor: 5
+:patch: 8
+:major: 0

data/init.rb

@@ -0,0 +1,2 @@
+#Needed to load rpx_now when used as Rails plugin
+require 'rpx_now'

data/lib/rpx_now.rb

@@ -0,0 +1,198 @@
+require 'json'
+require 'rpx_now/contacts_collection'
+require 'rpx_now/user_integration'
+require 'rpx_now/user_proxy'
+
+module RPXNow
+  extend self
+
+  HOST = 'rpxnow.com'
+  SSL_CERT = File.join(File.dirname(__FILE__), '..', 'certs', 'ssl_cert.pem')
+
+  attr_accessor :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
+
+    begin
+      data = secure_json_post("/api/v#{version}/auth_info", options)
+    rescue ServerError
+      return nil if $!.to_s=~/Data not found/
+      raise
+    end
+    if block_given? then yield(data) else read_user_data_from_response(data) end
+  end
+
+  # set the users status
+  def set_status(identifier, status, *args)
+    api_key, version, options = extract_key_version_and_options!(args)
+    options = {:identifier => identifier, :status => status, :apiKey => api_key}.merge options
+
+    begin
+      data = secure_json_post("/api/v#{version}/set_status", options)
+    rescue ServerError
+      return nil if $!.to_s=~/Data not found/
+      raise
+    end
+  end
+
+  # maps an identifier to an primary-key (e.g. user.id)
+  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("/api/v#{version}/map", options)
+  end
+
+  # un-maps an identifier to an primary-key (e.g. user.id)
+  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("/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, *args)
+    api_key, version, options = extract_key_version_and_options!(args)
+    options = {:primaryKey=>primary_key,:apiKey=>api_key}.merge options
+    data = secure_json_post("/api/v#{version}/mappings", options)
+    data['identifiers']
+  end
+
+  def all_mappings(*args)
+    api_key, version, options = extract_key_version_and_options!(args)
+    data = secure_json_post("/api/v#{version}/all_mappings", {:apiKey => api_key}.merge(options))
+    data['mappings']
+  end
+
+  def contacts(identifier, *args)
+    api_key, version, options = extract_key_version_and_options!(args)
+    options = {:apiKey => api_key, :identifier=> identifier}.merge(options)
+    data = secure_json_post("/api/v#{version}/get_contacts", options)
+    RPXNow::ContactsCollection.new(data['response'])
+  end
+  alias get_contacts contacts
+
+  def embed_code(subdomain,url,options={})
+    options = {:width => '400', :height => '240', :language => 'en'}.merge(options)
+<<EOF
+<iframe src="https://#{subdomain}.#{HOST}/openid/embed?token_url=#{url}&language_preference=#{options[:language]}"
+  scrolling="no" frameBorder="no" style="width:#{options[:width]}px;height:#{options[:height]}px;">
+</iframe>
+EOF
+  end
+
+  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}.#{HOST}/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}.#{HOST}/openid/v#{version}/signin?token_url=#{url}">
+  #{text}
+</a>
+<script src="https://#{HOST}/openid/v#{version}/widget" type="text/javascript"></script>
+<script type="text/javascript">
+  //<![CDATA[
+  RPXNOW.token_url = "#{url}";
+
+  RPXNOW.realm = "#{subdomain}";
+  RPXNOW.overlay = true;
+  RPXNOW.language_preference = '#{options[:language]||'en'}';
+  //]]>
+</script>
+EOF
+  end
+
+  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
+  # []
+  def extract_key_and_options(args)
+    if args.length == 2
+      [args[0],args[1]]
+    elsif args.length==1
+      if args[0].is_a? Hash then [@api_key,args[0]] else [args[0],{}] end
+    else
+      raise "NO Api Key found!" unless @api_key
+      [@api_key,{}]
+    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 = {}
+    data[:identifier] = user_data['identifier']
+    data[:email] = user_data['verifiedEmail'] || user_data['email']
+    data[:username] = user_data['preferredUsername'] || data[:email].to_s.sub(/@.*/,'')
+    data[:name] = user_data['displayName'] || data[:username]
+    data[:id] = user_data['primaryKey'] unless user_data['primaryKey'].to_s.empty?
+    data
+  end
+
+  def secure_json_post(path, data)
+    parse_response(post(path,data))
+  end
+
+  def post(path, data)
+    require 'net/http'
+    require 'net/https'
+    request = Net::HTTP::Get.new(path)
+    request.form_data = data.map{|k,v| [k.to_s,v]}#symbol keys -> string because of ruby 1.9.x bug http://redmine.ruby-lang.org/issues/show/1351
+    make_request(request)
+  end
+
+  def make_request(request)
+    http = Net::HTTP.new(HOST, 443)
+    http.use_ssl = true
+    http.ca_file = SSL_CERT
+    http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+    http.verify_depth = 5
+    http.request(request)
+  end
+
+  def parse_response(response)
+    if response.code.to_i >= 400
+      raise ServiceUnavailableError, "The RPX service is temporarily unavailable. (4XX)"
+    else
+      result = JSON.parse(response.body)
+      return result unless result['err']
+      
+      code = result['err']['code']
+      if code == -1
+        raise ServiceUnavailableError, "The RPX service is temporarily unavailable."
+      else
+        raise ApiError, "Got error: #{result['err']['msg']} (code: #{code}), HTTP status: #{response.code}"
+      end
+    end
+  end
+
+  class ServerError < Exception; end #backwards compatibility / catch all
+  class ApiError < ServerError; end
+  class ServiceUnavailableError < ServerError; end
+end

data/lib/rpx_now/contacts_collection.rb

@@ -0,0 +1,19 @@
+module RPXNow
+  class ContactsCollection < Array
+    def initialize(list)
+      @raw = list
+      @additional_info = list.reject{|k,v|k=='entry'}
+      list['entry'].each{|item| self << parse_data(item)}
+    end
+
+    def additional_info;@additional_info;end
+    def raw;@raw;end
+
+    private
+
+    def parse_data(entry)
+      entry['emails'] = entry['emails'].map{|email| email['value']}
+      entry
+    end
+  end
+end

data/lib/rpx_now/user_integration.rb

@@ -0,0 +1,7 @@
+module RPXNow
+  module UserIntegration
+    def rpx
+      RPXNow::UserProxy.new(id)
+    end
+  end
+end

data/lib/rpx_now/user_proxy.rb

@@ -0,0 +1,19 @@
+module RPXNow
+  class UserProxy
+    def initialize(id)
+      @id = id
+    end
+
+    def identifiers
+      RPXNow.mappings(@id)
+    end
+
+    def map(identifier)
+      RPXNow.map(identifier, @id)
+    end
+
+    def unmap(identifier)
+      RPXNow.unmap(identifier, @id)
+    end
+  end
+end

data/rpx_now.gemspec

@@ -0,0 +1,56 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rpx_now}
+  s.version = "0.5.8"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael Grosser"]
+  s.date = %q{2009-06-21}
+  s.email = %q{grosser.michael@gmail.com}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    "CHANGELOG",
+    "MIGRATION",
+    "README.markdown",
+    "Rakefile",
+    "VERSION.yml",
+    "init.rb",
+    "lib/rpx_now.rb",
+    "lib/rpx_now/contacts_collection.rb",
+    "lib/rpx_now/user_integration.rb",
+    "lib/rpx_now/user_proxy.rb",
+    "rpx_now.gemspec",
+    "spec/fixtures/get_contacts_response.json",
+    "spec/rpx_now/contacts_collection_spec.rb",
+    "spec/rpx_now/user_proxy_spec.rb",
+    "spec/rpx_now_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/grosser/rpx_now}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Helper to simplify RPX Now user login/creation}
+  s.test_files = [
+    "spec/rpx_now_spec.rb",
+    "spec/rpx_now/contacts_collection_spec.rb",
+    "spec/rpx_now/user_proxy_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 0"])
+  end
+end

data/spec/fixtures/get_contacts_response.json

@@ -0,0 +1,58 @@
+{
+  "response": {
+    "itemsPerPage": 5,
+    "totalResults": 5,
+    "entry": [
+      {
+        "displayName": "Bob Johnson",
+        "emails": [
+          {
+            "type": "other",
+            "value": "bob@example.com"
+          }
+        ]
+      },
+      {
+        "displayName": "Cindy Smith",
+        "emails": [
+          {
+            "type": "other",
+            "value": "cindy.smith@example.com"
+          }
+        ]
+      },
+      {
+        "displayName": "Fred Williams",
+        "emails": [
+          {
+            "type": "other",
+            "value": "fred.williams@example.com"
+          },
+          {
+            "type": "other",
+            "value": "fred@example.com"
+          }
+        ]
+      },
+      {
+        "emails": [
+          {
+            "type": "other",
+            "value": "j.lewis@example.com"
+          }
+        ]
+      },
+      {
+        "displayName": "Mary Jones",
+        "emails": [
+          {
+            "type": "other",
+            "value": "mary.jones@example.com"
+          }
+        ]
+      }
+    ],
+    "startIndex": 1
+  },
+  "stat": "ok"
+}

data/spec/rpx_now/contacts_collection_spec.rb

@@ -0,0 +1,32 @@
+require File.expand_path("../spec_helper", File.dirname(__FILE__))
+
+describe RPXNow::ContactsCollection do
+  before do
+    data = JSON.parse(File.read('spec/fixtures/get_contacts_response.json'))['response']
+    @collection = RPXNow::ContactsCollection.new(data)
+  end
+
+  it "behaves like an array" do
+    @collection.size.should == 5
+    @collection[0] = "1"
+    @collection[0].should == "1"
+  end
+
+  it "parses entry to items" do
+    @collection[0]['displayName'].should == "Bob Johnson"
+  end
+
+  it "parses emails to list" do
+    @collection[0]['emails'].should == ["bob@example.com"]
+  end
+
+  it "parses emails to list with multiple emails" do
+    @collection[2]['emails'].should == ["fred.williams@example.com","fred@example.com"]
+  end
+
+  it "holds additional_info" do
+    @collection.additional_info['startIndex'].should == 1
+    @collection.additional_info['itemsPerPage'].should == 5
+    @collection.additional_info['totalResults'].should == 5
+  end
+end

data/spec/rpx_now/user_proxy_spec.rb

@@ -0,0 +1,31 @@
+require File.expand_path("../spec_helper", File.dirname(__FILE__))
+
+class User
+  include RPXNow::UserIntegration
+
+  def id
+    5
+  end
+end
+
+describe RPXNow::UserProxy do
+  before do
+    RPXNow.unmap('http://test.myopenid.com', 5)
+  end
+
+  it "has identifiers" do
+    RPXNow.map('http://test.myopenid.com', 5)
+    User.new.rpx.identifiers.should == ['http://test.myopenid.com']
+  end
+
+  it "can map" do
+    User.new.rpx.map('http://test.myopenid.com')
+    User.new.rpx.identifiers.should == ['http://test.myopenid.com']
+  end
+
+  it "can unmap" do
+    RPXNow.map('http://test.myopenid.com', 5)
+    User.new.rpx.unmap('http://test.myopenid.com')
+    User.new.rpx.identifiers.should == []
+  end
+end

data/spec/rpx_now_spec.rb

@@ -0,0 +1,278 @@
+require File.expand_path("spec_helper", File.dirname(__FILE__))
+
+describe RPXNow do
+  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 mock(:code=>'200', :body=>%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
+    
+    it "defaults to English" do
+      RPXNow.embed_code('xxx', 'my_url').should =~ /language_preference=en/
+    end
+    
+    it "has a changeable language" do
+      RPXNow.embed_code('xxx', 'my_url', :language => 'es').should =~ /language_preference=es/
+    end
+    
+    it "defaults to 400px width" do
+      RPXNow.embed_code('xxx', 'my_url').should =~ /width:400px;/
+    end
+    
+    it "has a changeable width" do
+      RPXNow.embed_code('xxx', 'my_url', :width => '300').should =~ /width:300px;/
+    end
+    
+    it "defaults to 240px height" do
+      RPXNow.embed_code('xxx', 'my_url').should =~ /height:240px;/
+    end
+    
+    it "has a changeable height" do
+      RPXNow.embed_code('xxx', 'my_url', :height => '500').should =~ /height:500px;/
+    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
+  end
+
+  describe :user_data do
+    before do
+      @response_body = %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"})
+      @fake_user_data = {'profile'=>{}}
+    end
+
+    def fake_response
+      mock(:code=>"200",:body=>@response_body)
+    end
+    
+    it "raises ApiError when used with an invalid token" do
+      lambda{
+        RPXNow.user_data('xxxx')
+      }.should raise_error(RPXNow::ApiError)
+    end
+    
+    it "is empty when used with an unknown token" do
+      RPXNow.user_data('60d8c6374f4e9d290a7b55f39da7cc6435aef3d3').should == nil
+    end
+    
+    it "parses JSON response to user data" do
+      RPXNow.expects(:post).returns fake_response
+      RPXNow.user_data('').should == {:name=>'Michael Grosser',:email=>'grosser.michael@googlemail.com',:identifier=>"https://www.google.com/accounts/o8/id?id=AItOawmaOlyYezg_WfbgP_qjaUyHjmqZD9qNIVM", :username => 'grosser.michael'}
+    end
+    
+    it "adds a :id when primaryKey was returned" do
+      @response_body.sub!(%Q("verifiedEmail"), %Q("primaryKey":"2","verifiedEmail"))
+      RPXNow.expects(:post).returns fake_response
+      RPXNow.user_data('')[:id].should == '2'
+    end
+
+    it "handles primaryKeys that are not numeric" do
+      @response_body.sub!(%Q("verifiedEmail"), %Q("primaryKey":"dbalatero","verifiedEmail"))
+      RPXNow.expects(:post).returns fake_response
+      RPXNow.user_data('')[:id].should == 'dbalatero'
+    end
+    
+    it "hands JSON response to supplied block" do
+      RPXNow.expects(:post).returns mock(:code=>'200',:body=>%Q({"x":"1","stat":"ok"}))
+      response = nil
+      RPXNow.user_data(''){|data| response = data}
+      response.should == {"x" => "1", "stat" => "ok"}
+    end
+    
+    it "returns what the supplied block returned" do
+      RPXNow.expects(:post).returns mock(:code=>'200',:body=>%Q({"x":"1","stat":"ok"}))
+      RPXNow.user_data(''){|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('',:extended=>'true')
+    end
+
+    it "works with api key as 2nd parameter (backwards compatibility)" do
+      RPXNow.expects(:secure_json_post).with('/api/v2/auth_info', :apiKey=>'THE KEY', :token=>'id').returns @fake_user_data
+      RPXNow.user_data('id', 'THE KEY')
+      RPXNow.api_key.should == API_KEY
+    end
+
+    it "works with api key as 2nd parameter and options (backwards compatibility)" do
+      RPXNow.expects(:secure_json_post).with('/api/v2/auth_info', :apiKey=>'THE KEY', :extended=>'abc', :token=>'id' ).returns @fake_user_data
+      RPXNow.user_data('id', 'THE KEY', :extended=>'abc')
+      RPXNow.api_key.should == API_KEY
+    end
+
+    it "works with api version as option (backwards compatibility)" do
+      RPXNow.expects(:secure_json_post).with('/api/v123/auth_info', :apiKey=>API_KEY, :token=>'id', :extended=>'abc').returns @fake_user_data
+      RPXNow.user_data('id', :extended=>'abc', :api_version=>123)
+      RPXNow.api_version.should == API_VERSION
+    end
+  end
+
+  describe :set_status do
+    before do
+      @response_body = %Q({ "stat": "ok" })
+    end
+
+    def fake_response
+      mock(:code=>"200",:body=>@response_body)
+    end
+
+    it "parses JSON response to result hash" do
+      RPXNow.expects(:post).returns fake_response
+      RPXNow.set_status('identifier', 'Chillen...').should == {'stat' => 'ok'}
+    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 :contacts do
+    it "finds all contacts" do
+      response = JSON.parse(File.read('spec/fixtures/get_contacts_response.json'))
+      RPXNow.expects(:secure_json_post).with('/api/v2/get_contacts',:identifier=>'xx', :apiKey=>API_KEY).returns response
+      RPXNow.contacts('xx').size.should == 5
+    end
+  end
+
+  describe :parse_response do
+    it "parses json when status is ok" do
+      response = mock(:code=>'200', :body=>%Q({"stat":"ok","data":"xx"}))
+      RPXNow.send(:parse_response, response)['data'].should == "xx"
+    end
+
+    it "raises when there is a communication error" do
+      response = stub(:code=>'200', :body=>%Q({"err":"wtf","stat":"ok"}))
+      lambda{
+        RPXNow.send(:parse_response,response)
+      }.should raise_error(RPXNow::ApiError)
+    end
+
+    it "raises when service has downtime" do
+      response = stub(:code=>'200', :body=>%Q({"err":{"code":-1},"stat":"ok"}))
+      lambda{
+        RPXNow.send(:parse_response,response)
+      }.should raise_error(RPXNow::ServiceUnavailableError)
+    end
+
+    it "raises when service is down" do
+      response = stub(:code=>'400',:body=>%Q({"stat":"err"}))
+      lambda{
+        RPXNow.send(:parse_response,response)
+      }.should raise_error(RPXNow::ServiceUnavailableError)
+    end
+  end
+
+  describe :mappings do
+    it "parses JSON response to unmap data" do
+      RPXNow.expects(:post).returns mock(:code=>'200',:body=>%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 mock(:code=>'200',:body=>%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 mock(:code=>'200',:body=>%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 == "/api/v300/unmap"}
+      RPXNow.unmap('http://test.myopenid.com', 1, :api_key=>'xxx', :api_version=>300)
+    end
+  end
+
+  describe :mapping_integration do
+    before do
+      @k1 = 'http://test.myopenid.com'
+      RPXNow.unmap(@k1, 1)
+      @k2 = 'http://test-2.myopenid.com'
+      RPXNow.unmap(@k2, 1)
+    end
+
+    it "has no mappings when nothing was mapped" do
+      RPXNow.mappings(1).should == []
+    end
+
+    it "unmaps mapped keys" do
+      RPXNow.map(@k2, 1)
+      RPXNow.unmap(@k2, 1)
+      RPXNow.mappings(1).should == []
+    end
+
+    it "maps keys to a primary key and then retrieves them" do
+      RPXNow.map(@k1, 1)
+      RPXNow.map(@k2, 1)
+      RPXNow.mappings(1).sort.should == [@k2,@k1]
+    end
+
+    it "does not add duplicate mappings" do
+      RPXNow.map(@k1, 1)
+      RPXNow.map(@k1, 1)
+      RPXNow.mappings(1).should == [@k1]
+    end
+
+    it "finds all mappings" do
+      RPXNow.map(@k1, 1)
+      RPXNow.map(@k2, 2)
+      RPXNow.all_mappings.sort.should == [["1", ["http://test.myopenid.com"]], ["2", ["http://test-2.myopenid.com"]]]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+# ---- requirements
+require 'rubygems'
+require 'spec'
+require 'mocha'
+
+$LOAD_PATH << File.expand_path("../lib", File.dirname(__FILE__))
+
+# ---- setup environment/plugin
+require File.expand_path("../init", File.dirname(__FILE__))
+API_KEY = '4b339169026742245b754fa338b9b0aebbd0a733'
+API_VERSION = RPXNow.api_version
+
+# ---- rspec
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+  config.before :each do
+    RPXNow.api_key = API_KEY
+    RPXNow.api_version = API_VERSION
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: jackdempsey-rpx_now
+version: !ruby/object:Gem::Version 
+  version: 0.5.8
+platform: ruby
+authors: 
+- Michael Grosser
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-21 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: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: grosser.michael@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- CHANGELOG
+- MIGRATION
+- README.markdown
+- Rakefile
+- VERSION.yml
+- init.rb
+- lib/rpx_now.rb
+- lib/rpx_now/contacts_collection.rb
+- lib/rpx_now/user_integration.rb
+- lib/rpx_now/user_proxy.rb
+- rpx_now.gemspec
+- spec/fixtures/get_contacts_response.json
+- spec/rpx_now/contacts_collection_spec.rb
+- spec/rpx_now/user_proxy_spec.rb
+- spec/rpx_now_spec.rb
+- spec/spec_helper.rb
+has_rdoc: false
+homepage: http://github.com/grosser/rpx_now
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Helper to simplify RPX Now user login/creation
+test_files: 
+- spec/rpx_now_spec.rb
+- spec/rpx_now/contacts_collection_spec.rb
+- spec/rpx_now/user_proxy_spec.rb
+- spec/spec_helper.rb