sensu-plugins-slack 0.1.2 → 1.0.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZWJmNTBhNGNjODg2MDZjYzBkZDAzYTdmMmNhZWM3YTE5NjliM2I2Mg==
-  data.tar.gz: !binary |-
-    MmM5YzJmZTRlOWQ1ZDM3OWMwMGVmMDM5MzRkMzE1MzgwYjJiNGVjNg==
+SHA1:
+  metadata.gz: 3f54c218e9c552fac733928646ace4874f0649a4
+  data.tar.gz: 3a6a84804253872170a3ccf52803847164faede4
 SHA512:
-  metadata.gz: !binary |-
-    YWFhMmUzNzMzYjYxOGI1ZGVjNzU2ZjE5MzVlZGMyNjZkNTRkOWQ1OGVhYzMy
-    MmNjZDMwZWUxODY5NTMyNGY5MDEwZjVmZTNhZThkMjBkYjhmMzZmMGI2ZWEz
-    MzI5ZTc5OTQwNmM3ZWYyMjhmOTk0NmM4YmY4MGUzYTViYWVlZmI=
-  data.tar.gz: !binary |-
-    MzhmOWNjMzNjZGUzN2ExMGIxZWNlMGJlMjRkZWE5YThjMjc1ZjhmODU5NjFm
-    NGM1NWExODM1MGRhOTlmYzUzYTYxYzU0Njg3YTE0MTRkOWIwMmI5Y2U2MTky
-    N2FmNjZjNjZmOGUwZjQ5OGFmNGU2YWI0YjIxNGQwYzE0NjJmNTg=
+  metadata.gz: 224c3535db33eaa5af3aa1658a0b486b87fe19eca70939b3e5b6566d45a77072da7e8bb793fed0fb2a4138c35d7792836f301a39028fa22f37773d0b9101abd4
+  data.tar.gz: 3f4fb750ffc643689fb319541b031a15a3dfbe2c774dc9f0ade3fae1164a87e392ac89b237292ad28ae37bc2bfa18c5e1d43f6ca3a4d8484d27aa799c2820c86

data/CHANGELOG.md

@@ -3,7 +3,21 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachangelog.com/)
 
-## Unreleased
+## [Unreleased]
+
+## [1.0.0] - 2016-06-14
+### Added
+- Added a payload_template to allow for a customized JSON payload
+- Ruby 2.3.0 support
+
+### Fixed
+- Extended the payload_template to work with multi-channel handlers
+
+### Changed
+- Update to Rubocop 0.40 and cleanup
+
+### Removed
+- Ruby 1.9.3 support
 
 ## [0.1.2] - 2016-02-05
 ### Added
@@ -51,10 +65,11 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 ### Added
 - initial release
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-ssl/compare/0.1.2...HEAD
-[0.1.2]: https://github.com/sensu-plugins/sensu-plugins-ssl/compare/0.1.1...0.1.2
-[0.1.1]: https://github.com/sensu-plugins/sensu-plugins-ssl/compare/0.1.0...0.1.1
-[0.1.0]: https://github.com/sensu-plugins/sensu-plugins-ssl/compare/0.0.4...0.1.0
-[0.0.4]: https://github.com/sensu-plugins/sensu-plugins-ssl/compare/0.0.3...0.0.4
-[0.0.3]: https://github.com/sensu-plugins/sensu-plugins-ssl/compare/0.0.2...0.0.3
-[0.0.2]: https://github.com/sensu-plugins/sensu-plugins-ssl/compare/0.0.1...0.0.2
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-slack/compare/1.0.0...HEAD
+[1.0.0]: https://github.com/sensu-plugins/sensu-plugins-slack/compare/v0.1.2...1.0.0
+[0.1.2]: https://github.com/sensu-plugins/sensu-plugins-slack/compare/0.1.1...v0.1.2
+[0.1.1]: https://github.com/sensu-plugins/sensu-plugins-slack/compare/0.1.0...0.1.1
+[0.1.0]: https://github.com/sensu-plugins/sensu-plugins-slack/compare/0.0.4...0.1.0
+[0.0.4]: https://github.com/sensu-plugins/sensu-plugins-slack/compare/0.0.3...0.0.4
+[0.0.3]: https://github.com/sensu-plugins/sensu-plugins-slack/compare/0.0.2...0.0.3
+[0.0.2]: https://github.com/sensu-plugins/sensu-plugins-slack/compare/0.0.1...0.0.2

data/README.md

@@ -21,7 +21,9 @@
     "message_prefix": "optional prefix - can be used for mentions",
     "surround": "optional - can be used for bold(*), italics(_), code(`) and preformatted(```)",
     "bot_name": "optional bot name, defaults to slack defined",
-    "template": "/some/path/to/template.erb",
+    "message_template": "optional description erb template file - /some/path/to/template.erb",
+    "payload_template": "optional json payload template file (note: overrides most other template options.)",
+    "template": "backwards-compatible alias for message_template",
     "proxy_address": "The HTTP proxy address (example: proxy.example.com)",
     "proxy_port": "The HTTP proxy port (if there is a proxy)",
     "proxy_username": "The HTTP proxy username (if there is a proxy)",
@@ -38,8 +40,38 @@
   }
 }
 ```
+
 ## Installation
 
 [Installation and Setup](http://sensu-plugins.io/docs/installation_instructions.html)
 
 ## Notes
+
+### payload_template example
+
+```
+{
+  "username": "sensu alarms",
+  "icon_emoji": ":bell:",
+  "attachments": [
+    {
+      "fallback": "<%= @event["check"]["output"] %>",
+      "color": "<%= color %>",
+      "title": "<%= @event["check"]["name"] %> (<%= @event["client"]["name"] %>)",
+      "text": "<%= @event["check"]["output"].gsub('"', '\\"') %>"
+    }
+  ]
+}
+```
+
+You can also use `to_json`
+
+```
+<%=
+  {
+    :text => "Some text"
+  }.to_json
+-%>
+```
+
+See https://api.slack.com/incoming-webhooks and https://api.slack.com/docs/attachments

data/bin/handler-slack-multichannel.rb

@@ -44,6 +44,7 @@
 
 require 'sensu-handler'
 require 'json'
+require 'erubis'
 
 class Slack < Sensu::Handler
   option :json_config,
@@ -52,6 +53,14 @@ class Slack < Sensu::Handler
          long: '--json JSONCONFIG',
          default: 'slack'
 
+  def payload_template
+    get_setting('payload_template')
+  end
+
+  def message_template
+    get_setting('template') || get_setting('message_template')
+  end
+
   def slack_webhook_url
     get_setting('webhook_url')
   end
@@ -137,16 +146,44 @@ class Slack < Sensu::Handler
 
   def handle
     unless slack_channels.is_a?(Array)
-      puts 'nno channels found'
+      puts 'no channels found'
       return
     end
 
     notice = build_notice
 
     slack_channels.each do |channel|
-      puts "#{channel}: #{notice}"
-      post_data(notice, channel)
+      if payload_template.nil?
+        notice = @event['notification'] || build_description
+        post_data(notice, channel)
+      else
+        post_data(render_payload_template, channel)
+      end
+    end
+  end
+
+  def render_payload_template
+    return unless payload_template && File.readable?(payload_template)
+    template = File.read(payload_template)
+    eruby = Erubis::Eruby.new(template)
+    eruby.result(binding)
+  end
+
+  def build_description
+    if message_template && File.readable?(message_template)
+      template = File.read(message_template)
+    else
+      template = '''<%=
+      [
+        @event["check"]["output"].gsub(\'"\', \'\\"\'),
+        @event["client"]["address"],
+        @event["client"]["subscriptions"].join(",")
+      ].join(" : ")
+      %>
+      '''
     end
+    eruby = Erubis::Eruby.new(template)
+    eruby.result(binding)
   end
 
   def post_data(notice, channel)
@@ -162,9 +199,12 @@ class Slack < Sensu::Handler
 
     begin
       req = Net::HTTP::Post.new("#{uri.path}?#{uri.query}")
-      text = slack_surround ? slack_surround + notice + slack_surround : notice
-      req.body = payload(text, channel).to_json
-
+      if payload_template.nil?
+        text = slack_surround ? slack_surround + notice + slack_surround : notice
+        req.body = payload(text, channel).to_json
+      else
+        req.body = notice
+      end
       puts "request: #{req}"
 
       response = http.request(req)
@@ -213,4 +253,14 @@ class Slack < Sensu::Handler
   def check_status
     @event['check']['status']
   end
+
+  def translate_status
+    status = {
+      0 => :OK,
+      1 => :WARNING,
+      2 => :CRITICAL,
+      3 => :UNKNOWN
+    }
+    status[check_status.to_i]
+  end
 end

data/bin/handler-slack.rb

@@ -22,6 +22,10 @@ class Slack < Sensu::Handler
          long: '--json JSONCONFIG',
          default: 'slack'
 
+  def payload_template
+    get_setting('payload_template')
+  end
+
   def slack_webhook_url
     get_setting('webhook_url')
   end
@@ -51,7 +55,7 @@ class Slack < Sensu::Handler
   end
 
   def message_template
-    get_setting('template')
+    get_setting('template') || get_setting('message_template')
   end
 
   def fields
@@ -83,8 +87,19 @@ class Slack < Sensu::Handler
   end
 
   def handle
-    description = @event['notification'] || build_description
-    post_data("#{incident_key}: #{description}")
+    if payload_template.nil?
+      description = @event['notification'] || build_description
+      post_data("#{incident_key}: #{description}")
+    else
+      post_data(render_payload_template)
+    end
+  end
+
+  def render_payload_template
+    return unless payload_template && File.readable?(payload_template)
+    template = File.read(payload_template)
+    eruby = Erubis::Eruby.new(template)
+    eruby.result(binding)
   end
 
   def build_description
@@ -104,7 +119,7 @@ class Slack < Sensu::Handler
     eruby.result(binding)
   end
 
-  def post_data(notice)
+  def post_data(body)
     uri = URI(slack_webhook_url)
     http = if proxy_address.nil?
              Net::HTTP.new(uri.host, uri.port)
@@ -114,9 +129,13 @@ class Slack < Sensu::Handler
     http.use_ssl = true
 
     req = Net::HTTP::Post.new("#{uri.path}?#{uri.query}", 'Content-Type' => 'application/json')
-    text = slack_surround ? slack_surround + notice + slack_surround : notice
 
-    req.body = payload(text).to_json
+    if payload_template.nil?
+      text = slack_surround ? slack_surround + body + slack_surround : body
+      req.body = payload(text).to_json
+    else
+      req.body = body
+    end
 
     response = http.request(req)
     verify_response(response)

data/lib/sensu-plugins-slack/version.rb

@@ -1,8 +1,8 @@
 module SensuPluginsSlack
   module Version
-    MAJOR = 0
-    MINOR = 1
-    PATCH = 2
+    MAJOR = 1
+    MINOR = 0
+    PATCH = 0
 
     VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')
   end

metadata

@@ -1,45 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-slack
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
 autorequire: 
 bindir: bin
-cert_chain:
-- !binary |-
-  LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURuakNDQW9hZ0F3SUJB
-  Z0lCQVRBTkJna3Foa2lHOXcwQkFRVUZBREJLTVJVd0V3WURWUVFEREF4elpX
-  NXoKZFMxd2JIVm5hVzR4SFRBYkJnb0praWFKay9Jc1pBRVpGZzF6Wlc1emRT
-  MXdiSFZuYVc1ek1SSXdFQVlLQ1pJbQppWlB5TEdRQkdSWUNhVzh3SGhjTk1U
-  WXdNakEwTWpNeU1qRTNXaGNOTVRjd01qQXpNak15TWpFM1dqQktNUlV3CkV3
-  WURWUVFEREF4elpXNXpkUzF3YkhWbmFXNHhIVEFiQmdvSmtpYUprL0lzWkFF
-  WkZnMXpaVzV6ZFMxd2JIVm4KYVc1ek1SSXdFQVlLQ1pJbWlaUHlMR1FCR1JZ
-  Q2FXOHdnZ0VpTUEwR0NTcUdTSWIzRFFFQkFRVUFBNElCRHdBdwpnZ0VLQW9J
-  QkFRQy9VUzNmdEkyUmQrOWQzS3JIQUw0bERsOGxhN2s2ZHA3K1RPY210VHd3
-  YzRiMUwzV0NyeEFoClpDWms1Q3k2aUpvWUd4VHVoNittSDJZZ3ExbHZGRE4v
-  NTh5YVRHTVFINzNRYVJjZjVnak9IMkJSQTlkUWRzWUgKYTNZYnMrbGxwVlYv
-  ZC9kMklaYyt2RU9tc21rTFpVeEhzZFdQSTZsWTBuYXJwU2RxNHNML0lXWWZP
-  aW1ocFFTWgpTV0t5WHg5cjM4UFpZZ0Q3djIydjloNTZkcUpQZFFPY29OODhF
-  NkE4YTdQWTcvL1RweWdTREtuSldudkFwS1JxCjNCN0xMaFNkOTRQMHdRcGow
-  MS9sb05Nd0FCMytGQjRRQ0UrdG1QeFYxZ1Q2ZWE4VW1SNjQrcGZKTFN0NGl5
-  N0gKVGc5OTdCZFZqaURJdG5SYzhCSXNjVFl4S2JRai9wTEhBZ01CQUFHamdZ
-  NHdnWXN3Q1FZRFZSMFRCQUl3QURBTApCZ05WSFE4RUJBTUNCTEF3SFFZRFZS
-  ME9CQllFRk5McjBmZ1BmdnlWK0VneEVGRHhVcVFhU2xScE1DZ0dBMVVkCkVR
-  UWhNQitCSFhObGJuTjFMWEJzZFdkcGJrQnpaVzV6ZFMxd2JIVm5hVzV6TG1s
-  dk1DZ0dBMVVkRWdRaE1CK0IKSFhObGJuTjFMWEJzZFdkcGJrQnpaVzV6ZFMx
-  d2JIVm5hVzV6TG1sdk1BMEdDU3FHU0liM0RRRUJCUVVBQTRJQgpBUUNQZTZ0
-  RUJ0NS9uQzk1aFhvS2VLRmhrWVc5bTE2aU5YdWRKeEorZGRYcnpDc2tEMXk2
-  ajZjQXY0a1FlUDFmClBIbDE4aDVrOWtKeElQU1IrcUkrK2JJbDE3ZUVPU096
-  YXNMbXdzdGFNU25NN3U1UWZMcFdFWTJldVZXQkRzdGQKMmhrcG80VSswSzVT
-  d3ptZEphMFdLQXRmS3ZkdENROGk5MllJUCtIODNFdXZDU0xwZ29aaDYzRXJx
-  dVFVY25lbgphZmg1bHVUQkExaTFjcUJHNEFNSjBmTFdHeU9xSmFYOFA5WnN4
-  RERXUEVCbk5TaVd2WGIrSUttSkFWTzF1VzRrClFOODNielZXU1d1bFk4Qlk2
-  a1grSVFNd1lhelpBbEIvMTNkN2E4VTBoN0NyYjM2Sm5TUGF0aHVSemU0cUtY
-  RlEKM2YzVFVaV3d2UmZ0Y1N1K3Z0Y0JSa00wCi0tLS0tRU5EIENFUlRJRklD
-  QVRFLS0tLS0K
-date: 2016-02-05 00:00:00.000000000 Z
+cert_chain: []
+date: 2016-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis
@@ -59,144 +28,144 @@ dependencies:
   name: sensu-plugin
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
 - !ruby/object:Gem::Dependency
   name: github-markup
   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: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
 - !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'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.37.0
+        version: 0.40.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.37.0
+        version: 0.40.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
 description: Sensu plugins for interfacing with Slack chat
-email: <sensu-users@googlegroups.com>
+email: "<sensu-users@googlegroups.com>"
 executables:
 - handler-slack-multichannel.rb
 - handler-slack.rb
@@ -226,18 +195,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Sensu plugins for interfacing with Slack chat
 test_files: []
+has_rdoc: 

data.tar.gz.sig

@@ -1,3 +0,0 @@
-��<�*/����wӥ�Oa��=�4d��O���n��2W�
-���?�E�9��
-�WЌ���+��	��r=Ǯ�mF�y���ǎ=���9�����Z@��C՛r�����ddj?Q���Ѵ���_�����%�磉x�����<���](�T�c�SeŜ��0ܐ�htK\