clearbit 0.1.5 → 0.1.6.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94181dcf96160372ef82dd215b4696aba62d39fb
-  data.tar.gz: a8752294bc5b63fe7d3a055c94429467131c9288
+  metadata.gz: 7680a6adda38c41c8038adba29867b6d198da4de
+  data.tar.gz: 850f0b423e1d1139d9837ec3a6f518e7a0952383
 SHA512:
-  metadata.gz: f7085df982027dc0af97c63e483457c7f9e5287d9f580bee1108a9b2b13d999db394e31941ee0e44ecefb1f8ecdcad00066573db17728a01d645eef95d925d09
-  data.tar.gz: 8b3e2cd83dabd56cf74294cbda5f2c9d46206f0774caecd7606ce048e9c175bc6e1dbc2c90266b4e92ebff27a11bd311462af8edf95ce9f4f4100366a4dba0f4
+  metadata.gz: ac5d711f3deed52072696fa2cc89c40c542cbf80910a23de42c7a8c008c0ac7340d9b6140fdd1b5d46a3666432963bbf5d96d060d9765d66ab3d4a75c40fb9ff
+  data.tar.gz: 23ee689884c397194e4b01983eb0949468d4505e2018eed63302183465d44444a0f340958f28420ebeafa5fe0a53c80ff5d4054fc8230f9583e758a1ef559e89

data/README.md

@@ -77,3 +77,21 @@ Or to look up a company:
             "Garrett Camp"
           ],
           ...
+
+## Webhooks
+
+For rack apps use the `Clearbit::Webhook` module to wrap deserialization and verify the webhook is from trusted party:
+
+``` ruby
+post '/v1/webhooks/clearbit' do
+  begin
+    webhook = Clearbit::Webhook.new(env)
+    webhook.type #=> 'person'
+    webhook.body.name.given_name #=> 'Alex'
+
+    # ...
+  rescue Clearbit::Errors::InvalidWebhookSignature => e
+    # ...
+  end
+end
+```

data/Rakefile

@@ -1 +1,11 @@
 require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task :default => :spec
+rescue LoadError
+  # no rspec available
+end

data/apihub.gemspec

@@ -19,7 +19,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency 'bundler', '~> 1.3'
-  spec.add_development_dependency 'rake'
   spec.add_development_dependency 'net-http-spy'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rack'
   spec.add_dependency 'nestful', '~> 1.0.7'
 end

data/lib/clearbit.rb

@@ -10,14 +10,28 @@ module Clearbit
     Base.key = value
   end
 
+  def self.key
+    Base.key
+  end
+
+  def self.key!
+    key || raise('Clearbit.key not set')
+  end
+
   autoload :Base, 'clearbit/base'
   autoload :Company, 'clearbit/company'
   autoload :Mash, 'clearbit/mash'
   autoload :Person, 'clearbit/person'
   autoload :PersonCompany, 'clearbit/person_company'
+  autoload :Prospector, 'clearbit/prospector'
   autoload :Resource, 'clearbit/resource'
   autoload :Streaming, 'clearbit/streaming'
   autoload :Watchlist, 'clearbit/watchlist'
+  autoload :Webhook, 'clearbit/webhook'
+
+  module Errors
+    autoload :InvalidWebhookSignature, 'clearbit/errors/invalid_webhook_signature'
+  end
 
   if clearbit_key = ENV['CLEARBIT_KEY']
     Clearbit.key = clearbit_key

data/lib/clearbit/base.rb

@@ -10,6 +10,12 @@ module Clearbit
     def self.key=(value)
       add_options auth_type: :bearer,
                   password:  value
+
+      @key = value
+    end
+
+    def self.key
+      @key
     end
   end
 end

data/lib/clearbit/errors/invalid_webhook_signature.rb

@@ -0,0 +1,10 @@
+module Clearbit
+  module Errors
+    # Raised when the Webhook Request Signature doesn't validate.
+    class InvalidWebhookSignature < StandardError
+      def to_s
+        'Clearbit Webhook Request Signature was invalid.'
+      end
+    end
+  end
+end

data/lib/clearbit/prospector.rb

@@ -0,0 +1,10 @@
+module Clearbit
+  class Prospector < Base
+    endpoint 'https://prospector.clearbit.com'
+    path '/v1/people'
+
+    def self.search(params = {})
+      self.new get('search', params)
+    end
+  end
+end

