demandbase 0.1.0

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.0.1
+
+* Initial release.

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gem "json",         "~> 1.7.7"
+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"
+end

data/Gemfile.lock

@@ -0,0 +1,44 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    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)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.7)
+    metaclass (0.0.1)
+    mime-types (1.21)
+    mocha (0.10.5)
+      metaclass (~> 0.0.1)
+    multi_json (1.6.1)
+    rake (10.0.3)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    shoulda (3.3.2)
+      shoulda-context (~> 1.0.1)
+      shoulda-matchers (~> 1.4.1)
+    shoulda-context (1.0.2)
+    shoulda-matchers (1.4.2)
+      activesupport (>= 3.0.0)
+      bourne (~> 1.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.2.1)
+  jeweler (~> 1.8.3)
+  json (~> 1.7.7)
+  rdoc (~> 3.12)
+  rest-client (~> 1.6.7)
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Lee Reilly
+
+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,102 @@
+# Prerequisites
+
+* An active [Demandbase](http://www.demandbase.com?affiliate_id=LOL_JK_MAYBE) account with at least on RTID key.
+
+# Installation
+
+Install the Demandbase wrapper with `gem install demandbase`,
+
+# Configuraton
+
+Set an environment variable called `$DEMANDBASE_RTID_KEY` with the key value.
+
+# Usage
+
+If everything's installed and configured you should be able to look up companies' information via their domain name or IP address as follows.
+
+```ruby
+record = Demandbase::lookup_ip '123.12.1.123'
+# => <Demandbase::Record:0x007aba42a46484>
+
+record = Demandbase::lookup_domain 'ubs.com'
+# => <Demandbase::Record:0x007fce82a46060>
+
+record.company_name
+# => "UBS"
+
+record.demandbase_sid
+# => 3874866
+
+record.marketing_alias
+# => 3874866
+
+record.industry
+# => "Financial Services"
+
+record.sub_industry
+# => "Banking & Finance"
+
+record.employee_count
+# => 64820
+
+record.primary_sic
+# => "6021"
+
+record.street_address
+# => "Bahnhofstrasse 45"
+
+record.city
+# => "Z\u00fcrich"
+
+record.state
+# => "ZH"
+
+record.zip
+# => 8001
+
+record.country
+# => "CH"
+
+record.country_name
+# => "Switzerland"
+
+record.phone
+# => "+41 44 234 11 11"
+
+record.stock_ticker
+# => "UBS"
+
+record.web_site
+# => "ubs.com"
+
+record.annual_sales
+# =>  30632917000
+
+record.revenue_range
+# =>  "Over $5B"
+
+record.employee_range
+# =>  "Enterprise"
+
+record.latitude
+# =>  0.0
+
+record.longitude
+# =>  0.0
+
+record.fortune_1000
+# =>  false
+
+record.forbes_2000
+# =>  true
+```
+
+# 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.
+* Use the [forbes-finder](https://github.com/leereilly/forbes-finder) gem if you'd like to retrieve the ranking of a Fortune 1000 company.
+
+# License
+
+MIT.

data/Rakefile

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "demandbase"
+  gem.homepage = "http://github.com/leereilly/demandbase"
+  gem.license = "MIT"
+  gem.summary = %Q{Ruby wrapper for the Demandbase API}
+  gem.description = %Q{Ruby wrapper for the Demandbase API}
+  gem.email = "lee@leereilly.net"
+  gem.authors = ["Lee Reilly"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "demandbase #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/demandbase.gemspec

@@ -0,0 +1,67 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "demandbase"
+  s.version = "0.1.0"
+
+  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.description = "Ruby wrapper for the Demandbase API"
+  s.email = "lee@leereilly.net"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    "CHANGELOG.md",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "demandbase.gemspec",
+    "lib/demandbase.rb",
+    "lib/demandbase/record.rb",
+    "test/helper.rb",
+    "test/test_demandbase.rb",
+    "test/test_record.rb"
+  ]
+  s.homepage = "http://github.com/leereilly/demandbase"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.23"
+  s.summary = "Ruby wrapper for the Demandbase API"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<json>, ["~> 1.7.7"])
+      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"])
+    else
+      s.add_dependency(%q<json>, ["~> 1.7.7"])
+      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"])
+    end
+  else
+    s.add_dependency(%q<json>, ["~> 1.7.7"])
+    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"])
+  end
+end
+

data/lib/demandbase.rb

@@ -0,0 +1,19 @@
+require 'json'
+require 'rest_client'
+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'
+    end
+  end
+end

data/lib/demandbase/record.rb

@@ -0,0 +1,72 @@
+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
+    attr_accessor :marketing_alias
+    attr_accessor :industry
+    attr_accessor :sub_industry
+    attr_accessor :employee_count
+    attr_accessor :primary_sic
+    attr_accessor :street_address
+    attr_accessor :city
+    attr_accessor :state
+    attr_accessor :zip
+    attr_accessor :country
+    attr_accessor :country_name
+    attr_accessor :phone
+    attr_accessor :stock_ticker
+    attr_accessor :web_site
+    attr_accessor :annual_sales
+    attr_accessor :revenue_range
+    attr_accessor :employee_range
+    attr_accessor :b2b
+    attr_accessor :b2c
+    attr_accessor :traffic
+    attr_accessor :latitude
+    attr_accessor :longitude
+    attr_accessor :fortune_1000
+    attr_accessor :forbes_2000
+
+    # Instantiate a new Demandbase Record from a domain name.
+    def initialize(domain)
+      url = Demandbase::API_URLS[:domain] + "&query=#{domain}"
+
+      begin
+        response          = JSON.parse(RestClient.get(url))
+        @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
+        puts "Problem querying the server: #{e.inspect}"
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'demandbase'
+
+class Test::Unit::TestCase
+end

data/test/test_demandbase.rb

@@ -0,0 +1,44 @@
+require 'helper'
+
+class TestDemandbase < Test::Unit::TestCase
+  should "get a record for Stanford University" do
+    assert_equal 'Stanford University', Demandbase::lookup_domain('stanford.edu')
+  end
+
+  should "get a record for the University of Strathclyde" do
+
+  end
+
+  should "get a record for a GitHub's IP address" do
+
+  end
+
+  should "recognize IP addresses" do
+
+  end
+
+  should "recognize domain names" do
+
+  end
+
+  should "handle multiple formats" do
+    queries = [
+      "microsoft.com",
+      "www.microsoft.com",
+      "developer.hacks.microsoft.com",
+      "http://www.microsoft.com",
+      "https://www.microsofot.com",
+      "william.gates@microsoft.com",
+      "microsoft.co.uk"
+    ]
+  end
+
+  should "return nothing when no record is found" do
+
+  end
+
+  should "throw an exception when the service is down" do
+
+  end
+
+end

data/test/test_record.rb

@@ -0,0 +1,39 @@
+require 'helper'
+
+class TestDemandbaseRecord < Test::Unit::TestCase
+  should "remember to set DEMANDBASE_RTID_KEY" do
+    assert ENV['DEMANDBASE_RTID_KEY'], "Please set your $DEMANDBASE_RTID_KEY"
+  end
+
+  should "initialize a new record with a valid domain" do
+    domain = 'github.com'
+    record = Demandbase::Record.new(domain)
+
+    assert_equal "Github Inc",            record.company_name # dat h ಠ_ಠ
+    assert_equal 22528943,                record.demandbase_sid
+    assert_equal "Github",                record.marketing_alias
+    assert_equal "Software & Technology", record.industry
+    assert_equal "Software Applications", record.sub_industry
+    assert_equal 30,                      record.employee_count
+    assert_equal "7372",                  record.primary_sic
+    assert_equal "548 4th St",            record.street_address
+    assert_equal "San Francisco",         record.city
+    assert_equal "CA",                    record.state
+    assert_equal "94107",                 record.zip
+    assert_equal "US",                    record.country
+    assert_equal "United States",         record.country_name
+    assert_equal "415-409-8053",          record.phone
+    assert_equal nil,                     record.stock_ticker
+    assert_equal "github.com",            record.web_site
+    assert_equal 6240000,                 record.annual_sales
+    assert_equal "$5M - $10M",            record.revenue_range
+    assert_equal "Small",                 record.employee_range
+    assert_equal true,                    record.b2b
+    assert_equal true,                    record.b2c
+    assert_equal "Very High",             record.traffic
+    assert_equal 37.7789,                 record.latitude
+    assert_equal -122.398,                record.longitude
+    assert_equal false,                   record.fortune_1000 # TODO: fix this test in 2017
+    assert_equal false,                   record.forbes_2000  # TODO: fix this test in 2016
+  end
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: demandbase
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Lee Reilly
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+description: Ruby wrapper for the Demandbase API
+email: lee@leereilly.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- demandbase.gemspec
+- lib/demandbase.rb
+- lib/demandbase/record.rb
+- test/helper.rb
+- test/test_demandbase.rb
+- test/test_record.rb
+homepage: http://github.com/leereilly/demandbase
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3613502600391467336
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper for the Demandbase API
+test_files: []