netprospex-ruby 0.0.3

data/spec/netprospex/api/organization_spec.rb

@@ -0,0 +1,51 @@
+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']
+    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,45 @@
+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']
+    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,34 @@
+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']
+    end
+  end
+  after(:each) { NetProspex.reset }
+
+  let(:client) { NetProspex::Client.new(ENV['NETPROSPEX_USER_TOKEN'], ENV['NETPROSPEX_USER_SECRET']) }
+
+  it "builds the version into the api url" do
+    NetProspex.configure { |c| c.version = "9.9" }
+    stub = stub_request(:get, %r(api\.netprospex\.com/9\.9/.*)).to_return(body: '{"response":{}}', headers: {'Content-Type' => 'application/json'})
+    client.get("/industries.json")
+    stub.should have_been_requested
+  end
+
+  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,21 @@
+require "spec_helper"
+require_relative "../../lib/netprospex.rb"
+
+describe NetProspex::Configuration do
+  after(:each) { NetProspex.reset }
+
+  it "can be configured" do
+    expect {
+      NetProspex.configure do |config|
+        config.consumer_key = "foo"
+        config.consumer_secret = "bar"
+        config.version = "1.1"
+      end
+    }.to_not raise_exception
+  end
+
+  it "stores the api version" do
+    NetProspex.configure { |config| config.version = "9.9" }
+    NetProspex.version.should == "9.9"
+  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

data/spec/netprospex/middleware/raise_exceptions_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+require 'vcr_helper'
+require_relative "../../../lib/netprospex.rb"
+
+describe NetProspex::Middleware::RaiseExceptions do
+  before(:each) do
+    NetProspex.configure do |c|
+      c.consumer_key = ENV['NETPROSPEX_KEY']
+      c.consumer_secret = ENV['NETPROSPEX_SECRET']
+    end
+  end
+
+  let(:client) { NetProspex::Client.new(ENV['NETPROSPEX_USER_TOKEN'], ENV['NETPROSPEX_USER_SECRET']) }
+
+  it "raises AccessDenied" do
+    VCR.use_cassette('acl-error') do
+      expect {
+        client.get('/prospect/profile.json', organization_name: 'Pardot')
+      }.to raise_exception(NetProspex::AccessDenied)
+    end
+  end
+
+  it "raises AuthenticationError" do
+    VCR.use_cassette('auth-error') do
+      expect {
+        NetProspex::Client.new('bad','keys').get('/industries.json')
+      }.to raise_exception(NetProspex::AuthenticationError)
+    end
+  end
+
+  it "raises PaginationError" do
+    VCR.use_cassette('pag-error') do
+      expect {
+        client.get('/person/list.json', organization_name: 'Pardot', offset: -1)
+      }.to raise_exception(NetProspex::PaginationError)
+    end
+  end
+
+  it "raises ArgumentMissing" do
+    VCR.use_cassette('req-error') do
+      expect {
+        client.get('/person/list.json')
+      }.to raise_exception(NetProspex::ArgumentMissing)
+    end
+  end
+
+  # these are hard to produce so they're stubbed instead of VCRed
+  it "raises ZeroBalanceError" do
+    stub_request(:get, %r(api\.netprospex\.com/1\.1/person/list\.json)).to_return(body: '{"response":{"error":{"message":"zero balance","code":"ZBAL"}}}', headers: {'Content-Type' => 'application/json'})
+    expect {
+      puts client.get('/person/list.json', organization_name: 'Pardot')
+    }.to raise_exception(NetProspex::ZeroBalanceError)
+  end
+
+  it "raises DatabaseError" do
+    stub_request(:get, %r(api\.netprospex\.com/1\.1/person/list\.json)).to_return(body: '{"response":{"error":{"message":"database error","code":"DB"}}}', headers: {'Content-Type' => 'application/json'})
+    expect {
+      puts client.get('/person/list.json', organization_name: 'Pardot')
+    }.to raise_exception(NetProspex::DatabaseError)
+  end
+
+  it "raises SearchError" do
+    stub_request(:get, %r(api\.netprospex\.com/1\.1/person/list\.json)).to_return(body: '{"response":{"error":{"message":"search engine error","code":"SS"}}}', headers: {'Content-Type' => 'application/json'})
+    expect {
+      puts client.get('/person/list.json', organization_name: 'Pardot')
+    }.to raise_exception(NetProspex::SearchError)
+  end
+
+  it "raises ApiError for unknown error" do
+    stub_request(:get, %r(api\.netprospex\.com/1\.1/person/list\.json)).to_return(body: '{"response":{"error":{"message":"unknown error","code":"UNX"}}}', headers: {'Content-Type' => 'application/json'})
+    expect {
+      puts client.get('/person/list.json', organization_name: 'Pardot')
+    }.to raise_exception(NetProspex::ApiError)
+  end
+
+  it "raises ApiError for general error" do
+    stub_request(:get, %r(api\.netprospex\.com/1\.1/person/list\.json)).to_return(body: '{"response":{"error":{"message":"general error","code":"FAULT"}}}', headers: {'Content-Type' => 'application/json'})
+    expect {
+      puts client.get('/person/list.json', organization_name: 'Pardot')
+    }.to raise_exception(NetProspex::ApiError)
+  end
+
+  it "raises ApiError for version error" do
+    stub_request(:get, %r(api\.netprospex\.com/1\.1/person/list\.json)).to_return(
+      body: '{"response":{"version":"1.1","responseId":"8A3837BF-AB10-F3B4-EA19-0606207939CE","responseType":"error","request":{"startTime":"2013-09-04 09:18:21","requestType":"person_list","url":"\/1.1\/person\/list.json?firstName=Bob&lastName=Colananni&preview=1","userId":"1aebe6ed-6c79-11e2-a4df-f04da23ce7b0"},"transaction":{"accountId":"1ad39da8-6c79-11e2-a4df-f04da23ce7b0","accountStartBalance":100000,"accountEndBalance":null},"error":{"message":"invalid API version=1.1","code":"ARG"},"debug":{"requestTime":0.0185089111328}}}',
+      headers: {'Content-Type' => 'application/json'}
+    )
+    expect {
+      puts client.get('/person/list.json', organization_name: 'Pardot')
+    }.to raise_exception(NetProspex::ApiError)
+  end
+end