data/lib/clearbit/version.rb

@@ -1,3 +1,3 @@
 module Clearbit
-  VERSION = "0.1.5"
+  VERSION = "0.1.6.pre"
 end

data/lib/clearbit/webhook.rb

@@ -0,0 +1,35 @@
+require 'openssl'
+require 'rack'
+require 'json'
+
+module Clearbit
+  class Webhook < Mash
+    def self.clearbit_key
+      Clearbit.key!
+    end
+
+    def self.valid?(request_signature, body)
+      return false unless request_signature && body
+
+      signature = 'sha1=' + OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha1'), clearbit_key, body)
+      Rack::Utils.secure_compare(request_signature, signature)
+    end
+
+    def self.valid!(signature, body)
+      valid?(signature, body) ? true : raise(Errors::InvalidWebhookSignature.new)
+    end
+
+    def initialize(env)
+      request = Rack::Request.new(env)
+
+      request.body.rewind
+
+      signature = request.env['HTTP_X_REQUEST_SIGNATURE']
+      body      = request.body.read
+
+      self.class.valid!(signature, body)
+
+      merge!(JSON.parse(body))
+    end
+  end
+end

data/spec/lib/clearbit/webhook_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe Clearbit::Webhook do
+  before do |example|
+    Clearbit.key = 'clearbit_key'
+  end
+
+  context 'valid signature' do
+    it 'returns true' do
+      signature = generate_signature('A-OK')
+
+      result = Clearbit::Webhook.valid!(signature, 'A-OK')
+
+      expect(result).to eq true
+    end
+  end
+
+  context 'invalid signature' do
+    it 'returns false' do
+      signature = generate_signature('A-OK')
+
+      expect {
+        Clearbit::Webhook.valid!(signature, 'TAMPERED_WITH_BODY_BEWARE!')
+      }.to raise_error(Clearbit::Errors::InvalidWebhookSignature)
+    end
+  end
+
+  context 'initialize' do
+    it 'returns a mash' do
+      request_body = JSON.dump({
+        id:   '123',
+        type: 'person',
+        body: nil,
+        status: 404
+      })
+
+      request_signature = generate_signature(request_body)
+
+      env = Rack::MockRequest.env_for('/webhook',
+        method: 'POST',
+        input:  request_body,
+        'HTTP_X_REQUEST_SIGNATURE' => request_signature
+      )
+
+      webhook = Clearbit::Webhook.new(env)
+
+      expect(webhook.status).to eq 404
+    end
+  end
+
+  def generate_signature(webhook_body)
+    'sha1=' + OpenSSL::HMAC.hexdigest(OpenSSL::Digest::Digest.new('sha1'), 'clearbit_key', webhook_body)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+$LOAD_PATH << File.join(File.dirname(__FILE__))
+
+# External
+require 'rubygems'
+require 'rspec'
+require 'pry'
+
+# Library
+require 'clearbit'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clearbit
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6.pre
 platform: ruby
 authors:
 - Alex MacCaw
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-21 00:00:00.000000000 Z
+date: 2015-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: net-http-spy
+  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: pry
+  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +67,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: net-http-spy
+  name: rspec
+  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: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -88,9 +130,11 @@ files:
 - lib/clearbit.rb
 - lib/clearbit/base.rb
 - lib/clearbit/company.rb
+- lib/clearbit/errors/invalid_webhook_signature.rb
 - lib/clearbit/mash.rb
 - lib/clearbit/person.rb
 - lib/clearbit/person_company.rb
+- lib/clearbit/prospector.rb
 - lib/clearbit/resource.rb
 - lib/clearbit/streaming.rb
 - lib/clearbit/streaming/company.rb
@@ -98,6 +142,9 @@ files:
 - lib/clearbit/streaming/person_company.rb
 - lib/clearbit/version.rb
 - lib/clearbit/watchlist.rb
+- lib/clearbit/webhook.rb
+- spec/lib/clearbit/webhook_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/maccman/clearbit-ruby
 licenses:
 - MIT
@@ -113,14 +160,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: API client for clearbit.com
-test_files: []
+test_files:
+- spec/lib/clearbit/webhook_spec.rb
+- spec/spec_helper.rb
 has_rdoc: