hey-you-slack 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 986aefb9851549a114d5cf7cc1e3baa86d0b8bf130bc43fa38c1049c89cead94
+  data.tar.gz: d58f338a5d208d88c4518ccce006868680e5547ba2f7300150f9b280a065e4df
+SHA512:
+  metadata.gz: 78af35b992bde2f3516a3c053b95b9db4b8c9186eece2cc96c7495cce61baf32b3ee04d9c0def7097b32e1a9a41c74f77ba26324db58d840518b6de78b550c6d
+  data.tar.gz: 0fa09f7b2e78b75a4aef2e4015c3337e4e34c14f7990ecef891d6dc3e9fb9919036a5dd0c0f75975e34b11eaf10e65a4823b1e3e85ba4145edf7d739afd7aa00

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock
+.byebug_history

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,11 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+  - 2.4.2
+  - 2.5.3
+  - 2.6.1
+before_install: gem install bundler
+scripts:
+  - bundle exec rspec
+

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gem 'byebug'
+
+# Specify your gem's dependencies in hey-you-slack.gemspec
+gemspec

data/README.md

@@ -0,0 +1,64 @@
+# Hey, You, Slack!
+[![Build Status](https://travis-ci.com/QNester/hey-you-slack.svg?branch=master)](https://travis-ci.com/QNester/hey-you-slack#)
+[![Gem Version](https://badge.fury.io/rb/hey-you-slack.svg)](https://badge.fury.io/rb/hey-you-slack)
+
+Slack notifications via [hey-you gem](https://github.com/QNester/hey-you).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hey-you-slack'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hey-you-slack
+
+## Usage
+
+After load gem you can send notifications to slack via [hey-you](https://github.com/QNester/hey-you).
+
+For example:
+```yaml
+# config/notifications.yml
+events:
+  signed_up:
+    # ...
+    slack:
+      username: Greeter
+      text: 'User with email %{email} was signed up'
+      webhook_name: 'channel_name' # key from config.slack.webhooks
+      icon_emoji: ':grin:'
+```
+
+```ruby
+# config/initalizers/hey-you.rb
+HeyYou::Config.configure do 
+	# [Hash] required - list of slack-webhooks for your applications 
+  config.slack.webhooks = {
+    channel_name: 'http://webhooks.slack/channel_webhook'
+  } 
+	
+  # [String] optional - default name of author notifications messages in slack chats. 
+  config.slack.slack_username = 'MyApp_Notifier'
+end
+```
+
+```ruby
+# // somewhere in your app 
+builder = Builder.new('events.signed_up', email: created_user.email) 
+HeyYou::Channels::Slack.send!(builder) #=> { success: true }
+# Notification will be received in slack chat :)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. 

data/Rakefile

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

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require 'byebug'
+require "hey-you-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(__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/hey-you-slack.gemspec

@@ -0,0 +1,43 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "hey_you_slack/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "hey-you-slack"
+  spec.version       = HeyYouSlack::VERSION
+  spec.authors       = ["Sergey Nesterov"]
+  spec.email         = ["qnesterr@gmail.com"]
+
+  spec.summary       = "Slack notification via gem `hey-you`."
+  spec.description   = "This gem extend core gem `hey-you` for send notifications to slack with webhooks."
+  spec.homepage      = "https://github.com/QNester/hey-you-slack"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/QNester/hey-you-slack"
+    spec.metadata["changelog_uri"] = "https://github.com/QNester/hey-you-slack/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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_runtime_dependency "hey-you", '~> 0.1.8'
+  spec.add_runtime_dependency "httparty", '~> 0.16'
+
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", '~> 3.4'
+  spec.add_development_dependency "ffaker", '~> 2.9'
+end

data/lib/hey-you-slack.rb

@@ -0,0 +1,11 @@
+require 'hey-you'
+require 'hey_you_slack/version'
+require_relative 'hey_you/config/slack'
+require_relative 'hey_you/builder/slack'
+require_relative 'hey_you/channels/slack'
+
+module HeyYouSlack
+  CHANNEL_NAME = 'slack'.freeze
+
+  HeyYou::Config.instance.registrate_channel(CHANNEL_NAME)
+end

data/lib/hey_you/builder/slack.rb

@@ -0,0 +1,25 @@
+module HeyYou
+  class Builder
+    class Slack < Base
+      attr_reader :username, :text, :icon_emoji, :icon_url, :webhook_name
+
+      def build
+        @webhook_name = ch_data.fetch('webhook_name', nil)
+        @username = ch_data.fetch('username', nil) || Config.config.slack.slack_username
+        @text = interpolate(ch_data.fetch('text'), options)
+        @icon_emoji = ch_data.fetch('icon_emoji', nil)
+        @icon_url = ch_data.fetch('icon_url', nil)
+      end
+
+      def to_hash
+        excluded = [:@data, :@key, :@options]
+        self.instance_variables.inject({}) do |memo, var|
+          unless excluded.include?(var)
+            memo[var.to_s.gsub('@', '')] = instance_variable_get(var)
+          end
+          memo
+        end
+      end
+    end
+  end
+end

data/lib/hey_you/channels/slack.rb

@@ -0,0 +1,77 @@
+require 'httparty'
+require 'json'
+
+module HeyYou
+  module Channels
+    class Slack < Base
+      WEBHOOK_ERR_MSG_TMPL = "slack webhook `%{key}` was not configured".freeze
+
+      class << self
+        # @param [HeyYou::Builder] builder - builder with notifications texts and settings
+        # @option [String/Symbol] to - key from `config.slack.webhooks` hash
+        def send!(builder, **options)
+          raise CredentialsNotExists unless credentials_present?
+
+          if options[:to]&.is_a?(String) || options[:to]&.is_a?(Symbol)
+            return send_to_webhook(builder, options)
+          end
+
+          if builder.slack&.webhook_name
+            options.delete(:to)
+            return send_to_webhook(builder, options)
+          end
+
+          send_to_multiple_webhooks(builder, options)
+        end
+
+        private
+
+        def send_to_webhook(builder, **options)
+          hook_key = options[:to]&.to_sym || builder.slack.webhook_name.to_sym
+          webhook = config.slack.webhooks[hook_key]
+
+          if webhook == nil || webhook == ""
+            raise WebhookError, WEBHOOK_ERR_MSG_TMPL % { key: hook_key }
+          end
+
+          [make_request_to_webhook(hook_key, webhook, builder)]
+        end
+
+        def send_to_multiple_webhooks(builder, **options)
+          webhooks = config.slack.webhooks
+
+          if options[:to]&.is_a?(Array)
+            begin
+              webhooks = config.slack.webhooks.dup.keep_if { |k, _| options[:to].include?(k) }
+            rescue KeyError => err
+              raise WebhookError, WEBHOOK_ERR_MSG_TMPL % { key: err.key }
+            end
+          end
+
+          webhooks.map do |webhook_name, webhook|
+            make_request_to_webhook(webhook_name, webhook, builder)
+          end
+        end
+
+        def make_request_to_webhook(webhook_name, webhook, builder)
+          config.logger&.info("Send notification to webhook #{webhook_name}")
+          response = HTTParty.post(
+            webhook,
+            body: builder.slack.to_hash.to_json,
+            :headers => {
+              'Content-Type' => 'application/json',
+              'Accept' => 'application/json'
+            }
+          )
+          config.logger&.info("Response from slack: #{response.body}")
+          { webhook_name => response.body == 'ok' }
+        end
+
+        def required_credentials
+          [:webhooks]
+        end
+      end
+      class WebhookError < StandardError; end
+    end
+  end
+end

data/lib/hey_you/config/slack.rb

@@ -0,0 +1,25 @@
+require 'json'
+
+module HeyYou
+  class Config
+    class Slack
+      extend Configurable
+      attr_accessor :webhooks, :slack_username
+
+      DEFAULT_USERNAME = 'Hey, you'.freeze
+
+      def initialize
+        @slack_username = DEFAULT_USERNAME
+      end
+
+      def webhooks=(webhooks_hash)
+        return ArgumentError, 'webhooks must be a Hash' unless webhooks_hash.is_a?(Hash)
+
+        @webhooks = webhooks_hash.inject({}) do |memo, (k, v)|
+          memo[k.to_sym] = v
+          memo
+        end
+      end
+    end
+  end
+end

data/lib/hey_you_slack/version.rb

@@ -0,0 +1,3 @@
+module HeyYouSlack
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: hey-you-slack
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sergey Nesterov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hey-you
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.8
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: ffaker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+description: This gem extend core gem `hey-you` for send notifications to slack with
+  webhooks.
+email:
+- qnesterr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hey-you-slack.gemspec
+- lib/hey-you-slack.rb
+- lib/hey_you/builder/slack.rb
+- lib/hey_you/channels/slack.rb
+- lib/hey_you/config/slack.rb
+- lib/hey_you_slack/version.rb
+homepage: https://github.com/QNester/hey-you-slack
+licenses: []
+metadata:
+  homepage_uri: https://github.com/QNester/hey-you-slack
+  source_code_uri: https://github.com/QNester/hey-you-slack
+  changelog_uri: https://github.com/QNester/hey-you-slack/CHANGELOG.md
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Slack notification via gem `hey-you`.
+test_files: []