ruby-rapleaf 0.1.5 → 0.2.2

data/History.txt

@@ -1,6 +1,41 @@
-=== 1.0.0 / 2008-08-27
+=== 0.2.2 / 2010/10/18
 
-* 1 major enhancement
+* Allow specifying the read_timeout to pass through to Net::HTTP.
+  There are a few reasons why you might want to do this.  One is that
+  Net::HTTP's read_timeout is implemented using timeout.rb, which is known
+  to have race conditions, and in particular is unsafe to use in
+  EventMachine (because it can sometimes throw exceptions in the main
+  event loop and kill the whole process); so this lets you disable the
+  timeout entirely.
 
-  * Birthday!
+* Ruby 1.9 compatibility tweak (thanks to Justin Ip)
 
+=== 0.2.1 / 2010/04/27
+
+* If unexpected response code, exception should include diagnostic info
+
+=== 0.2.0 / 2010/04/24
+
+* Support Person API lookup by site profile (e.g. Twitter username) for API v3.
+
+=== 0.1.7 / 2010-04-14
+
+* URLencode email addresses before sending them to Rapleaf.
+
+* Remove workaround for mistakenly diagnosed problem (thought Rapleaf rejected emails containing '+', they just required encoding).
+
+* Use existing PersonEmailHashNotFound exception for 404 when looking up by hash
+
+  * removed NotFound class added in 0.1.6
+
+=== 0.1.6 / 2010-03-04
+
+* Modified by Sam Stokes
+
+  * Support for Rapleaf Person API v3 (which is now the default)
+
+  * Work around Rapleaf bug: they think email addresses containing '+' are malformed, so for those we send them hashes instead.
+
+=== 0.1.5 / 2008-08-28
+
+* Original version by Glenn Rempe, with support for Rapleaf Person API v2

data/README.txt

@@ -1,6 +1,6 @@
 = ruby-rapleaf
 
-* http://github.com/grempe/ruby-rapleaf
+* http://github.com/rapportive-oss/ruby-rapleaf
 
 == DESCRIPTION:
 
@@ -14,16 +14,24 @@ This library was inspired by the sample code provided by Rapleaf at:
 
 http://trac.rapleaf.com/ruby-api-kit/wiki
 
-The code was extensively re-written so it would work with the current
-Rapleaf v2 API and is provided for your use.  Sorry that no support
-for this library is currently available.  However, Git pull requests/patches
-are accepted.
+The code was extensively re-written by Glenn Rempe so it would work with the
+then-current Rapleaf v2 API, and further modified by Sam Stokes to support the
+v3 API.
+
+=== Original (v2 API compatible)
 
 http://github.com/grempe/ruby-rapleaf
 
 Glenn Rempe
 glenn@rempe.us
 
+=== Updated (v3 API compatible)
+
+http://github.com/rapportive-oss/ruby-rapleaf
+
+Sam Stokes
+sam@rapportive.com
+
 == SYNOPSIS:
 
 In order to use this API, you will need to get an API Key from Rapleaf. These
@@ -37,6 +45,8 @@ To run any of the examples, simply run it like:
   cd examples
   ruby person.rb
 
+(There are some known problems running the examples at the moment... sorry!)
+
 == REQUIREMENTS:
 
 The following gems are required for installation of the ruby-rapleaf gem.
@@ -46,17 +56,11 @@ The following gems are required for installation of the ruby-rapleaf gem.
 
 == INSTALL:
 
-Install as a Ruby Gem with:
-
-  Update to RubyGems 1.2.0 before proceeding!!
-
-  gem sources -a http://gems.github.com (you only have to do this once)
-
-  sudo gem install grempe-ruby-rapleaf
+Sorry, there's no hosted gem at the moment!
 
-  # OR
+You can build the gem yourself and install as a Ruby Gem with:
 
-  git clone git://github.com/grempe/ruby-rapleaf.git
+  git clone git://github.com/rapportive-oss/ruby-rapleaf.git
   cd ruby-rapleaf
   rake gem
   rake install_gem
@@ -68,7 +72,7 @@ provided below.
 
 RUBY LICENSE
 
-Copyright (c) 2008 Glenn Rempe
+Copyright (c) 2008-2010 Glenn Rempe, 2010 Sam Stokes, Justin Ip
 
 http://www.ruby-lang.org/en/LICENSE.txt
 

data/lib/rapleaf/rapleaf.rb

