dbalatero-evri_rpx 0.1.0

data/lib/evri/rpx/mappings.rb

@@ -0,0 +1,16 @@
+module Evri
+  module RPX
+    class Mappings
+      attr_reader :json
+      alias :raw :json
+
+      def initialize(json)
+        @json = json
+      end
+
+      def identifiers
+        @json['identifiers'] || []
+      end
+    end
+  end
+end

data/lib/evri/rpx/session.rb

@@ -0,0 +1,125 @@
+module Evri
+  module RPX
+    class Session
+      API_VERSION = 'v2'
+      API_HOST = 'rpxnow.com'
+      ROOT_CA_PATH = File.expand_path(File.join(File.dirname(__FILE__),
+                                                '..', '..', '..', 'certs',
+                                                'curl-ca-bundle.crt'))
+
+
+      class ServiceUnavailableError < StandardError; end
+      class APICallError < StandardError; end
+
+      attr_reader :api_key
+
+      def initialize(api_key)
+        @api_key = api_key
+      end
+
+      # Returns an auth_info User response from RPXNow.
+      # Options:
+      #   :tokenUrl => 'http://...'
+      #     RPX will validate that the tokenUrl that you received
+      #     a login redirect from matches the tokenUrl they have on
+      #     file. This is extra security to guard against spoofing.
+      #
+      #     Default: nil
+      #   :extended => (true|false)
+      #     If you are a Plus/Pro customer, RPX will return extended
+      #     data.
+      #
+      #     Default: false
+      def auth_info(token, options = {})
+        params = { 'apiKey' => @api_key,
+                   'token' => token }
+        params.merge!(options)
+
+        json = parse_response(get("/api/#{API_VERSION}/auth_info",
+                                  params))
+        User.new(json)
+      end
+
+      # Returns the mappings for a given user's primary key, as a
+      # Evri::RPX::Mappings object.
+      #
+      # Takes either a string of the user's primary key:
+      #   session.mappings('dbalatero')
+      # or a User object with an attached primary key:
+      #   session.mappings(
+      def mappings(user_or_primary_key)
+        params = { 'apiKey' => @api_key }
+        params['primaryKey'] = user_or_primary_key.respond_to?(:primary_key) ?
+            user_or_primary_key.primary_key : user_or_primary_key
+        
+        json = parse_response(get("/api/#{API_VERSION}/mappings",
+                                  params))
+        Mappings.new(json)
+      end
+
+
+      # Map an OpenID to a primary key. Future logins by this owner of 
+      # this OpenID will return the mapped primaryKey in the auth_info 
+      # API response, which you may use to sign the user in.
+      #
+      #  
+      def map(user_or_identifier, primary_key, options = {})
+        params = { 'apiKey' => @api_key,
+                   'primaryKey' => primary_key,
+                   'overwrite' => true }
+        params.merge!(options)
+        params['identifier'] = identifier_param(user_or_identifier)
+        json = parse_response(get("/api/#{API_VERSION}/map",
+                                  params))
+
+        json['stat'] == 'ok'
+      end
+
+      def unmap(user_or_identifier, primary_key)
+        params = { 'apiKey' => @api_key,
+                   'primaryKey' => primary_key }
+        params['identifier'] = identifier_param(user_or_identifier)
+
+        json = parse_response(get("/api/#{API_VERSION}/unmap",
+                                  params))
+
+        json['stat'] == 'ok'
+      end
+
+      private
+      def identifier_param(user_or_identifier)
+        user_or_identifier.respond_to?(:identifier) ? 
+            user_or_identifier.identifier : user_or_identifier
+      end
+
+      def get(resource, params)
+        request = Net::HTTP::Get.new(resource)
+        request.form_data = params
+        make_request(request)
+      end
+
+      def make_request(request)
+        http = Net::HTTP.new(API_HOST, 443)
+        http.ca_path = ROOT_CA_PATH
+        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
+          result = JSON.parse(response.body)
+
+          code = result['err']['code']
+          if code == -1
+            raise ServiceUnavailableError, "The RPX service is temporarily unavailable."
+          else
+            raise APICallError, "Got error: #{result['err']['msg']} (code: #{code}), HTTP status: #{response.code}"
+          end
+        else
+          JSON.parse(response.body)
+        end
+      end
+    end
+  end
+end

data/lib/evri/rpx/user.rb

@@ -0,0 +1,86 @@
+module Evri
+  module RPX
+    class User
+      class InvalidUserJsonError < StandardError; end
+
+      attr_reader :json
+      alias :raw :json
+
+      def initialize(json)
+        if json.nil? or !json['profile']
+          raise InvalidUserJsonError,
+                'The JSON passed in is invalid!'
+        end
+        @json = json
+      end
+
+      # Returns the person's full name (aka David Balatero)
+      def name
+        @json['profile']['name']['formatted'] rescue nil
+      end
+
+      # Returns a name that should be displayed for this user.
+      def display_name
+        @json['profile']['displayName'] rescue nil
+      end
+
+      # Returns a username for this user.
+      def username
+        @json['profile']['preferredUsername'] rescue nil
+      end
+
+      # Returns a unique identifier for this user.
+      def identifier
+        @json['profile']['identifier'] rescue nil
+      end
+
+      # Returns the primary key for this user, if they have
+      # been mapped already.
+      def primary_key
+        @json['profile']['primaryKey'] rescue nil
+      end
+
+      # Returns a photo URL for a user if they have one.
+      def photo
+        @json['profile']['photo'] rescue nil
+      end
+
+      # Returns a URL to a person's profile on the 3rd-party site.
+      def profile_url
+        @json['profile']['url'] rescue nil
+      end
+
+      def credentials
+        nil
+      end
+
+      # Returns a user's email.
+      def email
+        @json['profile']['email'] rescue nil
+      end
+
+      # Returns the provider name for this user, aka "Twitter", "Google".
+      # Also, see convenience methods such as #google?, #twitter?
+      def provider_name
+        @json['profile']['providerName'] rescue nil
+      end
+
+      # Returns true if this is a Twitter login.
+      def twitter?
+        provider_name == 'Twitter'
+      end
+
+      def google?
+        provider_name == 'Google'
+      end
+
+      def facebook?
+        provider_name == 'Facebook'
+      end
+
+      def yahoo?
+        provider_name == 'Yahoo!'
+      end
+    end
+  end
+end

data/lib/evri/rpx.rb

@@ -0,0 +1,4 @@
+module Evri
+  module RPX
+  end
+end

data/lib/evri_rpx.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)))
+
+require 'json'
+require 'net/http'
+require 'net/https'
+
+require 'evri/rpx'
+require 'evri/rpx/mappings'
+require 'evri/rpx/session'
+require 'evri/rpx/user'

data/spec/evri/rpx/mappings_spec.rb

@@ -0,0 +1,21 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'spec_helper'))
+
+describe Evri::RPX::Mappings do
+  describe "identifiers" do
+    it "should return the identifiers present in the response" do
+      json = json_fixture('mappings/identifiers.json')
+      mappings = Evri::RPX::Mappings.new(json)
+      mappings.identifiers.should include("http://brian.myopenid.com/")
+      mappings.identifiers.should include("http://brianellin.com/")
+    end
+  end
+
+  describe "raw/json" do
+    it "should return the raw JSON that was passed to the constructor" do
+      json = {}
+      mappings = Evri::RPX::Mappings.new(json)
+      mappings.raw.should == json
+      mappings.json.should == json
+    end
+  end
+end

data/spec/evri/rpx/session_spec.rb

@@ -0,0 +1,114 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'spec_helper'))
+
+describe Evri::RPX::Session do
+  before(:all) do
+    @session = Evri::RPX::Session.new('fake_api_key')
+  end
+
+  describe "api_key" do
+    it "should return the current API key" do
+      @session.api_key.should == 'fake_api_key'
+    end
+  end
+
+  describe "auth_info" do
+    after(:each) do
+      FakeWeb.clean_registry
+    end
+
+    it "should raise an APICallError if RPX returns an error message" do
+      FakeWeb.register_uri(:get,
+                           'http://rpxnow.com:443/api/v2/auth_info',
+                           :file => fixture_path('session/normal_error.json'),
+                           :status => ['400', 'Bad Request'])
+      lambda {
+        @session.auth_info('errortoken')
+      }.should raise_error(Evri::RPX::Session::APICallError)
+    end
+
+    it "should raise ServiceUnavailableError if the service is not available" do
+      FakeWeb.register_uri(:get,
+                           'http://rpxnow.com:443/api/v2/auth_info',
+                           :file => fixture_path('session/service_down_error.json'),
+                           :status => ['404', 'Not Found'])
+      lambda {
+        @session.auth_info('errortoken')
+      }.should raise_error(Evri::RPX::Session::ServiceUnavailableError)
+    end
+
+    it "should return a User object for a mapping" do
+      FakeWeb.register_uri(:get,
+                           'http://rpxnow.com:443/api/v2/auth_info',
+                           :file => fixture_path('user/dbalatero_gmail.json'))
+
+      result = @session.auth_info('mytoken')
+      result.should be_a_kind_of(Evri::RPX::User)
+    end
+  end
+
+  describe "map" do
+    before(:each) do
+      FakeWeb.register_uri(:get,
+                           'http://rpxnow.com:443/api/v2/map',
+                           :file => fixture_path('session/map.json'))
+    end
+
+    it "should take in a User object as the second parameter" do
+      user = mock('user')
+      user.should_receive(:identifier).and_return('http://www.facebook.com/dbalatero')
+
+      result = @session.map(user, 50)
+      result.should be_true
+    end
+
+    it "should take in a identifier string as the second parameter" do
+      result = @session.map('http://www.facebook.com/dbalatero', 50)
+      result.should be_true
+    end
+  end
+
+  describe "mappings" do
+    it "should return a Mappings object" do
+      FakeWeb.register_uri(:get,
+                           'http://rpxnow.com:443/api/v2/mappings',
+                           :file => fixture_path('mappings/identifiers.json'))
+
+      result = @session.mappings('dbalatero')
+      result.should be_a_kind_of(Evri::RPX::Mappings)
+      result.identifiers.should_not be_empty
+    end
+
+    it "should take a User object in" do
+      FakeWeb.register_uri(:get,
+                           'http://rpxnow.com:443/api/v2/mappings',
+                           :file => fixture_path('mappings/identifiers.json'))
+      user = mock('user')
+      user.should_receive(:primary_key).and_return('dbalatero')
+
+      result = @session.mappings(user)
+      result.should be_a_kind_of(Evri::RPX::Mappings)
+      result.identifiers.should_not be_empty
+    end
+  end
+
+  describe "unmap" do
+    before(:each) do
+      FakeWeb.register_uri(:get,
+                           'http://rpxnow.com:443/api/v2/unmap',
+                           :file => fixture_path('session/unmap.json'))
+    end
+
+    it "should take a string as the identifier" do
+      result = @session.unmap('http://www.facebook.com/dbalatero', 50)
+      result.should be_true
+    end
+
+    it "should take a User as the identifier" do
+      user = mock('user')
+      user.should_receive(:identifier).and_return('http://www.facebook.com/dbalatero')
+
+      result = @session.unmap(user, 50)
+      result.should be_true
+    end
+  end
+end

data/spec/evri/rpx/user_spec.rb

