whitepages_pro 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZjU5N2QzZTBkOWUyYjJjY2Y1MmYxNjc0YTNlYTQ5ZjBhOTkzOWJkZA==
+  data.tar.gz: !binary |-
+    Y2I3NjA5YTg1NmU3ZDJiMjU4MDdlOGNkNjFlNmNiM2RmNzRmZWNkYQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    Yzk2M2YwMDEzN2IyZjhiZGY4ZDQ5Y2RiMDc0YWJiNmIxNzkyNTU2MmE5Mjlh
+    MmM3NGUwNDMzNTIzZmQ2Mzc0ZTlmMTQ1Y2YzZjdmNDgwY2ZmM2RjNGMxOWM1
+    MjJhNWQyZDRhZTQ2M2YxOWFjNGNhNTM1ZDEzYzExYjUzYjdmZjc=
+  data.tar.gz: !binary |-
+    Y2NjNDMxMTcxMzM0MGEyZWU0ODIwOWY0ZDhhYWFlM2RmMjQ5MWZmNDcxNjRi
+    ZTQzNmVjNjcwZGZlYjA0ZDI5OTYzYjkzMTAxNTQ1ZDg3YWQzYWEzNmVkMmVk
+    ZGFjOWIzNzMyNWQxNjdlZDFkOWQxNzVjNmQ3NGU3ODYzOGNkYzU=

data/LICENSE.txt

@@ -0,0 +1,24 @@
+Copyright (c) 2013, WhitePages, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+  * Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+  * Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in the
+    documentation and/or other materials provided with the distribution.
+  * Neither the name of the company nor the
+    names of its contributors may be used to endorse or promote products
+    derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL WHITEPAGES, INC. BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.rdoc

@@ -0,0 +1,32 @@
+= Overview
+
+= History
+
+[0.1.0 - 2013-Apr-25] Initial Release.
+
+= License
+
+  Copyright (c) 2013, WhitePages, Inc.
+  All rights reserved.
+
+  Redistribution and use in source and binary forms, with or without
+  modification, are permitted provided that the following conditions are met:
+      * Redistributions of source code must retain the above copyright
+        notice, this list of conditions and the following disclaimer.
+      * Redistributions in binary form must reproduce the above copyright
+        notice, this list of conditions and the following disclaimer in the
+        documentation and/or other materials provided with the distribution.
+      * Neither the name of the company nor the
+        names of its contributors may be used to endorse or promote products
+        derived from this software without specific prior written permission.
+
+  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+  DISCLAIMED. IN NO EVENT SHALL WHITEPAGES, INC. BE LIABLE FOR ANY
+  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/Rakefile

@@ -0,0 +1,19 @@
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../Gemfile", Pathname.new(__FILE__).realpath)
+require 'rubygems'
+require 'bundler/setup'
+
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = ['--backtrace']
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.rdoc_files.add "lib/**/*.rb", "README.rdoc"
+  rdoc.options << "--all"
+  #rdoc.options << "--coverage-report" # Useful for finding something undocumented, but won't generate output when this is selected!
+end

data/lib/whitepages_pro/match_score.rb

@@ -0,0 +1,65 @@
+require 'httparty'
+require 'whitepages_pro'
+
+module WhitepagesPro
+  module MatchScore
+    def api_key(api_key)
+      WhitepagesPro.api_key(api_key)
+    end
+
+    # ActiveMerchant has definition
+
+    # :order_id - The order number
+    # :ip - The IP address of the customer making the purchase
+    # :customer - The name, customer number, or other information that identifies the customer
+    # :invoice - The invoice number
+    # :merchant - The name or description of the merchant offering the product
+    # :description - A description of the transaction
+    # :email - The email address of the customer
+    # :currency - The currency of the transaction. Only important when you are using a currency that is not the default with a gateway that supports multiple currencies.
+    # :billing_address - A hash containing the billing address of the customer.
+    # :shipping_address - A hash containing the shipping address of the customer.
+
+    # The :billing_address, and :shipping_address hashes can have the following keys:
+
+    # :name - The full name of the customer.
+    # :company - The company name of the customer.
+    # :address1 - The primary street address of the customer.
+    # :address2 - Additional line of address information.
+    # :city - The city of the customer.
+    # :state - The state of the customer. The 2 digit code for US and Canadian addresses. The full name of the state or province for foreign addresses.
+    # :country - The [ISO 3166-1-alpha-2 code](www.iso.org/iso/country_codes/iso_3166_code_lists/english_country_names_and_code_elements.htm) for the customer.
+    # :zip - The zip or postal code of the customer.
+    # :phone - The phone number of the customer.
+
+    def match_score(money, creditcard, options)
+      name = (options[:billing_address] && options[:billing_address][:name]) ||
+        (options[:shipping_address] && options[:shipping_address][:name])
+
+      billing_address_street = get_street options[:billing_address]
+      billing_address_zip = get_zip options[:billing_address]
+      billing_phone = get_phone options[:shipping_address]
+
+      shipping_address_street = get_street options[:shipping_address]
+      shipping_address_zip = get_zip options[:shipping_address]
+      shipping_phone = get_phone options[:shipping_address]
+
+      WhitepagesPro.match_score(name, billing_address_street, billing_address_zip, billing_phone,
+                                shipping_address_street, shipping_address_zip, shipping_phone)
+    end
+
+    def get_street(address_info)
+      return nil unless address_info
+      "#{address_info[:address1]} #{address_info[:address2]}"
+    end
+
+    def get_zip(address_info)
+      return address_info[:zip] if address_info[:zip]
+      return "#{address_info[:city]} #{address_info[:state]}"
+    end
+
+    def get_phone(address_info)
+      address_info[:phone]
+    end
+  end
+end

data/lib/whitepages_pro/version.rb

@@ -0,0 +1,4 @@
+module WhitepagesPro
+  # The current version of the WhitePagesPRO gem.
+  VERSION = '0.1.0'
+end

data/lib/whitepages_pro/whitepages_pro.rb

@@ -0,0 +1,73 @@
+require 'httparty'
+require 'json'
+
+module WhitepagesPro
+
+  class WhitepagesPro
+    include HTTParty
+    base_uri 'https://proapi.whitepages.com'
+#    debug_output
+
+    def WhitepagesPro.api_key(api_key)
+      @@api_key = api_key
+    end
+
+    def WhitepagesPro.get_default_options
+      {}.tap do | options |
+        options["api_key"] = @@api_key
+        options["outputtype"] = "JSON"
+      end
+    end
+
+    def WhitepagesPro.result(response)
+      return nil unless response.code == 200
+      JSON.parse response.body
+    end
+
+
+    def WhitepagesPro.match_score(name = nil, billing_address_street = nil, billing_address_zip = nil, billing_phone = nil, shipping_address_street = nil, shipping_address_zip = nil, shipping_phone = nil)
+      query = get_default_options
+      query["name"] = name if name
+      query["billing_address_street"] = billing_address_street if billing_address_street
+      query["billing_address_zip"] = billing_address_zip if billing_address_zip
+      query["billing_phone"] = billing_phone if billing_phone
+      query["shipping_address_street"] = shipping_address_street if shipping_address_street
+      query["shipping_address_zip"] = shipping_address_zip if shipping_address_zip
+      query["shipping_phone"] = shipping_phone if shipping_phone
+
+      result get("/match_score/1.1/", :query => query)
+
+    end
+
+    def WhitepagesPro.reverse_address(street, where)
+      query = get_default_options
+      query["street"] = street
+      query["where"] = where
+
+      result get("/reverse_address/1.1", :query => query)
+    end
+
+    def WhitepagesPro.reverse_phone(phone)
+      query = get_default_options
+      query["phone"] = phone
+      result get("/reverse_phone/1.1", :query => query)
+    end
+
+    def WhitepagesPro.find_person(name, where, metro = true)
+      query = get_default_options
+      query["metro"] = metro ? 1 : 0
+      query["name"] = name
+      query["where"] = where
+
+      result get("/find_person/1.1", :query => query)
+    end
+
+    def WhitepagesPro.find_business(keywords, where)
+      query = get_default_options
+      query["keywords"] = keywords
+      query["location"] = where
+
+      result get("/find_business/1.1", :query => query)
+    end
+  end
+end

data/lib/whitepages_pro.rb

@@ -0,0 +1,8 @@
+require 'whitepages_pro/version'
+
+require 'whitepages_pro/whitepages_pro'
+require 'whitepages_pro/match_score'
+
+module WhitepagesPro
+  # Only declared here for RDoc docuemntation purposes of the module.
+end

