white_pages 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+.DS_Store
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1,2 @@
+rvm_gemset_create_on_use_flag=1
+rvm use 1.9.2@white_pages

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Octohq.com
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,34 @@
+WhitePages
+=========
+
+WhitePages is a Ruby wrapper for the WhitePages.com API.
+
+WhitePages API Docs
+=========
+
+http://developer.whitepages.com/
+
+You will need to register for a WhitePages API Key.
+
+INSTALLATION
+==========
+
+gem install white_pages
+
+USAGE
+==========
+
+# Set API Key
+WhitePages.api_key = 'XXXXXXXX'
+
+WhitePages.find_person(name: 'John Doe')
+WhitePages.find_business(businessname: 'Target')
+WhitePages.reverse_phone(phone: '3334445555')
+WhitePages.reverse_address(street: '333 S. 3rd St', city: 'Los Angeles', state: 'CA')
+
+Available options can be found by generating RDoc or visiting http://developer.whitepages.com.
+
+COPYRIGHT
+=========
+
+Copyright (c) 2011 octohq.com. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler'
+require 'rspec/core/rake_task'
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/lib/white_pages/client.rb

@@ -0,0 +1,105 @@
+module WhitePages
+  class Client
+    include HTTParty
+    base_uri 'http://api.whitepages.com'
+
+    # API Version
+    def version
+      '1.0'
+    end
+
+    # Find a person
+    #
+    # http://developer.whitepages.com/docs/read/Methods/find_person
+    #
+    # * <tt>:firstname</tt>
+    # * <tt>:lastname</tt> - Required unless :name is provided
+    # * <tt>:name</tt> - Full name. Required unless :lastname is provided
+    # * <tt>:house</tt> - House number
+    # * <tt>:street</tt> - Street name, including any directional prefix or suffix
+    # * <tt>:city</tt>
+    # * <tt>:state</tt> - USPS two-character abbreviation
+    # * <tt>:zip</tt> - Will accept 5 digit ZIP Code or 9 digit ZIP+4
+    # * <tt>:areacode</tt>
+    # * <tt>:metro</tt> - Expand search to metro area
+    # 
+    # == Example
+    #
+    #  WhitePages.api_key = API_KEY
+    #  WhitePages.find_person(name: 'John Doe', state: 'CA')
+    #
+    def find_person(options = {})
+      fetch(:find_person, options)
+    end
+
+    # Find a business
+    #
+    # http://developer.whitepages.com/docs/read/Methods/find_business
+    #
+    # * <tt>:businessname</tt> - Required unless :category is provided
+    # * <tt>:category</tt> - Required unless :businessname is provided
+    # * <tt>:house</tt> - House number
+    # * <tt>:street</tt> - Street name, including any directional prefix or suffix
+    # * <tt>:city</tt>
+    # * <tt>:state</tt> - USPS two-character abbreviation
+    # * <tt>:zip</tt> - Will accept 5 digit ZIP Code or 9 digit ZIP+4
+    # * <tt>:areacode</tt>
+    # * <tt>:metro</tt> - Expand search to metro area
+    # 
+    # == Example
+    #
+    #  WhitePages.api_key = API_KEY
+    #  WhitePages.find_business(businessname: 'Target', city: 'Los Angeles', state: 'CA')
+    #
+    def find_business(options = {})
+      fetch(:find_business, options)
+    end
+
+    # Reverse lookup of a phone number
+    #
+    # http://developer.whitepages.com/docs/read/Methods/reverse_phone
+    #
+    # * <tt>:phone</tt> - 7 or 10 digits
+    # * <tt>:state</tt> - USPS two-character abbreviation. Required if :phone is 7 digits 
+    # 
+    # == Example
+    #
+    #  WhitePages.api_key = API_KEY
+    #  WhitePages.reverse_phone(phone: '3334445555')
+    #
+    def reverse_phone(options = {})
+      fetch(:reverse_phone, options)
+    end
+
+    # Reverse lookup of an address
+    #
+    # http://developer.whitepages.com/docs/read/Methods/reverse_address
+    #
+    # * <tt>:house</tt> - House number
+    # * <tt>:apt</tt> - Apartment number
+    # * <tt>:street</tt> - Street name, including any directional prefix or suffix. Required
+    # * <tt>:city</tt>
+    # * <tt>:state</tt> - USPS two-character abbreviation
+    # * <tt>:zip</tt> - Will accept 5 digit ZIP Code or 9 digit ZIP+4
+    # * <tt>:areacode</tt>
+    #
+    # == Example
+    #
+    #  WhitePages.api_key = API_KEY
+    #  WhitePages.reverse_address(street: '333 S. 3rd St', city: 'Los Angeles', state: 'CA')
+    #
+    def reverse_address(options = {})
+      fetch(:reverse_address, options)
+    end
+
+    protected
+    def fetch(method, options)
+      options.merge!(api_key: WhitePages.api_key, outputtype: 'JSON')
+      response = self.class.get("/#{method}/#{version}", query: options)
+      case response.code
+      when 400...600 then raise WhitePagesError.new(response.headers['x-mashery-error-code'])
+      else Hashie::Mash.new(response)
+      end  
+    end
+  end
+end

data/lib/white_pages.rb

@@ -0,0 +1,30 @@
+require 'hashie'
+require 'httparty'
+
+module WhitePages
+  VERSION = "0.0.1"
+
+  class WhitePagesError < StandardError; end
+
+  autoload :Client, 'white_pages/client'
+
+  class << self
+    attr_accessor :api_key
+  end
+  
+  def self.find_person(options)
+    Client.new(self.api_key).find_person(options)
+  end
+  
+  def self.find_business(options)
+    Client.new(self.api_key).find_business(options)
+  end
+  
+  def self.reverse_address(options)
+    Client.new(self.api_key).reverse_address(options)
+  end
+  
+  def self.reverse_phone(options)
+    Client.new(self.api_key).reverse_phone(options)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'white_pages'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end
+
+# Be sure to pass wp_api_key=XXX or change the API key here
+WhitePages.api_key = ENV['wp_api_key'] || '0123456789abcdef'

data/spec/white_pages_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe WhitePages do
+  context "Valid API Key" do
+    it "should find a person" do
+      WhitePages.find_person(name: 'John Doe').should be_an_instance_of(Hashie::Mash)
+    end
+    
+    it "should find a business" do
+      WhitePages.find_business(businessname: 'Target').should be_an_instance_of(Hashie::Mash)
+    end
+    
+    it "should reverse a phone number" do
+      WhitePages.reverse_phone(phone: '3236030004').should be_an_instance_of(Hashie::Mash)
+    end
+    
+    it "should reverse an address" do
+      WhitePages.reverse_address(street: 'Santa Monica Blvd').should be_an_instance_of(Hashie::Mash)
+    end
+  end
+  
+  context "Invalid API Key" do
+    it "should raise errors" do
+      WhitePages.api_key = 'invalid'
+      lambda { WhitePages.find_person(name: 'John Doe') }.should raise_error(WhitePages::WhitePagesError)
+    end
+  end
+end

data/white_pages.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "white_pages"
+
+Gem::Specification.new do |s|
+  s.name        = "white_pages"
+  s.version     = WhitePages::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["kris"]
+  s.email       = ["kris@octohq.com"]
+  s.homepage    = ""
+  s.summary     = %q{Simple interface to WhitePages API}
+  s.description = %q{Simple interface to WhitePages API}
+
+  s.rubyforge_project = "white_pages"
+  
+  s.add_dependency "hashie"
+  s.add_dependency "httparty"
+  
+  s.add_development_dependency("rspec", "~> 2.0.1")
+  
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: white_pages
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- kris
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-21 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hashie
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.0.1
+  type: :development
+  version_requirements: *id003
+description: Simple interface to WhitePages API
+email: 
+- kris@octohq.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- LICENSE
+- README
+- Rakefile
+- lib/white_pages.rb
+- lib/white_pages/client.rb
+- spec/spec_helper.rb
+- spec/white_pages_spec.rb
+- white_pages.gemspec
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: white_pages
+rubygems_version: 1.6.0
+signing_key: 
+specification_version: 3
+summary: Simple interface to WhitePages API
+test_files: 
+- spec/spec_helper.rb
+- spec/white_pages_spec.rb