fullcontact-api-ruby 0.1.0

data/lib/fullcontact/ext/hash/to_snake_keys.rb

@@ -0,0 +1,41 @@
+# Hash.to_snake_keys
+class Hash
+  # Recursively converts CamelCase and camelBack JSON-style hash keys to
+  # Rubyish snake_case, suitable for use during instantiation of Ruby
+  # model attributes.
+  #
+  def to_snake_keys(value = self)
+    case value
+    when Array
+      value.map { |v| to_snake_keys(v) }
+    when Hash
+      snake_hash(value)
+    else
+      value
+    end
+  end
+
+  private
+
+  def snake_hash(value)
+    Hash[value.map { |k, v| [underscore_key(k).to_sym, to_snake_keys(v)] }]
+  end
+
+  def underscore_key(k)
+    if k.is_a? Symbol
+      underscore(k.to_s).to_sym
+    elsif k.is_a? String
+      underscore(k)
+    else
+      k # Plissken can't snakify anything except strings and symbols
+    end
+  end
+
+  def underscore(string)
+    string.gsub(/::/, '/')
+      .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+      .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+      .tr('-', '_')
+      .downcase
+  end
+end

data/lib/fullcontact/request.rb

@@ -0,0 +1,28 @@
+module FullContact
+  # Defines HTTP request methods
+  module Request
+    # Perform an HTTP GET request
+    def get(path, options={}, raw=false, faraday_options={})
+      request(:get, path, options, raw, faraday_options)
+    end
+
+    private
+
+    # Perform an HTTP request
+    def request(method, path, options, raw=false, faraday_options={})
+      response = connection(raw, faraday_options).send(method) do |request|
+        if FullContact.options[:auth_type] == :query
+          options[:apiKey] = FullContact.options[:api_key]
+        end
+        request.url(formatted_path(path), options)
+        request.headers[FullContact::Configuration::AUTH_HEADER_NAME] = FullContact.options[:api_key]
+      end
+
+      raw ? response : response.body
+    end
+
+    def formatted_path(path)
+      [path, format].compact.join('.')
+    end
+  end
+end

data/lib/fullcontact/version.rb

@@ -0,0 +1,3 @@
+module FullContact
+  VERSION = '0.1.0'
+end

data/lib/fullcontact.rb

@@ -0,0 +1,29 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'fullcontact/ext/hash/to_snake_keys'
+require 'fullcontact/error'
+require 'fullcontact/configuration'
+require 'fullcontact/api'
+require 'fullcontact/client'
+require 'fullcontact/version'
+
+module FullContact
+  extend Configuration
+
+  # Alias for FullContact::Client.new
+  #
+  # @return [FullContact::Client]
+  def self.client(options={})
+    FullContact::Client.new(options)
+  end
+
+  # Delegate to FullContact::Client
+  def self.method_missing(method, *args, &block)
+    return super unless client.respond_to?(method)
+    client.send(method, *args, &block)
+  end
+
+  def self.respond_to?(method, include_private = false)
+    client.respond_to?(method, include_private) || super(method, include_private)
+  end
+end

data/spec/faraday/response_spec.rb

@@ -0,0 +1,57 @@
+require 'helper'
+require 'faraday'
+require 'fullcontact'
+
+describe Faraday::Response do
+  before do
+    FullContact.configure do |config|
+      config.api_key = "api_key"
+    end
+    @client = FullContact::Client.new
+  end
+
+  {
+      400 => FullContact::BadRequest,
+      401 => FullContact::Unauthorized,
+      403 => FullContact::Forbidden,
+      404 => FullContact::NotFound,
+      422 => FullContact::Invalid,
+      429 => FullContact::RateLimited,
+      500 => FullContact::InternalServerError,
+      502 => FullContact::BadGateway,
+      503 => FullContact::ServiceUnavailable,
+  }.each do |status, exception|
+    if (status >= 500)
+      context "when HTTP status is #{status}" do
+        before do
+          stub_get('person.json').
+              with(:query => {:apiKey => "api_key", :email => 'brawest@gmail.com'}).
+              to_return(:status => status)
+        end
+
+        it "should raise #{exception.name} error" do
+          lambda do
+            @client.person(:email => 'brawest@gmail.com')
+          end.should raise_error(exception)
+        end
+      end
+    else
+      [nil, "error", "errors"].each do |body|
+        context "when HTTP status is #{status} and body is #{body||='nil'}" do
+          before do
+            body_message = '{"'+body+'":"test"}' unless body.nil?
+            stub_get('person.json').
+                with(:query => {:apiKey => "api_key", :email => 'brawest@gmail.com'}).
+                to_return(:status => status, :body => body_message)
+          end
+
+          it "should raise #{exception.name} error" do
+            lambda do
+              @client.person(:email => 'brawest@gmail.com')
+            end.should raise_error(exception)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/fixtures/company.json

