kickboxer 0.0.1

data/spec/fixtures/person-twitter.json

@@ -0,0 +1,231 @@
+{
+  "status": 200,
+  "contactInfo": {
+    "familyName": "Lorang",
+    "givenName": "Bart",
+    "fullName": "Bart Lorang",
+    "websites": 
+    [
+      {
+        "url": "http://blog.fullcontact.com"
+      },
+      {
+        "url": "http://fullcontact.com"
+      }
+    ]
+  },
+  "photos": 
+  [
+    {
+      "typeName": "Twitter",
+      "type": "twitter",
+      "typeId": "twitter",
+      "url": "http://a0.twimg.com/profile_images/1364842224/Bart_Profile_1_normal.jpg"
+    },
+    {
+      "url": "http://social.sxsw.com//system/badge_photos/46809/thumb/photo.jpg",
+      "type": "sxsw",
+      "typeId": "sxsw",
+      "typeName": "SxSW"
+    },
+    {
+      "typeName": "Facebook",
+      "type": "facebook",
+      "typeId": "facebook",
+      "url": "http://profile.ak.fbcdn.net/hprofile-ak-snc4/161274_651620441_7937905_n.jpg",
+      "isPrimary": true
+    },
+    {
+      "typeName": "Quora",
+      "type": "quora",
+      "typeId": "quora",
+      "url": "http://qph.cf.quoracdn.net/main-thumb-235179-50-jKTxWZQMbAl9MrGaLTDAs19WUiZoCuPW.jpeg"
+    },
+    {
+      "typeName": "Linkedin",
+      "type": "linkedin",
+      "typeId": "linkedin",
+      "url": "http://media.linkedin.com/mpr/pub/image-24YYLlk7VOVyx4vHbB2m_YZnM8tEVXNxn4NgrixwM2axoWjK24YgfwS7MnuP13NJifCJ/bart-lorang.jpg"
+    },
+    {
+      "url": "http://qph.cf.quoracdn.net/main-thumb-235179-200-jKTxWZQMbAl9MrGaLTDAs19WUiZoCuPW.jpeg",
+      "type": "quora",
+      "typeId": "quora",
+      "typeName": "Quora"
+    },
+    {
+      "url": "http://media.linkedin.com/mpr/pub/image-8kD9yK95845PPSkQ3U3ryL0B2bTfOSKQ2EBfy9Si3h5FEh6_/bart-lorang.jpg",
+      "type": "linkedin",
+      "typeId": "linkedin",
+      "typeName": "Linkedin"
+    }
+  ],
+  "demographics": {
+    "locationGeneral": "Boulder, Colorado",
+    "gender": "male"
+  },
+  "digitalFootprint": {
+    "topics": 
+    [
+      {
+        "value": "angel investing",
+        "provider": "klout"
+      },
+      {
+        "value": "technology",
+        "provider": "klout"
+      },
+      {
+        "value": "denver broncos",
+        "provider": "klout"
+      },
+      {
+        "value": "tim tebow",
+        "provider": "klout"
+      },
+      {
+        "value": "sxsw",
+        "provider": "klout"
+      }
+    ],
+    "scores": 
+    [
+      {
+        "value": 48.41,
+        "provider": "klout",
+        "type": "general"
+      },
+      {
+        "value": 31.4,
+        "provider": "klout",
+        "type": "network"
+      },
+      {
+        "value": 978,
+        "provider": "klout",
+        "type": "reach"
+      },
+      {
+        "value": 21,
+        "provider": "klout",
+        "type": "amplification"
+      }
+    ]
+  },
+  "socialProfiles": 
+  [
+    {
+      "id": 5998422,
+      "typeName": "Twitter",
+      "following": 507,
+      "followers": 750,
+      "username": "lorangb",
+      "bio": "CEO & Co-Founder of @FullContactApp and @FullContactAPI - Tech Entrepreneur and Angel Investor.",
+      "type": "twitter",
+      "typeId": "twitter",
+      "url": "http://www.twitter.com/lorangb",
+      "rss": "http://twitter.com/statuses/user_timeline/lorangb.rss"
+    },
+    {
+      "type": "sxsw",
+      "url": "http://social.sxsw.com/users/46809",
+      "id": 46809,
+      "typeId": "sxsw",
+      "typeName": "SxSW"
+    },
+    {
+      "typeName": "Klout",
+      "username": "lorangb",
+      "type": "klout",
+      "typeId": "klout",
+      "url": "http://www.klout.com/lorangb"
+    },
+    {
+      "url": "http://www.myspace.com/137200880",
+      "type": "myspace",
+      "typeId": "myspace",
+      "typeName": "Myspace"
+    },
+    {
+      "url": "http://www.facebook.com/bartlorang",
+      "username": "bartlorang",
+      "type": "facebook",
+      "typeId": "facebook",
+      "typeName": "Facebook",
+      "id": "651620441"
+    },
+    {
+      "typeName": "About Me",
+      "username": "lorangb",
+      "type": "aboutme",
+      "typeId": "aboutme",
+      "url": "http://about.me/lorangb"
+    },
+    {
+      "typeName": "Flickr",
+      "id": "39267654@N00",
+      "rss": "http://api.flickr.com/services/feeds/photos_public.gne?id=39267654@N00&lang=en-us&format=rss_200",
+      "type": "flickr",
+      "typeId": "flickr",
+      "url": "http://www.flickr.com/photos/39267654@N00/"
+    },
+    {
+      "typeName": "Quora",
+      "username": "bart-lorang",
+      "type": "quora",
+      "typeId": "quora",
+      "url": "http://www.quora.com/bart-lorang"
+    },
+    {
+      "typeName": "Linkedin",
+      "username": "bartlorang",
+      "type": "linkedin",
+      "typeId": "linkedin",
+      "url": "http://www.linkedin.com/in/bartlorang"
+    },
+    {
+      "typeName": "Foursquare",
+      "username": "lorangb",
+      "type": "foursquare",
+      "typeId": "foursquare",
+      "url": "http://foursquare.com/lorangb"
+    },
+    {
+      "typeName": "Google Profile",
+      "username": "lorangb",
+      "type": "googleprofile",
+      "typeId": "googleprofile",
+      "url": "http://profiles.google.com/lorangb"
+    },
+    {
+      "typeName": "Youtube",
+      "username": "rainmaker0MakeitRain",
+      "type": "youtube",
+      "typeId": "youtube",
+      "url": "http://youtube.com/user/rainmaker0MakeitRain",
+      "rss": "http://youtube.com/rss/user/lorangb/videos.rss"
+    },
+    {
+      "typeName": "Plancast",
+      "id": "1634762",
+      "username": "lorangb",
+      "type": "plancast",
+      "typeId": "plancast",
+      "url": "http://plancast.com/user/1634762"
+    },
+    {
+      "typeName": "Tungle Me",
+      "type": "tungleme",
+      "typeId": "tungleme",
+      "url": "http://tungle.me/bartlorang"
+    }
+  ],
+  "organizations": 
+  [
+    {
+      "name": "FullContact",
+      "title": "CEO",
+      "isPrimary": true
+    }
+  ]
+}

data/spec/kickboxer/config_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+require 'kickboxer/config'
+
+describe Kickboxer do
+  it 'stores an api key at the module level' do
+    Kickboxer.api_key = '12345'
+    Kickboxer.api_key.should eq '12345'
+
+    # cleanup
+    Kickboxer.api_key = nil
+  end
+end

data/spec/kickboxer/name_spec.rb

@@ -0,0 +1,141 @@
+require 'spec_helper'
+require 'kickboxer/name'
+
+describe Kickboxer::Name do
+  it 'returns a normalized name' do
+    stub_response('name-normalize')
+    response = Kickboxer::Name.normalize('Mr. John (Johnny) Michael Smith Jr.')
+
+    response.status_code.should eq 200
+    response.status_text.should eq 'OK'
+
+    response.likelihood.should eq 0.815
+    response.region.should eq 'USA'
+
+    details = response.nameDetails
+    details.givenName.should eq 'John'
+    details.familyName.should eq 'Smith'
+    details.middleNames.should eq %w( Michael )
+    details.prefixes.should eq %w( Mr. )
+    details.suffixes.should eq %w( Jr. )
+    details.nicknames.should eq %w( Johnny )
+    details.fullName.should eq 'John Michael Smith'
+  end
+
+  it 'deduces real name from email' do
+    stub_response('name-deduce-email')
+    response = Kickboxer::Name.deduce(email: 'johndsmith79@gmail.com')
+
+    response.status_code.should eq 200
+    response.status_text.should eq 'OK'
+
+    response.likelihood.should eq 0.665
+    response.region.should eq 'USA'
+
+    details = response.nameDetails
+    details.givenName.should eq 'John'
+    details.familyName.should eq 'Smith'
+    details.middleNames.should eq %w( D. )
+    details.fullName.should eq 'John D. Smith'
+  end
+
+  it 'calculates the similarity between two names' do
+    stub_response('name-similarity')
+    response = Kickboxer::Name.similarity('john', 'johnathan')
+
+    response.status_code.should eq 200
+    response.status_text.should eq 'OK'
+
+    result = response.result
+    sim_metrics = result.SimMetrics
+
+    jaro_winkler = sim_metrics.jaroWinkler
+    sprintf('%.4f', jaro_winkler.similarity).should eq '0.8889'
+    sprintf('%.4f', jaro_winkler.timeEstimated).should eq '0.0016'
+    jaro_winkler.timeActual.should eq 0
+
+    levenshtein = sim_metrics.levenshtein
+    sprintf('%.4f', levenshtein.similarity).should eq '0.4444'
+    sprintf('%.4f', levenshtein.timeEstimated).should eq '0.0065'
+    levenshtein.timeActual.should eq 0
+
+    second_string = result.SecondString
+
+    jaro_winkler = second_string.jaroWinkler
+    sprintf('%.4f', jaro_winkler.similarity).should eq '0.8889'
+    jaro_winkler.timeTaken.should eq "1 ms"
+
+    result.FullContact.BigramAnalysis.dice.similarity.should eq 0.5454545455
+  end
+
+  it 'returns statistics for an ambiguous name' do
+    stub_response('name-stats-ambiguous')
+    response = Kickboxer::Name.stats(name: 'john')
+
+    response.status_code.should eq 200
+    response.status_text.should eq 'OK'
+
+    response.name.given.likelihood.should eq 0.992
+    response.name.given.rank.should eq 3
+    response.name.given.male.likelihood.should eq 0.996
+    response.name.given.female.likelihood.should eq 0.004
+
+    response.name.family.likelihood.should eq 0.008
+  end
+
+  it 'returns statistics for a given name' do
+    stub_response('name-stats-given')
+    response = Kickboxer::Name.stats(givenName: 'john')
+
+    response.status_code.should eq 200
+    response.status_text.should eq 'OK'
+
+    response.name.given.should_not respond_to(:likelihood)
+    response.name.given.rank.should eq 3
+    response.name.given.male.likelihood.should eq 0.996
+    response.name.given.female.likelihood.should eq 0.004
+
+    response.name.should_not respond_to(:family)
+  end
+
+  it 'returns statistics for a family name' do
+    stub_response('name-stats-family')
+    response = Kickboxer::Name.stats(familyName: 'smith')
+
+    response.status_code.should eq 200
+    response.status_text.should eq 'OK'
+
+    response.name.family.should_not respond_to(:likelihood)
+    response.name.family.rank.should eq 1
+
+    response.name.should_not respond_to(:given)
+  end
+
+  it 'returns statistics for given and family name' do
+    stub_response('name-stats-both')
+    response = Kickboxer::Name.stats(givenName: 'john', familyName: 'smith')
+
+    response.status_code.should eq 200
+    response.status_text.should eq 'OK'
+
+    response.name.family.should_not respond_to(:likelihood)
+    response.name.family.rank.should eq 1
+
+    response.name.given.should_not respond_to(:likelihood)
+    response.name.given.rank.should eq 3
+    response.name.given.male.likelihood.should eq 0.996
+    response.name.given.female.likelihood.should eq 0.004
+  end
+
+  it 'parses full name strings into given and family names' do
+    stub_response('name-parse')
+    response = Kickboxer::Name.parse('john smith')
+
+    response.status_code.should eq 200
+    response.status_text.should eq 'OK'
+
+    response.result.givenName.should eq 'John'
+    response.result.familyName.should eq 'Smith'
+    response.result.likelihood.should eq 1
+  end
+end

data/spec/kickboxer/person_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+require 'kickboxer/person'
+
+describe Kickboxer::Person do
+  it 'looks up a person by email address' do
+    stub_response('person-email')
+    response = Kickboxer::Person.find_by_email('bart@fullcontact.com')
+
+    response.status_code.should eq 200
+    response.contactInfo.familyName.should eq 'Lorang'
+    response.contactInfo.givenName.should eq 'Bart'
+    response.contactInfo.websites.length.should eq 4
+    response.contactInfo.chats.length.should eq 2
+    response.photos.length.should eq 26
+    response.demographics.age.should eq '32'
+    response.demographics.locationGeneral.should eq 'Boulder, Colorado'
+    response.demographics.gender.should eq 'Male'
+    topics = response.digitalFootprint.topics.map{|topic| topic['value'] }
+    topics.should include 'entrepreneurship'
+    topics.should include 'tequila'
+    topics.should include 'tim tebow'
+    twitter = response.socialProfiles.detect{|p| p['type'] == 'twitter' }
+    twitter['url'].should eq 'http://www.twitter.com/lorangb'
+    organizations = response.organizations.map{|o| o['name'] }
+    organizations.should include 'FullContact'
+    organizations.should include 'Techstars'
+    organizations.should include 'Rainmaker Technologies'
+  end
+
+  it 'looks up a person by phone number' do
+    stub_response('person-phone')
+    response = Kickboxer::Person.find_by_phone_number('+13037170414')
+
+    response.status_code.should eq 200
+    response.contactInfo.familyName.should eq 'Lorang'
+    response.contactInfo.givenName.should eq 'Bart'
+    response.contactInfo.websites.length.should eq 5
+    response.contactInfo.chats.length.should eq 2
+    response.photos.length.should eq 24
+    response.demographics.age.should eq '32'
+    response.demographics.locationGeneral.should eq 'Denver, Colorado, United States'
+    response.demographics.gender.should eq 'male'
+    topics = response.digitalFootprint.topics.map{|topic| topic['value'] }
+    topics.should include 'entrepreneurship'
+    topics.should include 'tequila'
+    topics.should include 'tim tebow'
+    twitter = response.socialProfiles.detect{|p| p['type'] == 'twitter' }
+    twitter['url'].should eq 'http://www.twitter.com/lorangb'
+    organizations = response.organizations.map{|o| o['name'] }
+    organizations.should include 'FullContact'
+  end
+
+  it 'looks up a person by twitter username' do
+    stub_response('person-twitter')
+    response = Kickboxer::Person.find_by_twitter('lorangb')
+
+    response.status_code.should eq 200
+    response.contactInfo.familyName.should eq 'Lorang'
+    response.contactInfo.givenName.should eq 'Bart'
+    response.contactInfo.websites.length.should eq 2
+    response.photos.length.should eq 7
+    response.demographics.locationGeneral.should eq 'Boulder, Colorado'
+    response.demographics.gender.should eq 'male'
+    topics = response.digitalFootprint.topics.map{|topic| topic['value'] }
+    topics.should include 'angel investing'
+    topics.should include 'technology'
+    topics.should include 'tim tebow'
+    twitter = response.socialProfiles.detect{|p| p['type'] == 'twitter' }
+    twitter['url'].should eq 'http://www.twitter.com/lorangb'
+    organizations = response.organizations.map{|o| o['name'] }
+    organizations.should include 'FullContact'
+  end
+
+  it 'looks up a person by facebook username' do
+    stub_response('person-facebook')
+    response = Kickboxer::Person.find_by_facebook('bart.lorang')
+
+    response.status_code.should eq 200
+    response.contactInfo.familyName.should eq 'Lorang'
+    response.contactInfo.givenName.should eq 'Bart'
+    response.contactInfo.websites.length.should eq 1
+    response.photos.length.should eq 3
+    response.demographics.gender.should eq 'male'
+    twitter = response.socialProfiles.detect{|p| p['type'] == 'twitter' }
+    twitter['url'].should eq 'http://twitter.com/lorangb'
+  end
+end