data/spec/match_score_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+require 'activemerchant'
+
+describe WhitepagesPro::MatchScore do
+  describe 'requests' do
+    it 'should return a payload for match score' do
+      # test gateway
+      ActiveMerchant::Billing::Base.mode = :test
+
+      credit_card = ActiveMerchant::Billing::CreditCard.new(
+                                                            :number     => '4111111111111111',
+                                                            :month      => '8',
+                                                            :year       => '2015',
+                                                            :first_name => 'Matt',
+                                                            :last_name  => 'Woodward',
+                                                            :verification_value  => '123'
+                                                            )
+      expect(credit_card.valid?).to eq(true)
+
+      # Create a gateway object to the TrustCommerce service
+      gateway = ActiveMerchant::Billing::TrustCommerceGateway.new(
+                                                                  :login    => 'TestMerchant',
+                                                                  :password => 'password'
+                                                                  )
+
+      billing_address = {
+        :name =>      'Matt Woodward',
+        :address1 =>  '1835 73rd Ave NE',
+        :city =>      'Medina',
+        :state =>     'WA',
+        :zip =>       '98039',
+        :phone =>     '4254138445',
+      }
+
+      shipping_address = {
+        :name =>      'Matt Woodward',
+        :address1 =>  '1301 5th Ave',
+        :address2 =>  'Suite 1600',
+        :city =>      'Seattle',
+        :state =>     'WA',
+        :zip =>       '98101',
+        :phone =>     '2069735100',
+      }
+
+      order = {
+        :order_id =>         '1234',
+        :ip =>               '192.168.1.1',
+        :customer =>         'c118e792',
+        :invoice =>          '230',
+        :merchant =>         'SuperTrain, Inc.',
+        :description =>      'ticket purchase',
+        :email =>            'mwoodward@whitepages.com',
+        :currency =>         'USD',
+        :billing_address =>  billing_address,
+        :shipping_address => shipping_address,
+      }
+
+      gateway.extend(WhitepagesPro::MatchScore)
+
+      gateway.api_key APIKey.get_api_key
+
+      ms_response = gateway.match_score(1000, credit_card, order)
+
+      expect(ms_response).not_to eq(nil)
+
+
+      # authorize for $10
+
+      response = gateway.authorize(1000, credit_card, order)
+
+      if response.success?
+        # capture
+        gateway.capture(1000, response.authorization, order)
+      end
+    end
+
+    it 'should not return a payload outside of the US' do
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'simplecov'
+require 'yaml'
+
+SimpleCov.start do
+  add_filter {|sf| sf.filename !~ /\/lib\//}
+end
+
+require 'whitepages_pro'
+
+# Require the debugger, if present.
+begin
+  require 'debugger'
+rescue LoadError
+  module Kernel
+    def debugger(*args, &block)
+      STDERR.puts "*** Debugger not available."
+    end
+  end
+end
+
+class APIKey
+  def APIKey.get_api_key
+    YAML.load_file('apikey.yml')["whitepages_api_key"]
+  end
+end

data/spec/whitepages_pro_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe WhitepagesPro::WhitepagesPro do
+  describe 'requests' do
+    it 'should return a json payload for reverse_phone' do
+      WhitepagesPro::WhitepagesPro.api_key APIKey.get_api_key
+      rev_phone_data = WhitepagesPro::WhitepagesPro.reverse_phone("2069735100")
+      expect(rev_phone_data).not_to eq(nil)
+    end
+
+    it 'should return a json payload for find_person' do
+      WhitepagesPro::WhitepagesPro.api_key APIKey.get_api_key
+      find_person_data = WhitepagesPro::WhitepagesPro.find_person("bill gates", "seattle, wa")
+      expect(find_person_data).not_to eq(nil)
+   end
+
+    it 'should return a json payload for match_score' do
+      WhitepagesPro::WhitepagesPro.api_key APIKey.get_api_key
+      match_score_data = WhitepagesPro::WhitepagesPro.match_score("Matthew Woodward", "12234 10th ave s", "98168", "2062444545", "12234 10th ave s", "98168", "2062444724")
+      expect(match_score_data).not_to eq(nil)
+    end
+
+    it 'should return a json payload reverse_address' do
+      WhitepagesPro::WhitepagesPro.api_key APIKey.get_api_key
+      rev_address_data = WhitepagesPro::WhitepagesPro.reverse_address("1301 5th Ave", "seattle, wa")
+      expect(rev_address_data).not_to eq(nil)
+    end
+
+    it 'should return a json payload for find_business' do
+      WhitepagesPro::WhitepagesPro.api_key APIKey.get_api_key
+      find_business_data = WhitepagesPro::WhitepagesPro.find_business("starbucks", "seattle, wa")
+      expect(find_business_data).not_to eq(nil)
+    end
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: whitepages_pro
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matt Woodward
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-28 00:00:00.000000000 Z
+dependencies: []
+description: WhitePagesPRO provides lookup and anti-fraud APIs. For access, please
+  contact pro-sales@whitepages.com
+email:
+- mwoodward@whitepages.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- lib/whitepages_pro/match_score.rb
+- lib/whitepages_pro/version.rb
+- lib/whitepages_pro/whitepages_pro.rb
+- lib/whitepages_pro.rb
+- spec/match_score_spec.rb
+- spec/spec_helper.rb
+- spec/whitepages_pro_spec.rb
+- README.rdoc
+- LICENSE.txt
+- Rakefile
+homepage: https://github.com/whitepages/whitepages_pro
+licenses:
+- BSD
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby interfaces for WhitePagesPRO web services.
+test_files: []
+has_rdoc: true