@@ -0,0 +1,191 @@
+
+{
+  "status" : 200,
+  "requestId" : "92d5908a-8de4-4294-85d2-774051c33ef3",
+  "category" : [ {
+    "name" : "Other",
+    "code" : "OTHER"
+  } ],
+  "logo" : "https://d2ojpxxtu63wzl.cloudfront.net/static/e9f3aeb8965684906efa7ae514988ffb_0837a93ef09a70f8b9ff73efac18176225fd0b9cb8bf84a60c5926701b4c5033",
+  "website" : "https://www.fullcontact.com",
+  "languageLocale" : "en",
+  "organization" : {
+    "name" : "FullContact Inc.",
+    "approxEmployees" : 50,
+    "founded" : "2010",
+    "overview" : "Solving the world's contact information problem!",
+    "contactInfo" : {
+      "emailAddresses" : [ {
+        "value" : "support@fullcontact.com",
+        "label" : "support"
+      }, {
+        "value" : "sales@fullcontact.com",
+        "label" : "sales"
+      } ],
+      "phoneNumbers" : [ {
+        "number" : "+1 (888) 330-6943",
+        "label" : "other"
+      } ],
+      "addresses" : [ {
+        "addressLine1" : "1755 Blake Street",
+        "addressLine2" : "Suite 450",
+        "locality" : "Denver",
+        "region" : {
+          "name" : "Colorado",
+          "code" : "CO"
+        },
+        "country" : {
+          "name" : "United States",
+          "code" : "US"
+        },
+        "postalCode" : "80202",
+        "label" : "work"
+      } ]
+    },
+    "links" : [ {
+      "url" : "https://www.fullcontact.com/comments/feed",
+      "label" : "rss"
+    }, {
+      "url" : "https://www.fullcontact.com/home/feed",
+      "label" : "rss"
+    }, {
+      "url" : "https://www.fullcontact.com/developer",
+      "label" : "other"
+    }, {
+      "url" : "https://www.fullcontact.com/feed",
+      "label" : "rss"
+    }, {
+      "url" : "https://fullcontact.com/blog",
+      "label" : "blog"
+    }, {
+      "url" : "https://www.youtube.com/watch?v=koFtyUDbYak",
+      "label" : "youtube"
+    } ],
+    "images" : [ {
+      "url" : "https://d2ojpxxtu63wzl.cloudfront.net/static/1c390465c39c998a59c8717034982dfc_ff8af9a9f14da29ee687053e65d2ed103b8ab6f95b1f4d0147b9077ea04a3d6c",
+      "label" : "facebook"
+    }, {
+      "url" : "https://d2ojpxxtu63wzl.cloudfront.net/static/edaa53d9a080aea37ddfb85d775620a9_98a2d7beef6a5b4a53f43da4dd1a90bda21dc18f755394fdbf9b6cf3283853a0",
+      "label" : "twitter"
+    }, {
+      "url" : "https://d2ojpxxtu63wzl.cloudfront.net/static/1bacd7306731a30d2a9f024eeb1dcff1_94d77dcdedbfe40707ac4a75ca4f4d2978bffc20b2e33a3288ea9e4d47f5af6c",
+      "label" : "twitter"
+    }, {
+      "url" : "https://d2ojpxxtu63wzl.cloudfront.net/static/3f64db7ba9331fbd1e4cc11655e2d3d4_a2477a83cafc8a98d5533f3617f0b1db2796ad0826482e2eabdc8d3345d70c17",
+      "label" : "twitter"
+    }, {
+      "url" : "https://d2ojpxxtu63wzl.cloudfront.net/static/ee07ac81180408fde663426d3b0afb3f_3a1154347631c037b9bd2b2f33d4cbc8511d58f5c11ad3cbbc319957d1a5149b",
+      "label" : "pinterest"
+    }, {
+      "url" : "https://d2ojpxxtu63wzl.cloudfront.net/static/80885c5e8b570e69bdc55d29aad115cd_a1ce9fb51ea43971d861e452034056d807422a391ac8e27f76ee4a9e803698d1",
+      "label" : "googleplus"
+    }, {
+      "url" : "https://d2ojpxxtu63wzl.cloudfront.net/static/4be5211e4b0129d1c8d41e84f257f343_3d84b3de68d6060243972af12a8ca67c4a595fd86a4419d50bf429e6d778ce2d",
+      "label" : "other"
+    }, {
+      "url" : "https://d2ojpxxtu63wzl.cloudfront.net/static/7e9aa6402ff2975e297a01243c358619_c0b8d4a63a52f4a47106494561c0332b79f848b40fcbe92336a0a17b843f44f8",
+      "label" : "other"
+    } ],
+    "keywords" : [ "APIs", "Boulder", "Business", "Colorado", "Contact Management", "Denver", "Developer APIs", "Marketing", "Social Media", "Software", "Techstars", "Venture Capital" ]
+  },
+  "socialProfiles" : [ {
+    "bio" : "FullContact automatically cleans your contacts, enriches them with social profile data, and continually syncs them with all your contact sources.\n\nFor developers, we offer a suite of contact management APIs to normalize, de-duplicate, and enrich contact data with social profiles.\n\nAs Dropbox did for files and Evernote did for notes, FullContact is doing for contacts. And we’re providing it to individuals, businesses, and developers.",
+    "typeId" : "facebook",
+    "typeName" : "Facebook",
+    "url" : "https://www.facebook.com/FullContactAPI",
+    "username" : "FullContactAPI",
+    "id" : "159926450745554"
+  }, {
+    "bio" : "We're solving the world's contact information problem. Get your contacts under control with @FullContactApp & check out @FullContactAPI for our APIs.",
+    "followers" : 6279,
+    "following" : 1756,
+    "typeId" : "twitter",
+    "typeName" : "Twitter",
+    "url" : "https://twitter.com/FullContactInc",
+    "username" : "FullContactInc",
+    "id" : "142954090"
+  }, {
+    "bio" : "The API that turns partial contact information into full contact information. We provide data enrichment, de-duplication, normalization, and much more.",
+    "followers" : 5032,
+    "following" : 2444,
+    "typeId" : "twitter",
+    "typeName" : "Twitter",
+    "url" : "https://twitter.com/FullContactAPI",
+    "username" : "FullContactAPI",
+    "id" : "340611236"
+  }, {
+    "bio" : "Keep your contact information clean, complete & current across all your address books.",
+    "followers" : 3395,
+    "following" : 1561,
+    "typeId" : "twitter",
+    "typeName" : "Twitter",
+    "url" : "https://twitter.com/FullContactApp",
+    "username" : "FullContactApp",
+    "id" : "451688048"
+  }, {
+    "bio" : "FullContact's address book brings all of your contacts into one place and keeps them automatically up to date on the web, as well as on your iPhone and iPad. \n\nAdd photos to your contacts. Find them on social networks like Twitter, Facebook, LinkedIn and of course AngelList. It's the address book that busy professionals from any walk of life can appreciate, and best of all it's free. \n\nFor developers, the suite of FullContact APIs builds powerful, complete profiles of contacts that can be included in any application.",
+    "followers" : 259,
+    "typeId" : "angellist",
+    "typeName" : "AngelList",
+    "url" : "https://angel.co/fullcontact",
+    "username" : "fullcontact"
+  }, {
+    "bio" : "FullContact provides a suite of cloud-based contact management solutions for businesses, developers, and individuals.",
+    "typeId" : "crunchbasecompany",
+    "typeName" : "CrunchBase",
+    "url" : "http://www.crunchbase.com/organization/fullcontact",
+    "username" : "fullcontact"
+  }, {
+    "bio" : "FullContact is the API that keeps contact information current. We build APIs that developers can integrate into their applications using any language.",
+    "followers" : 28,
+    "following" : 55,
+    "typeId" : "pinterest",
+    "typeName" : "Pinterest",
+    "url" : "http://www.pinterest.com/fullcontact/",
+    "username" : "fullcontact"
+  }, {
+    "bio" : "All your contacts in one place and automatically up-to-date.  Learn more about how we're solving the world's contact information problem at https://www.fullcontact.com.",
+    "typeId" : "google",
+    "typeName" : "GooglePlus",
+    "url" : "https://plus.google.com/u/0/107620035082673219790",
+    "id" : "107620035082673219790"
+  }, {
+    "typeId" : "klout",
+    "typeName" : "Klout",
+    "url" : "http://klout.com/FullContactApp",
+    "username" : "FullContactApp",
+    "id" : "85568398087860504"
+  }, {
+    "typeId" : "klout",
+    "typeName" : "Klout",
+    "url" : "http://klout.com/FullContactAPI",
+    "username" : "FullContactAPI",
+    "id" : "33777001971317895"
+  }, {
+    "bio" : "FullContact is solving the world's contact information problem by providing APIs to software developers to keep contact information clean, complete and current. FullContact provides identity resolution for all of the disparate pieces of contact information out there on the web. We do this by aggregating billions of contact records, all with numerous attributes, including quality, freshness and frequency. Our patent pending algorithms process all of this data and automatically produce clean, accurate full contact records. As a final step, we then check each data element to make sure that it's publicly available before providing it to our customers. FullContact is a TechStars Boulder 2011 Company.",
+    "typeId" : "linkedincompany",
+    "typeName" : "LinkedIn",
+    "url" : "https://www.linkedin.com/company/fullcontact-inc-",
+    "username" : "fullcontact-inc-",
+    "id" : "2431118"
+  } ],
+  "traffic" : {
+    "topCountryRanking" : [ {
+      "rank" : 7914,
+      "locale" : "us"
+    }, {
+      "rank" : 14756,
+      "locale" : "in"
+    }, {
+      "rank" : 10628,
+      "locale" : "gb"
+    } ],
+    "ranking" : [ {
+      "rank" : 19254,
+      "locale" : "global"
+    }, {
+      "rank" : 7914,
+      "locale" : "us"
+    } ]
+  }
+}

