ruby-rapleaf 0.1.5

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2008-08-27
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,10 @@
+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

data/README.txt

@@ -0,0 +1,131 @@
+= ruby-rapleaf
+
+* http://github.com/grempe/ruby-rapleaf
+
+== 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.
+
+== FEATURES/PROBLEMS:
+
+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.
+
+http://github.com/grempe/ruby-rapleaf
+
+Glenn Rempe
+glenn@rempe.us
+
+== SYNOPSIS:
+
+In order to use this API, you will need to get an API Key from Rapleaf. These
+can be obtained free at http://www.rapleaf.com/.
+
+To run the samples you will need to put your API Key in the
+examples/person.rb file or the examples will fail.
+
+To run any of the examples, simply run it like:
+
+  cd examples
+  ruby person.rb
+
+== REQUIREMENTS:
+
+The following gems are required for installation of the ruby-rapleaf gem.
+
+* xml-simple
+* builder
+
+== 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
+
+  # OR
+
+  git clone git://github.com/grempe/ruby-rapleaf.git
+  cd ruby-rapleaf
+  rake gem
+  rake install_gem
+
+== LICENSE:
+
+This software is distributed under the Ruby License.  A copy of which is
+provided below.
+
+RUBY LICENSE
+
+Copyright (c) 2008 Glenn Rempe
+
+http://www.ruby-lang.org/en/LICENSE.txt
+
+Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.co.jp>.
+You can redistribute it and/or modify it under either the terms of the GPL
+(see COPYING.txt file), or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+          modifications to Usenet or an equivalent medium, or by allowing
+          the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) rename any non-standard executables so the names do not conflict
+          with standard executables, which must also be provided.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or executable
+     form, provided that you do at least ONE of the following:
+
+       a) distribute the executables and library files of the software,
+          together with instructions (in the manual page or equivalent)
+          on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+          the software.
+
+       c) give non-standard executables non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under this terms.
+
+     They are gc.c(partly), utils.c(partly), regex.[ch], st.[ch] and some
+     files under the ./missing directory.  See each file for the copying
+     condition.
+
+  5. The scripts and library files supplied as input to or produced as
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them,
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.

data/Rakefile

@@ -0,0 +1,28 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/ruby-rapleaf.rb'
+
+Hoe.new('ruby-rapleaf', Rapleaf::VERSION) do |p|
+  p.rubyforge_name = 'ruby-rapleaf' # if different than lowercase project name
+  p.developer('Glenn Rempe', 'glenn@rempe.us')
+  p.extra_deps = [['xml-simple', '>= 1.0.11'], ['builder', '>= 2.1.2']]
+end
+
+namespace :manifest do
+  desc 'Recreate Manifest.txt to include ALL files'
+  task :refresh do
+    `rake check_manifest | patch -p0 > Manifest.txt`
+  end
+end
+
+namespace :gemspec do
+  desc 'Refresh the gemspec file'
+  task :refresh do
+    `rake debug_gem > ruby-rapleaf.gemspec`
+    # remove the first line from the file which is an artifact of the gemspec generation
+    `perl -pi -e '$_ = "" if ($. == 1);' ruby-rapleaf.gemspec`
+  end
+end
+

data/examples/person.rb

@@ -0,0 +1,65 @@
+require 'rubygems'
+require File.dirname(__FILE__) + '/../lib/ruby-rapleaf'
+
+# Instanciate a Rapleaf object with your API Key.
+@rapleaf = Rapleaf::Base.new('REPLACE_WITH_YOUR_API_KEY')
+
+@person = @rapleaf.person(:email => 'dummy@rapleaf.com')
+
+puts "\n\n"
+puts "BASICS"
+
+puts "\n@person.basics.name:"
+puts @person.basics.name
+
+puts "\n@person.basics.age:"
+puts @person.basics.age
+
+puts "\n@person.basics.gender:"
+puts @person.basics.gender
+
+puts "\n@person.basics.location:"
+puts @person.basics.location
+
+puts "\n@person.basics.occupations:"
+if @person.basics.occupations
+  @person.basics.occupations.each do |occupation|
+    puts "occupation.job_title"
+    puts occupation.job_title
+    puts "occupation.company"
+    puts occupation.company
+  end
+end
+
+puts "\n@person.basics.universities:"
+if @person.basics.universities
+  @person.basics.universities.each do |university|
+    puts "university:"
+    puts university
+  end
+end
+
+puts "\n@person.basics.earliest_known_activity:"
+puts @person.basics.earliest_known_activity
+
+puts "\n@person.basics.latest_known_activity:"
+puts @person.basics.latest_known_activity
+
+puts "\n@person.basics.num_friends:"
+puts @person.basics.num_friends
+
+puts "\nMEMBERSHIPS"
+
+puts "\n@person.memberships.inspect"
+puts @person.memberships.inspect
+
+puts "\n@person.memberships.primary.inspect"
+puts @person.memberships.primary.inspect
+
+puts "\n@person.memberships.primary.membership[0].site"
+puts @person.memberships.primary.membership[0].site
+
+# Look up a profile by hashed email address.
+puts "\nLookup by hashed email:"
+@person = @rapleaf.person(:email => '1147e414eec8b785fb760f13f7890a767ffaef6e')
+

data/lib/rapleaf/exceptions.rb

@@ -0,0 +1,61 @@
+module Rapleaf
+
+  # CLIENT SIDE ERRORS
+
+  # All of our errors are superclassed by Error < RuntimeError
+  class Error < RuntimeError #:nodoc:
+  end
+
+  # A client side only argument error
+  class ArgumentError < Error #:nodoc:
+  end
+
+  # SERVER SIDE ERRORS
+
+  # GENERAL API
+  # =============================================
+
+  # 401 Unauthorized
+  # API key was not provided or is invalid.
+  class AuthFailure < Error #:nodoc:
+  end
+
+  # 403 Forbidden
+  # Your query limit has been exceeded.
+  class ForbiddenQueryLimitExceeded < Error #:nodoc:
+  end
+
+  # 500 Internal Server Error
+  # There was an unexpected error on our server. This should be very
+  # rare and if you see it please contact developer@rapleaf.com.
+  class InternalServerError < Error #:nodoc:
+  end
+
+
+  # PERSON API
+  # =============================================
+
+  # 202 Accepted
+  # This person is currently being searched. Check back shortly and we should have data.
+  class PersonAccepted < Error #:nodoc:
+  end
+
+  # 400 Bad Request
+  # Invalid email address.
+  class PersonBadRequestInvalidEmail < Error #:nodoc:
+  end
+
+  # 404 Not Found
+  # Only returned for lookup by hash. 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.
+  class PersonEmailHashNotFound < Error #:nodoc:
+  end
+
+
+  # ABOOK API
+  # =============================================
+
+  # TODO
+
+end

data/lib/rapleaf/rapleaf.rb

@@ -0,0 +1,52 @@
+module Rapleaf
+
+  class Base
+
+    def initialize(api_key, options = {})
+      options = {
+                  :api_host     => API_HOST,
+                  :api_port     => API_PORT,
+                  :api_version  => API_VERSION
+                }.merge(options)
+
+      @api_key  = api_key
+      @host     = options[:api_host]
+      @port     = options[:api_port]
+      @version  = options[:api_version]
+    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')
+    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))
+
+      case resp.code
+      when '200'
+        return Response.parse(:xml => resp.body)
+      when '202'
+        raise PersonAccepted, 'This person is currently being searched. Check back shortly and we should have data.'
+      when '400'
+        raise PersonBadRequestInvalidEmail, 'Invalid email address.'
+      when '401'
+        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 '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'
+      end
+    end
+
+    def abook( opts = {} )
+      # TODO
+    end
+
+  end
+
+end

data/lib/rapleaf/responses.rb

