demandbase 0.1.4 → 0.1.5

data/VERSION

@@ -1 +1 @@
-0.1.4
+0.1.5

data/demandbase.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "demandbase"
-  s.version = "0.1.4"
+  s.version = "0.1.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Lee Reilly"]
-  s.date = "2013-03-15"
+  s.date = "2013-03-24"
   s.description = "Ruby wrapper for the Demandbase API"
   s.email = "lee@leereilly.net"
   s.extra_rdoc_files = [
@@ -26,10 +26,14 @@ Gem::Specification.new do |s|
     "VERSION",
     "demandbase.gemspec",
     "lib/demandbase.rb",
+    "lib/demandbase/domain_record.rb",
     "lib/demandbase/error.rb",
+    "lib/demandbase/ip_record.rb",
     "lib/demandbase/record.rb",
     "test/helper.rb",
     "test/test_demandbase.rb",
+    "test/test_domain_record.rb",
+    "test/test_ip_record.rb",
     "test/test_record.rb"
   ]
   s.homepage = "http://github.com/leereilly/demandbase"

data/lib/demandbase.rb

@@ -1,9 +1,12 @@
 require 'json'
 require 'public_suffix'
+require 'resolv'
 require 'rest_client'
 
 require 'demandbase/error'
 require 'demandbase/record'
+require 'demandbase/ip_record'
+require 'demandbase/domain_record'
 
 module Demandbase
 
@@ -27,8 +30,95 @@ module Demandbase
     "8299"  # schools and educational services, not elsewhere classified
   ]
 
+  # SIC codes for government.
+  GOVERNMENT_SIC_CODES = [
+    "91",   # executive, legislative, and general government, except finance
+    "911",  # executive offices
+    "9111", # executive offices
+    "912",  # legislative bodies
+    "9121", # legislative bodies
+    "913",  # executive and legislative offices combined
+    "9131", # executive and legislative offices combined
+    "919",  # general government, not elsewhere classified
+    "9199", # general government, not elsewhere classified
+    "92",   # justice, public order, and safety
+    "921",  # courts
+    "9211", # courts
+    "922",  # public order and safety
+    "9221", # police protection
+    "9222", # legal counsel and prosecution
+    "9223", # correctional institutions
+    "9224", # fire protection
+    "9229", # public order and safety, not elsewhere classified
+    "93",   # public finance, taxation, and monetary policy
+    "931",  # public finance, taxation, and monetary policy
+    "9311", # public finance, taxation, and monetary policy
+    "94",   # administration of human resource programs
+    "941",  # administration of educational programs
+    "9411", # administration of educational programs
+    "943",  # administration of public health programs
+    "9431", # administration of educational programs
+    "944",  # administration of social, human resource and income maintenance programs
+    "9441", # administration of social, human resource and income maintenance prorgrams
+    "945",  # administration of veterans' affairs, except health and insurance
+    "9451", # administration of veterans' affairs, except health and insurance
+    "95",   # administration of environmental quality and housing programs
+    "951",  # administration of environmental quality programs
+    "9511", # air and water resource and solid waste management
+    "9512", # land, mineral, wildlife, and forest conservation
+    "953",  # administration of housing and urban development progr
+    "9531", # administration of housing programs
+    "9532", # administration of urban planning and community and rural development
+    "96",   # administration of economic programs
+    "961",  # administration of general economic programs
+    "9611", # administration of general economic programs
+    "962",  # regulation and administration of transportation programs
+    "9621", # regulation and administration of transportation programs
+    "963",  # regulation and administration of communications, electric, gas, and other utilities
+    "9631", # regulation and administration of communications, electric, gas, and other utilities
+    "964",  # regulation of agricultural marketing and commodities
+    "9641", # regulation of agricultural marketing and commodities
+    "965",  # regulation, licensing, and inspection of miscellaneous commercial
+    "9561", # regulation, licensing, and inspection of miscellaneous commercial
+    "966",  # space research and technology
+    "9661", # space research and technology
+    "977",  # national security and international affairs
+    "971",  # national security
+    "9711", # national security
+    "972",  # international affairs
+    "9721"  # international affairs
+  ]
+
+  # SIC codes for registered nonprofits.
+  NONPROFIT_SIC_CODES = [
+    "6732", # Educational, religious, and charitable Trusts
+    "864",  # Civic, social, and fraternal associations
+    "8641", # Civic, social, and fraternal associations
+    "865",  # Political organizations
+    "8651", # Political organizations
+    "866",  # Religious organizations
+    "8661", # Religious organizations
+    "869",  # Membership organizations, not elsewhere classified
+    "8699"  # Membership organizations, not elsewhere classified
+  ]
+
   class << self
 
+    def lookup_ip(query)
+      Demandbase::IPRecord.new(query)
+    end
+    alias_method :lookup_ip_address, :lookup_ip
+
+    def lookup_domain(query)
+      Demandbase::DomainRecord.new(query)
+    end
+    alias_method :lookup_domain_name, :lookup_domain
+
+    def lazy_lookup
+
+    end
+    alias_method :lookup, :lazy_lookup
+
     # Look up a Demandbase record for a given domain name.
     #
     # Returns a Demandbase::Record if the record is found; nil otherwise.