data/spec/fixtures/person.json

@@ -0,0 +1,48 @@
+
+{
+  "status": 200,
+  "photos": 
+  [
+    {
+      "url": "http://a0.twimg.com/profile_images/1084241539/steps_normal.jpg",
+      "type": "twitter"
+    },
+    {
+      "isPrimary": false,
+      "type": "gravatar",
+      "url": "https://secure.gravatar.com/avatar/b2f65d319b253da9cf92635d8eac808b"
+    },
+    {
+      "message": "More Data Available - 3rd party credentials required - contact api@fullcontact.cc for more information."
+    }
+  ],
+  "contactInfo": {
+    "familyName": "West",
+    "givenName": "Brandon",
+    "fullName": "Brandon West"
+  },
+  "demographics": {
+    "age": {
+      "message": "More Data Available - 3rd party credentials required - contact api@fullcontact.cc for more information."
+    },
+    "locationGeneral": "Littleton, Colorado",
+    "gender": {
+      "message": "More Data Available - 3rd party credentials required - contact api@fullcontact.cc for more information."
+    }
+  },
+  "socialProfiles": 
+  [
+    {
+      "url": "http://twitter.com/brandonmwest",
+      "id": "16517063",
+      "type": "twitter",
+      "username": "brandonmwest"
+    },
+    {
+      "message": "More Data Available - 3rd party credentials required - contact api@fullcontact.cc for more information."
+    },
+    {
+      "message": "More Data Available - 3rd party credentials required - contact api@fullcontact.cc for more information."
+    }
+  ]
+}

