apihub-baller 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9cec884f74416e8cf29a5af40494cfa1e0da330
-  data.tar.gz: c6d8822460ffd0f6242e8e9be9052d303e9ab060
+  metadata.gz: b80fb7cfa6a464a65def7aa0e278b337cda6d5df
+  data.tar.gz: 13becedcd35f4409ba0a233f71a435713bd6898c
 SHA512:
-  metadata.gz: 0ac19a439cfdfae485368ce4be27ee11f86b558ea5e9f68a63acf857e3a3fd8c8bf7b6875e97583fc3c193af1e3518f56dd8656df873a086b6de2bd05d696655
-  data.tar.gz: 3a8da8efbf931b40bde5f17f14a9fff1680e2960ad98e5b55474dc5c1b96d3683b379f16ec002e9fd53861e6e7921d9f64f8e8284baa72d99e36604bf5ca85b8
+  metadata.gz: 2231469c2e92f8b15e455bbb2f879e3e53ce1ee100bca4f31fbeac843909730484c561859f6d0a7fae4e8d7229e2178869f7de5bd867b10116e8275748a79d12
+  data.tar.gz: b0e3e193824178138f715f50ae5343bde21096155e43c58751b1091bf585b807c2c6434366d9d604237f23d7c54c4183de7117e1b3f8b74699ee17b0525276d7

data/README.md

@@ -1,5 +1,19 @@
 # Baller
 
+This library calculates a 'baller' score, a simple score which gives you some indication that an email address is either associated with an influential individual, or a high profile company.
+
+This score is especially useful for sales and marketing. For example, you could calculate scores for all your inbound sales inquires and also for existing customers, providing a good signal for valuable leads.
+
+Behind the scenes, this library uses [APIHub](https://apihub.co), a data API which returns information on email addresses and company domain names. That information is then [used to calculate](https://github.com/maccman/apihub-baller/blob/master/lib/apihub/baller.rb#L53) a (fairly rudimentary) score taking into account such things as how many Twitter followers the person has, or if how much the company has raised, how many employees it has, etc.
+
+Scores are out of `1.0`, where `1.0` is the highest and `0.0` the lowest (we didn't find any information).
+
+## Getting started
+
+Firstly you'll need an [APIHub](https://apihub.co) API key - register there and save your key. APIHub provides 50 free lookups a month.
+
+Then install the gem, `apihub-baller`. A CLI is provided for simple email lookups.
+
     gem install apihub-baller
 
     $ apihub-baller
@@ -8,4 +22,42 @@
           -h, --help                       Display this screen
 
 
-    apihub-baller --api-key APIHUB_KEY alex@alexmaccaw.com
+    apihub-baller --api-key APIHUB_KEY alex@alexmaccaw.com
+
+There's also a Ruby API.
+
+    APIHub::Baller.api_key = ENV['APIHUB_KEY']
+
+    result = APIHub::Baller.lookup(email)
+
+    if result
+      puts "Name: #{result.name}"
+      puts "Company name: #{result.company.try(:name)}"
+
+      if result.score > 0.5
+        puts "Baller"
+      end
+
+    else
+      puts "Person or company not found"
+    end
+
+
+## Method: `lookup(email, options)`
+
+As well as just passing an email, there are a number of additional options you can send to `APIHub::Baller.lookup`, such as the weights that are used internally. You could also just use the information returned to calculate your own score.
+
+The default options are:
+
+    {
+      twitter_followers_weight:   0.05,
+      angellist_followers_weight: 0.05,
+      klout_score_weight:         0.05,
+      company_twitter_followers_weight: 0.05,
+      company_alexa_rank_weight:  0.000005,
+      company_google_rank_weight: 0.05,
+      company_employees_weight:   0.5,
+      company_raised_weight:      0.0000005,
+      company_score:              10,
+      total_score:                1415
+    }

data/lib/apihub/baller.rb

@@ -17,7 +17,8 @@ module APIHub
       company_google_rank_weight: 0.05,
       company_employees_weight:   0.5,
       company_raised_weight:      0.0000005,
-      company_score:              10
+      company_score:              10,
+      total_score:                1415
     })
 
     def api_key=(value)
@@ -31,9 +32,13 @@ module APIHub
     end
 
     def lookup(email)
-      suffix, domain = email.split('@', 2)
+      if email =~ /.+@.+/
+        person = Streaming::Person[email: email]
+        suffix, domain = email.split('@', 2)
 
-      person = Streaming::Person[email: email]
+      else
+        domain = email
+      end
 
       unless EmailProviders::DOMAINS.include?(domain)
         company = Streaming::Company[domain: domain]
@@ -66,7 +71,7 @@ module APIHub
         score += result.angellist.followers * options.angellist_followers_weight
       end
 
-      if result.klout
+      if result.klout && result.klout.score
         score += result.klout.score * options.klout_score_weight
       end
 
@@ -90,7 +95,7 @@ module APIHub
                     options.company_alexa_rank_weight)
         end
 
-        if company.google && company.google.rank
+        if company.google && company.google.rank && company.google.rank > 0
           score += 1 / (company.google.rank *
                     options.company_google_rank_weight)
         end
@@ -101,7 +106,9 @@ module APIHub
         end
       end
 
-      score.round
+      score /= options.total_score
+
+      [score.round(1), 1.0].min
     end
   end
 end

data/lib/apihub/baller/version.rb

@@ -1,5 +1,5 @@
 module APIHub
   module Baller
-    VERSION = "0.0.3"
+    VERSION = "0.0.4"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apihub-baller
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Alex MacCaw
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-16 00:00:00.000000000 Z
+date: 2014-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler