forbes-finder 0.1.1 → 0.1.2

data/CONTRIBUTING.md

@@ -2,7 +2,15 @@
 
 ## Creating aliases / subsidiaries
 
-Ebay is listed in the Forbes 2000, but it's domain is listed as `ebayinc.com`. In order for ForbesFinder to recognize `ebay.com` or `paypal.com` (both subsidiaries) we need to set up some alises. It's pretty easy to - just use git to store symlinks to the existing TOML files e.g.
+In this example, there's a file called `ebayinc.com.toml` with the following contents:
+
+```toml
+name = "eBay"
+domain = "ebayinc.com"
+rank = 322
+```
+
+That file ensures that `ebayinc.com` will be recognized as a Forbes 2000 company. To ensure that `paypal.com` and `ebay.com` are both recognized, we'll need to add two additional files `ebay.com.toml` and `paypal.com.toml` that are symlinks to `ebayinc.com.toml`:
 
 ```
 cd lib/data/2012
@@ -20,4 +28,4 @@ git push origin master
 * Start a feature/bugfix branch.
 * Commit and push until you are happy with your contribution.
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

data/README.md

@@ -2,7 +2,18 @@ The Forbes Global 2000 is an annual ranking of the top 2000 public companies in
 
 # Installation
 
-`gem install forbes-finder`
+This is a Ruby gem, so you'll need a little Ruby-fu to get it working.
+
+```
+gem install forbes-finder
+```
+
+Or add this to your `Gemfile`:
+
+```
+gem 'forbes-finder', '~> 0.1.1'
+```
+
 
 # Usage
 
@@ -20,25 +31,44 @@ record.rank
 It'll handle email addresses and URLs with all sorts of subdomains, parameters, etc.
 
 ```ruby
-record = ForbesFinder::lookup 'https://developer.apple.com/devcenter/ios/checklist/'
-# => <ForbesFinder::Record:0x007faa338072a0>
+ForbesFinder::lookup('https://developer.apple.com/devcenter/ios/checklist/').rank
+# => 22
 
-record.domain
-# => "apple.com"
+ForbesFinder::lookup('www.chevron.com').rank
+# => 12
 
-record.name
-# => "Apple"
+ForbesFinder::lookup('william.gates@microsoft.com').rank
+# 42
 
-record.rank
-# => 22
+```
+
+It'll also work with aliases or subsidiaries, but I'll need *your* help (see [contribution guidelines](/CONTRIBUTING.md) if you're interested).
 
-ForbesFinder::lookup('william.gates@microsoft.com').name
-# => "Microsoft"
+```ruby
+ForbesFinder::lookup('ebayinc.com').rank
+# => 322
+ForbesFinder::lookup('ebayinc.com').alias
+# => false
+
+ForbesFinder::lookup('ebay.com').rank
+# => 322
+ForbesFinder::lookup('ebay.com').alias
+# => 322
+
+ForbesFinder::lookup('paypal.com').rank
+# => 322
+ForbesFinder::lookup('paypal.com').alias
+# => true
+ForbesFinder::lookup('paypal.com').name
+# => eBay
+ForbesFinder::lookup('paypal.com').domain
+# => ebayinc.com
 ```
 
 # Limitations
 
-* There may be cases when the company you're lookup up is a subsidiary of a Forbes 2000 company that has a different domain name. Keeping track of all of those is beyong the scope of this gem, but you're welcome to submit it as an alias.
+* There may be cases when the company you're lookup up is a subsidiary of a Forbes 2000 company that has a different domain name e.g. eBay is a Forbes 2000 company identified primarily with `ebayinc.com`, but has many associated domains / subsidiaries like `ebay.com` and `paypal.com`. Using the power of Git, GitHub and TOML you can identify those relationships - please read the [contribution guidelines](/CONTRIBUTING.md) if you'd like to help.
+
 
 **Data source(s):**
  * http://www.forbes.com/global2000/list/

data/VERSION

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

data/forbes-finder.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "forbes-finder"
-  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"]
-  s.date = "2013-03-06"
+  s.date = "2013-03-07"
   s.description = "Look up Forbes 2000 companies based on a domain name or email address"
   s.email = "lee@leereilly.net"
   s.extra_rdoc_files = [
@@ -1838,6 +1838,7 @@ Gem::Specification.new do |s|
     "lib/data/2012/wacker.com.toml",
     "lib/data/2012/walgreens.com.toml",
     "lib/data/2012/walmart.com.toml",
+    "lib/data/2012/walmartstores.com.toml",
     "lib/data/2012/want-want.com.toml",
     "lib/data/2012/wartsila.com.toml",
     "lib/data/2012/waters.com.toml",

data/lib/data/2012/walmartstores.com.toml

@@ -0,0 +1,3 @@
+name = "Wal-Mart Stores"
+domain = "walmart.com"
+rank = 16

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: forbes-finder
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-06 00:00:00.000000000 Z
+date: 2013-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: public_suffix
@@ -1920,6 +1920,7 @@ files:
 - lib/data/2012/wacker.com.toml
 - lib/data/2012/walgreens.com.toml
 - lib/data/2012/walmart.com.toml
+- lib/data/2012/walmartstores.com.toml
 - lib/data/2012/want-want.com.toml
 - lib/data/2012/wartsila.com.toml
 - lib/data/2012/waters.com.toml
@@ -2026,7 +2027,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1102380800505603812
+      hash: 2526135352681628838
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: