clearbit 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5b0cfa609b6d8cb8a20bcfb8341eb972e1413723
+  data.tar.gz: 4c1389dca0b4b2e69173395dde00ef620e0afdeb
+SHA512:
+  metadata.gz: b2053d03b6e1211e0a801bbfa0b58df2ec52ca6dbe72f71e4f4bb83bad352e45d93698c61b9e2768094d84b2a2f53895b2afdc442f5815fad45fb24e8467079a
+  data.tar.gz: e3b24f8fe720f16fc523104f323bef21f60403568427e601d35e3ebdb914df987e010ea45ea3c426d2e537e715354b14c85eac6dd426c5d7d823f0d9e91b458e

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in clearbit.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Alex MacCaw
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,71 @@
+# Clearbit
+
+A Ruby API client to [https://clearbit.co](https://clearbit.co).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'clearbit'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install clearbit
+
+## Usage
+
+First authorize requests by setting the API key found on your [account's settings page](https://clearbit.co/profile).
+
+    Clearbit.api_key = ENV['APIHUB_KEY']
+
+Then you can lookup people by email address:
+
+    person = Clearbit::Person[email: 'info@eribium.org']
+
+If the person can't be found, then `nil` will be returned.
+
+See the [documentation](https://clearbit.co/docs/person) for more information.
+
+## Company lookup
+
+You can lookup company data by domain name:
+
+    company = Clearbit::Company[domain: 'uber.com']
+
+If the company can't be found, then `nil` will be returned.
+
+See the [documentation](https://clearbit.co/docs/company) for more information.
+
+## CLI
+
+The gem also includes a `clearbit` executable, which you can use like this:
+
+    $ clearbit person --email info@eribium.org
+
+        {
+          "name": {
+            "fullName": "Alex MacCaw",
+            "givenName": "Alex",
+            "familyName": "MacCaw"
+          },
+          ...
+
+Or to look up a company:
+
+    $ clearbit company --domain uber.com
+
+        {
+          "name": "Uber",
+          "legalName": "Uber, Inc.",
+          "categories": [
+            "Transport"
+          ],
+          "founders": [
+            "Travis Kalanick",
+            "Garrett Camp"
+          ],
+          ...

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/apihub.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'clearbit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "clearbit"
+  spec.version       = Clearbit::VERSION
+  spec.authors       = ["Alex MacCaw"]
+  spec.email         = ["alex@clearbit.co"]
+  spec.description   = %q{API client for clearbit.co}
+  spec.summary       = %q{API client for clearbit.co}
+  spec.homepage      = "https://github.com/maccman/clearbit-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_dependency 'nestful', '~> 1.0.7'
+end

data/bin/clearbit

@@ -0,0 +1,69 @@
+#!/usr/bin/env ruby
+
+require 'clearbit'
+require 'json'
+require 'optparse'
+
+begin
+  require 'awesome_print'
+rescue LoadError
+  def ap(value)
+    puts JSON.pretty_generate(value)
+  end
+end
+
+options = {}
+values  = {}
+
+parser  = OptionParser.new do |opts|
+  opts.banner = "Usage: clearbit [person|company] [options]"
+
+  opts.on("--email EMAIL", String, "Email") do |v|
+    values[:email] = v
+  end
+
+  opts.on("--domain DOMAIN", String, "Domain") do |v|
+    values[:domain] = v
+  end
+
+  opts.on("--api-key KEY", String, "Clearbit") do |v|
+    options[:api_key] = v
+  end
+end
+
+parser.parse!
+
+case ARGV[0]
+when 'person'
+  entity = Clearbit::Streaming::Person
+when 'company'
+  entity = Clearbit::Streaming::Company
+else
+  puts parser
+  exit
+end
+
+if values == {}
+  puts parser
+  exit
+end
+
+if key = ENV['APIHUB_KEY']
+  options[:api_key] ||= key
+end
+
+if key = options.delete(:api_key)
+  Clearbit.api_key = key
+else
+  puts 'API Key required'
+  puts parser
+  exit
+end
+
+object = entity.find(values, options)
+
+if object
+  ap object.to_hash
+else
+  puts 'Not found'
+end

data/examples/email.rb

@@ -0,0 +1,6 @@
+require 'clearbit'
+require 'pp'
+
+Clearbit.api_key = ENV['CLEARBIT_KEY']
+
+pp Clearbit::Person[email: 'info@eribium.org']

data/lib/clearbit.rb

@@ -0,0 +1,23 @@
+require 'nestful'
+require 'clearbit/version'
+
+module Clearbit
+  def self.api_key=(value)
+    Base.options Base.options.merge(
+      auth_type: :bearer,
+      password:  value
+    )
+  end
+
+  def self.key=(value)
+    self.api_key = value
+  end
+
+  autoload :Base, 'clearbit/base'
+  autoload :Company, 'clearbit/company'
+  autoload :Mash, 'clearbit/mash'
+  autoload :Person, 'clearbit/person'
+  autoload :Resource, 'clearbit/resource'
+  autoload :Streaming, 'clearbit/streaming'
+  autoload :Watchlist, 'clearbit/watchlist'
+end

data/lib/clearbit/base.rb

@@ -0,0 +1,6 @@
+module Clearbit
+  class Base < Resource
+    endpoint 'https://api.clearbit.co'
+    options :format => :json
+  end
+end

data/lib/clearbit/company.rb

@@ -0,0 +1,37 @@
+module Clearbit
+  class Company < Base
+    endpoint 'https://company.clearbit.co'
+    path '/v1/companies'
+
+    def self.find(values, options = {})
+      unless values.is_a?(Hash)
+        values = {:id => values}
+      end
+
+      options = options.dup
+      params  = options.delete(:params) || {}
+
+      if domain = values[:domain]
+        response = get(uri(:domain, domain), params, options)
+
+      elsif id = values[:id]
+        response = get(id, params, options)
+
+      else
+        raise ArgumentError, 'Invalid values'
+      end
+
+      if response.status == 202
+        self.new(pending: true)
+      else
+        self.new(response)
+      end
+
+    rescue Nestful::ResourceNotFound
+    end
+
+    class << self
+      alias_method :[], :find
+    end
+  end
+end

data/lib/clearbit/mash.rb

@@ -0,0 +1,180 @@
+module Clearbit
+  class Mash < Hash
+    def self.new(value = nil, *args)
+      if value.respond_to?(:each) &&
+        !value.respond_to?(:each_pair)
+        value.map {|v| super(v) }
+      else
+        super
+      end
+    end
+
+    alias_method :to_s, :inspect
+
+    def initialize(source_hash = nil, default = nil, &blk)
+      deep_update(source_hash.to_hash) if source_hash
+      default ? super(default) : super(&blk)
+    end
+
+    class << self; alias [] new; end
+
+    def id #:nodoc:
+      self['id']
+    end
+
+    def type #:nodoc:
+      self['type']
+    end
+
+    alias_method :regular_reader, :[]
+    alias_method :regular_writer, :[]=
+
+    # Retrieves an attribute set in the Mash. Will convert
+    # any key passed in to a string before retrieving.
+    def custom_reader(key)
+      value = regular_reader(convert_key(key))
+      yield value if block_given?
+      value
+    end
+
+    # Sets an attribute in the Mash. Key will be converted to
+    # a string before it is set, and Hashes will be converted
+    # into Mashes for nesting purposes.
+    def custom_writer(key,value) #:nodoc:
+      regular_writer(convert_key(key), convert_value(value))
+    end
+
+    alias_method :[], :custom_reader
+    alias_method :[]=, :custom_writer
+
+    # This is the bang method reader, it will return a new Mash
+    # if there isn't a value already assigned to the key requested.
+    def initializing_reader(key)
+      ck = convert_key(key)
+      regular_writer(ck, self.class.new) unless key?(ck)
+      regular_reader(ck)
+    end
+
+    # This is the under bang method reader, it will return a temporary new Mash
+    # if there isn't a value already assigned to the key requested.
+    def underbang_reader(key)
+      ck = convert_key(key)
+      if key?(ck)
+        regular_reader(ck)
+      else
+        self.class.new
+      end
+    end
+
+    def fetch(key, *args)
+      super(convert_key(key), *args)
+    end
+
+    def delete(key)
+      super(convert_key(key))
+    end
+
+    alias_method :regular_dup, :dup
+    # Duplicates the current mash as a new mash.
+    def dup
+      self.class.new(self, self.default)
+    end
+
+    def key?(key)
+      super(convert_key(key))
+    end
+    alias_method :has_key?, :key?
+    alias_method :include?, :key?
+    alias_method :member?, :key?
+
+    # Performs a deep_update on a duplicate of the
+    # current mash.
+    def deep_merge(other_hash, &blk)
+      dup.deep_update(other_hash, &blk)
+    end
+    alias_method :merge, :deep_merge
+
+    # Recursively merges this mash with the passed
+    # in hash, merging each hash in the hierarchy.
+    def deep_update(other_hash, &blk)
+      other_hash.each_pair do |k,v|
+        key = convert_key(k)
+        if regular_reader(key).is_a?(Mash) and v.is_a?(::Hash)
+          custom_reader(key).deep_update(v, &blk)
+        else
+          value = convert_value(v, true)
+          value = blk.call(key, self[k], value) if blk
+          custom_writer(key, value)
+        end
+      end
+      self
+    end
+    alias_method :deep_merge!, :deep_update
+    alias_method :update, :deep_update
+    alias_method :merge!, :update
+
+    # Performs a shallow_update on a duplicate of the current mash
+    def shallow_merge(other_hash)
+      dup.shallow_update(other_hash)
+    end
+
+    # Merges (non-recursively) the hash from the argument,
+    # changing the receiving hash
+    def shallow_update(other_hash)
+      other_hash.each_pair do |k,v|
+        regular_writer(convert_key(k), convert_value(v, true))
+      end
+      self
+    end
+
+    def replace(other_hash)
+      (keys - other_hash.keys).each { |key| delete(key) }
+      other_hash.each { |key, value| self[key] = value }
+      self
+    end
+
+    # Will return true if the Mash has had a key
+    # set in addition to normal respond_to? functionality.
+    def respond_to?(method_name, include_private=false)
+      return true if key?(method_name) || method_name.to_s.slice(/[=?!_]\Z/)
+      super
+    end
+
+    def method_missing(method_name, *args, &blk)
+      return self.[](method_name, &blk) if key?(method_name)
+      match = method_name.to_s.match(/(.*?)([?=!_]?)$/)
+      case match[2]
+      when "="
+        self[match[1]] = args.first
+      when "?"
+        !!self[match[1]]
+      when "!"
+        initializing_reader(match[1])
+      when "_"
+        underbang_reader(match[1])
+      else
+        default(method_name, *args, &blk)
+      end
+    end
+
+    protected
+
+    def convert_key(key) #:nodoc:
+      key.to_s
+    end
+
+    def convert_value(val, duping=false) #:nodoc:
+      case val
+        when self.class
+          val.dup
+        when ::Hash
+          val = val.dup if duping
+          Mash.new(val)
+        when ::Array
+          val.map {|e| convert_value(e) }
+        else
+          val
+      end
+    end
+  end
+end

data/lib/clearbit/person.rb

@@ -0,0 +1,43 @@
+module Clearbit
+  class Person < Base
+    endpoint 'https://person.clearbit.co'
+    path '/v1/people'
+
+    def self.find(values, options = {})
+      unless values.is_a?(Hash)
+        values = {:id => values}
+      end
+
+      options = options.dup
+      params  = options.delete(:params) || {}
+
+      if email = values[:email]
+        response = get(uri(:email, email), params, options)
+
+      elsif twitter = values[:twitter]
+        response = get(uri(:twitter, twitter), params, options)
+
+      elsif github = values[:github]
+        response = get(uri(:github, github), params, options)
+
+      elsif id = values[:id]
+        response = get(id, params, options)
+
+      else
+        raise ArgumentError, 'Invalid values'
+      end
+
+      if response.status == 202
+        self.new(pending: true)
+      else
+        self.new(response)
+      end
+
+    rescue Nestful::ResourceNotFound
+    end
+
+    class << self
+      alias_method :[], :find
+    end
+  end
+end

data/lib/clearbit/resource.rb

@@ -0,0 +1,66 @@
+require 'uri'
+
+module Clearbit
+  class Resource < Mash
+    def self.endpoint(value = nil)
+      @endpoint = value if value
+      return @endpoint if @endpoint
+      superclass.respond_to?(:endpoint) ? superclass.endpoint : nil
+    end
+
+    def self.path(value = nil)
+      @path = value if value
+      return @path if @path
+      superclass.respond_to?(:path) ? superclass.path : nil
+    end
+
+    def self.options(value = nil)
+      @options = value if value
+      return @options if @options
+      superclass.respond_to?(:options) ? superclass.options : {}
+    end
+
+    class << self
+      alias_method :endpoint=, :endpoint
+      alias_method :path=, :path
+      alias_method :options=, :options
+    end
+
+    def self.url
+      URI.join(endpoint.to_s, path.to_s).to_s
+    end
+
+    def self.uri(*parts)
+      # If an absolute URI already
+      if (uri = parts.first) && uri.is_a?(URI)
+        return uri if uri.host
+      end
+
+      URI.parse(Nestful::Helpers.to_path(url, *parts))
+    end
+
+    def self.get(action = '', params = {}, options = {})
+      request(uri(action), options.merge(method: :get, params: params))
+    end
+
+    def self.put(action = '', params = {}, options = {})
+      request(uri(action), options.merge(method: :put, params: params))
+    end
+
+    def self.post(action = '', params = {}, options = {})
+      request(uri(action), options.merge(method: :post, params: params))
+    end
+
+    def self.delete(action = '', params = {}, options = {})
+      request(uri(action), options.merge(method: :delete, params: params))
+    end
+
+    def self.request(url, options = {})
+      options = Nestful::Helpers.deep_merge(self.options, options)
+
+      self.new Nestful::Request.new(
+        url, options
+      ).execute
+    end
+  end
+end

data/lib/clearbit/streaming.rb

@@ -0,0 +1,6 @@
+module Clearbit
+  module Streaming
+    autoload :Company, 'clearbit/streaming/company'
+    autoload :Person, 'clearbit/streaming/person'
+  end
+end

data/lib/clearbit/streaming/company.rb

@@ -0,0 +1,7 @@
+module Clearbit
+  module Streaming
+    class Company < Clearbit::Company
+      endpoint 'https://company-stream.clearbit.co'
+    end
+  end
+end

data/lib/clearbit/streaming/person.rb

@@ -0,0 +1,7 @@
+module Clearbit
+  module Streaming
+    class Person < Clearbit::Person
+      endpoint 'https://person-stream.clearbit.co'
+    end
+  end
+end

data/lib/clearbit/version.rb

@@ -0,0 +1,3 @@
+module Clearbit
+  VERSION = "0.0.6"
+end

data/lib/clearbit/watchlist.rb

@@ -0,0 +1,28 @@
+module Clearbit
+  class Watchlist < Base
+    endpoint 'https://watchlist.clearbit.co'
+    path '/v1/search/all'
+
+    def self.search(name, options = {})
+      options = options.dup
+      params  = options.delete(:params) || {}
+
+      params  = {
+        name:      name,
+        threshold: options.delete(:threshold) || 1.0
+      }.merge(params)
+
+      response = post('', params, options)
+
+      self.new(response)
+    end
+
+    class Individual < Watchlist
+      path '/v1/search/individuals'
+    end
+
+    class Entity < Watchlist
+      path '/v1/search/entities'
+    end
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: clearbit
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+platform: ruby
+authors:
+- Alex MacCaw
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nestful
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.7
+description: API client for clearbit.co
+email:
+- alex@clearbit.co
+executables:
+- clearbit
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- apihub.gemspec
+- bin/clearbit
+- examples/email.rb
+- lib/clearbit.rb
+- lib/clearbit/base.rb
+- lib/clearbit/company.rb
+- lib/clearbit/mash.rb
+- lib/clearbit/person.rb
+- lib/clearbit/resource.rb
+- lib/clearbit/streaming.rb
+- lib/clearbit/streaming/company.rb
+- lib/clearbit/streaming/person.rb
+- lib/clearbit/version.rb
+- lib/clearbit/watchlist.rb
+homepage: https://github.com/maccman/clearbit-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: API client for clearbit.co
+test_files: []