data/spec/fullcontact_spec.rb

@@ -0,0 +1,145 @@
+require 'fullcontact'
+require 'helper'
+
+describe FullContact do
+  after do
+    FullContact.reset
+  end
+
+  context "when delegating to a client" do
+
+    before do
+      FullContact.configure do |config|
+        config.api_key = "api_key"
+      end
+
+      stub_get("person.json").
+          with(:query => {:apiKey => "api_key", :email => "brawest@gmail.com"}).
+          to_return(:body => fixture("person.json"), :headers => {:content_type => "application/json; charset=utf-8"})
+
+      stub_get("person.json").
+          with(:query => {:apiKey => "api_key", :twitter => "brawtest"}).
+          to_return(:body => fixture("person.json"), :headers => {:content_type => "application/json; charset=utf-8"})
+
+      stub_get("person.json").
+          with(:query => {:email => "brawest@gmail.com"})
+    end
+
+    context "when using query auth type" do
+
+      before do
+        FullContact.configure do |config|
+          config.auth_type = :query
+        end
+      end
+
+      it "should get the correct resource" do
+        FullContact.person(email: "brawest@gmail.com")
+        a_get("person.json")
+            .with(:query => {:apiKey => "api_key", :email => "brawest@gmail.com"})
+            .should have_been_made
+      end
+    end
+
+    context "when using header auth type" do
+
+      before do
+        FullContact.configure do |config|
+          config.auth_type = :header
+        end
+      end
+
+      it "should get the correct resource" do
+        FullContact.person(email: "brawest@gmail.com")
+        a_get("person.json")
+            .with(:query => {:email => "brawest@gmail.com"}, :headers => {:'X-Fullcontact-Apikey'=>'api_key'})
+            .should have_been_made
+      end
+    end
+
+    it "should return the same results as a client by email" do
+      FullContact.person(:email => "brawest@gmail.com").should == FullContact::Client.new.person(:email => "brawest@gmail.com")
+    end
+
+    it "should return the same results as a client by twitter" do
+      FullContact.person(:twitter => "brawtest").should == FullContact::Client.new.person(:twitter => "brawtest")
+    end
+  end
+
+  describe ".client" do
+    it "should be a FullContact::Client" do
+      FullContact.client.should be_a FullContact::Client
+    end
+  end
+
+  describe ".adapter" do
+    it "should return the default adapter" do
+      FullContact.adapter.should == FullContact::Configuration::DEFAULT_ADAPTER
+    end
+  end
+
+  describe ".adapter=" do
+    it "should set the adapter" do
+      FullContact.adapter = :typhoeus
+      FullContact.adapter.should == :typhoeus
+    end
+  end
+
+  describe ".endpoint" do
+    it "should return the default endpoint" do
+      FullContact.endpoint.should == FullContact::Configuration::DEFAULT_ENDPOINT
+    end
+  end
+
+  describe ".endpoint=" do
+    it "should set the endpoint" do
+      FullContact.endpoint = 'http://tumblr.com/'
+      FullContact.endpoint.should == 'http://tumblr.com/'
+    end
+  end
+
+  describe ".format" do
+    it "should return the default format" do
+      FullContact.format.should == FullContact::Configuration::DEFAULT_FORMAT
+    end
+  end
+
+  describe ".format=" do
+    it "should set the format" do
+      FullContact.format = 'xml'
+      FullContact.format.should == 'xml'
+    end
+  end
+
+  describe ".user_agent" do
+    it "should return the default user agent" do
+      FullContact.user_agent.should == FullContact::Configuration::DEFAULT_USER_AGENT
+    end
+  end
+
+  describe ".user_agent" do
+    it "should return the default user agent" do
+      expect(FullContact.user_agent).to satisfy { |ua| ua.start_with? 'FullContact Ruby Client/' }
+    end
+  end
+
+  describe ".user_agent=" do
+    it "should set the user_agent" do
+      FullContact.user_agent = 'Custom User Agent'
+      FullContact.user_agent.should == 'Custom User Agent'
+    end
+  end
+
+  describe ".configure" do
+
+    FullContact::Configuration::VALID_OPTIONS_KEYS.each do |key|
+
+      it "should set the #{key}" do
+        FullContact.configure do |config|
+          config.send("#{key}=", key)
+          FullContact.send(key).should == key
+        end
+      end
+    end
+  end
+end