@@ -37,8 +127,14 @@ module Demandbase
     # 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)
+    def lookup(query)
+      if Demandbase::IPRecord.is_ip(query)
+        Demandbase::IPRecord.new(query)
+      elsif Demandbase::DomainRecord.is_domain(query)
+        Demandbase::DomainRecord.new(query)
+      else
+        raise Demandbase::ParseError
+      end
     end
 
     # Find out if a particular domain is associated with an academic institution.
@@ -50,12 +146,49 @@ module Demandbase
     # Raises a Demandbase::ServerError if the Demandbase server is unresponsive.
     #
     def is_academic?(domain)
-      record = Demandbase::Record.new(domain)
+      record = Demandbase::DomainRecord.new(domain)
+
       if record && ACADEMIC_SIC_CODES.include?(record.primary_sic)
         return true
       else
         return false
       end
     end
+
+    # Find out if a particular domain is associated with an government agency.
+    #
+    # Returns true if it looks like an government agency; false 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 is_government?(domain)
+      record = Demandbase::DomainRecord.new(domain)
+
+      if record && GOVERNMENT_SIC_CODES.include?(record.primary_sic)
+        return true
+      else
+        return false
+      end
+    end
+
+    # Find out if a particular domain is associated with a nonprofit.
+    #
+    # Returns true if it looks like a nonprofit; false 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 is_nonprofit?(domain)
+      record = Demandbase::DomainRecord.new(domain)
+
+      if record && NONPROFIT_SIC_CODES.include?(record.primary_sic)
+        return true
+      else
+        return false
+      end
+    end
   end
 end

data/lib/demandbase/domain_record.rb

@@ -0,0 +1,84 @@
+module Demandbase
+  class DomainRecord < Demandbase::Record
+
+    # Return the base URL for the Demandbase domain API
+    def api_url
+      "http://api.demandbase.com/api/v1/domain.json?key=#{rtid_key}"
+    end
+
+    # Ascertain whether the given query string is a valid domain name.
+    #
+    # Returns true if it's a valid domain name; false otherwise.
+    def self.is_domain(query)
+      begin
+        result = PublicSuffix.valid?((Demandbase::DomainRecord.cleanse_domain(query)))
+        result
+      rescue => e
+        false
+      end
+    end
+
+    # Instantiate a new Demandbase Domain Record from a domain name.
+    def initialize(domain)
+      raise Demandbase::RTIDNotSetError if rtid_key.nil?
+
+      begin
+        query = Demandbase::DomainRecord.cleanse_domain(domain)
+        url = 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"]
+        @industry         = response["domain"]["industry"]
+        @sub_industry     = response["domain"]["sub_industry"]
+        @employee_count   = response["domain"]["employee_count"]
+        @primary_sic      = response["domain"]["primary_sic"]
+        @street_address   = response["domain"]["street_address"]
+        @city             = response["domain"]["city"]
+        @state            = response["domain"]["state"]
+        @zip              = response["domain"]["zip"]
+        @country          = response["domain"]["country"]
+        @country_name     = response["domain"]["country_name"]
+        @phone            = response["domain"]["phone"]
+        @stock_ticker     = response["domain"]["stock_ticker"]
+        @web_site         = response["domain"]["web_site"]
+        @annual_sales     = response["domain"]["annual_sales"]
+        @revenue_range    = response["domain"]["revenue_range"]
+        @employee_range   = response["domain"]["employee_range"]
+        @b2b              = response["domain"]["b2b"]
+        @b2c              = response["domain"]["b2c"]
+        @traffic          = response["domain"]["traffic"]
+        @latitude         = response["domain"]["latitude"]
+        @longitude        = response["domain"]["longitude"]
+        @fortune_1000     = response["domain"]["fortune_1000"]
+        @forbes_2000      = response["domain"]["forbes_2000"]
+      rescue => e
+        raise ServerError
+      end
+    end
+
+    # Clean the domain of things like 'http(s)://', 'www',
+    # '?foo=bar', etc.
+    #
+    # Return the domain string.
+    def self.cleanse_domain(domain)
+      domain.downcase!
+      domain = domain.sub(/^https?\:\/\//, '').sub(/^www./,'')
+      domain = domain.split(  "/").first
+      domain = domain.split("@").last
+
+      domain = PublicSuffix.parse(domain)
+      domain = "#{domain.sld}.#{domain.tld}"
+      domain
+    end
+
+  end
+end

data/lib/demandbase/ip_record.rb

@@ -0,0 +1,98 @@
+module Demandbase
+  class IPRecord < Demandbase::Record
+    attr_accessor :registry_company_name
+    attr_accessor :registry_city
+    attr_accessor :registry_state
+    attr_accessor :registry_zip_code
+    attr_accessor :registry_area_code
+    attr_accessor :registry_country
+    attr_accessor :registry_country_code
+    attr_accessor :registry_latitude
+    attr_accessor :registry_longitude
+    attr_accessor :ip
+    attr_accessor :information_level
+    attr_accessor :audience
+    attr_accessor :audience_segment
+    attr_accessor :information_level
+    attr_accessor :worldhq_sid
+    attr_accessor :domestichq_sid
+    attr_accessor :hq_sid
+    attr_accessor :isp
+
+    # Return the base URL for the Demandbase IP API
+    def api_url
+      "http://api.demandbase.com/api/v2/ip.json?key=#{rtid_key}"
+    end
+
+    # Ascertain whether the given query string is a valid IP address.
+    #
+    # Returns true if it's a valid IP address; false otherwise.
+    def self.is_ip(query)
+      !!(query =~ Resolv::IPv4::Regex)
+    end
+
+    # Instantiate a new Demandbase IP Record from an IP address.
+    def initialize(ip)
+      raise Demandbase::RTIDNotSetError if rtid_key.nil?
+
+      begin
+        url = api_url + "&query=#{ip}"
+      rescue => e
+        raise Demandbase::ParseError
+      end
+
+      begin
+        response = JSON.parse(RestClient.get(url))
+        return nil unless response
+
+        @registry_company_name  = response["registry_company_name"]
+        @registry_city          = response["registry_city"]
+        @registry_state         = response["registry_state"]
+        @registry_zip_code      = response["registry_zip_code"]
+        @registry_area_code     = response["registry_area_code"]
+        @registry_country       = response["registry_country"]
+        @registry_country_code  = response["registry_country_code"]
+        @registry_latitude      = response["registry_latitude"]
+        @registry_longitude     = response["registry_longitude"]
+        @company_name           = response["company_name"]
+        @demandbase_sid         = response["demandbase_sid"]
+        @marketing_alias        = response["marketing_alias"]
+        @industry               = response["industry"]
+        @sub_industry           = response["sub_industry"]
+        @employee_count         = response["employee_count"]
+        @primary_sic            = response["primary_sic"]
+        @street_address         = response["street_address"]
+        @city                   = response["city"]
+        @state                  = response["state"]
+        @zip                    = response["zip"]
+        @country                = response["country"]
+        @country_name           = response["country_name"]
+        @phone                  = response["phone"]
+        @stock_ticker           = response["stock_ticker"]
+        @web_site               = response["web_site"]
+        @annual_sales           = response["annual_sales"]
+        @revenue_range          = response["revenue_range"]
+        @employee_range         = response["employee_range"]
+        @b2b                    = response["b2b"]
+        @b2c                    = response["b2c"]
+        @traffic                = response["traffic"]
+        @latitude               = response["latitude"]
+        @longitude              = response["longitude"]
+        @fortune_1000           = response["fortune_1000"]
+        @forbes_2000            = response["forbes_2000"]
+        @ip                     = response["ip"]
+        @audience               = response["audience"]
+        @audience_segment       = response["audience_segment"]
+        @information_level      = response["information_level"]
+        @worldhq_sid            = response["worldhq_sid"]
+        @domestichq_sid         = response["domestichq_sid"]
+        @hq_sid                 = response["hq_sid"]
+        @isp                    = response["isp"]
+      rescue RestClient::ResourceNotFound => rcrnf
+        return nil
+      rescue
+        raise ServerError
+      end
+    end
+  end
+end

data/lib/demandbase/record.rb

@@ -27,81 +27,9 @@ module Demandbase
     attr_accessor :fortune_1000
     attr_accessor :forbes_2000
 
-    # Instantiate a new Demandbase Record from a domain name.
-    def initialize(domain)
-      raise Demandbase::RTIDNotSetError if rtid_key.nil?
-
-      begin
-        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"]
-        @industry         = response["domain"]["industry"]
-        @sub_industry     = response["domain"]["sub_industry"]
-        @employee_count   = response["domain"]["employee_count"]
-        @primary_sic      = response["domain"]["primary_sic"]
-        @street_address   = response["domain"]["street_address"]
-        @city             = response["domain"]["city"]
-        @state            = response["domain"]["state"]
-        @zip              = response["domain"]["zip"]
-        @country          = response["domain"]["country"]
-        @country_name     = response["domain"]["country_name"]
-        @phone            = response["domain"]["phone"]
-        @stock_ticker     = response["domain"]["stock_ticker"]
-        @web_site         = response["domain"]["web_site"]
-        @annual_sales     = response["domain"]["annual_sales"]
-        @revenue_range    = response["domain"]["revenue_range"]
-        @employee_range   = response["domain"]["employee_range"]
-        @b2b              = response["domain"]["b2b"]
-        @b2c              = response["domain"]["b2c"]
-        @traffic          = response["domain"]["traffic"]
-        @latitude         = response["domain"]["latitude"]
-        @longitude        = response["domain"]["longitude"]
-        @fortune_1000     = response["domain"]["fortune_1000"]
-        @forbes_2000      = response["domain"]["forbes_2000"]
-      rescue => e
-        raise ServerError
-      end
-    end
-
-    # Clean the domain of things like 'http(s)://', 'www',
-    # '?foo=bar', etc.
-    #
-    # Return the domain string.
-    def cleanse_domain(domain)
-      domain.downcase!
-      domain = domain.sub(/^https?\:\/\//, '').sub(/^www./,'')
-      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