collins_notify 0.0.4 → 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA1: 
+  metadata.gz: a93809e56aa3bd43d7aad5409b97f312aac580d3
+  data.tar.gz: e3b9480167b3a8b07c236a2694607b233f4b4444
+SHA512: 
+  metadata.gz: 8a27de791234dbfd11c36ee727a73bb00f86f9c689c728a07e5c9ab1bba93b333b76c459cf2231191a6af8334dfdd8a4f40b4c058d8232bc09e34115a654c09d
+  data.tar.gz: a2ccd8962e2eccc92fa2669ea818e9f7b523db8bc2a6ceedf9faf77cb2d0a70ea326745cfcae25b0ca9c8adbbdeee5228316a9eaaf97a2a2e2290a46a35b925d

data/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source 'https://rubygems.org'
 
 gem 'addressable',    '~> 2.3.2'
 gem 'collins_client', '~> 0.2.10'
@@ -7,10 +7,10 @@ gem 'mail',           '~> 2.4.4'
 gem 'nokogiri',       '~> 1.5.2'
 
 group :development do
-  gem "rspec", "~> 2.12.0"
-  gem "yard", "~> 0.8.3"
-  gem "rdoc", "~> 3.12"
-  gem "bundler", "~> 1.2.0"
-  gem "jeweler", "~> 1.8.4"
-  gem "simplecov"
+  gem 'i18n',         '< 0.7.0'	# versions above 0.7.0 require ruby 1.9.3
+  gem 'rspec',        '~> 2.12.0'
+  gem 'yard',         '~> 0.8.3'
+  gem 'rdoc',         '~> 3.12'
+  gem 'bundler',      '>= 1.2.0'
+  gem 'simplecov',    '~> 0.9.1'
 end

data/README.rdoc

@@ -1,7 +1,7 @@
 = collins-notify
 
 CLI and library for sending templated (or not) notifications via email, hipchat,
-and IRC.
+slack, and IRC.
 
 == Exit Codes
 

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/collins_notify.gemspec

@@ -1,17 +1,14 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = "collins_notify"
-  s.version = "0.0.4"
+  s.version = File.read 'VERSION'
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Blake Matheny"]
-  s.date = "2013-01-31"
-  s.description = "Send notifications via hipchat, IRC and email"
-  s.email = "bmatheny@tumblr.com"
+  s.authors = ["Blake Matheny", "Will Richard"]
+  s.date = "2015-01-06"
+  s.description = "Send notifications via hipchat, slack, IRC, and email"
+  s.email = "collins-sm@googlegroups.com"
   s.executables = ["collins-notify"]
   s.files = [
     "Gemfile",
@@ -25,6 +22,7 @@ Gem::Specification.new do |s|
     "lib/collins_notify/adapter/helper/carried-pigeon.rb",
     "lib/collins_notify/adapter/hipchat.rb",
     "lib/collins_notify/adapter/irc.rb",
+    "lib/collins_notify/adapter/slack.rb",
     "lib/collins_notify/application.rb",
     "lib/collins_notify/command_runner.rb",
     "lib/collins_notify/configuration.rb",
@@ -37,7 +35,8 @@ Gem::Specification.new do |s|
     "templates/default_email.erb",
     "templates/default_email.html.erb",
     "templates/default_hipchat.erb",
-    "templates/default_irc.erb"
+    "templates/default_irc.erb",
+    "templates/default_slack.erb"
   ]
   s.homepage = "https://github.com/tumblr/collins/tree/master/support/ruby/collins-notify"
   s.licenses = ["MIT"]

data/lib/collins_notify.rb

@@ -13,4 +13,5 @@ require 'collins_notify/notifier'
 require 'collins_notify/adapter/email'
 require 'collins_notify/adapter/hipchat'
 require 'collins_notify/adapter/irc'
+require 'collins_notify/adapter/slack'
 require 'collins_notify/application'

data/lib/collins_notify/adapter/slack.rb

@@ -0,0 +1,84 @@
+require 'json'
+
+module CollinsNotify
+
+  # currently this only supports incoming webhooks to pust to slack
+  # https://tumblr.slack.com/services/new/incoming-webhook
+
+  class SlackAdapter < Notifier
+    register_name :slack
+    supports_mimetype :text
+    require_config :webhook_url
+
+    def configure!
+      @webhook_url = config.adapters[:slack][:webhook_url]
+      logger.info "Configured Slack adapter"
+    end
+    
+    # Available in template binding:
+    # message_obj - Depends on call
+    # channel - channel sending to
+    def notify! message_obj = OpenStruct.new, to = nil
+      slack_hash = Hash.new
+      channel = get_channel config.adapters[:slack], to
+      slack_hash['channel'] = channel
+      optional_parameters = [:username, :icon_url, :icon_emoji]
+      optional_parameters.each do |op|
+        if config.adapters[:slack][op]
+          slack_hash[op] = config.adapters[:slack][op]
+        end
+      end
+
+      slack_hash['text'] = get_message_body(binding)
+
+      @logger.debug "slack parameters: #{slack_hash.inspect}"
+        
+      if config.test? then
+        @logger.info "Not sending message in test mode"
+        return true
+      end
+
+      begin
+        @logger.debug "Posting to slack webhook: #{@webhook_url}"
+        reply = HTTParty.post(@webhook_url, :body => JSON.dump(slack_hash))
+        reply.response.value # this raises an error if the response said it was unsuccessful
+        true
+      rescue CollinsNotify::CollinsNotifyException => e
+        @logger.error "error sending slack notification - #{e}"
+        raise e
+      rescue Exception => e
+        @logger.error "#{e.class.to_s} - error sending slack notification - #{e}"
+        raise CollinsNotify::CollinsNotifyException.new e
+      end
+    end
+
+    protected
+
+    # get the channel from one of many sources
+    # slack does not require a channel for a web hook (you can set a default through the webhook settings)
+    # but we're going to require that a channel is specified for the purposes of this gem
+    def get_channel hash, to
+      if config.recipient then
+        make_channel config.recipient
+      elsif to then
+        make_channel to
+      elsif hash[:channel]
+        make_channel hash[:channel]
+      else
+        raise CollinsNotify::ConfigurationError.new "No slack.channel or config.recipient specified"
+      end
+    end
+
+    # slack can both DM users and post to channels
+    # If the recipient isn't explicitly a user (@username) then we'll assume the string is a channel
+    def make_channel chan
+      @logger.debug "In make_channel, got #{chan}"
+      # If we are DMing a user (chan looks like @username), do nothing
+      # otherwise, make sure chan starts with a '#', if it doesn't already
+
+      # channel names must be lowercase, and not contain spaces or periods
+      # I'm going to assume that usernames need the same requirements
+      chan.sub(/^(?!#|@)/,'#').downcase.gsub(/ |\./, '_')
+    end
+  end
+end

data/sample_config.yaml

@@ -30,3 +30,13 @@
     join: true
     notice: true
     channel: "#test"
+:slack:
+    webhook_url: "some webhook url"
+    # the following parameters are optional.
+    # if they are not specified, the defaults set in the slack webhook configuration will be used
+    username: "bot_username"
+    icon_emoji: ":smile:"
+    icon_url: "https://icon_url.png"
+    # channel is also optional
+    # but it can be overridden via the --recipient flag
+    channel: "#channel or @username"

data/templates/default_slack.erb

@@ -0,0 +1 @@
+<%=message_obj.to_s%>

metadata

@@ -1,22 +1,21 @@
 --- !ruby/object:Gem::Specification 
 name: collins_notify
 version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Blake Matheny
+- Will Richard
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2013-01-31 00:00:00 Z
+date: 2015-01-06 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: addressable
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
@@ -27,7 +26,6 @@ dependencies:
   name: collins_client
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
@@ -38,7 +36,6 @@ dependencies:
   name: hipchat
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
@@ -49,7 +46,6 @@ dependencies:
   name: mail
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
@@ -60,15 +56,14 @@ dependencies:
   name: nokogiri
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
         version: 1.5.2
   type: :runtime
   version_requirements: *id005
-description: Send notifications via hipchat, IRC and email
-email: bmatheny@tumblr.com
+description: Send notifications via hipchat, slack, IRC, and email
+email: collins-sm@googlegroups.com
 executables: 
 - collins-notify
 extensions: []
@@ -87,6 +82,7 @@ files:
 - lib/collins_notify/adapter/helper/carried-pigeon.rb
 - lib/collins_notify/adapter/hipchat.rb
 - lib/collins_notify/adapter/irc.rb
+- lib/collins_notify/adapter/slack.rb
 - lib/collins_notify/application.rb
 - lib/collins_notify/command_runner.rb
 - lib/collins_notify/configuration.rb
@@ -100,30 +96,30 @@ files:
 - templates/default_email.html.erb
 - templates/default_hipchat.erb
 - templates/default_irc.erb
+- templates/default_slack.erb
 homepage: https://github.com/tumblr/collins/tree/master/support/ruby/collins-notify
 licenses: 
 - MIT
+metadata: {}
+
 post_install_message: 
 rdoc_options: []
 
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
-  - - ">="
+  - &id006 
+    - ">="
     - !ruby/object:Gem::Version 
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  - *id006
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 2.3.0
 signing_key: 
 specification_version: 3
 summary: Notifications for Collins