evri_rpx 1.0.0

data/evri_rpx.gemspec

@@ -0,0 +1,82 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{evri_rpx}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["David Balatero"]
+  s.date = %q{2009-06-17}
+  s.email = %q{dbalatero@evri.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "CHANGELOG.markdown",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "certs/cacert.pem",
+     "evri_rpx.gemspec",
+     "lib/evri/rpx.rb",
+     "lib/evri/rpx/contact.rb",
+     "lib/evri/rpx/contact_list.rb",
+     "lib/evri/rpx/credentials.rb",
+     "lib/evri/rpx/mappings.rb",
+     "lib/evri/rpx/session.rb",
+     "lib/evri/rpx/user.rb",
+     "lib/evri_rpx.rb",
+     "spec/evri/rpx/contact_list_spec.rb",
+     "spec/evri/rpx/contact_spec.rb",
+     "spec/evri/rpx/credentials_spec.rb",
+     "spec/evri/rpx/mappings_spec.rb",
+     "spec/evri/rpx/session_spec.rb",
+     "spec/evri/rpx/user_spec.rb",
+     "spec/fixtures/contacts/bob_johnson.json",
+     "spec/fixtures/credentials/dbalatero_facebook.json",
+     "spec/fixtures/credentials/dbalatero_twitter.json",
+     "spec/fixtures/credentials/dbalatero_windowslive.json",
+     "spec/fixtures/mappings/identifiers.json",
+     "spec/fixtures/session/all_mappings.json",
+     "spec/fixtures/session/get_contacts.json",
+     "spec/fixtures/session/map.json",
+     "spec/fixtures/session/normal_error.json",
+     "spec/fixtures/session/service_down_error.json",
+     "spec/fixtures/session/unmap.json",
+     "spec/fixtures/user/dbalatero_facebook.json",
+     "spec/fixtures/user/dbalatero_gmail.json",
+     "spec/fixtures/user/dbalatero_twitter.json",
+     "spec/fixtures/user/dbalatero_windows_live.json",
+     "spec/fixtures/user/dbalatero_yahoo.json",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/dbalatero/evri_rpx}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{evrigems}
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{An API wrapper for the RPXNow.com login service.}
+  s.test_files = [
+    "spec/evri/rpx/contact_list_spec.rb",
+     "spec/evri/rpx/contact_spec.rb",
+     "spec/evri/rpx/credentials_spec.rb",
+     "spec/evri/rpx/mappings_spec.rb",
+     "spec/evri/rpx/session_spec.rb",
+     "spec/evri/rpx/user_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
+    else
+    end
+  else
+  end
+end

data/lib/evri/rpx.rb

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

data/lib/evri/rpx/contact.rb

@@ -0,0 +1,18 @@
+module Evri
+  module RPX
+    class Contact
+      # Returns the person's display name, eg "Bob Johnson".
+      attr_reader :display_name
+
+      # Returns an array of emails, eg ['bob@johnson.com']
+      attr_reader :emails
+
+      def initialize(json)
+        @display_name = json['displayName']
+        @emails = json['emails'].map do |email|
+          email['value']
+        end
+      end
+    end
+  end
+end

data/lib/evri/rpx/contact_list.rb

@@ -0,0 +1,27 @@
+module Evri
+  module RPX
+    class ContactList
+      # Returns the total amount of contacts found for this user.
+      attr_reader :total_results
+
+      # Returns the current pagination index into the contact results
+      attr_reader :start_index
+
+      # Returns the number of contacts returned per page.
+      attr_reader :items_per_page
+
+      # Returns an array of Contact objects.
+      attr_reader :contacts
+
+      def initialize(json)
+        @total_results = json['response']['totalResults'] rescue 0
+        @start_index = json['response']['startIndex'] rescue nil
+        @items_per_page = json['response']['itemsPerPage']
+
+        @contacts = json['response']['entry'].map do |contact_json|
+          Contact.new(contact_json)
+        end
+      end
+    end
+  end
+end

data/lib/evri/rpx/credentials.rb

@@ -0,0 +1,65 @@
+module Evri
+  module RPX
+    class Credentials
+      def initialize(json)
+        @json = json
+      end
+
+      # Returns the type of credentials:
+      #   (Facebook|OAuth|WindowsLive)
+      #
+      # Generally, you should use the helper methods such
+      # as #facebook?, #oauth?, #windows_live?
+      def type
+        @json['type']
+      end
+
+      # Returns true if these credentials are Facebook.
+      def facebook?
+        type == 'Facebook'
+      end
+
+      # Returns the Facebook session key.
+      def facebook_session_key
+        @json['sessionKey']
+      end
+
+      # Returns when this Facebook session expires, as a Time
+      # object.
+      def facebook_expires
+        Time.at(@json['expires'].to_i)
+      end
+
+      # Returns the UID for the authorized Facebook user.
+      def facebook_uid
+        @json['uid']
+      end
+
+      # Returns true if these credentials are OAuth.
+      def oauth?
+        type == 'OAuth'
+      end
+
+      # Returns the OAuth token.
+      def oauth_token
+        @json['oauthToken']
+      end
+
+      # Returns the OAuth token secret.
+      def oauth_token_secret
+        @json['oauthTokenSecret']
+      end
+
+      # Returns true if these credentials are for Windows Live
+      def windows_live?
+        type == 'WindowsLive'
+      end
+
+      # Returns the Windows Live eact string, which contains the
+      # user's delegated authentication consent token.
+      def windows_live_eact
+        @json['eact']
+      end
+    end
+  end
+end

data/lib/evri/rpx/mappings.rb

@@ -0,0 +1,19 @@
+module Evri
+  module RPX
+    class Mappings
+      # Gives back the raw JSON returned by RPX.
+      attr_reader :json
+      alias :raw :json
+
+      def initialize(json)
+        @json = json
+      end
+
+      # Returns a list of identifiers for a user, or an empty
+      # array if there are none.
+      def identifiers
+        @json['identifiers'] || []
+      end
+    end
+  end
+end

data/lib/evri/rpx/session.rb

@@ -0,0 +1,161 @@
+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',
+                                                'cacert.pem'))
+
+      # This error is raised when the RPX service is unavailable.
+      class ServiceUnavailableError < StandardError; end
+
+      # This error is raised when an API call is misformed,
+      # or there is bad configuration on the other end.
+      class APICallError < StandardError; end
+
+      # Returns the current RPX api_key attached to the session.
+      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
+
+      # Get all stored mappings for a particular application.
+      #
+      # Returns a hash in this form:
+      #   { 'identifier1' => ['mapping1', 'mapping2'],
+      #     'identifier2' => ['mapping3', 'mapping4'],
+      #     ... }
+      def all_mappings
+        json = parse_response(get("/api/#{API_VERSION}/all_mappings",
+                                  :apiKey => @api_key))
+        json['mappings']
+      end
+
+      # Retrieve a list of contacts for an identifier in the
+      # Portable Contacts format. 
+      #
+      # Takes either a string identifier, or a User object
+      # that responds to :identifier.
+      #
+      # This feature is only available for RPX Pro customers.
+      def get_contacts(user_or_identifier)
+        identifier = identifier_param(user_or_identifier)
+        json = parse_response(get("/api/#{API_VERSION}/get_contacts",
+                                  :apiKey => @api_key,
+                                  :identifier => identifier))
+        ContactList.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:
+      #   m = session.mappings('dbalatero')
+      # or a User object with an attached primary key:
+      #   user = session.auth_info(params[:token])
+      #   m = session.mappings(user)
+      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.
+      #
+      # Returns true.  
+      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
+
+      # Remove (unmap) an OpenID from a primary key.
+      #
+      # Returns true.
+      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.use_ssl = true
+        http.ca_file = ROOT_CA_PATH
+        http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+        http.verify_depth = 5
+        http.request(request)
+      end
+
+      def parse_response(response)
+        result = JSON.parse(response.body)
+
+        if result['err']
+          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
+        end
+
+        result
+      end
+    end
+  end
+end

data/lib/evri/rpx/user.rb

@@ -0,0 +1,105 @@
+module Evri
+  module RPX
+    class User
+      class InvalidUserJsonError < StandardError; end
+
+      # Returns a Credentials object for this user, or nil.
+      attr_reader :credentials
+
+      # Returns the raw JSON returned by RPX, in case you want it. 
+      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
+
+        if @json['accessCredentials']
+          @credentials = Credentials.new(@json['accessCredentials'])
+        end
+      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
+
+      # 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
+
+      # Returns true if this is a Google login.
+      def google?
+        provider_name == 'Google'
+      end
+
+      # Returns true if this is a Facebook login.
+      def facebook?
+        provider_name == 'Facebook'
+      end
+
+      # Returns true if this is a Yahoo! login.
+      def yahoo?
+        provider_name == 'Yahoo!'
+      end
+
+      # Returns true if this is a Windows Live login.
+      def windows_live?
+        provider_name == 'Windows Live'
+      end
+
+      # Returns true if this provider is unknown / doesn't have
+      # a specific name in the RPX system.
+      def other?
+        provider_name == 'Other'
+      end
+    end
+  end
+end