slack_notifier 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 682923ee0b54ce851b8234a8aefdb7ccf8cb6e0a
+  data.tar.gz: 240a006122a8a38dc12a136eb2f7299a08dc314d
+SHA512:
+  metadata.gz: 32abcba21e799e9fab0a28e3e8ec9cb27292ced15ce0612fa0551efef6dcf15929249fc57cd97733431c306ab36823981250217bb3d96afb0e0227857887d004
+  data.tar.gz: 5f2cbf36c1f9a1983389e7640f8d8a0fc3a4bbe4f607dba3a7536da1de3e90ae52678a0ac4299d9f609d43bfce0cf282110595e0a2f55ffe2738042a33c82183

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    slack_notifier (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.12)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  slack_notifier!
+
+BUNDLED WITH
+   1.15.1

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 FindHotel
+
+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,57 @@
+# SlackNotifier
+
+Simple Ruby gem for sending messages to Slack
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'slack_notifier'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install slack_notifier
+
+## Configuration
+
+```ruby
+SlackNotifier.configure({
+  default_channel: 'deployment-alerts',
+  default_nickname: 'Deployment Bot',
+  default_icon_emoji: ':ship:',
+  default_report_title: 'Details',
+  default_report_color: '#D3D3D3',
+  webhook_url: 'https://hooks.slack.com/services/X01XXYY11/A1XXY1X00/YYYYYYYYYYYYYYYYYY',
+  raise_delivery_errors: false
+})
+```
+
+## Usage
+```ruby
+SlackNotifier::Message.send(
+  text: "This uses all default configuration",
+  report: 'Some report/attachment text'
+)
+
+# Customizing default configuration
+SlackNotifier::Message.send(
+  channel: 'errors',
+  nickname: 'Bugs',
+  text: ex.message,
+  report: ex.backtrace
+)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/FindHotel/ruby_slack_notifier.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "slack_notifier"
+
+# 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/lib/slack_notifier/config.rb

@@ -0,0 +1,21 @@
+module SlackNotifier
+  class Config
+    PRESET_REPORT_TITLE = 'Details'
+    PRESET_REPORT_COLOR = '#D3D3D3'
+
+    class << self
+      attr_reader :default_channel, :default_nickname, :default_icon_emoji, :default_report_color,
+                  :default_report_title, :webhook_url, :raise_delivery_errors
+
+      def set(config)
+        @default_channel = config[:default_channel]
+        @default_nickname = config[:default_nickname]
+        @default_icon_emoji = config[:default_icon_emoji]
+        @default_report_title = config[:default_report_title] || PRESET_REPORT_TITLE
+        @default_report_color = config[:default_report_color] || PRESET_REPORT_COLOR
+        @webhook_url = config[:webhook_url]
+        @raise_delivery_errors = config[:raise_delivery_errors]
+      end
+    end
+  end
+end

data/lib/slack_notifier/message.rb

@@ -0,0 +1,90 @@
+module SlackNotifier
+  class Message
+    def self.send(text:, channel: nil, nickname: nil, icon_emoji: nil, icon_url: nil, report: nil)
+      channel ||= Config.default_channel
+      nickname ||= Config.default_nickname
+      new(text, channel, nickname, icon_emoji, icon_url, report).tap(&:deliver)
+    rescue => ex
+      raise ex if Config.raise_delivery_errors
+      puts ex.message
+      puts ex.backtrace.join("\n")
+    end
+
+    def deliver
+      payload_hash = {
+          username: @nickname,
+          text: @message.gsub('\'', '`'),
+          channel: @channel
+      }
+
+      payload_hash.merge!(icon_param)
+      payload_hash.merge!(compose_attachment) if !@report.nil? && !@report.empty?
+
+      payload = payload_hash.to_json
+
+      cmd = %(curl -X POST --data-urlencode 'payload=#{payload}' #{Config.webhook_url})
+      puts "Executing: `#{cmd}`"
+
+      result = `#{cmd}`
+      puts "Result: #{result}"
+
+      Time.now
+    end
+
+    private
+
+    def initialize(message, channel, nickname, icon, icon_ur, report)
+      @message = message
+      @channel = channel
+      @nickname = nickname
+      @created_at = Time.now
+      @report = report
+
+      set_icon(icon, icon_ur)
+    end
+
+    def icon_param
+      @icon_emoji ? { icon_emoji: @icon_emoji } : { icon_url: @icon_url }
+    end
+
+    def set_icon(icon_emoji, icon_url)
+      if no_icon?(icon_emoji, icon_url)
+        @icon_emoji = Config.default_icon_emoji
+      end
+
+      if more_than_one_icon?(icon_emoji, icon_url)
+        fail 'Please specify either an icon_emoji or an icon_url'
+      end
+
+      if icon_emoji
+        @icon_emoji = icon_emoji
+      else
+        @icon_url = icon_url
+      end
+    end
+
+    def no_icon?(icon_emoji, icon_url)
+      icon_emoji.nil? && icon_url.nil?
+    end
+
+    def more_than_one_icon?(icon_emoji, icon_url)
+      !icon_emoji.nil? && !icon_url.nil?
+    end
+
+    def compose_attachment
+      {
+          attachments: [
+              {
+                  title: Config.default_report_title,
+                  color: Config.default_report_color,
+                  text: key_value_pairs_to_s(@report)
+              }
+          ]
+      }
+    end
+
+    def key_value_pairs_to_s(hash)
+      hash.map { |k, v| "#{k}: #{v}" }.join("\n")
+    end
+  end
+end

data/lib/slack_notifier/version.rb

@@ -0,0 +1,3 @@
+module SlackNotifier
+  VERSION = '1.0.1'
+end

data/lib/slack_notifier.rb

@@ -0,0 +1,10 @@
+require 'json'
+require 'slack_notifier/config'
+require 'slack_notifier/message'
+require 'slack_notifier/version'
+
+module SlackNotifier
+  def self.configure(config)
+    Config.set(config)
+  end
+end

data/slack_notifier.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'slack_notifier/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "slack_notifier"
+  spec.version       = SlackNotifier::VERSION
+  spec.authors       = ['Elod Peter', 'Mohamed Osama']
+  spec.email         = ['bejmuller@gmail.com', 'mohamed.o.alnagdy@gmail.com']
+
+  spec.summary       = %q{Simple Ruby gem for sending messages to Slack}
+  spec.description   = %q{Simple Ruby gem for sending messages to Slack}
+  spec.homepage      = "https://github.com/FindHotel/ruby_slack_notifier"
+
+  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_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: slack_notifier
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Elod Peter
+- Mohamed Osama
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: Simple Ruby gem for sending messages to Slack
+email:
+- bejmuller@gmail.com
+- mohamed.o.alnagdy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/slack_notifier.rb
+- lib/slack_notifier/config.rb
+- lib/slack_notifier/message.rb
+- lib/slack_notifier/version.rb
+- slack_notifier.gemspec
+homepage: https://github.com/FindHotel/ruby_slack_notifier
+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.6.12
+signing_key: 
+specification_version: 4
+summary: Simple Ruby gem for sending messages to Slack
+test_files: []