netprospex 0.0.1

data/fixtures/cassettes/req-error.yml

@@ -0,0 +1,45 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api-sb.netprospex.com/1.1/person/list.json
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.8.7
+      Authorization:
+      - OAuth oauth_consumer_key="<NETPROSPEX_KEY>", oauth_nonce="2e2556d88815db3044d263110492c76d",
+        oauth_signature="MX5V81z3L50m1oIYkNYYn%2BgLT18%3D", oauth_signature_method="HMAC-SHA1",
+        oauth_timestamp="1366302031", oauth_token="<NETPROSPEX_USER_TOKEN>", oauth_version="1.0"
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - ! '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 18 Apr 2013 16:20:32 GMT
+      Server:
+      - Apache/2.2.22 (Unix) mod_ssl/2.2.22 OpenSSL/1.0.0-fips DAV/2 mod_wsgi/3.3
+        Python/2.7.2 PHP/5.3.10
+      X-Powered-By:
+      - PHP/5.3.10
+      Connection:
+      - close
+      Content-Length:
+      - '484'
+      Content-Type:
+      - application/json
+    body:
+      encoding: US-ASCII
+      string: ! '{"response":{"version":"1.1","responseId":"CB93209F-A577-A249-8714-7849B42E325F","responseType":"error","request":{"startTime":"2013-04-18
+        12:20:32","requestType":"person_list","url":"\/1.1\/person\/list.json","userId":"d5c72b79-a2ed-11e2-8c42-00259059ba92"},"transaction":{"accountId":"d5c51e5f-a2ed-11e2-8c42-00259059ba92","accountStartBalance":7120,"accountEndBalance":null},"error":{"message":"no
+        valid arguments were found","code":"REQ"},"debug":{"requestTime":0.0180189609528}}}'
+    http_version: 
+  recorded_at: Thu, 18 Apr 2013 16:20:32 GMT
+recorded_with: VCR 2.4.0

data/lib/netprospex/api/address.rb

@@ -0,0 +1,9 @@
+require 'ostruct'
+
+module NetProspex::Api
+  class Address < OpenStruct
+    def to_s
+      self.formatted_address
+    end
+  end
+end

data/lib/netprospex/api/organization.rb

@@ -0,0 +1,10 @@
+require 'netprospex/api/sub_objects.rb'
+require 'ostruct'
+
+module NetProspex::Api
+  class Organization < OpenStruct
+    include HasAddress
+    include HasPhones
+    include HasDomains
+  end
+end

data/lib/netprospex/api/person.rb

@@ -0,0 +1,10 @@
+require 'netprospex/api/sub_objects.rb'
+require 'ostruct'
+
+module NetProspex::Api
+  class Person < OpenStruct
+    include HasAddress
+    include HasPhones
+    include HasOrganization
+  end
+end

data/lib/netprospex/api/phone.rb

@@ -0,0 +1,9 @@
+require 'ostruct'
+
+module NetProspex::Api
+  class Phone < OpenStruct
+    def to_s
+      self.formatted_number
+    end
+  end
+end

data/lib/netprospex/api/sub_objects.rb

@@ -0,0 +1,52 @@
+module NetProspex::Api
+  module HasPhones
+    def initialize(*args)
+      super(*args)
+      self.phones ||= []
+      self.phones.map! do |phone|
+        if phone.is_a? Hash
+          if phone[:national_number] && !phone[:national_number].empty?
+            NetProspex::Api::Phone.new(phone)
+          else
+            nil
+          end
+        else
+          phone
+        end
+      end
+      self.phones.compact!
+    end
+  end
+  module HasAddress
+    def initialize(*args)
+      super(*args)
+      if self.postal_address.is_a? Hash
+        formatted_address = self.postal_address[:formatted_address]
+        if formatted_address && !formatted_address.empty?
+          self.postal_address = NetProspex::Api::Address.new(self.postal_address)
+        else
+          self.postal_address = nil
+        end
+      end
+    end
+  end
+  module HasOrganization
+    def initialize(*args)
+      super(*args)
+      if self.organization.is_a? Hash
+        self.organization = NetProspex::Api::Organization.new(self.organization)
+      end
+    end
+  end
+  module HasDomains
+    def initialize(*args)
+      super(*args)
+      if self.domains.is_a? Hash
+        domain = self.domains.fetch(:domain, {})[:url]
+        self.domains = domain ? [domain] : []
+      elsif self.domains.is_a? Array #TODO: I'm just guessing at this formatting
+        self.domains.map! {|h| h[:domain][:url]}
+      end
+    end
+  end
+end

