demandbase 0.1.1 → 0.1.2

data/CHANGELOG.md

@@ -1,6 +1,16 @@
+# 0.1.2
+
+* `Demandbase::lookup()` now returns nil if no record is found.
+
+* Added some new Error classes to
+ * raises a `Demandbase::RTIDNotSetError` if a RTID key is not set.
+ * raises a `Demandbase::ParseError `if the domain doesn't look legit.
+ * raises a `Demandbase::ServerError` if the Demandbase server is unresponsive.
+
+
 # 0.1.1
 
-* Add support for subdomains, email addresses, etc. e.g. the following now work:
+* Added support for subdomains, email addresses, etc. e.g. the following now work:
 
 ```ruby
   Demandbase::Record.new "www.github.com",

data/Gemfile

@@ -5,8 +5,9 @@ gem "public_suffix", "~> 1.2.0"
 gem "rest-client",   "~> 1.6.7"
 
 group :development do
-  gem "shoulda",  ">= 0"
-  gem "rdoc",     "~> 3.12"
   gem "bundler",  "~> 1.2.1"
   gem "jeweler",  "~> 1.8.3"
+  gem "mocha",      "~> 0.13.3"
+  gem "rdoc",     "~> 3.12"
+  gem "shoulda",  ">= 3.3.2"
 end

data/Gemfile.lock

@@ -4,8 +4,6 @@ GEM
     activesupport (3.2.12)
       i18n (~> 0.6)
       multi_json (~> 1.0)
-    bourne (1.1.2)
-      mocha (= 0.10.5)
     git (1.2.5)
     i18n (0.6.4)
     jeweler (1.8.4)
@@ -16,7 +14,7 @@ GEM
     json (1.7.7)
     metaclass (0.0.1)
     mime-types (1.21)
-    mocha (0.10.5)
+    mocha (0.13.3)
       metaclass (~> 0.0.1)
     multi_json (1.6.1)
     public_suffix (1.2.0)
@@ -29,9 +27,8 @@ GEM
       shoulda-context (~> 1.0.1)
       shoulda-matchers (~> 1.4.1)
     shoulda-context (1.0.2)
-    shoulda-matchers (1.4.2)
+    shoulda-matchers (1.4.1)
       activesupport (>= 3.0.0)
-      bourne (~> 1.1.2)
 
 PLATFORMS
   ruby
@@ -40,7 +37,8 @@ DEPENDENCIES
   bundler (~> 1.2.1)
   jeweler (~> 1.8.3)
   json (~> 1.7.7)
+  mocha (~> 0.13.3)
   public_suffix (~> 1.2.0)
   rdoc (~> 3.12)
   rest-client (~> 1.6.7)
-  shoulda
+  shoulda (>= 3.3.2)

data/README.md

@@ -1,76 +1,93 @@
-# Prerequisites
+The Demandbase gem is a Ruby wrapper for the [Demandbase](http://www.demandbase.com?affiliate_id=LOL_JK_MAYBE) platform allowing you to [buzzwords here].
 
-* An active [Demandbase](http://www.demandbase.com?affiliate_id=LOL_JK_MAYBE) account with at least on RTID key.
+### Prerequisites
 
-# Installation
+You'll need an active Demandbase account with at least one Real Time Identification(RTID) key. You can sign up for a trial developer key [here](http://www.demandbase.com?affiliate_id=LOL_JK_MAYBE)).
 
-Install the Demandbase wrapper with `gem install demandbase`,
+### Installation
 
-# Configuraton
+Install the Demandbase wrapper with:
 
-Set an environment variable called `$DEMANDBASE_RTID_KEY` with the key value.
+`gem install demandbase`
 
-# Usage
+or add the following to your `Gemfile`:
 
-If everything's installed and configured you should be able to look up companies' information via their domain name or IP address as follows.
+`gem 'demandbase', '~> 0.1.1'`
 
-```ruby
-record = Demandbase::lookup_ip '123.12.1.123'
-# => <Demandbase::Record:0x007aba42a46484>
+### Configuraton
+
+Set an environment variable called `$DEMANDBASE_RTID_KEY` with the your RTID key value.
+
+#### Bash Example
+
+```
+export DEMANDBASE_RTID_KEY=1234deadbeef4321
+```
+
+#### Heroku Example
+
+```
+heroku set DEMANDBASE_RTID_KEY=1234deadbeef4321
+```
 
-record = Demandbase::lookup_domain 'ubs.com'
+### Usage
+
+If everything's installed and configured you should be able to look up companies' information via their domain name as follows:
+
+```ruby
+record = Demandbase::lookup_domain 'microsoft.com'
 # => <Demandbase::Record:0x007fce82a46060>
 
 record.company_name
-# => "UBS"
+# => "Microsoft Corporation"
 
 record.demandbase_sid
-# => 3874866
+# => 457441
 
 record.marketing_alias
-# => 3874866
+# => "Microsoft"
 
 record.industry
-# => "Financial Services"
+# => "Software & Technology"
 
 record.sub_industry
-# => "Banking & Finance"
+# => "Software Applications"
 
 record.employee_count
-# => 64820
+# => 94050
 
 record.primary_sic
-# => "6021"
+# => "7372"
 
 record.street_address
-# => "Bahnhofstrasse 45"
+# => "1 Microsoft Way"
 
 record.city
-# => "Z\u00fcrich"
+# => "Redmond"
 
 record.state
-# => "ZH"
+# => "WA"
 
 record.zip
-# => 8001
+# => "98052"
 
 record.country
-# => "CH"
+# => "US"
 
 record.country_name
-# => "Switzerland"
+# => "United States"
 
 record.phone
-# => "+41 44 234 11 11"
+# => "425-882-8080"
 
 record.stock_ticker
-# => "UBS"
+# => "MSFT"
 
 record.web_site
-# => "ubs.com"
+# => "microsoft.com"
 
 record.annual_sales
-# =>  30632917000
+# =>  73723000000
 
 record.revenue_range
 # =>  "Over $5B"
@@ -78,20 +95,29 @@ record.revenue_range
 record.employee_range
 # =>  "Enterprise"
 
+record.b2b
+# =>  true
+
+record.b2c
+# =>  true
+
+record.traffic
+# => "Very High"
+
 record.latitude
-# =>  0.0
+# =>  47.6401
 
 record.longitude
-# =>  0.0
+# =>  -122.13
 
 record.fortune_1000
-# =>  false
+# =>  true
 
 record.forbes_2000
 # =>  true
 ```
 
