igsearch 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 24fb34f4f3914f863ac70aedad7c6a966e792e04
+  data.tar.gz: 1c91f81d712a43a999d0fb5065b7d02f2339afd6
+SHA512:
+  metadata.gz: 864c9483df219229282e1a24fcc22124b29c6c081d6d3d6a6a90974be68b3c650afb7b53084073bd22296aec3498afcba3f2bc8a1251fe0a79f28bc8f9b0c10b
+  data.tar.gz: 1bb30b216a165f1a44c092b7a5bf8d69df28fff8b98e10d4af1121e424b2f323c98b2a6c8ce8ef2b1572553da747db309766a185638851d08f0278cc73390e6d

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+test.rb
+*.env

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in igsearch.gemspec
+gemspec
+
+group :test do
+  # gem 'webmock'
+  gem 'vcr'
+  gem 'turn'
+  gem 'rake'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Hayk Saakian
+
+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.md

@@ -0,0 +1,48 @@
+# Igsearch
+
+This is a Ruby gem that makes it easier to talk to the [Infogroup API](http://developer.infoconnect.com/).
+
+The Infogroup API lets you search for people or businesess based on criteria that would be useful for conducting sales activity.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'igsearch'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install igsearch
+
+## Usage
+
+1.  Configure an API Key
+
+Igsearch.configure do |config|
+  config.apikey = ENV["INFOCONNECT_API_KEY"]
+end
+
+2.  Use the API
+
+person = Igsearch::Person.search({
+  :FirstName => "William",
+  :LastName => "Gates",
+  :City => "Redmond",
+  :StateProvince => "WA"
+}).first # .search returns an array
+# => {"ETag"=>"bd62003e", "Id"=>"601223668643", "Links"=>[{"Href"=>"/v1/people/601223668643", "Rel"=>"self"}], "Address"=>"1 Microsoft Way Bldg 3", "AddressParsed"=>{"Name"=>"Microsoft", "Number"=>"1", "Suffix"=>"Way", "UnitNumber"=>"3", "UnitType"=>"Bldg"}, "City"=>"Redmond", "FirstName"=>"William", "LastName"=>"Gates", "Location"=>{"Latitude"=>47.639661, "Longitude"=>-122.130606}, "MiddleInitial"=>"H", "PostalCode"=>"98052", "StateProvince"=>"WA"} 
+
+3. There is no step 3
+
+## Contributing
+
+1. Fork it ( https://github.com/hayksaakian/igsearch/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+
+  t.libs << 'lib/igsearch'
+  t.test_files = FileList['test/lib/igsearch/*_test.rb']
+  t.verbose = true
+end
+ 
+task :default => :test

data/igsearch.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'igsearch/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "igsearch"
+  spec.version       = Igsearch::VERSION
+  spec.authors       = ["hayksaakian"]
+  spec.email         = ["hayk@skyrealre.com"]
+  spec.summary       = %q{Wrapper for Infoconnect API. (Unofficial)}
+  spec.description   = %q{Search through groups of people and businesses with this API.}
+  spec.homepage      = "https://www.github.com/hayksaakian/igsearch"
+  spec.license       = "MIT"
+
+  # files must be commited before they're included in the build
+  spec.files         = `git ls-files -z`.split("\x0") 
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httparty", "~> 0"
+  spec.add_dependency "StreetAddress", "~> 1.0.5"
+  spec.add_development_dependency "dotenv", "~> 0"
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 0"
+end
+

data/lib/igsearch.rb

@@ -0,0 +1,38 @@
+require 'igsearch/version'
+require 'igsearch/person'
+
+module Igsearch
+  # Public: Set global options. 
+  #
+  # Yields the Igsearch module so you can set options on it.
+  #
+  # Returns self.
+  def self.configure
+    yield self
+    # TODO: find a better way to do this
+    self::Person.default_params :apikey => self.apikey
+    self
+  end
+  # Public: Reset the configuration to the defaults. Useful for testing.
+  #
+  # Returns nil.
+  def self.reset!
+    @apikey = nil
+  end
+  class << self
+    # Public: Your Infogroup API key.
+    attr_accessor :apikey
+  end
+end
+
+####################################
+##
+##   Punting to next major version:
+##
+########
+# class Company
+# end
+# class SIC
+# end
+# class Match
+# end

data/lib/igsearch/person.rb

@@ -0,0 +1,93 @@
+require 'httparty'
+require 'street_address'
+require 'json'
+
+module Igsearch
+
+  def self.live_api?
+    HTTParty.get('http://api.infoconnect.com/v1/').code == 200
+  end
+
+  # docs: http://developer.infoconnect.com/post-search-0
+  class Person
+    include HTTParty
+
+    base_uri "api.infoconnect.com/v1/people"
+    headers 'Content-Type' => 'application/json', 'Accept' => 'application/json'
+    format :json
+    # debug_output $stdout
+
+    # BUG/PROBLEM:
+    # still need to .to_json to send json...
+
+    def initialize(apikey=Igsearch.apikey)
+      # this changes it for all instances
+      self.class.default_params :apikey => apikey
+    end
+
+    def self.hi
+      return "success #{Igsearch.apikey}"
+    end
+
+    def self.find(id, options={})
+
+      response = get("/#{id}", options)
+
+      return response.parsed_response if response.success?
+      handle_error response
+    end
+
+    def self.search(criteria, options={})
+      response = post('/search', :body => criteria.to_json)
+
+      return response.parsed_response if response.success?
+      handle_error response
+    end
+
+    def self.search_raw_address(raw_address, options={})
+      p_address = StreetAddress::US.parse(raw_address)
+
+      return [] if p_address.nil?
+
+      address = self.render_parsed_address_to_api_format(p_address)
+      self.search(address, options)
+    end
+
+    def self.count(criteria, options={})
+      response = post('/count', body: criteria.to_json)
+
+      return response.parsed_response["MatchCount"] if response.success?
+      handle_error response
+    end
+
+    private
+    def self.handle_error(response)
+      raise response.response.code + ' ' + response.response.message # fix this to show resp. code and message
+    end
+
+    def self.render_parsed_address_to_api_format(address)
+      ap = {} # address, parsed and rendered for infogroup API
+      ap["Number"] = address.number
+      ap["PreDirectional"] = address.prefix
+      ap["Name"] = address.street
+      # the infoconnect api has different names than
+      # those used by the street_address gem
+      ap["Suffix"] = address.street_type # this is not a mistake
+      ap["PostDirectional"] = address.suffix # this is not a mistake
+      # for buildings
+      ap["UnitNumber"] = address.unit
+      ap["UnitType"] = address.unit_prefix
+      # clean up null keys/values
+      ap.delete_if { |k, v| v.nil? }
+      qap = {}
+      qap["AddressParsed"] = ap
+      qap["City"] = address.city
+      qap["StateProvince"] = address.state
+      qap["PostalCode"] = address.postal_code
+
+      qap.delete_if { |k, v| v.nil? }
+      
+      return qap
+    end
+  end
+end

data/lib/igsearch/version.rb

@@ -0,0 +1,3 @@
+module Igsearch
+  VERSION = "0.0.2"
+end

data/test/lib/igsearch/person_test.rb

@@ -0,0 +1,56 @@
+require_relative '../../test_helper'
+
+describe Igsearch do
+
+  before do
+    Igsearch.configure do |config|
+      config.apikey = ENV["INFOCONNECT_API_KEY"]
+    end
+  end
+
+  it "must say hi" do
+    assert Igsearch::Person.hi.is_a?(String), "something weird is messed up"
+  end
+
+  it "must access a live API" do
+    assert Igsearch.live_api?, "API is not live!"
+  end
+
+  it "must find person by id" do 
+    person = Igsearch::Person.find('601223668643')
+    assert !person.nil?, "No person found by id"
+    assert person['FirstName'] == "William", "Did not find Bill Gates!"
+  end
+
+  it "must find bill gates by search" do
+    person = Igsearch::Person.search({
+      :FirstName => "William",
+      :LastName => "Gates",
+      :City => "Redmond",
+      :StateProvince => "WA"
+      }).first
+    assert !person.nil?, "No person found by search"
+    assert person['Id'] == '601223668643', "This is not the right Bill Gates!"
+  end
+
+  it "must find bill gates by raw address" do
+    person = Igsearch::Person.search_raw_address("1 Microsoft Way, Redmond, WA").first
+    assert !person.nil?, "No person found by raw address"
+    assert person['Id'] == '601223668643', "This is not Bill Gates' Address!"
+  end
+
+  it "must handle bad raw address" do
+    person = Igsearch::Person.search_raw_address("123 Any Street").first
+
+    assert person.nil?, "Did not handle errors properly"
+  end
+
+  it "must count rich people named paul allen" do
+    num_people = Igsearch::Person.count({
+      :FirstName => "Paul",
+      :LastName => "Allen",
+      :ActualIncome => ["400000", "500000"]
+      })
+    assert num_people > 0, "Bill Gates either isnt very rich or couldnt be found"
+  end
+end

data/test/lib/igsearch/version_test.rb

@@ -0,0 +1,9 @@
+require_relative '../../test_helper'
+ 
+describe Igsearch do
+ 
+  it "must be defined" do
+    Igsearch::VERSION.wont_be_nil
+  end
+ 
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'dotenv'
+require File.expand_path('../../lib/igsearch.rb', __FILE__)
+
+Dotenv.load

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: igsearch
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- hayksaakian
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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: StreetAddress
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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'
+description: Search through groups of people and businesses with this API.
+email:
+- hayk@skyrealre.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- igsearch.gemspec
+- lib/igsearch.rb
+- lib/igsearch/person.rb
+- lib/igsearch/version.rb
+- test/lib/igsearch/person_test.rb
+- test/lib/igsearch/version_test.rb
+- test/test_helper.rb
+homepage: https://www.github.com/hayksaakian/igsearch
+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.2
+signing_key: 
+specification_version: 4
+summary: Wrapper for Infoconnect API. (Unofficial)
+test_files:
+- test/lib/igsearch/person_test.rb
+- test/lib/igsearch/version_test.rb
+- test/test_helper.rb