slack-notification 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 83e0b0242c87913f71ddfc6ce4ddba328055844e497aa8d724128a413d76c31a
+  data.tar.gz: 7e1986ba946e6020d877534825f76077cca78242a3c4e2faaea72395a20329e4
+SHA512:
+  metadata.gz: b2416cea694677140932daa0c019334c8e6602eace72ee01930ef0d7d595161deb3b2b1938932f6d95b7d7e4dd333fd8f3cae426bf1a6d73a9d3f997d779098e
+  data.tar.gz: dc0d2ab30971b435e7b971b24745b113ec7cef31518dfc9e481dbfe0b096a16dca1f6e5451b06d81a72f3be7cb99d8791b65de46569c189c5c477350d4786f3d

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Julian Fiander
+
+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,66 @@
+# SlackNotification
+
+This is a simplified API for sending Slack messages from (e.g.) a Rails application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'slack-notification'
+```
+
+And then execute:
+
+```sh
+bundle
+```
+
+Or install it yourself as:
+
+```sh
+gem install slack-notification
+```
+
+## Usage
+
+```ruby
+SlackNotification.new(
+    channel: 'channel-name-here', type: :success, title: 'Something Happened',
+    fallback: "Plain-text version of the message.",
+    fields: [
+    { title: 'Field one', value: value_one, short: true },
+    { title: 'Field two', value: value_two, short: true },
+    { title: 'Longer field that needs more space.', value: value_three, short: false }
+    ]
+).notify!
+```
+
+Options:
+
+```ruby
+:type     # Notification type (see below)
+:dryrun   # Do not actually submit the message
+:title    # Title for the message
+:fallback # Plain-text version for if fields won't work
+:fields   # Regular data for the message
+:channel  # The channel webhook to submit to
+```
+
+Available notification types:
+
+```ruby
+%i[success info warning failure]
+```
+
+Fields can be formatted in several ways:
+
+String: The fields value becomes the message title, and no fields are submitted.
+Hash:   Format: `{ title_1: :value_1, [...] }`
+Array:  Array of hashes, each of format: `{ title: 'Field name', value: field_value, short: true }`
+
+Channels can be made available by setting ENV variables beginning with `SLACK_URL_`.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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/notification"
+
+# 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(__FILE__)

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_notification.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require 'slack-notifier'
+
+class SlackNotification
+  attr_accessor :type, :dryrun, :title, :fallback, :fields, :channel
+
+  def initialize(options = {})
+    @channel = validated_channel(options[:channel].to_s)
+    @type = validated_type(options[:type])
+    @title = options[:title]
+    @fallback = options[:fallback]
+    @dryrun = options[:dryrun] || (defined?(Rails) && Rails.env.test?)
+    @fields = validated_fields(options[:fields])
+  end
+
+  def data
+    @data = {}
+    @data['title'] = @title || 'Notification'
+    @data['fallback'] = @fallback || @data['title']
+    @data['fields'] = @fields if @fields.present?
+    @data['color'] = slack_color
+    @data['footer'] = Rails.env if defined?(Rails)
+    @data
+  end
+
+  def notify!
+    @dryrun ? data : notifier.post(attachments: [data])
+  end
+
+private
+
+  def notifier
+    raise "Missing notifier url for #{@channel}." if slack_urls[@channel].blank?
+
+    Slack::Notifier.new(slack_urls[@channel])
+  end
+
+  def validated_fields(fields)
+    if fields.is_a?(Hash)
+      fields = fields_from_hash(fields)
+    elsif fields.is_a?(String)
+      @title = fields
+      fields = []
+    elsif !fields.is_a?(Array)
+      raise ArgumentError, 'Unsupported fields format.'
+    end
+
+    fields.is_a?(Hash) ? fields_from_hash(fields) : fields
+  end
+
+  def fields_from_hash(hash)
+    hash.map do |title, value|
+      { 'title' => title, 'value' => value, 'short' => true }
+    end
+  end
+
+  def slack_color
+    return '#CCCCCC' if @type.blank?
+
+    {
+      success: '#1086FF', info: '#99CEFF',
+      warning: '#FF6600', failure: '#BF0D3E'
+    }[@type]
+  end
+
+  def validated_channel(channel = nil)
+    channel = channel.delete('#')
+    unknown_channel if channel.present? && !channel.in?(slack_urls.keys)
+
+    channel = 'notifications' if channel.blank?
+    channel = 'test' unless Rails.env.production?
+    channel
+  end
+
+  def unknown_channel
+    raise ArgumentError, 'Unknown channel.'
+  end
+
+  def slack_urls
+    ENV.select { |k, _| k.match?(/SLACK_URL_/) }.map do |key, url|
+      { key.gsub('SLACK_URL_', '').downcase => url }
+    end.reduce({}, :merge)
+  end
+
+  def validated_type(type = nil)
+    valid_types = %i[success info warning failure]
+    return type if type.blank? || type.in?(valid_types)
+
+    raise ArgumentError, 'Unrecognized notification type.'
+  end
+end

data/slack-notification.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'slack-notification'
+  spec.version       = '0.1.0'
+  spec.authors       = ['Julian Fiander']
+  spec.email         = ['julian@fiander.one']
+
+  spec.summary       = 'A simplified Slack API.'
+  spec.description   = 'A simplified Slack API for integration into Rails applications.'
+  spec.homepage      = 'https://github.com/jfiander/slack-notification'
+  spec.license       = 'MIT'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/jfiander/slack-notification'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake',    '~> 10.0'
+
+  spec.add_dependency 'slack-notifier', '~> 2.3'
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: slack-notification
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Julian Fiander
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: slack-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: A simplified Slack API for integration into Rails applications.
+email:
+- julian@fiander.one
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/slack_notification.rb
+- slack-notification.gemspec
+homepage: https://github.com/jfiander/slack-notification
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jfiander/slack-notification
+  source_code_uri: https://github.com/jfiander/slack-notification
+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.7.6
+signing_key: 
+specification_version: 4
+summary: A simplified Slack API.
+test_files: []