-# DLC / Enhancements
+### DLC / Enhancements
 
 * Use the [csi](https://github.com/leereilly/csi) gem if you'd like to correlate SIC codes with NAICS codes.
 * Use the [fortune-finder](https://github.com/leereilly/fortune-finder) gem if you'd like to retrieve the ranking of a Fortune 500 company.

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/demandbase.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "demandbase"
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Lee Reilly"]
@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
     "VERSION",
     "demandbase.gemspec",
     "lib/demandbase.rb",
+    "lib/demandbase/error.rb",
     "lib/demandbase/record.rb",
     "test/helper.rb",
     "test/test_demandbase.rb",
@@ -44,27 +45,30 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<json>, ["~> 1.7.7"])
       s.add_runtime_dependency(%q<public_suffix>, ["~> 1.2.0"])
       s.add_runtime_dependency(%q<rest-client>, ["~> 1.6.7"])
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
-      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_development_dependency(%q<bundler>, ["~> 1.2.1"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_development_dependency(%q<mocha>, ["~> 0.13.3"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<shoulda>, [">= 3.3.2"])
     else
       s.add_dependency(%q<json>, ["~> 1.7.7"])
       s.add_dependency(%q<public_suffix>, ["~> 1.2.0"])
       s.add_dependency(%q<rest-client>, ["~> 1.6.7"])
-      s.add_dependency(%q<shoulda>, [">= 0"])
-      s.add_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_dependency(%q<bundler>, ["~> 1.2.1"])
       s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_dependency(%q<mocha>, ["~> 0.13.3"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<shoulda>, [">= 3.3.2"])
     end
   else
     s.add_dependency(%q<json>, ["~> 1.7.7"])
     s.add_dependency(%q<public_suffix>, ["~> 1.2.0"])
     s.add_dependency(%q<rest-client>, ["~> 1.6.7"])
-    s.add_dependency(%q<shoulda>, [">= 0"])
-    s.add_dependency(%q<rdoc>, ["~> 3.12"])
     s.add_dependency(%q<bundler>, ["~> 1.2.1"])
     s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    s.add_dependency(%q<mocha>, ["~> 0.13.3"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<shoulda>, [">= 3.3.2"])
   end
 end
 

data/lib/demandbase.rb

@@ -1,21 +1,24 @@
 require 'json'
+require 'mocha/setup'
 require 'public_suffix'
 require 'rest_client'
 
+require 'demandbase/error'
 require 'demandbase/record'
 
 module Demandbase
    class << self
-    def lookup_domain(domain)
-      'Stanford University'
-    end
-
-    def lookup_ip(ip)
-      'Stanford University'
-    end
 
-    def lookup(domain_or_ip)
-      'Stanford University'
+    # Look up a Demandbase record for a given domain name.
+    #
+    # Returns a Demandbase::Record if the record is found; nil otherwise.
+    #
+    # Raises a Demandbase::RTIDNotSetError if a RTID key is not set.
+    # Raises a Demandbase::ParseError if the domain doesn't look legit.
+    # Raises a Demandbase::ServerError if the Demandbase server is unresponsive.
+    #
+    def lookup(domain)
+      Demandbase::Record.new(domain)
     end
   end
 end

data/lib/demandbase/error.rb

@@ -0,0 +1,17 @@
+module Demandbase
+
+  # The base error class for all Demandbase error classes.
+  class Error < StandardError
+  end
+
+  # Raised when the query string doesn't look like a domain
+  class ParseError < Error
+  end
+
+  class RTIDNotSetError < Error
+  end
+
+  # Raised when there's a problem communicating with the Demandbase server.
+  class ServerError < Error
+  end
+end

data/lib/demandbase/record.rb

@@ -1,9 +1,4 @@
 module Demandbase
-  RTID_KEY = ENV['DEMANDBASE_RTID_KEY']
-  API_URLS = {
-    :domain => "http://api.demandbase.com/api/v1/domain.json?key=#{RTID_KEY}",
-    :ip     => "http://api.demandbase.com/api/v1/ip.json?key=#{RTID_KEY}" }
-
   class Record
     attr_accessor :company_name
     attr_accessor :demandbase_sid
@@ -34,11 +29,20 @@ module Demandbase
 
     # Instantiate a new Demandbase Record from a domain name.
     def initialize(domain)
-      query = cleanse_domain(domain)
-      url = Demandbase::API_URLS[:domain] + "&query=#{query}"
+      raise Demandbase::RTIDNotSetError if rtid_key.nil?
 
       begin
-        response          = JSON.parse(RestClient.get(url))
+        query = cleanse_domain(domain)
+        url = domain_api_url + "&query=#{query}"
+      rescue => e
+        raise Demandbase::ParseError
+      end
+
+      begin
+        response = JSON.parse(RestClient.get(url))
+
+        return nil unless response["domain"]
+
         @company_name     = response["domain"]["company_name"]
         @demandbase_sid   = response["domain"]["demandbase_sid"]
         @marketing_alias  = response["domain"]["marketing_alias"]
@@ -66,7 +70,7 @@ module Demandbase
         @fortune_1000     = response["domain"]["fortune_1000"]
         @forbes_2000      = response["domain"]["forbes_2000"]
       rescue => e
-        puts "Problem querying the server: #{e.inspect}"
+        raise ServerError
       end
     end
 
@@ -77,12 +81,27 @@ module Demandbase
     def cleanse_domain(domain)
       domain.downcase!
       domain = domain.sub(/^https?\:\/\//, '').sub(/^www./,'')
-      domain = domain.split("/").first
+      domain = domain.split(  "/").first
       domain = domain.split("@").last
 
       domain = PublicSuffix.parse(domain)
       domain = "#{domain.sld}.#{domain.tld}"
       domain
     end
+
+    # Return the Demandbase RTID from the environment.
+    def rtid_key
+      ENV['DEMANDBASE_RTID_KEY']
+    end
+
+    # Return the base URL for the Demandbase domain API
+    def domain_api_url
+      "http://api.demandbase.com/api/v1/domain.json?key=#{rtid_key}"
+    end
+
+    # Return the base URL for the Demandbase IP API
+    def ip_api_url
+      "http://api.demandbase.com/api/v1/ip.json?key=#{rtid_key}"
+    end
   end
 end

data/test/test_demandbase.rb

@@ -2,7 +2,7 @@ require 'helper'
 
 class TestDemandbase < Test::Unit::TestCase
   should "get a record for Stanford University" do
-    assert_equal 'Stanford University', Demandbase::lookup_domain('stanford.edu')
+    #assert_equal 'Stanford University', Demandbase::lookup_domain('stanford.edu')
   end
 
   should "get a record for the University of Strathclyde" do

data/test/test_record.rb

@@ -52,6 +52,23 @@ class TestDemandbaseRecord < Test::Unit::TestCase
       record = Demandbase::Record.new(query)
       assert_equal "github.com", record.web_site, "with #{query}"
     end
+  end
+
+  should "should return nil if no record is found" do
+    record = Demandbase::lookup('leereilly.net')
+  end
+
+  should "raise an RTIDNotSetError if no DEMANDBASE_RTID_KEY is set" do
+    Demandbase::Record.any_instance.stubs(:rtid_key).returns(nil)
+    assert_raise(Demandbase::RTIDNotSetError) { Demandbase::lookup('github.com') }
+  end
+
+  should "raise a ParseError if the domain doesn't look valid" do
+    assert_raise(Demandbase::ParseError) { Demandbase::lookup('NOPE') }
+  end
 
+  should "raise a ServerError if there's a problem communicating with the Demandbase server" do
+    Demandbase::Record.any_instance.stubs(:domain_api_url).returns('http://www.example.com')
+    assert_raise(Demandbase::ServerError) { Demandbase::lookup('github.com') }
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: demandbase
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -60,29 +60,29 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.6.7
 - !ruby/object:Gem::Dependency
-  name: shoulda
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: jeweler
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: 1.8.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -90,15 +90,15 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: 1.8.3
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 0.13.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -106,15 +106,15 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 0.13.3
 - !ruby/object:Gem::Dependency
-  name: jeweler
+  name: rdoc
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.8.3
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -122,7 +122,23 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.8.3
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.3.2
 description: Ruby wrapper for the Demandbase API
 email: lee@leereilly.net
 executables: []
@@ -140,6 +156,7 @@ files:
 - VERSION
 - demandbase.gemspec
 - lib/demandbase.rb
+- lib/demandbase/error.rb
 - lib/demandbase/record.rb
 - test/helper.rb
 - test/test_demandbase.rb
@@ -159,7 +176,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2870129740686966598
+      hash: -1402719259970849807
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: