alerty-plugin-slack 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f586824308ff49aa74e3b4b02e3bd272abd45333
+  data.tar.gz: aefff96c07fc41416f9561a1b77490e1221d9848
+SHA512:
+  metadata.gz: 65d0ccc18dde3c160b8fe684ab8c0e4921bfb0d6af9e0c81dfd5d261ad7259d68741a16c335cb4e5c39a639c7623d2f90629f2f7c0c71f291fd5e9f364409c2d
+  data.tar.gz: 79acd12fdb51d4794c938baf10c54711a48f8203571b1b9c2243bb34032c0ebab88cc337b63ebcafaad84609771c02237255e79032dd0dbeda51db5252119f7e

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+example/slackbot2.yml

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.0.1 (2016/09/07)
+
+first version

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at sonots@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Naotoshi Seo
+
+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,51 @@
+# Alerty::Plugin::Slack
+
+Slack plugin for [alerty](https://github.com/sonots/alerty).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'alerty-plugin-slack'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install alerty-plugin-slack
+
+## Configuration
+
+- type: must be `slack`
+- webhook_url: Slack Webhook URL. Get from https://slack.com/apps/A0F7XDUAZ-incoming-webhooks
+- slackbot_url: Slack SlackBot URL. Get from https://analytics-support.slack.com/apps/A0F81R8ET-slackbot
+- webapi_token: Slack WebAPI token
+- payload
+  - text: text message
+  - channel: channel name
+  - see https://api.slack.com/methods/chat.postMessage and https://api.slack.com/docs/message-attachments
+
+## Placeholders
+
+* `${hostname}`: hostname which rans the command
+* `${command}`: a given command
+* `${exitstatus}`: exitstatus of the executed command
+* `${output}`: output of the executed command
+
+## Development
+
+```
+bundle exec alerty -c example/slackbot.yml -- ls /this_is_a_test
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sonots/alerty-plugin-slack. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/alerty-plugin-slack.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'alerty/plugin/slack/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "alerty-plugin-slack"
+  spec.version       = Alerty::Plugin::Slack::VERSION
+  spec.authors       = ["Naotoshi Seo"]
+  spec.email         = ["sonots@gmail.com"]
+
+  spec.summary       = %q{Slack plugin for alerty.}
+  spec.description   = %q{Slack plugin for alerty.}
+  spec.homepage      = "https://github.com/sonots/alerty-plugin-slack"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "alerty"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "alerty/plugin/slack"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/example/slackbot.yml

@@ -0,0 +1,10 @@
+log_path: STDOUT
+log_level: debug
+plugins:
+  - type: slack
+    slackbot_url: https://xxxxxx.slack.com/services/hooks/slackbot?token=XXXXXXXXXXXXXXXXXXXXX
+    # see https://api.slack.com/methods/chat.postMessage
+    payload:
+      channel: alerty_test
+      text: "FAILURE: [${hostname}] ${command}\n${output}"
+

data/example/webhook.yml

@@ -0,0 +1,8 @@
+log_path: STDOUT
+log_level: debug
+plugins:
+  - type: slack
+    webhook_url: https://hooks.slack.com/services/XXXXX/XXXXX/XXXXX
+    # see https://api.slack.com/methods/chat.postMessage
+    payload:
+      text: "FAILURE: [${hostname}] ${command}"

data/lib/alerty/plugin/slack.rb

@@ -0,0 +1,82 @@
+require 'alerty'
+require_relative 'slack/version'
+require_relative 'slack/slack_client'
+
+class Alerty
+  class Plugin
+    class Slack
+      def initialize(config)
+        @payload = config.payload || {}
+        if config.webhook_url
+          raise ConfigError.new('slack: webhook_url is given, but empty') if config.webhook_url.empty?
+          @client = SlackClient::IncomingWebhook.new(config.webhook_url)
+        elsif config.slackbot_url
+          raise ConfigError.new('slack: slackbot_url is given, but empty') if config.slackbot_url.empty?
+          @client = SlackClient::Slackbot.new(config.slackbot_url)
+        elsif config.webapi_token
+          raise ConfigError.new('slack: webapi_token is given, but empty') if config.webapi_token.empty?
+          @client = SlackClient::Webapi.new
+          @payload['token'] = config.webapi_token
+        end
+        @client.log = Alerty.logger
+        @client.https_proxy = config.https_proxy if config.https_proxy
+
+        @num_retries = config.num_retries || 3
+      end
+
+      def alert(record)
+        payload = build_payload(record).to_h
+        with_retry(@num_retries) { @client.post_message(payload) }
+      end
+
+      private
+
+      def with_retry(num_retries, &block)
+        retries = 0
+        begin
+          yield
+        rescue => e
+          retries += 1
+          sleep 1
+          if retries <= num_retries
+            retry
+          else
+            raise e
+          end
+        end
+      end
+
+      # https://api.slack.com/methods/chat.postMessage
+      # https://api.slack.com/docs/messages
+      # https://api.slack.com/docs/messages/builder
+      # https://api.slack.com/docs/message-attachments
+      def build_payload(record)
+        deep_expand_placeholder(@payload, record)
+      end
+
+      def deep_expand_placeholder(obj, record)
+        case obj
+        when Hash
+          obj.each do |k, v|
+            obj[k] = deep_expand_placeholder(v, record)
+          end
+        when Array
+          obj.each_with_index do |v, i|
+            obj[i] = deep_expand_placeholder(v, record)
+          end
+        when String
+          expand_placeholder(obj, record)
+        end
+      end
+
+      def expand_placeholder(str, record)
+        str.dup.tap {|s|
+          s.gsub!('${hostname}', record[:hostname])
+          s.gsub!('${command}', record[:command])
+          s.gsub!('${exitstatus}', record[:exitstatus].to_s)
+          s.gsub!('${output}', record[:output])
+        }
+      end
+    end
+  end
+end

data/lib/alerty/plugin/slack/slack_client.rb

@@ -0,0 +1,283 @@
+require 'uri'
+require 'net/http'
+require 'net/https'
+require 'logger'
+
+class Alerty
+  class Plugin
+    class Slack
+      module SlackClient
+        class Error < StandardError
+          attr_reader :res, :req_params
+
+          def initialize(res, req_params = {})
+            @res        = res
+            @req_params = req_params.dup
+          end
+
+          def message
+            @req_params['token'] = '[FILTERED]' if @req_params['token']
+            "res.code:#{@res.code}, res.body:#{@res.body}, req_params:#{@req_params}"
+          end
+
+          alias :to_s :message
+        end
+        class ChannelNotFoundError < Error; end
+        class NameTakenError < Error; end
+
+        # The base framework of slack client
+        class Base
+          attr_accessor :log, :debug_dev
+          attr_reader   :endpoint, :https_proxy
+
+          # @param [String] endpoint
+          #
+          #     (Incoming Webhook) required
+          #     https://hooks.slack.com/services/XXX/XXX/XXX
+          #
+          #     (Slackbot) required
+          #     https://xxxx.slack.com/services/hooks/slackbot?token=XXXXX
+          #
+          #     (Web API) optional and default to be
+          #     https://slack.com/api/
+          #
+          # @param [String] https_proxy (optional)
+          #
+          #     https://proxy.foo.bar:port
+          #
+          def initialize(endpoint = nil, https_proxy = nil)
+            self.endpoint    = endpoint    if endpoint
+            self.https_proxy = https_proxy if https_proxy
+            @log = Logger.new(nil)
+          end
+
+          def endpoint=(endpoint)
+            @endpoint    = URI.parse(endpoint)
+          end
+
+          def https_proxy=(https_proxy)
+            @https_proxy = URI.parse(https_proxy)
+            @proxy_class = Net::HTTP.Proxy(@https_proxy.host, @https_proxy.port)
+          end
+
+          def proxy_class
+            @proxy_class ||= Net::HTTP
+          end
+
+          def post(endpoint, params)
+            http = proxy_class.new(endpoint.host, endpoint.port)
+            http.use_ssl = (endpoint.scheme == 'https')
+            http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+            http.set_debug_output(debug_dev) if debug_dev
+            # http.open_timeout = # default: 60s
+            # http.read_timeout = # default: 60s
+
+            req = Net::HTTP::Post.new(endpoint.request_uri)
+            req['Host'] = endpoint.host
+            req['Accept'] = 'application/json; charset=utf-8'
+            req['User-Agent'] = 'fluent-plugin-slack'
+            req.body = encode_body(params)
+
+            res = http.request(req)
+            response_check(res, params)
+          end
+
+          private
+
+          def encode_body(params)
+            raise NotImplementedError
+          end
+
+          def response_check(res, params)
+            if res.code != "200"
+              raise Error.new(res, params)
+            end
+          end
+
+          def filter_params(params)
+            params.dup.tap {|p| p['token'] = '[FILTERED]' if p['token'] }
+          end
+
+          # Required to implement to use #with_channels_create
+          # channels.create API is available from only Slack Web API
+          def api
+            raise NotImplementedError
+          end
+
+          def with_channels_create(params = {}, opts = {})
+            retries = 1
+            begin
+              yield
+            rescue ChannelNotFoundError => e
+              if params['token'] and opts['auto_channels_create']
+                log.warn "out_slack: channel \"#{params['channel']}\" is not found. try to create the channel, and then retry to post the message."
+                api.channels_create({name: params['channel'], token: params['token']})
+                retry if (retries -= 1) >= 0 # one time retry
+              else
+                raise e
+              end
+            end
+          end
+        end
+
+        # Slack client for Incoming Webhook
+        # https://api.slack.com/incoming-webhooks
+        class IncomingWebhook < Base
+          def initialize(endpoint, https_proxy = nil)
+            super
+          end
+
+          def post_message(params = {}, opts = {})
+            log.info { "out_slack: post_message #{params}" }
+            post(endpoint, params)
+          end
+
+          private
+
+          def encode_body(params = {})
+            # https://api.slack.com/docs/formatting
+            params.to_json.gsub(/&/, '&amp;').gsub(/</, '&lt;').gsub(/>/, '&gt;')
+          end
+
+          def response_check(res, params)
+            super
+            unless res.body == 'ok'
+              raise Error.new(res, params)
+            end
+          end
+        end
+
+        # Slack client for Slackbot Remote Control
+        # https://api.slack.com/slackbot
+        class Slackbot < Base
+          def initialize(endpoint, https_proxy = nil)
+            super
+          end
+
+          def api
+            @api ||= WebApi.new(nil, https_proxy)
+          end
+
+          def post_message(params = {}, opts = {})
+            raise ArgumentError, "channel parameter is required" unless params['channel']
+            with_channels_create(params, opts) do
+              log.info { "out_slack: post_message #{filter_params(params)}" }
+              post(slackbot_endpoint(params), params)
+            end
+          end
+
+          private
+
+          def slackbot_endpoint(params)
+            endpoint.dup.tap {|e| e.query += "&channel=#{URI.encode(params['channel'])}" }
+          end
+
+          def encode_body(params = {})
+            return params['text']if params['text']
+            unless params['attachments']
+              raise ArgumentError, "params['text'] or params['attachments'] is required"
+            end
+            # handle params['attachments']
+            attachment = Array(params['attachments']).first # see only the first for now
+            # {
+            #   attachments: [{
+            #     text: "HERE",
+            #   }]
+            # }
+            text = attachment['text']
+            # {
+            #   attachments: [{
+            #     fields: [{
+            #       title: "title",
+            #       value: "HERE",
+            #     }]
+            #   }]
+            # }
+            if text.nil? and attachment['fields']
+              text = Array(attachment['fields']).first['value'] # see only the first for now
+            end
+            text
+          end
+
+          def response_check(res, params)
+            if res.body == 'channel_not_found'
+              raise ChannelNotFoundError.new(res, params)
+            elsif res.body != 'ok'
+              raise Error.new(res, params)
+            end
+          end
+        end
+
+        # Slack client for Web API
+        class WebApi < Base
+          DEFAULT_ENDPOINT = "https://slack.com/api/".freeze
+
+          def api
+            self
+          end
+
+          def endpoint
+            @endpoint ||= URI.parse(DEFAULT_ENDPOINT)
+          end
+
+          def post_message_endpoint
+            @post_message_endpoint    ||= URI.join(endpoint, "chat.postMessage")
+          end
+
+          def channels_create_endpoint
+            @channels_create_endpoint ||= URI.join(endpoint, "channels.create")
+          end
+
+          # Sends a message to a channel.
+          #
+          # @see https://api.slack.com/methods/chat.postMessage
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/chat.postMessage.md
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/chat.postMessage.json
+          def post_message(params = {}, opts = {})
+            with_channels_create(params, opts) do
+              log.info { "out_slack: post_message #{filter_params(params)}" }
+              post(post_message_endpoint, params)
+            end
+          end
+
+          # Creates a channel.
+          #
+          # NOTE: Bot user can not create a channel. Token must be issued by Normal User Account
+          # @see https://api.slack.com/bot-users
+          #
+          # @see https://api.slack.com/methods/channels.create
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.create.md
+          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.create.json
+          def channels_create(params = {}, opts = {})
+            log.info { "out_slack: channels_create #{filter_params(params)}" }
+            post(channels_create_endpoint, params)
+          end
+
+          private
+
+          def encode_body(params = {})
+            body = params.dup
+            if params['attachments']
+              body['attachments'] = params['attachments'].to_json
+            end
+            URI.encode_www_form(body)
+          end
+
+          def response_check(res, params)
+            super
+            res_params = JSON.parse(res.body)
+            return if res_params['ok']
+            case res_params['error']
+            when 'channel_not_found'
+              raise ChannelNotFoundError.new(res, params)
+            when 'name_taken'
+              raise NameTakenError.new(res, params)
+            else
+              raise Error.new(res, params)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/alerty/plugin/slack/version.rb

@@ -0,0 +1,7 @@
+class Alerty
+  class Plugin
+    class Slack
+      VERSION = "0.0.1"
+    end
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: alerty-plugin-slack
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Naotoshi Seo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: alerty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Slack plugin for alerty.
+email:
+- sonots@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- alerty-plugin-slack.gemspec
+- bin/console
+- bin/setup
+- example/slackbot.yml
+- example/webhook.yml
+- lib/alerty/plugin/slack.rb
+- lib/alerty/plugin/slack/slack_client.rb
+- lib/alerty/plugin/slack/version.rb
+homepage: https://github.com/sonots/alerty-plugin-slack
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Slack plugin for alerty.
+test_files: []