@@ -1,3 +1,6 @@
+require 'digest/md5'
+require 'uri'
+
 module Rapleaf
 
   class Base
@@ -6,24 +9,26 @@ module Rapleaf
       options = {
                   :api_host     => API_HOST,
                   :api_port     => API_PORT,
-                  :api_version  => API_VERSION
+                  :api_version  => API_VERSION,
+                  :api_read_timeout => 30,
                 }.merge(options)
 
       @api_key  = api_key
       @host     = options[:api_host]
       @port     = options[:api_port]
       @version  = options[:api_version]
+      @read_timeout  = options[:api_read_timeout]
     end
 
     # This resource is used to retrieve information about a person, identified
     # using an email address or email address hash.
-    # Example: person(:email => 'dummy@rapleaf.com')
+    # Examples:
+    #  person(:email => 'dummy@rapleaf.com')
+    #  person(:site => :twitter, :profile => 'samstokes')
+    #  person(:sha1 => Digest::SHA1.hexdigest('dummy@rapleaf.com'))
+    #  person(:md5 => Digest::MD5.hexdigest('dummy@rapleaf.com'))
     def person( opts = {} )
-
-      raise ArgumentError, 'Email address must be provided' if opts[:email].nil? || opts[:email] == ''
-
-      url = "http://#{@host}:#{@port}/#{@version}/person/#{opts[:email]}?api_key=#{@api_key}"
-      resp = Net::HTTP.get_response(URI.parse(url))
+      resp = fetch_response(URI.parse(person_url(opts)))
 
       case resp.code
       when '200'
@@ -36,15 +41,90 @@ module Rapleaf
         raise AuthFailure, 'API key was not provided or is invalid.'
       when '403'
         raise ForbiddenQueryLimitExceeded, 'Your query limit has been exceeded. Contact developer@rapleaf.com if you would like to increase your limit.'
+      when '404'
+        raise PersonEmailHashNotFound, 'We do not have this email in our system and are not able to create a person using a hash. If you would like better results, consider supplying the unhashed email address.'
       when '500'
         raise InternalServerError, 'There was an unexpected error on our server. This should be very rare and if you see it please contact developer@rapleaf.com.'
       else
-        raise Error, 'Unknown error'
+        msg = resp.body[0,50]
+        msg << "..." if 50 < resp.body.length
+        raise Error, %(Unexpected response code #{resp.code}: "#{msg}")
+      end
+    end
+
+  private
+    def fetch_response(uri)
+      # Have to do this a verbose way in order to override Net::HTTP's
+      # default read_timeout
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      if uri.scheme == 'https'
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      http.read_timeout = @read_timeout
+
+      http.start { http.get(uri.path + '?' + uri.query) }
+    end
+
+    def person_url(opts)
+      email = opts[:email]
+
+      site_profile = [opts[:site], opts[:profile]]
+      if site_profile.any?
+        raise ArgumentError, 'Require both :site and :profile if either is specified' unless site_profile.all?
+      else
+        site_profile = nil
       end
+
+      md5 = opts[:md5]
+      sha1 = opts[:sha1]
+
+      # Rapleaf requires email addresses be urlencoded
+      # Pass our own "unsafe regex" as URI.escape's default is too permissive
+      # (lets + through, but Rapleaf rejects it)
+      email = URI.escape(email, /[^a-zA-Z0-9.\-_]/) if email
+
+      selector = [email, site_profile, md5, sha1].compact
+      raise ArgumentError, 'Please provide only one of :email, [:site and :profile], :md5 or :sha1' if selector.size > 1
+      raise ArgumentError, 'Person selector must be provided' if selector.empty? || '' == selector[0]
+
+      case @version
+      when "v2"
+        if site_profile
+          raise ArgumentError, 'Query by website ID requires API v3 or greater'
+        end
+        person_url_v2_by_email_or_hash(email_or_hash[0])
+      when "v3"
+        if email
+          person_url_v3_by_email(email)
+        elsif site_profile
+          person_url_v3_by_site_profile(*site_profile)
+        elsif md5
+          person_url_v3_by_hash(:md5, md5)
+        else
+          person_url_v3_by_hash(:sha1, sha1)
+        end
+      else
+        raise ArgumentError, "Person queries not supported for API version #{@version}"
+      end
+    end
+
+    def person_url_v2_by_email_or_hash(email_or_hash)
+      "http://#{@host}:#{@port}/v2/person/#{email_or_hash}?api_key=#{@api_key}"
+    end
+
+    def person_url_v3_by_email(email)
+      "http://#{@host}:#{@port}/v3/person/email/#{email}?api_key=#{@api_key}"
+    end
+
+    def person_url_v3_by_site_profile(site, profile)
+      # TODO validate param formats
+      "http://#{@host}:#{@port}/v3/person/web/#{site}/#{profile}?api_key=#{@api_key}"
     end
 
-    def abook( opts = {} )
-      # TODO
+    def person_url_v3_by_hash(algo, hash)
+      "http://#{@host}:#{@port}/v3/person/hash/#{algo}/#{hash}?api_key=#{@api_key}"
     end
 
   end

data/lib/ruby-rapleaf.rb

@@ -6,18 +6,19 @@ require 'net/http'
 require 'builder'
 require 'ostruct'
 
-require 'rapleaf/rapleaf.rb'
-require 'rapleaf/exceptions.rb'
-require 'rapleaf/responses.rb'
+library_files = Dir[File.join(File.dirname(__FILE__), "/rapleaf/**/*.rb")]
+library_files.each do |file|
+  require file.gsub(/\.rb$/, "")
+end
 
 module Rapleaf
 
-  VERSION = '0.1.5'
+  VERSION = '0.2.2'
 
   # API Constants
   API_HOST = 'api.rapleaf.com'
   API_PORT = 80
-  API_VERSION = 'v2'
+  API_VERSION = 'v3'
 
 end
 

data/ruby-rapleaf.gemspec

@@ -1,16 +1,16 @@
 Gem::Specification.new do |s|
   s.name = %q{ruby-rapleaf}
-  s.version = "0.1.5"
+  s.version = "0.2.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Glenn Rempe"]
-  s.date = %q{2008-08-27}
+  s.authors = ["Glenn Rempe", "Sam Stokes", "Justin Ip"]
+  s.date = %q{2010-10-18}
   s.description = %q{Rapleaf's goal is to make the internet safe and transparent, by allowing you to evaluate your web footprint across a variety of user-generated sites. See http://www.rapleaf.com for more information.}
-  s.email = ["glenn@rempe.us"]
+  s.email = ["glenn@rempe.us", "sam@rapportive.com"]
   s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt"]
   s.files = ["History.txt", "Manifest.txt", "README.txt", "Rakefile", "examples/person.rb", "lib/ruby-rapleaf.rb", "lib/rapleaf/exceptions.rb", "lib/rapleaf/rapleaf.rb", "lib/rapleaf/responses.rb", "ruby-rapleaf.gemspec"]
   s.has_rdoc = true
-  s.homepage = %q{http://github.com/grempe/ruby-rapleaf}
+  s.homepage = %q{http://github.com/rapportive-oss/ruby-rapleaf}
   s.rdoc_options = ["--main", "README.txt"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{ruby-rapleaf}

metadata

@@ -1,50 +1,77 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-rapleaf
 version: !ruby/object:Gem::Version 
-  version: 0.1.5
+  hash: 19
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Glenn Rempe
+- Sam Stokes
+- Justin Ip
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2008-08-28 00:00:00 -07:00
+date: 2010-10-18 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: xml-simple
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 0
+        - 11
         version: 1.0.11
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: builder
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 1
+        - 2
         version: 2.1.2
-    version: 
+  type: :runtime
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: hoe
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 7
+        - 0
         version: 1.7.0
-    version: 
+  type: :development
+  version_requirements: *id003
 description: Rapleaf's goal is to make the internet safe and transparent, by allowing you to evaluate your web footprint across a variety of user-generated sites. See http://www.rapleaf.com for more information.
 email: 
 - glenn@rempe.us
+- sam@rapportive.com
 executables: []
 
 extensions: []
@@ -65,7 +92,9 @@ files:
 - lib/rapleaf/responses.rb
 - ruby-rapleaf.gemspec
 has_rdoc: true
-homepage: http://github.com/grempe/ruby-rapleaf
+homepage: http://github.com/rapportive-oss/ruby-rapleaf
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --main
@@ -73,21 +102,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: ruby-rapleaf
-rubygems_version: 1.2.0
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 2
 summary: Rapleaf's goal is to make the internet safe and transparent, by allowing you to evaluate your web footprint across a variety of user-generated sites