data/spec/netprospex/query_methods_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+require 'vcr_helper'
+require_relative "../../lib/netprospex.rb"
+
+describe NetProspex::QueryMethods do
+  before(:each) do
+    NetProspex.configure do |c|
+      c.consumer_key = ENV['NETPROSPEX_KEY']
+      c.consumer_secret = ENV['NETPROSPEX_SECRET']
+    end
+  end
+
+  let(:client) { NetProspex::Client.new(ENV['NETPROSPEX_USER_TOKEN'], ENV['NETPROSPEX_USER_SECRET']) }
+
+  describe "#find_person_by_id" do
+    it "gets a person" do
+      VCR.use_cassette("person-by-id") do
+        resp = client.find_person_by_id(29435533)
+        resp.should be_a NetProspex::Api::Person
+        resp.person_id.should == 29435533
+      end
+    end
+
+    it "stores account balance" do
+      VCR.use_cassette("person-by-id") do
+        client.account_balance.should be_nil
+        client.find_person_by_id(29435533)
+        client.account_balance.should_not be_nil
+      end
+    end
+  end
+
+  describe "#find_person_by_email" do
+    it "gets a person" do
+      VCR.use_cassette("person-by-email") do
+        resp = client.find_person_by_email("grublev@netprospex.com")
+        resp.should be_a NetProspex::Api::Person
+        resp.email.should == "grublev@netprospex.com"
+      end
+    end
+
+    it "stores account balance" do
+      VCR.use_cassette("person-by-email") do
+        client.account_balance.should be_nil
+        client.find_person_by_email("grublev@netprospex.com")
+        client.account_balance.should_not be_nil
+      end
+    end
+  end
+
+  describe "#find_people" do
+    it "gets a list of people" do
+      VCR.use_cassette("person-list") do
+        resp = client.find_people(organization_name: ["Pardot", "Silverpop"])
+        resp.should be_an Array
+        resp.first.should be_a NetProspex::Api::Person
+      end
+    end
+
+    it "stores account balance" do
+      VCR.use_cassette("person-list") do
+        client.account_balance.should be_nil
+        client.find_people(organization_name: ["Pardot", "Silverpop"])
+        client.account_balance.should_not be_nil
+      end
+    end
+  end
+end

data/spec/netprospex_spec.rb

@@ -0,0 +1,5 @@
+require "spec_helper"
+require_relative "../lib/netprospex.rb"
+
+describe NetProspex do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'webmock/rspec'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.order = 'random'
+end

data/spec/vcr_helper.rb

@@ -0,0 +1,12 @@
+require "vcr"
+
+VCR.configure do |c|
+  c.cassette_library_dir = "fixtures/cassettes"
+  c.hook_into :webmock
+  c.default_cassette_options  = { :record => :once }
+  c.configure_rspec_metadata!
+  c.filter_sensitive_data('<NETPROSPEX_KEY>') { ENV['NETPROSPEX_KEY'] }
+  c.filter_sensitive_data('<NETPROSPEX_SECRET>') { ENV['NETPROSPEX_SECRET'] }
+  c.filter_sensitive_data('<NETPROSPEX_USER_TOKEN>') { ENV['NETPROSPEX_USER_TOKEN'] }
+  c.filter_sensitive_data('<NETPROSPEX_USER_SECRET>') { ENV['NETPROSPEX_USER_SECRET'] }
+end

metadata

@@ -0,0 +1,236 @@
+--- !ruby/object:Gem::Specification
+name: netprospex-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Michael Limiero
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simple_oauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The NetProspex API provides search and lookup for detailed information
+  on people and companies.
+email:
+- mike5713@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fixtures/cassettes/acl-error.yml
+- fixtures/cassettes/auth-error.yml
+- fixtures/cassettes/incomplete-organization.yml
+- fixtures/cassettes/incomplete-person.yml
+- fixtures/cassettes/industries.yml
+- fixtures/cassettes/pag-error.yml
+- fixtures/cassettes/person-by-email.yml
+- fixtures/cassettes/person-by-id.yml
+- fixtures/cassettes/person-list.yml
+- fixtures/cassettes/req-error.yml
+- lib/netprospex.rb
+- lib/netprospex/api/address.rb
+- lib/netprospex/api/organization.rb
+- lib/netprospex/api/person.rb
+- lib/netprospex/api/phone.rb
+- lib/netprospex/api/sub_objects.rb
+- lib/netprospex/client.rb
+- lib/netprospex/configuration.rb
+- lib/netprospex/exceptions.rb
+- lib/netprospex/helpers/formatters.rb
+- lib/netprospex/middleware/raise_exceptions.rb
+- lib/netprospex/middleware/rubyize.rb
+- lib/netprospex/query_methods.rb
+- lib/netprospex/version.rb
+- netprospex.gemspec
+- spec/netprospex/api/organization_spec.rb
+- spec/netprospex/api/person_spec.rb
+- spec/netprospex/client_spec.rb
+- spec/netprospex/configuration_spec.rb
+- spec/netprospex/helpers/formatters_spec.rb
+- spec/netprospex/middleware/raise_exceptions_spec.rb
+- spec/netprospex/query_methods_spec.rb
+- spec/netprospex_spec.rb
+- spec/spec_helper.rb
+- spec/vcr_helper.rb
+homepage: https://github.com/SalesLoft/netprospex-ruby
+licenses:
+- MIT
+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.2.1
+signing_key: 
+specification_version: 4
+summary: Ruby bindings for NetProspex API
+test_files:
+- spec/netprospex/api/organization_spec.rb
+- spec/netprospex/api/person_spec.rb
+- spec/netprospex/client_spec.rb
+- spec/netprospex/configuration_spec.rb
+- spec/netprospex/helpers/formatters_spec.rb
+- spec/netprospex/middleware/raise_exceptions_spec.rb
+- spec/netprospex/query_methods_spec.rb
+- spec/netprospex_spec.rb
+- spec/spec_helper.rb
+- spec/vcr_helper.rb
+has_rdoc: