README.md in demandbase-0.1.4 vs README.md in demandbase-0.1.5
- old
+ new
@@ -1,12 +1,10 @@
-
+The Demandbase gem is a Ruby wrapper for the [Demandbase](http://www.demandbase.com?affiliate_id=LOL_JK_MAYBE) real-time targeting and personalization platform's [API](http://wiki.demandbaselabs.com/mwiki/index.php?title=Demandbase_API_Documentation).
-The Demandbase gem is a Ruby wrapper for the [Demandbase](http://www.demandbase.com?affiliate_id=LOL_JK_MAYBE) real-time targeting and personalization platform.
-
### Prerequisites
-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/who-is-demandbase/contact-demandbase/?affiliate_id=LOL_JK_MAYBE).
+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/who-is-demandbase/contact-demandbase/?affiliate_id=LOL_JK_MAYBE).
### Installation
Install the Demandbase wrapper with:
@@ -32,10 +30,12 @@
heroku config:add DEMANDBASE_RTID_KEY=1234deadbeef4321
```
### Usage
+#### Domain Lookup
+
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>
@@ -116,9 +116,467 @@
# => true
record.forbes_2000
# => true
```
+
+#### IP Lookup
+
+The IP lookup returns some additional information e.g.
+
+```ruby
+record = Demandbase::lookup_ip 'microsoft.com'
+# => <Demandbase::Record:0x007fce82a46060>
+<<<<<<< HEAD
+
+
+=======
+>>>>>>> ae8ee8ca255b42a6a0754c9087e83102c966d2f8
+```
+
+#### Lazy Lookup
+
+If you have an IP, domain name, email address, or craptacular URL and just want to use that use `lazy_lookup`
+
+```ruby
+ip_looking_thing = '12.12.12.12'
+domain_looking_thing 'http://google.com'
+url_looking_thing 'www.google.com/lol?seriously=true'
+email_looking_thing 'willy@microsoft.com'
+
+(Demandbase::lazy_lookup ip_looking_thing).class
+# => Demanbase::IPRecord
+
+(Demandbase::lazy_lookup domain_looking_thing).class
+# => Demanbase::DomainRecord
+
+(Demandbase::lazy_lookup url_looking_thing).class
+# => Demanbase::DomainRecord
+
+(Demandbase::lazy_lookup email_looking_thing).class
+# => Demanbase::DomainRecord
+```
+
+### Field Info
+
+<table>
+ <tr>
+ <th>Field name (click for description)</th>
+ <th>DomainRecord Presence?</th>
+ <th>IPRecord Presence?</th>
+ </tr>
+
+ <tr>
+ <td><a href="https://github.com/leereilly/demandbase/blob/master/README.md#registry-company-name">registry_company_name</a></td>
+ <td>:finnadie:</td>
+ <td>:metal:</td>
+ </tr>
+
+ <tr>
+ <td><a href="https://github.com/leereilly/demandbase/blob/master/README.md#registry-city">registry_city</a></td>
+ <td>:finnadie:</td>
+ <td>:metal:</td>
+ </tr>
+
+ <tr>
+ <td><a href="https://github.com/leereilly/demandbase/blob/master/README.md#registry-state">registry_state</a></td>
+ <td>:finnadie:</td>
+ <td>:metal:</td>
+ </tr>
+
+ <tr>
+ <td><a href="https://github.com/leereilly/demandbase/blob/master/README.md#registry-country">registry_country</a></td>
+ <td>:finnadie:</td>
+ <td>:metal:</td>
+ </tr>
+
+ <tr>
+ <td><a href="https://github.com/leereilly/demandbase/blob/master/README.md#registry-latitude">registry_latitude</a></td>
+ <td>:finnadie:</td>
+ <td>:metal:</td>
+ </tr>
+
+ <tr>
+ <td><a href="https://github.com/leereilly/demandbase/blob/master/README.md#registry-longitude">registry_longitude</a></td>
+ <td>:finnadie:</td>
+ <td>:metal:</td>
+ </tr>
+
+ <tr>
+ <td><a href="https://github.com/leereilly/demandbase/blob/master/README.md#ip">ip</a></td>
+ <td>:finnadie:</td>
+ <td>:metal:</td>
+ </tr>
+
+ <tr>
+ <td><a href="https://github.com/leereilly/demandbase/blob/master/README.md#information-level">information_level</a></td>
+ <td>:finnadie:</td>
+ <td>:metal:</td>
+ </tr>
+
+ <tr>
+ <td><a href="https://github.com/leereilly/demandbase/blob/master/README.md#worldhq-sid">worldhq_sid</a></td>
+ <td>:finnadie:</td>
+ <td>:metal:</td>
+ </tr>
+
+ <tr>
+ <td><a href="https://github.com/leereilly/demandbase/blob/master/README.md#domestichq-sid">domestichq_sid</a></td>
+ <td>:finnadie:</td>
+ <td>:metal:</td>
+ </tr>
+
+ <tr>
+ <td><a href="https://github.com/leereilly/demandbase/blob/master/README.md#hq-sid">hq_sid</a></td>
+ <td>:finnadie:</td>
+ <td>:metal:</td>
+ </tr>
+
+ <tr>
+ <td><a href="https://github.com/leereilly/demandbase/blob/master/README.md#isp">isp</a></td>
+ <td>:finnadie:</td>
+ <td>:metal:</td>
+ </tr>
+
+ <tr>
+ <td><a href="https://github.com/leereilly/demandbase/blob/master/README.md#company-name">company_name</a></td>
+ <td>:metal:</td>
+ <td>:metal:</td>
+ </tr>
+
+ <tr>
+ <td><a href="https://github.com/leereilly/demandbase/blob/master/README.md#demandbase-sid">demandbase_sid</a></td>
+ <td>:metal:</td>
+ <td>:metal:</td>
+ </tr>
+
+ <tr>
+ <td><a href="https://github.com/leereilly/demandbase/blob/master/README.md#marketing-alias">marketing_alias</a></td>
+ <td>:metal:</td>
+ <td>:metal:</td>
+ </tr>
+
+ <tr>
+ <td><a href="https://github.com/leereilly/demandbase/blob/master/README.md#industry">industry</a></td>
+ <td>:metal:</td>
+ <td>:metal:</td>
+ </tr>
+
+ <tr>
+ <td><a href="https://github.com/leereilly/demandbase/blob/master/README.md#sub-industry">sub_industry</a></td>
+ <td>:metal:</td>
+ <td>:metal:</td>
+ </tr>
+
+ <tr>
+ <td><a href="https://github.com/leereilly/demandbase/blob/master/README.md#employee-count">employee_count</a></td>
+ <td>:metal:</td>
+ <td>:metal:</td>
+ </tr>
+
+ <tr>
+ <td><a href="https://github.com/leereilly/demandbase/blob/master/README.md#primary-sic">primary_sic</a></td>
+ <td>:metal:</td>
+ <td>:metal:</td>
+ </tr>
+
+ <tr>
+ <td><a href="https://github.com/leereilly/demandbase/blob/master/README.md#street-address">street_address</a></td>
+ <td>:metal:</td>
+ <td>:metal:</td>
+ </tr>
+
+ <tr>
+ <td><a href="https://github.com/leereilly/demandbase/blob/master/README.md#city">city</a></td>
+ <td>:metal:</td>
+ <td>:metal:</td>
+ </tr>
+
+ <tr>
+ <td><a href="https://github.com/leereilly/demandbase/blob/master/README.md#state">state</a></td>
+ <td>:metal:</td>
+ <td>:metal:</td>
+ </tr>
+
+ <tr>
+ <td><a href="https://github.com/leereilly/demandbase/blob/master/README.md#zip">zip</a></td>
+ <td>:metal:</td>
+ <td>:metal:</td>
+ </tr>
+
+ <tr>
+ <td><a href="https://github.com/leereilly/demandbase/blob/master/README.md#country">country</a></td>
+ <td>:metal:</td>
+ <td>:metal:</td>
+ </tr>
+
+ <tr>
+ <td><a href="https://github.com/leereilly/demandbase/blob/master/README.md#country-name">country_name</a></td>
+ <td>:metal:</td>
+ <td>:metal:</td>
+ </tr>
+
+ <tr>
+ <td><a href="https://github.com/leereilly/demandbase/blob/master/README.md#phone">phone</a></td>
+ <td>:metal:</td>
+ <td>:metal:</td>
+ </tr>
+
+ <tr>
+ <td><a href="https://github.com/leereilly/demandbase/blob/master/README.md#web-site">web_site</a></td>
+ <td>:metal:</td>
+ <td>:metal:</td>
+ </tr>
+
+ <tr>
+ <td><a href="https://github.com/leereilly/demandbase/blob/master/README.md#annual-sales">annual_sales</a></td>
+ <td>:metal:</td>
+ <td>:metal:</td>
+ </tr>
+
+ <tr>
+ <td><a href="https://github.com/leereilly/demandbase/blob/master/README.md#revenue-range">revenue_range</a></td>
+ <td>:metal:</td>
+ <td>:metal:</td>
+ </tr>
+
+ <tr>
+ <td><a href="https://github.com/leereilly/demandbase/blob/master/README.md#employee-range">employee_range</a></td>
+ <td>:metal:</td>
+ <td>:metal:</td>
+ </tr>
+
+ <tr>
+ <td><a href="https://github.com/leereilly/demandbase/blob/master/README.md#b2b">b2b</a></td>
+ <td>:metal:</td>
+ <td>:metal:</td>
+ </tr>
+
+ <tr>
+ <td><a href="https://github.com/leereilly/demandbase/blob/master/README.md#b2c">b2c</a></td>
+ <td>:metal:</td>
+ <td>:metal:</td>
+ </tr>
+
+ <tr>
+ <td><a href="https://github.com/leereilly/demandbase/blob/master/README.md#traffic">traffic</a></td>
+ <td>:metal:</td>
+ <td>:metal:</td>
+ </tr>
+
+ <tr>
+ <td><a href="https://github.com/leereilly/demandbase/blob/master/README.md#latitude">latitude</a></td>
+ <td>:metal:</td>
+ <td>:metal:</td>
+ </tr>
+
+ <tr>
+ <td><a href="https://github.com/leereilly/demandbase/blob/master/README.md#longitude">longitude</a></td>
+ <td>:metal:</td>
+ <td>:metal:</td>
+ </tr>
+
+ <tr>
+ <td><a href="https://github.com/leereilly/demandbase/blob/master/README.md#fortune_1000">fortune_1000</a></td>
+ <td>:metal:</td>
+ <td>:metal:</td>
+ </tr>
+
+ <tr>
+ <td><a href="https://github.com/leereilly/demandbase/blob/master/README.md#forbes_2000">forbes_2000</a></td>
+ <td>:metal:</td>
+ <td>:metal:</td>
+ </tr>
+
+</table>
+
+#### Registry Company Name
+
+#### Registry City
+
+#### Registry State
+
+#### Registry Country
+
+#### Registry Latitude
+
+#### Registry Longitude
+
+#### IP
+
+#### Information Level
+
+#### World HQ SID
+
+#### Domestic HQ SID
+
+#### HQ SID
+
+#### ISP
+
+#### Company Name
+
+#### Demandbase SID
+
+#### Marketing Alias
+
+#### Industry
+
+#### Sub Industry
+
+#### Employee Count
+
+#### Primary SIC
+
+#### Street Address
+
+#### City
+
+#### State
+
+#### Zip
+
+#### Country
+
+#### Country Name
+
+#### Phone
+
+#### Web Site
+
+#### Annual Sales
+
+#### Revenue Range
+
+#### Revenue Range
+
+<table>
+ <tr>
+ <th>Value</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>$1 - $1M</td>
+ <td>:credit_card:</td>
+ </tr>
+ <tr>
+ <td>$1M - $5M</td>
+ <td>:dollar:</td>
+ </tr>
+ <tr>
+ <td>$5M - $10M</td>
+ <td>:dollar: :dollar:</td>
+ </tr>
+ <tr>
+ <td>$10M - $25M</td>
+ <td>:dollar: :dollar: :dollar: :dollar: :dollar: :dollar: :dollar: :dollar: :dollar: :dollar:</td>
+ </tr>
+ <tr>
+ <td>$25M - $50M</td>
+ <td>:dollar: :dollar: :dollar: :dollar: :dollar: :dollar: :dollar: :dollar: :dollar: :dollar: :dollar: :dollar: :dollar: :dollar: :dollar: :dollar: :dollar: :dollar: :dollar: :dollar:</td>
+ </tr>
+ <tr>
+ <td>$50M - $100M</td>
+ <td>:moneybag:</td>
+ </tr>
+ <tr>
+ <td>$100M - $250M</td>
+ <td>:moneybag::moneybag:</td>
+ </tr>
+ <tr>
+ <td>$250M - $500M</td>
+ <td>:moneybag::moneybag::moneybag:</td>
+ </tr>
+ <tr>
+ <td>$500M - $1B</td>
+ <td>:moneybag::moneybag::moneybag::moneybag:</td>
+ </tr>
+ <tr>
+ <td>$1B - $2.5B</td>
+ <td>:moneybag::moneybag::moneybag::moneybag::moneybag:</td>
+ </tr>
+ <tr>
+ <td>$2.5B - $5B</td>
+ <td>:moneybag::moneybag::moneybag::moneybag::moneybag::moneybag:</td>
+ </tr>
+ <tr>
+ <td>Over $5B</td>
+ <td>:money_with_wings:</td>
+ </tr>
+</table>
+
+#### Employee Range
+
+<table>
+ <tr>
+ <th>Value</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>Unknown</td>
+ <td>:house:</td>
+ </tr>
+ <tr>
+ <td>Small</td>
+ <td>:school:1-99 employees</td>
+ </tr>
+ <tr>
+ <td>Mid-Market</td>
+ <td>:department_store: 100-999 employees</td>
+ </tr>
+ <tr>
+ <td>Enterprise</td>
+ <td>:office: 1000+ employees</td>
+ </tr>
+</table>
+
+#### Audience
+
+<table>
+ <tr>
+ <th>Company Size</th>
+ <th>Vertical</th>
+ <th>Origination</th>
+ </tr>
+ <tr>
+ <td>Enterprise<br>Mid-Market<br>SMB</td>
+ <td>Government<br>Education</td>
+ <td>Wireless<br>Residential<br>SOHO<br>Unknown</td>
+ </tr>
+</table>
+
+#### Audience Segment
+
+<table>
+ <tr>
+ <th>Company Size</th>
+ <th>Government</th>
+ <th>Education</th>
+ <th>Wireless</th>
+ <th>Residential/SOHO/Unknown</th>
+ </tr>
+ <tr>
+ <td>Industry<br>Search Engine</td>
+ <td>Federal<br>International<br>State<br>City<br>Local<br>Military<br>Public Safety</td>
+ <td>University<br>K12<br>Vocational<br>Educational Services<br>Educational ISP</td>
+ <td>Wireless Device<br>Wireless Hotspot</td>
+ <td>Bots</td>
+ </tr>
+</table>
+
+#### B2B
+
+#### B2C
+
+#### Traffic
+
+#### Latitude
+
+#### Longitude
+
+#### Fortune 1000
+
+#### Forbes 2000
### 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.