@@ -0,0 +1,142 @@
+module Rapleaf
+
+  # Credits :
+  # I learned the magic of making an OpenStruct object able to respond as a fully Enumerable
+  # object (responds to .each, etc.) thanks to a great blog article on Struct and OpenStruct
+  # at http://errtheblog.com/post/30
+  #
+  # Thanks to Sean Knapp for the XmlSimple response patch which greatly simplified the response
+  # mechanism for the whole library while making it more accurate and much less brittle to boot!
+  #
+
+  require 'rubygems'
+  begin
+    require 'xmlsimple' unless defined? XmlSimple
+  rescue Exception => e
+    require 'xml-simple' unless defined? XmlSimple
+  end
+
+  class Response < OpenStruct
+
+    include Enumerable
+
+    def self.parse(options = {})
+      options = {
+        :xml => "",
+        :parse_options => { 'ForceArray' => ['item'], 'SuppressEmpty' => nil }
+      }.merge(options)
+      response = Response.new(XmlSimple.xml_in(options[:xml], options[:parse_options]))
+
+      # set the xml attribute of the response object to contain the original XML that was
+      # returned.  This allows anyone to bypass our parsing if desired and just
+      # get right at the raw XML response.
+      response.xml = options[:xml]
+      return response
+    end
+
+    # Every member of an OpenStruct object has getters and setters, the latter of which
+    # has a method ending in "=". Find all of these methods, excluding those defined on
+    # parent classes.
+    def members
+      methods(false).sort.grep(/=/).map { |m| m[0...-1] }
+    end
+
+    # Required by the Enumerable module. Iterate over each item in the members array
+    # and pass as a value the block passed to each using yield.
+    def each
+      members.each do |method|
+        yield send(method)
+      end
+      self
+    end
+
+    # Same as the each method, but with both key and value.
+    #
+    #Sample Use:
+    # obj.each_pair { |k,v| puts "key: #{k}, value: #{v}" }
+    def each_pair
+      members.each do |method|
+        yield method, send(method)
+      end
+      self
+    end
+
+    # Alternative method for getting members.
+    def [](member)
+      send(member)
+    end
+
+    # Alternative method for setting members.
+    def []=(member, value)
+      send("#{member}=", value)
+    end
+
+    # Helper for converting to string which support a long and short version
+    # to avoid recursion problems with parents.
+    def to_string(short=false)
+      s = "#<#{self.class}:0x#{(2 ** 32 + object_id).to_s(16).upcase}"
+      if (short)
+        s += " ..."
+      else
+        each_pair { |k,v|
+          if (v == self.parent && v.kind_of?(Response))
+            v = v.to_string(true)
+          elsif (v.kind_of?(String))
+            v = "\"#{v.gsub("\"", "\\\"")}\""
+          elsif (v.kind_of?(NilClass))
+            v = "nil"
+          end
+          s += " #{k}=#{v}"
+        }
+      end
+      s += ">"
+      return s
+    end
+
+    # Override of to string method.
+    def to_s
+      return to_string
+    end
+
+    private
+
+    # Initialize the object by passing data to the OpenStruct initialize method
+    # and then converting ourself to guarantee we have top-to-bottom data
+    # representation as a Response object.
+    def initialize(data, parent=nil)
+      super(data)
+      self.parent = parent
+      Response.convert(self, parent)
+    end
+
+    # The "brains" of our Response class. This method takes an arbitray object and
+    # depending on its class attempts to convert it.
+    def self.convert(obj, parent)
+      if (obj.kind_of?(Response))
+        # Recursively convert the object.
+        obj.each_pair { |k,v|
+          if (v != obj.parent)
+            obj[k] = convert(v, obj)
+          end
+        }
+        return obj
+      elsif (obj.kind_of?(Hash))
+        # Hashes make good Responses already thanks to OpenStruct.
+        return Response.new(obj, parent)
+      elsif (obj.kind_of?(Array))
+        # With arrays, make sure each element is appropriately converted.
+        new_arr = []
+        obj.each { |elem|
+          new_arr << convert(elem, parent)
+        }
+        return new_arr
+      else
+        # At this point we're out of ideas, so let's hope it is a string.
+        return obj
+      end
+    end
+
+  end  # class Response < OpenStruct
+
+end  # module
+

data/lib/ruby-rapleaf.rb

@@ -0,0 +1,23 @@
+require 'base64'
+require 'cgi'
+require 'openssl'
+require 'digest/sha1'
+require 'net/http'
+require 'builder'
+require 'ostruct'
+
+require 'rapleaf/rapleaf.rb'
+require 'rapleaf/exceptions.rb'
+require 'rapleaf/responses.rb'
+
+module Rapleaf
+
+  VERSION = '0.1.5'
+
+  # API Constants
+  API_HOST = 'api.rapleaf.com'
+  API_PORT = 80
+  API_VERSION = 'v2'
+
+end
+

data/ruby-rapleaf.gemspec

@@ -0,0 +1,38 @@
+Gem::Specification.new do |s|
+  s.name = %q{ruby-rapleaf}
+  s.version = "0.1.5"
+
+  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.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.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.rdoc_options = ["--main", "README.txt"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{ruby-rapleaf}
+  s.rubygems_version = %q{1.2.0}
+  s.summary = %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}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if current_version >= 3 then
+      s.add_runtime_dependency(%q<xml-simple>, [">= 1.0.11"])
+      s.add_runtime_dependency(%q<builder>, [">= 2.1.2"])
+      s.add_development_dependency(%q<hoe>, [">= 1.7.0"])
+    else
+      s.add_dependency(%q<xml-simple>, [">= 1.0.11"])
+      s.add_dependency(%q<builder>, [">= 2.1.2"])
+      s.add_dependency(%q<hoe>, [">= 1.7.0"])
+    end
+  else
+    s.add_dependency(%q<xml-simple>, [">= 1.0.11"])
+    s.add_dependency(%q<builder>, [">= 2.1.2"])
+    s.add_dependency(%q<hoe>, [">= 1.7.0"])
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: ruby-rapleaf
+version: !ruby/object:Gem::Version 
+  version: 0.1.5
+platform: ruby
+authors: 
+- Glenn Rempe
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-28 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: xml-simple
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.11
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: builder
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.7.0
+    version: 
+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
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+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
+has_rdoc: true
+homepage: http://github.com/grempe/ruby-rapleaf
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+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: ruby-rapleaf
+rubygems_version: 1.2.0
+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
+test_files: []
+