clearbit-slack 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5d9dfc7ac039cfaa0447d80da593ebd05aff9165
+  data.tar.gz: dfbcb4635d839a66769fddb3596eba20a0d9a1cc
+SHA512:
+  metadata.gz: 47036dddbc356e39c732f34f33555a9507dae21eac3857215cd0c9f729d11462f45729a9fa626ecd30f56adf689f82258129007c8a80d66df851783dedc7398a
+  data.tar.gz: 7ee62b77dc88118e9547a52143bf9ef19da360a44d4962507a57f42298aaaca33936ca6ef5066f6c065312b76abbf88732a9fe4c740d6e12bc83c5d6d8af2c9b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.5

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Clearbit
+
+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,117 @@
+# Clearbit Slack Notifier
+
+Send Clearbit Person and Company data into a Slack channel.
+
+![alex_test](https://cloud.githubusercontent.com/assets/739782/8149387/3f89cd68-1276-11e5-863c-5529237bfe6c.png)
+
+## Installation
+
+Add to your application's Gemfile:
+
+```ruby
+gem 'clearbit'
+gem 'clearbit-slack'
+```
+
+### Configuration
+
+Add Clearbit and Slack config vars:
+
+```ruby
+# config/initializers/clearbit.rb
+Clearbit.key = ENV['CLEARBIT_KEY']
+
+Clearbit::Slack.configure do |config|
+  config.slack_url = ENV['SLACK_URL']
+  config.slack_channel = '#signups'
+end
+```
+
+### Clearbit Key
+
+Sign up for a [Free Trial](https://clearbit.com/) if you don't already have a Clearbit key.
+
+## Notifications
+
+### Parameters
+
+| Field       | Description                                        |
+| ----------- | -------------------------------------------------- |
+| company     | Company data returned from Clearbit                |
+| person      | Person data returned form Clearbit                 |
+| message     | Used for deep link into an internal Admin/CRM      |
+| email       | Used to augment message data when Person not found |
+| given_name  | Used to augment message data when Person not found |
+| family_name | Used to augment message data when Person not found |
+
+### Streaming API
+
+Lookup email using the Clearbit streaming API and ping Slack channel:
+
+```ruby
+# app/jobs/signup_notification.rb
+module APIHub
+  module Jobs
+    class SignupNotification
+      include Sidekiq::Worker
+
+      def perform(customer_id)
+        customer = Customer.find!(customer_id)
+        response = Clearbit::Streaming::PersonCompany[email: customer.email]
+
+        if response.person || response.company
+          params = {
+            company: response.company,
+            email: customer.email,
+            family_name: customer.last_name,
+            given_name: customer.first_name,
+            message: "View details in <https://admin-panel.com/#{customer.token}|Admin Panel>",
+            person: response.person
+          }
+
+          Clearbit::Slack.ping(params)
+        end
+
+        # Persist Clearbit Data
+      end
+    end
+  end
+end
+```
+
+### Webhooks
+
+Receive a webhook with Clearbit data and ping Slack channel:
+
+```ruby
+# app/controllers/webhooks_controller.rb
+class WebhooksController < ApplicationController
+  def clearbit
+    webhook = Clearbit::Webhook.new(env)
+    customer = Customer.find!(webhook.webhook_id)
+
+    if webhook.body.person || webhook.body.company
+      params = {
+        company: webhook.body.company,
+        email: customer.email,
+        family_name: customer.last_name,
+        given_name: customer.first_name,
+        message: "View details in <https://admin-panel/#{webhook.webhook_id}|Admin Panel>",
+        person: webhook.body.person
+      }
+
+      Clearbit::Slack.ping(params)
+    end
+
+    # Persist Clearbit Data
+  end
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/clearbit-slack/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/clearbit-slack.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/slack/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "clearbit-slack"
+  spec.version       = Clearbit::Slack::VERSION
+  spec.authors       = ["Harlow Ward"]
+  spec.email         = ["harlow@clearbit.com"]
+
+  spec.summary       = %q{Push Clearbit data into Slack channel}
+  spec.description   = %q{Push Clearbit data into Slack channel}
+  spec.homepage      = "https://github.com/clearbit/clearbit-slack"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'maccman-mash', '~> 0.0.2'
+  spec.add_dependency 'slack-notifier', '~> 1.2.1'
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'pry', '~> 0.10.1'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/clearbit/slack.rb

@@ -0,0 +1,33 @@
+require 'slack-notifier'
+require 'mash'
+
+require 'clearbit/slack/configuration'
+require 'clearbit/slack/helpers'
+require 'clearbit/slack/notifier'
+require 'clearbit/slack/version'
+require 'clearbit/slack/attachments/person'
+require 'clearbit/slack/attachments/company'
+
+module Clearbit
+  module Slack
+    def self.ping(attrs = {})
+      Notifier.new(attrs).ping
+    end
+
+    def self.slack_url
+      configuration.slack_url || raise('Config Error: No slack_url provided')
+    end
+
+    def self.slack_channel
+      configuration.slack_channel || raise('Config Error: No slack_channel provided')
+    end
+
+    def self.configure
+      yield configuration if block_given?
+    end
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+  end
+end

data/lib/clearbit/slack/attachments/company.rb

@@ -0,0 +1,69 @@
+module Clearbit
+  module Slack
+    module Attachments
+      class Company
+        include Helpers
+        attr_reader :company
+
+        def initialize(company)
+          @company = company
+        end
+
+        def as_json(options = {})
+          {
+            author_name: company.name,
+            author_icon: company.logo,
+            text: company.description,
+            color: color,
+            fields: fields.compact
+          }
+        end
+
+        private
+
+        def color
+          'good'
+        end
+
+        def fields
+          [
+            website,
+            raised,
+            location,
+            type,
+            employees,
+            angellist(company.angellist),
+            facebook(company.facebook),
+            linkedin(company.linkedin),
+            twitter(company.twitter),
+          ]
+        end
+
+        def type
+          return unless company.type
+          field 'Type', company.type
+        end
+
+        def employees
+          return unless company.employees
+          field 'Employees', format_number(company.employees)
+        end
+
+        def location
+          return unless company.location
+          field 'Location', company.location
+        end
+
+        def website
+          return unless company.url
+          field 'Website', company.url
+        end
+
+        def raised
+          return unless company.raised
+          field 'Raised', "$#{format_number(company.raised)}"
+        end
+      end
+    end
+  end
+end

data/lib/clearbit/slack/attachments/person.rb

@@ -0,0 +1,67 @@
+module Clearbit
+  module Slack
+    module Attachments
+      class Person
+        include Helpers
+        attr_reader :person
+
+        def initialize(person)
+          @person = person
+        end
+
+        def as_json(options = {})
+          {
+            color: color,
+            fields: fields.compact
+          }
+        end
+
+        private
+
+        def fields
+          [
+            bio,
+            email,
+            employment,
+            position,
+            location,
+            aboutme(person.aboutme),
+            angellist(person.angellist),
+            facebook(person.facebook),
+            linkedin(person.linkedin),
+            twitter(person.twitter),
+          ]
+        end
+
+        def bio
+          return unless person.bio
+          field 'Bio', person.bio, false
+        end
+
+        def email
+          return unless person.email
+          field 'Email', person.email
+        end
+
+        def employment
+          return unless person.employment && person.employment.name
+          field 'Employment', person.employment.name
+        end
+
+        def position
+          return unless person.employment && person.employment.title
+          field 'Position', person.employment.title
+        end
+
+        def location
+          return unless person.location
+          field 'Location', person.location
+        end
+
+        def color
+          'good'
+        end
+      end
+    end
+  end
+end

data/lib/clearbit/slack/configuration.rb

@@ -0,0 +1,7 @@
+module Clearbit
+  module Slack
+    class Configuration
+      attr_accessor :slack_url, :slack_channel
+    end
+  end
+end

data/lib/clearbit/slack/helpers.rb

@@ -0,0 +1,83 @@
+module Clearbit
+  module Slack
+    module Helpers
+      def format_number(value)
+        value.to_s.reverse.gsub(/(\d{3})(?=\d)/, '\\1,').reverse
+      end
+
+      def field(title, value, short = true)
+        {
+          title: title,
+          value: value,
+          short: short
+        }
+      end
+
+      def link(url, title, followers = nil)
+        if followers
+          followers = format_number(followers)
+          followers = " (#{followers} followers)"
+        end
+
+        "<#{url}|#{title}>#{followers}".strip
+      end
+
+      def aboutme(aboutme)
+        return unless aboutme && aboutme.handle
+        value = link(
+          "https://about.me/#{aboutme.handle}",
+          aboutme.handle
+        )
+        field 'AboutMe', value
+      end
+
+      def angellist(angellist)
+        return unless angellist && angellist.handle
+        value = link(
+          "https://angel.co/#{angellist.handle}",
+          angellist.handle,
+          angellist.followers
+        )
+        field 'AngelList', value
+      end
+
+      def github(github)
+        return unless github && github.handle
+        value = link(
+          "https://github.com/#{github.handle}",
+          github.handle,
+          github.followers
+        )
+        field 'GitHub', value
+      end
+
+      def facebook(facebook)
+        return unless facebook && facebook.handle
+        value = link(
+          "https://www.facebook.com/#{facebook.handle}",
+          facebook.handle
+        )
+        field 'Facebook', value
+      end
+
+      def twitter(twitter)
+        return unless twitter && twitter.handle
+        value = link(
+          "http://twitter.com/#{twitter.handle}",
+          twitter.handle,
+          twitter.followers
+        )
+        field 'Twitter', value
+      end
+
+      def linkedin(linkedin)
+        return unless linkedin && linkedin.handle
+        value = link(
+          "https://www.linkedin.com/#{linkedin.handle}",
+          linkedin.handle
+        )
+        field 'LinkedIn', value
+      end
+    end
+  end
+end

data/lib/clearbit/slack/notifier.rb

@@ -0,0 +1,67 @@
+module Clearbit
+  module Slack
+    class Notifier
+      attr_reader :company, :message, :person, :given_name, :family_name, :email
+
+      def initialize(attrs = {})
+        @company = attrs[:company]
+        @message = attrs[:message]
+        @person = attrs[:person]
+        @given_name = attrs[:given_name]
+        @family_name = attrs[:family_name]
+        @email = attrs[:email]
+      end
+
+      def ping
+        notifier = ::Slack::Notifier.new(
+          Slack.slack_url,
+          channel: Slack.slack_channel,
+          icon_url: icon_url,
+          username: username
+        )
+
+        attachments << Attachments::Person.new(person).as_json
+
+        if company
+          attachments << Attachments::Company.new(company).as_json
+        end
+
+        notifier.ping message.to_s, attachments: attachments
+      end
+
+      private
+
+      def icon_url
+        person && person.avatar || ''
+      end
+
+      def username
+        if person.name.full_name
+          person.name.full_name
+        elsif person.name.given_name && person.name.family_name
+          [person.name.given_name, person.name.family_name].join(' ')
+        else
+          'Unknown'
+        end
+      end
+
+      def person
+        @person ||= unknown_person
+      end
+
+      def unknown_person
+        Mash.new(
+          email: email,
+          name: {
+            given: given_name,
+            family: family_name
+          }
+        )
+      end
+
+      def attachments
+        @attachments ||= []
+      end
+    end
+  end
+end

data/lib/clearbit/slack/version.rb

@@ -0,0 +1,5 @@
+module Clearbit
+  module Slack
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: clearbit-slack
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Harlow Ward
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: maccman-mash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+- !ruby/object:Gem::Dependency
+  name: slack-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Push Clearbit data into Slack channel
+email:
+- harlow@clearbit.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- clearbit-slack.gemspec
+- lib/clearbit/slack.rb
+- lib/clearbit/slack/attachments/company.rb
+- lib/clearbit/slack/attachments/person.rb
+- lib/clearbit/slack/configuration.rb
+- lib/clearbit/slack/helpers.rb
+- lib/clearbit/slack/notifier.rb
+- lib/clearbit/slack/version.rb
+homepage: https://github.com/clearbit/clearbit-slack
+licenses: []
+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: Push Clearbit data into Slack channel
+test_files: []