data/lib/netprospex/client.rb

@@ -0,0 +1,58 @@
+require "netprospex/query_methods"
+require "faraday"
+require "faraday_middleware"
+
+module NetProspex
+  class Client
+    include NetProspex::Helpers::Formatters
+    include NetProspex::QueryMethods
+    attr_reader :account_balance
+
+    def initialize(token, secret)
+      @token = token
+      @secret = secret
+    end
+
+    def get(path, query={})
+      http.get(api_url(path, query)).body
+    end
+
+    def post(path, params={})
+      http.post(api_url(path), params).body
+    end
+
+    protected
+
+    def api_base
+      @api_base ||= case NetProspex.environment
+      when :production
+        "http://api.netprospex.com/1.1"
+      when :sandbox
+        "http://api-sb.netprospex.com/1.1"
+      end
+    end
+
+    def api_url(path, query={})
+      api_base + path + stringify_query(query)
+    end
+
+    def http
+      raise NetProspex::ConfigurationError if api_base.nil?
+
+      @http ||=  Faraday.new do |builder|
+        builder.use Faraday::Request::OAuth, {
+          consumer_key: NetProspex.consumer_key,
+          consumer_secret: NetProspex.consumer_secret,
+          token: @token,
+          token_secret: @secret
+        }
+
+        builder.use NetProspex::Middleware::RaiseExceptions
+        builder.use NetProspex::Middleware::Rubyize, content_type: /\bjson$/
+        builder.use FaradayMiddleware::ParseJson, content_type: /\bjson$/
+
+        builder.adapter :net_http
+      end
+    end
+  end
+end

data/lib/netprospex/configuration.rb

@@ -0,0 +1,27 @@
+module NetProspex
+  module Configuration
+    attr_accessor :consumer_key, :consumer_secret
+    attr_reader :environment
+    def environment=(env)
+      if [:production, :sandbox].include? env
+        @environment = env
+      else
+        raise NetProspex::ConfigurationError.new("Unknown environment")
+      end
+    end
+
+    def self.extended(base)
+      base.reset
+    end
+
+    def reset
+      self.consumer_key = nil
+      self.consumer_secret = nil
+      self.environment = :production
+    end
+
+    def configure
+      yield self
+    end
+  end
+end

data/lib/netprospex/exceptions.rb

@@ -0,0 +1,13 @@
+module NetProspex
+  class Error < StandardError; end
+  class ConfigurationError < Error; end
+
+  class ApiError < Error; end
+  class AccessDenied < ApiError; end
+  class AuthenticationError < ApiError; end
+  class DatabaseError < ApiError; end
+  class SearchError < ApiError; end
+  class PaginationError < ApiError; end
+  class ArgumentMissing < ApiError; end
+  class ZeroBalanceError < ApiError; end
+end

data/lib/netprospex/helpers/formatters.rb

@@ -0,0 +1,67 @@
+require "active_support/all"
+require "uri"
+
+module NetProspex
+  module Helpers
+    module Formatters
+      def stringify_query(query)
+        return "" if query.blank?
+        components = []
+        unrubyize_keys(query).each do |k,v|
+          if v.is_a? Array
+            v.each do |w|
+              components << [k+'[]', w]
+            end
+          else
+            components << [k,v]
+          end
+        end
+        "?" + URI.encode_www_form(components)
+      end
+
+      def unrubyize_keys(hash)
+        new_hash = {}
+        hash.each do |k,v|
+          new_k = case k
+                  when Symbol
+                    k.to_s.camelize(:lower)
+                  else
+                    k
+                  end
+          new_v = case v
+                  when Hash
+                    unrubyize_keys(v)
+                  when Array
+                    v.map {|w| (Hash === w) ? unrubyize_keys(w) : w}
+                  else
+                    v
+                  end
+          new_hash[new_k] = new_v
+        end
+        new_hash
+      end
+
+      def rubyize_keys(hash)
+        new_hash = {}
+        hash.each do |k,v|
+          new_k = case k
+                  when String
+                    k.underscore.to_sym
+                  else
+                    k
+                  end
+          new_v = case v
+                  when Hash
+                    rubyize_keys(v)
+                  when Array
+                    v.map {|w| (Hash === w) ? rubyize_keys(w) : w}
+                  else
+                    v
+                  end
+          new_hash[new_k] = new_v
+        end
+        new_hash
+      end
+    end
+  end
+end

data/lib/netprospex/middleware/raise_exceptions.rb

@@ -0,0 +1,31 @@
+require 'faraday_middleware/response_middleware'
+
+module NetProspex
+  module Middleware
+    class RaiseExceptions < Faraday::Middleware
+      def call(environment)
+        @app.call(environment).on_complete do |env|
+          next unless env[:body].is_a?(Hash) && (error = env[:body][:response][:error])
+          case error[:code]
+          when "ACL"
+            raise NetProspex::AccessDenied.new(error[:message])
+          when "AUTH"
+            raise NetProspex::AuthenticationError.new(error[:message])
+          when "DB"
+            raise NetProspex::DatabaseError.new(error[:message])
+          when "SS"
+            raise NetProspex::SearchError.new(error[:message])
+          when "PAG"
+            raise NetProspex::PaginationError.new(error[:message])
+          when "REQ"
+            raise NetProspex::ArgumentMissing.new(error[:message])
+          when "ZBAL"
+            raise NetProspex::ZeroBalanceError.new(error[:message])
+          when "FAULT","UNX"
+            raise NetProspex::ApiError.new(error[:message])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/netprospex/middleware/rubyize.rb

@@ -0,0 +1,16 @@
+require 'faraday_middleware/response_middleware'
+module NetProspex
+  module Middleware
+    class Rubyize < FaradayMiddleware::ResponseMiddleware
+      extend NetProspex::Helpers::Formatters
+
+      define_parser do |body|
+        rubyize_keys(body) if body.is_a? Hash
+      end
+
+      def parse_response?(env)
+        env[:body].is_a? Hash
+      end
+    end
+  end
+end

data/lib/netprospex/query_methods.rb

@@ -0,0 +1,41 @@
+module NetProspex
+  module QueryMethods
+    def find_person(query)
+      response = get('/person/profile.json', query)
+      store_balance(response)
+      if p = response.fetch(:response,{}).fetch(:person_profile,{})[:person]
+        return NetProspex::Api::Person.new(p)
+      else
+        return nil
+      end
+    end
+
+    def find_person_by_id(id)
+      find_person(person_id: id)
+    end
+
+    def find_person_by_email(email)
+      find_person(email: email)
+    end
+
+    def find_people(query)
+      # these are boolean but the API wants 0 or 1
+      [:calc_found_rows, :preview].each do |k|
+        query[k] = 1 if query[k]
+      end
+      response = get('/person/list.json', query)
+      store_balance(response)
+      if persons = response.fetch(:response,{}).fetch(:person_list,{})[:persons]
+        return persons.map{|p| NetProspex::Api::Person.new(p)}
+      else
+        return [] #TODO should this raise an error?
+      end
+    end
+
+    protected
+    def store_balance(hash)
+      balance = hash.fetch(:response,{}).fetch(:transaction,{})[:account_end_balance]
+      @account_balance = balance if balance
+    end
+  end
+end

data/lib/netprospex/version.rb

@@ -0,0 +1,3 @@
+module NetProspex
+  VERSION = "0.0.1"
+end

data/lib/netprospex.rb

@@ -0,0 +1,8 @@
+Dir[File.dirname(__FILE__) + '/netprospex/helpers/*.rb'].each {|file| require file }
+Dir[File.dirname(__FILE__) + '/netprospex/middleware/*.rb'].each {|file| require file }
+Dir[File.dirname(__FILE__) + '/netprospex/api/*.rb'].each {|file| require file }
+Dir[File.dirname(__FILE__) + '/netprospex/*.rb'].each {|file| require file }
+
+module NetProspex
+  extend Configuration
+end

data/netprospex.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'netprospex/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'netprospex'
+  gem.version       = NetProspex::VERSION
+  gem.authors       = ['Michael Limiero']
+  gem.email         = ['mike5713@gmail.com']
+  gem.homepage      = 'https://github.com/SalesLoft/netprospex-ruby'
+  gem.summary       = %q{Ruby bindings for NetProspex API}
+  gem.description   = %q{The NetProspex API provides search and lookup for detailed information on people and companies.}
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency 'bundler', '~> 1.3'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'webmock'
+  gem.add_development_dependency 'vcr'
+  gem.add_runtime_dependency 'activesupport'
+  gem.add_runtime_dependency 'faraday'
+  gem.add_runtime_dependency 'faraday_middleware'
+  gem.add_runtime_dependency 'json'
+  gem.add_runtime_dependency 'simple_oauth'
+end

data/spec/netprospex/api/organization_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+require 'vcr_helper'
+require_relative '../../../lib/netprospex.rb'
+
+describe NetProspex::Api::Organization do
+  before(:each) do
+    NetProspex.configure do |c|
+      c.consumer_key = ENV['NETPROSPEX_KEY']
+      c.consumer_secret = ENV['NETPROSPEX_SECRET']
+      c.environment = :sandbox
+    end
+  end
+
+  let(:client) { NetProspex::Client.new(ENV['NETPROSPEX_USER_TOKEN'], ENV['NETPROSPEX_USER_SECRET']) }
+  let(:person) {
+    VCR.use_cassette("person-by-id") do
+      client.find_person_by_id(29435533)
+    end
+  }
+  let(:organization) { person.organization }
+
+  it "simplifies domains to an array" do
+    organization.domains.should be_an Array
+    organization.domains.first.should be_a String
+  end
+
+  it "converts phones to objects" do
+    organization.phones.should be_an Array
+    organization.phones.first.should be_a NetProspex::Api::Phone
+  end
+
+  it "converts address to an object" do
+    organization.postal_address.should be_a NetProspex::Api::Address
+  end
+
+  context "when missing data" do
+    let(:incomplete_organization) {
+      VCR.use_cassette("incomplete-organization") do
+        client.find_person_by_id(85652828).organization
+      end
+    }
+
+    it "has nil address" do
+      incomplete_organization.postal_address.should be_nil
+    end
+
+    it "has empty phones array" do
+      incomplete_organization.phones.should be_an Array
+      incomplete_organization.phones.should be_empty
+    end
+  end
+end

data/spec/netprospex/api/person_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+require 'vcr_helper'
+require_relative '../../../lib/netprospex.rb'
+
+describe NetProspex::Api::Person do
+  before(:each) do
+    NetProspex.configure do |c|
+      c.consumer_key = ENV['NETPROSPEX_KEY']
+      c.consumer_secret = ENV['NETPROSPEX_SECRET']
+      c.environment = :sandbox
+    end
+  end
+
+  let(:client) { NetProspex::Client.new(ENV['NETPROSPEX_USER_TOKEN'], ENV['NETPROSPEX_USER_SECRET']) }
+  let(:person) {
+    VCR.use_cassette("person-by-id") do
+      client.find_person_by_id(29435533)
+    end
+  }
+
+  it "converts organization to an object" do
+    person.organization.should be_a NetProspex::Api::Organization
+  end
+
+  it "converts phones to objects" do
+    person.phones.should be_an Array
+    person.phones.first.should be_a NetProspex::Api::Phone
+  end
+
+  it "converts address to an object" do
+    person.postal_address.should be_a NetProspex::Api::Address
+  end
+
+  context "when missing data" do
+    let(:incomplete_person) {
+      VCR.use_cassette("incomplete-person") do
+        client.find_people(organization_name: "Pardot", preview: true, limit: 1).first
+      end
+    }
+
+    it "has empty phones array" do
+      incomplete_person.phones.should be_an Array
+      incomplete_person.phones.should be_empty
+    end
+  end
+end

data/spec/netprospex/client_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+require "vcr_helper"
+require_relative "../../lib/netprospex.rb"
+
+describe NetProspex::Client do
+  before(:each) do
+    NetProspex.configure do |c|
+      c.consumer_key = ENV['NETPROSPEX_KEY']
+      c.consumer_secret = ENV['NETPROSPEX_SECRET']
+      c.environment = :sandbox
+    end
+  end
+
+  let(:client) { NetProspex::Client.new(ENV['NETPROSPEX_USER_TOKEN'], ENV['NETPROSPEX_USER_SECRET']) }
+
+  it "makes GET requests" do
+    VCR.use_cassette("industries") do
+      client.get("/industries.json")
+    end
+  end
+
+  it "makes GET requests with fancy parameters" do
+    VCR.use_cassette("person-list") do
+      client.get("/person/list.json", organization_name: ["Pardot", "Silverpop"])
+    end
+  end
+end

data/spec/netprospex/configuration_spec.rb

@@ -0,0 +1,22 @@
+require "spec_helper"
+require_relative "../../lib/netprospex.rb"
+
+describe NetProspex::Configuration do
+  it "can be configured" do
+    expect {
+      NetProspex.configure do |config|
+        config.consumer_key = "foo"
+        config.consumer_secret = "bar"
+        config.environment = :sandbox
+      end
+    }.to_not raise_exception
+  end
+
+  it "validates environment" do
+    expect {
+      NetProspex.configure do |config|
+        config.environment = :bad_value
+      end
+    }.to raise_exception(NetProspex::ConfigurationError)
+  end
+end

data/spec/netprospex/helpers/formatters_spec.rb

@@ -0,0 +1,78 @@
+require "spec_helper"
+require_relative "../../../lib/netprospex.rb"
+
+describe NetProspex::Helpers::Formatters do
+  include NetProspex::Helpers::Formatters
+  describe ".unrubyize_keys" do
+    it "converts snake_case to camelCase" do
+      unrubyize_keys(first_name: "John", last_name: "Doe").should == {
+        'firstName' => 'John',
+        'lastName' => 'Doe'
+      }
+    end
+
+    it "handles nested hashes" do
+      unrubyize_keys(some_person: {first_name: "John", last_name: "Doe"}).should ==
+        {'somePerson' => {'firstName' => 'John', 'lastName' => 'Doe'}}
+    end
+
+    it "handles array values" do
+      unrubyize_keys(some_people: [
+                     {first_name: "John", last_name: "Doe"},
+                     {first_name: "Mary", last_name: "Smith"}
+      ]).should == {'somePeople' => [
+        {'firstName' => 'John', 'lastName' => 'Doe'},
+        {'firstName' => 'Mary', 'lastName' => 'Smith'}
+      ]}
+    end
+  end
+
+  describe ".rubyize_keys" do
+    it "converts camelCase to snake_case" do
+      rubyize_keys({
+        'firstName' => 'John',
+        'lastName' => 'Doe'
+      }).should == {first_name: "John", last_name: "Doe"} 
+    end
+
+    it "handles nested hashes" do
+      rubyize_keys({'somePerson' =>
+                   {'firstName' => 'John', 'lastName' => 'Doe'}}).should ==
+        {some_person: {first_name: "John", last_name: "Doe"}}
+    end
+
+    it "handles array values" do
+      rubyize_keys({'somePeople' => [
+        {'firstName' => 'John', 'lastName' => 'Doe'},
+        {'firstName' => 'Mary', 'lastName' => 'Smith'}
+      ]}).should == {some_people: [
+        {first_name: "John", last_name: "Doe"},
+        {first_name: "Mary", last_name: "Smith"}
+      ]}
+    end
+  end
+
+  describe ".stringify_query" do
+    it "is blank for empty query" do
+      stringify_query(nil).should == ""
+      stringify_query({}).should == ""
+    end
+
+    it "converts snake_case keys to camelCase" do
+      stringify_query(first_name: "John", last_name: "Doe").should ==
+        "?firstName=John&lastName=Doe"
+    end
+
+    it "escapes keys and values" do
+      stringify_query('be safe?&=' => 'foo').should ==
+        "?be+safe%3F%26%3D=foo"
+      stringify_query(first_name: "John&doEvil=true").should ==
+        "?firstName=John%26doEvil%3Dtrue"
+    end
+
+    it "handles array values" do
+      stringify_query(companies: ["Apple", "Google"]).should ==
+        "?companies%5B%5D=Apple&companies%5B%5D=Google"
+    end
+  end
+end