@@ -0,0 +1,303 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'spec_helper'))
+
+describe Evri::RPX::User do
+  describe "initialize" do
+    it "should not accept any JSON hash that doesn't have profile data in it" do
+      lambda {
+        Evri::RPX::User.new({})
+      }.should raise_error(Evri::RPX::User::InvalidUserJsonError)
+
+      lambda {
+        Evri::RPX::User.new(nil)
+      }.should raise_error(Evri::RPX::User::InvalidUserJsonError)
+    end
+  end
+
+  describe "raw / json methods" do
+    it "should return the raw JSON that was passed to the constructor" do
+      json = { 'profile' => { 'email' => 'foo@bar.com' } }
+      user = Evri::RPX::User.new(json)
+      user.raw.should == json
+      user.json.should == json
+    end
+  end
+
+  describe "parsing Twitter logins" do
+    before(:all) do
+      json = json_fixture('user/dbalatero_twitter.json')
+      @user = Evri::RPX::User.new(json)
+    end
+
+    describe "name" do
+      it "should be equal to the formatted name" do
+        @user.name.should == 'David Balatero'
+      end
+    end
+
+    describe "photo" do
+      it "should be a valid photo" do
+        @user.photo.should =~ /http:\/\/s3\.amazonaws\.com/
+      end
+    end
+
+    describe "display_name" do
+      it "should be the displayName in the JSON" do
+        @user.display_name.should == 'David Balatero'
+      end
+    end
+    
+    describe 'profile_url' do
+      it "should point to the user's Twitter page" do
+        @user.profile_url.should == 'http://twitter.com/dbalatero'
+      end
+    end
+
+    describe 'username' do
+      it "should be the user's Twitter username" do
+        @user.username.should == 'dbalatero'
+      end
+    end
+
+    describe 'primary_key' do
+      it "should be nil" do
+        @user.primary_key.should be_nil
+      end
+    end
+    
+    describe 'identifier' do
+      it "should be the identifier that Twitter gives" do
+        @user.identifier.should =~ /user_id=35834683/
+      end
+    end
+
+    describe "twitter?" do
+      it "should be true for Twitter responses" do
+        @user.twitter?.should be_true
+      end
+    end
+
+    describe "credentials" do
+      it "should not be nil" do
+        pending
+      end
+    end
+
+    describe 'provider_name' do
+      it 'should be Twitter' do
+        @user.provider_name.should == 'Twitter'
+      end
+    end
+  end
+
+  # Google logins
+  describe "parsing Google logins" do
+    before(:all) do
+      json = json_fixture('user/dbalatero_gmail.json')
+      @user = Evri::RPX::User.new(json)
+    end
+
+    describe "name" do
+      it "should be equal to the formatted name" do
+        @user.name.should == 'David Balatero'
+      end
+    end
+
+    describe "photo" do
+      it "should be nil" do
+        @user.photo.should be_nil
+      end
+    end
+
+    describe "display_name" do
+      it "should be the displayName in the JSON" do
+        @user.display_name.should == 'dbalatero'
+      end
+    end
+    
+    describe 'profile_url' do
+      it "should be nil" do
+        @user.profile_url.should be_nil
+      end
+    end
+
+    describe 'username' do
+      it "should be the user's Google username" do
+        @user.username.should == 'dbalatero'
+      end
+    end
+
+    describe 'primary_key' do
+      it "should be set to the correct mapping" do
+        @user.primary_key.should == 'DavidBalateroTestRPXX'
+      end
+    end
+    
+    describe 'identifier' do
+      it "should be the identifier that Twitter gives" do
+        @user.identifier.should =~ /https:\/\/www.google.com\/accounts/
+      end
+    end
+
+    describe "google?" do
+      it "should be true for Google responses" do
+        @user.google?.should be_true
+      end
+    end
+
+    describe "credentials" do
+      it "should be nil" do
+        @user.credentials.should be_nil
+      end
+    end
+
+    describe 'provider_name' do
+      it 'should be Google' do
+        @user.provider_name.should == 'Google'
+      end
+    end
+
+    describe "email" do
+      it "should be set to dbalatero@gmail.com" do
+        @user.email.should == 'dbalatero@gmail.com'
+      end
+    end
+  end
+
+  # Facebook logins
+  describe "parsing Facebook logins" do
+    before(:all) do
+      json = json_fixture('user/dbalatero_facebook.json')
+      @user = Evri::RPX::User.new(json)
+    end
+
+    describe "name" do
+      it "should be equal to the formatted name" do
+        @user.name.should == 'David Balatero'
+      end
+    end
+
+    describe "photo" do
+      it "should be a Facebook profile picture." do
+        @user.photo.should_not be_nil
+        @user.photo.should =~ /http:\/\/profile\.ak\.facebook\.com/
+      end
+    end
+
+    describe "display_name" do
+      it "should be the displayName in the JSON" do
+        @user.display_name.should == 'David Balatero'
+      end
+    end
+    
+    describe 'profile_url' do
+      it "should be the correct Facebook profile URL" do
+        @user.profile_url.should == 'http://www.facebook.com/profile.php?id=10701789'
+      end
+    end
+
+    describe 'username' do
+      it "should be the user's Google username" do
+        @user.username.should == 'DavidBalatero'
+      end
+    end
+
+    describe 'identifier' do
+      it "should be the identifier that Twitter gives" do
+        @user.identifier.should == 'http://www.facebook.com/profile.php?id=10701789'
+      end
+    end
+
+    describe "facebook?" do
+      it "should be true for Google responses" do
+        @user.facebook?.should be_true
+      end
+    end
+
+    describe "credentials" do
+      it "should be set" do
+        pending
+        @user.credentials.should_not be_nil
+      end
+    end
+
+    describe 'provider_name' do
+      it 'should be Facebook' do
+        @user.provider_name.should == 'Facebook'
+      end
+    end
+  end
+
+  # Yahoo logins
+  describe "parsing Yahoo logins" do
+    before(:all) do
+      json = json_fixture('user/dbalatero_yahoo.json')
+      @user = Evri::RPX::User.new(json)
+    end
+
+    describe "name" do
+      it "should be equal to the formatted name" do
+        @user.name.should == 'David Balatero'
+      end
+    end
+
+    describe "photo" do
+      it "should be nil" do
+        @user.photo.should be_nil
+      end
+    end
+
+    describe "display_name" do
+      it "should be the displayName in the JSON" do
+        @user.display_name.should == 'David Balatero'
+      end
+    end
+    
+    describe 'profile_url' do
+      it "should be nil" do
+        @user.profile_url.should be_nil
+      end
+    end
+
+    describe 'username' do
+      it "should be the user's Yahoo username" do
+        @user.username.should == 'David'
+      end
+    end
+
+    describe 'primary_key' do
+      it "should be nil" do
+        @user.primary_key.should == 'David'
+      end
+    end
+    
+    describe 'identifier' do
+      it "should be the identifier that Yahoo gives" do
+        @user.identifier.should =~ /https:\/\/me\.yahoo\.com/
+      end
+    end
+
+    describe 'email' do
+      it "should be dbalatero@yahoo.com" do
+        @user.email.should == 'dbalatero@yahoo.com'
+      end
+    end
+
+    describe "yahoo?" do
+      it "should be true for Yahoo responses" do
+        @user.yahoo?.should be_true
+      end
+    end
+
+    describe "credentials" do
+      it "should be nil" do
+        @user.credentials.should be_nil
+      end
+    end
+
+    describe 'provider_name' do
+      it 'should be Yahoo' do
+        @user.provider_name.should == 'Yahoo!'
+      end
+    end
+  end
+end

data/spec/fixtures/mappings/identifiers.json

@@ -0,0 +1,7 @@
+{
+  "stat": "ok",
+  "identifiers": [
+    "http:\/\/brian.myopenid.com\/",
+    "http:\/\/brianellin.com\/"
+  ]
+}

data/spec/fixtures/session/map.json

@@ -0,0 +1,3 @@
+{
+  "stat": "ok"
+}