rapleaf_api 0.1.0

data/Manifest.txt

@@ -0,0 +1,8 @@
+Manifest.txt
+README.txt
+Rakefile
+lib/rapleaf_api.rb
+lib/api/api.rb
+lib/api/graph.rb
+lib/api/person.rb
+lib/api/errors.rb

data/README.md

@@ -0,0 +1,51 @@
+# rapleaf_api
+
+Getting Started
+---------------
+
+You need to first get an API key found here:
+
+[http://www.rapleaf.com/developer/](http://www.rapleaf.com/developer/)
+  
+
+Installation
+------------
+
+	sudo gem install rapleaf_api
+
+Usage
+-----
+
+	require 'rubygems'
+	require 'rapleaf_api'
+
+	rapAPI = RapleafApi::Api.new("your api key")
+	
+### Person API
+
+	#by email
+	person = rapAPI.query({:type => :person, {:email => "email"}})
+
+	#by md5 hash of email
+	person = rapAPI.query({:type => :person, {:hash => RapleafApi::MD5, :id => "md5 hash of email"}})
+
+	#by site id
+	person = rapAPI.query({:type => :person, {:site => RapleafApi::TWITTER, :id => "twitter username"}})
+
+### Graph API
+
+	#by email (note this query will only work if you have an email set stored with Rapleaf)
+	friendList = rapAPI.query({:type => :graph, {:id => "email address"}})
+
+	#by email, return Rapleaf IDs instead of scoped emails
+	friendList = rapAPI.query({:type => :graph, {:id => "email address", :return_rapid => true}})
+
+	#by Rapleaf ID, this will return a list of Rapleaf IDs
+	friendList = rapAPI.query({:type => :graph, {:id => "rapleaf id", :by_rapid => true}})
+	
+Authors
+-------
+
+* Adam Coffman :: coffman.adam@gmail.com
+* Brent Beer :: brentbeer@gmail.com
+* Mark Sands :: marksands07@gmail.com

data/lib/api/api.rb

@@ -0,0 +1,85 @@
+module RapleafApi
+  class Api
+
+    def initialize(api_key)
+      @API_KEY = "?api_key=#{api_key}"
+      @PERSON_URL = "http://api.rapleaf.com/v3/person/"
+      @GRAPH_URL = "http://api.rapleaf.com/v2/graph/"
+    end
+
+    def query(params)
+			raise InvalidParams, "Invalid query, please use an :opts hash to specify your options" unless !params[:opts].nil?
+      case params[:type]
+				when :person
+          return Person.new(person_request(params[:opts]))
+        when :graph
+          return Graph.new(graph_request(params[:opts]))
+        else
+          raise InvalidParams, "Invalid query type, use either :graph or :person"
+      end
+    end
+
+    private
+
+    def request(url)
+      resp = Net::HTTP.get_response(URI.parse(url))
+      if resp.code == "200"
+        return resp.body
+      else
+        raise_response_errors(resp.code)
+      end
+    end
+
+    def person_request(params)
+      raise InvalidParams, "Your params hash was formatted incorrectly!" unless url = verify_and_build_person_url(params)
+      request(url)
+    end
+
+    def graph_request(params)
+      raise InvalidParams, "Your params hash was formatted incorrectly!" unless url = verify_and_build_graph_url(params)
+      request(url)
+    end
+
+    def verify_and_build_person_url(params)
+      if params.size == 1
+        return false unless params[:email]
+        return @PERSON_URL + "email/#{params[:email]}" + @API_KEY
+      else
+        return false unless params[:id] && (params[:hash] || params[:site])
+        return @PERSON_URL + (!params[:hash].nil? ? "hash/#{params[:hash]}/#{params[:id]}" : "web/#{params[:site]}/#{params[:id]}") + @API_KEY 
+      end
+    end
+
+    def verify_and_build_graph_url(params)
+      if params.size == 1
+        return false unless params[:id]
+        return @GRAPH_URL + params[:id] + @API_KEY
+      elsif params.size == 2
+        return false unless params[:id] && (params[:by_rapid] || params[:return_rapid])
+        return @GRAPH_URL + params[:id] + @API_KEY + "&" + ( !params[:by_rapid].nil? ? "n=2" : "n=1")
+      else
+        return false
+      end
+    end
+
+    def raise_response_errors(code)
+      case code 
+        when "202"
+          raise AcceptedException, "This person is currently being searched. Please check back shortly."
+        when "400"
+          raise MalformedRequestException, "Malformed request."
+        when "401"
+          raise ApiKeyInvalidException, "API Key invalid"
+        when "403"
+          raise RateLimitExceededException, "API Key query limit exceded, please contact developer@rapleaf.com to have your limit increased."
+        when "404"
+          raise PersonNotFoundException, "We do not have this person in our system. If you would like better results, consider supplying the 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 "Unkown Error"
+      end
+    end
+
+  end
+end

data/lib/api/errors.rb

@@ -0,0 +1,26 @@
+module RapleafApi
+  
+  class InvalidParams < Exception
+  end
+
+  class AcceptedException < Exception
+  end
+
+  class MalformedRequestException < Exception
+  end
+
+  class ApiKeyInvalidException < Exception
+  end
+
+  class RateLimitExceededException < Exception
+  end
+
+  class PersonNotFoundException < Exception
+  end
+
+  class InternalServerError < Exception
+  end
+
+end
+
+

data/lib/api/graph.rb

@@ -0,0 +1,17 @@
+module RapleafApi
+  class Graph
+  
+    def initialize( body )
+      @body = body
+    end
+  
+    def friends
+			if @body.include?(",")
+				@body.split(",")
+			else
+      	@body.split("\n")
+			end
+    end
+
+  end
+end

data/lib/api/person.rb

@@ -0,0 +1,19 @@
+module RapleafApi
+
+	class Person
+
+		def initialize(xml)
+ 			@xml = XmlSimple.xml_in(xml)
+		end
+
+		def xml
+			@xml
+		end
+
+		def rapleaf_id
+			@xml["id"]
+		end
+
+	end
+
+end

data/lib/rapleaf_api.rb

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'net/http'
+require 'xmlsimple'
+
+%w{api.rb person.rb graph.rb errors.rb}.each do |file|
+  require File.dirname(__FILE__) +"/api/" + file
+end
+
+module RapleafApi
+
+  VERSION = '0.1.0'
+
+  #Constants for web queries
+  BEBO = "bebo"
+  FACEBOOK = "facebook"
+  FLICKR = "flickr"
+  FRIENDSTER = "friendster"
+  HI5 = "hi5"
+  LINKEDIN = "linkedin"
+  MYSPACE = "myspace"
+  PLAXO = "plaxo"
+  RAPLEAF = "rapleaf"
+  TWITTER = "twitter"
+
+  #constants for hash types
+  MD5 = "md5"
+  SHA1 = "sha1"
+
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: rapleaf_api
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Adam Coffman
+- Brent Beer
+- Mark Sands
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-12 00:00:00 -06: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: "0"
+    version: 
+description: An interface to Rapleaf's person and graph APIs. Note that this library is not maintained by or affiliated with Rapleaf in any way and you will still need a (free) api key from Rapleaf to use this.
+email: 
+- coffman.adam@gmail.com
+- brent.beer@gmail.com
+- marksands07@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- Manifest.txt
+- lib/rapleaf_api.rb
+- lib/api/api.rb
+- lib/api/graph.rb
+- lib/api/person.rb
+- lib/api/errors.rb
+has_rdoc: true
+homepage: http://github.com/thecoffman/rapleaf_api
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: An interface to Rapleaf's person and graph APIs.
+test_files: []
+