data/spec/helper.rb

@@ -0,0 +1,23 @@
+require 'rspec'
+require 'webmock/rspec'
+require 'simplecov'
+
+WebMock.disable_net_connect!(:allow => 'codeclimate.com')
+
+SimpleCov.start
+
+def a_get(path)
+  a_request(:get, FullContact.endpoint + path)
+end
+
+def stub_get(path)
+  stub_request(:get, FullContact.endpoint + path)
+end
+
+def fixture_path
+  File.expand_path("../fixtures", __FILE__)
+end
+
+def fixture(file)
+  File.new(fixture_path + '/' + file)
+end

data/spec/ruby_fullcontact/api_spec.rb

@@ -0,0 +1,68 @@
+require 'helper'
+
+describe FullContact::API do
+  before do
+    @keys = FullContact::Configuration::VALID_OPTIONS_KEYS
+  end
+
+  context "with module configuration" do
+    before do
+      FullContact.configure do |config|
+        @keys.each do |key|
+          config.send("#{key}=", key)
+        end
+      end
+    end
+
+    after do
+      FullContact.reset
+    end
+
+    it "should inherit module configuration" do
+      api = FullContact::API.new
+      @keys.each do |key|
+        api.send(key).should == key
+      end
+    end
+
+    context "with class configuration" do
+
+      before do
+        @configuration = {
+            :api_key => 'api_key',
+            :auth_type => :headers,
+            :adapter => :typhoeus,
+            :endpoint => 'http://tumblr.com/',
+            :gateway => 'apigee-1111.apigee.com',
+            :format => :xml,
+            :proxy => 'http://erik:sekret@proxy.example.com:8080',
+            :user_agent => 'Custom User Agent',
+            :skip_rubyize => true,
+            :include_headers_in_response => true
+        }
+      end
+
+      context "during initialization"
+
+      it "should override module configuration" do
+        api = FullContact::API.new(@configuration)
+        @keys.each do |key|
+          api.send(key).should == @configuration[key]
+        end
+      end
+
+      context "after initilization" do
+
+        it "should override module configuration after initialization" do
+          api = FullContact::API.new
+          @configuration.each do |key, value|
+            api.send("#{key}=", value)
+          end
+          @keys.each do |key|
+            api.send(key).should == @configuration[key]
+          end
+        end
+      end
+    end
+  end
+end

data/spec/ruby_fullcontact/client/company_spec.rb

@@ -0,0 +1,37 @@
+require 'helper'
+
+describe FullContact::Client::Company do
+  FullContact::Configuration::VALID_FORMATS.each do |format|
+    context ".new(:format => '#{format}')" do
+      before do
+        @client = FullContact::Client.new(:format => format, :api_key => 'api_key')
+      end
+
+    end
+  end
+
+  context "when parsing a response" do
+
+    before do
+      FullContact.configure do |config|
+        config.api_key = "api_key"
+      end
+
+      stub_get("company/lookup.json").
+          with(:query => {:apiKey => "api_key", :domain => "fullcontact.com"}).
+          to_return(:body => fixture("company.json"), :headers => {:content_type => "application/json; charset=utf-8"})
+
+      stub_get("company/lookup.json").
+          with(:query => {:apiKey => "api_key", :domain => "fullcontact.com"}).
+          to_return(:body => fixture("company.json"), :headers => {:content_type => "application/json; charset=utf-8"})
+    end
+
+    it 'should rubyize keys' do
+      expect(FullContact.company(domain: "fullcontact.com").organization.name).to(eq("FullContact Inc."))
+
+      expect(FullContact.company(domain: "fullcontact.com")).to satisfy do |v|
+        v.keys.all? { |k| !k.match(/[A-Z]/) }
+      end
+    end
+  end
+end