slack_mailer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f7b02c1b68e24f2001a70a4e34dee2a5230139a6a10d14b0d368630a78b1886e
+  data.tar.gz: 9c6895c0a4286c029ce834fab53ed033c2faab0fb2ad7a45f69cb6c768965cd4
+SHA512:
+  metadata.gz: fb39ef37aa06e7898737ff6473765627bdab19079a91e2abb5aa6ebeebb445f41f9c70cd8c63b0afe46e9b699eaca1462eae7a5b9a2981f1827e934b31ab835d
+  data.tar.gz: e32b7dddd40d4a592fb0c2016ac95e0bcd0fea757537ec50ecce35a229888d251283116f9937bd732ef68e4a571f8774983a5ebcbacdaf0d0ac518126a14b5bf

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.0.pre.3

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    slack_mailer (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    slack-notifier (2.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16.a)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  slack-notifier (~> 2.3.2)
+  slack_mailer!
+
+BUNDLED WITH
+   1.16.0.pre.3

data/README.md

@@ -0,0 +1,90 @@
+# SlackMailer
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'slack_mailer'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install slack_mailer
+## Dependencies
+
+Before using game you need install [sidekiq](https://github.com/mperham/sidekiq) in to your project.
+
+## Configuring
+
+Add queue for sidekiq in to config/sidekiq.yml
+
+```yml
+- [slack_messages, 1]
+```
+
+Create configuration file config/initializers/slack_mailer.rb
+
+```ruby
+Slack::Mailer.configure do |config|
+  config.templates_path = "#{Rails.root}/app/views/slack_templates/"
+  config.templates_type = 'text'
+  config.erb_in_templates = true
+  config.slack_hook_urls = ['https://hooks.slack.com/services/...........',
+                            'https://hooks.slack.com/services/...........']
+end
+```
+
+## Usage
+
+app/slack_mailers/user_mailer.rb
+
+```ruby
+class UserMailer < Slack::Mailer
+
+  def created(user)
+    @user = user
+    mail(to: 'channel_name', template: 'created')
+  end
+
+end
+```
+
+If you want to send message via Mailer without sidekiq
+```ruby
+class UserMailer < Slack::Mailer
+
+  def created(user)
+    @user = user
+    mail(to: 'channel_name', template: 'created', use_sidekiq: false)
+  end
+
+end
+```
+
+Mailer will be using template *app/views/slack_templates/user_mailer/created.text.erb*
+
+```text
+Name: <%= @user.name %>
+Full name: <%= @user.full_name %>
+Phone: <%= @user.phone %>
+```
+#### Sending messages
+```ruby
+UserMailer.created(user)
+```
+
+Sending small messages(one line message)
+```ruby
+Slack::Mailer.send_message('#channel', 'name', 'message')
+```
+
+Sending message bypassing sidekiq
+```ruby
+Slack::Mailer.send_direct_message('#channel', 'name', 'message')
+```
+Also you can do this by using [slack-notifier](https://github.com/stevenosloan/slack-notifier)

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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "slack_mailer"
+
+# 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_mailer/configuration.rb

@@ -0,0 +1,27 @@
+module Slack
+  class Mailer
+    class Configuration
+
+      attr_accessor :templates_path, :templates_type, :erb_in_templates, :slack_hook_urls
+
+      def initialize
+        @templates_path = nil
+        @templates_type = nil
+        @erb_in_templates = false
+        @slack_hook_urls = nil
+      end
+
+      def self.config
+        @configuration ||= Slack::Mailer::Configuration.new
+      end
+
+      def self.reset
+        @configuration = Slack::Mailer::Configuration.new
+      end
+
+      def self.configure
+        yield(config)
+      end
+    end
+  end
+end

data/lib/slack_mailer/delivery_worker.rb

@@ -0,0 +1,29 @@
+require_relative 'configuration'
+require 'slack-notifier'
+require 'sidekiq'
+
+module Slack
+  class Mailer
+    class DeliveryWorker
+      include Sidekiq::Worker
+      sidekiq_options queue: :slack_messages
+      sidekiq_options retry: Proc.new{ Slack::Mailer::Configuration.config.slack_hook_urls.length }, dead: false
+      sidekiq_retry_in { 1 }
+      sidekiq_retries_exhausted do |msg|
+        Slack::Mailer::DeliveryWorker.perform_async(msg['args'][0])
+      end
+
+      attr_accessor :name, :channel, :message, :url, :retry_count
+
+      def retry_count
+        @retry_count || 0
+      end
+
+      def perform(params)
+        params['url'] = Slack::Mailer::Configuration.config.slack_hook_urls[retry_count]
+        params.each{ |attribute, value| send("#{attribute}=", value) if respond_to?(attribute) }
+        Slack::Notifier.new(url, username: name, channel: channel, link_names: 1).ping(message)
+      end
+    end
+  end
+end

data/lib/slack_mailer/version.rb

@@ -0,0 +1,5 @@
+module Slack
+  class Mailer
+    VERSION = "0.1.0"
+  end
+end

data/lib/slack_mailer.rb

@@ -0,0 +1,43 @@
+require_relative 'slack_mailer/configuration'
+require_relative 'slack_mailer/delivery_worker'
+require 'slack-notifier'
+
+module Slack
+  class Mailer
+    class << self
+
+      def method_missing(method, *args)
+        self.new.send(method, *args)
+      end
+
+      def send_message(channel = '', name = '', message = '')
+        return if channel.empty? || name.empty? || message.empty?
+        Slack::Mailer::DeliveryWorker.perform_async(name: name, message: message, channel: channel)
+      end
+
+      def send_direct_message(channel = '', name = '', message = '')
+        return if channel.empty? || name.empty? || message.empty?
+        url = Slack::Mailer::Configuration.config.slack_hook_urls.mrandom
+        Slack::Notifier.new(url, username: name, channel: channel, link_names: 1).ping(message)
+      end
+
+    end
+
+    def mail(to: nil, template: nil, use_sidekiq: true)
+      channel = '#' << to
+      instance_variables = self.instance_variables.map { |instance_variable|
+        { instance_variable => self.instance_variable_get(instance_variable) }
+      }.reduce(:merge)
+      message = collect_message(template, instance_variables)
+      method = use_sidekiq ? :send_message : :send_direct_message
+      self.class.send(method, channel, "#{self.class.name}##{template}", message)
+    end
+
+    def collect_message(template, instance_variables)
+      template = "#{template}.#{Slack::Mailer::Configuration.config.templates_type}"
+      template + '.erb' if Slack::Mailer::Configuration.config.erb_in_templates
+      ActionView::Base.new("#{Slack::Mailer::Configuration.config.templates_path}/#{self.class.name.underscore}",
+                           {}, ActionController::Base.new).render(file: template, locals: instance_variables || {})
+    end
+  end
+end

data/slack_mailer.gemspec

@@ -0,0 +1,25 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "slack_mailer/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "slack_mailer"
+  spec.version       = Slack::Mailer::VERSION
+  spec.authors       = ["Appodeal"]
+  spec.email         = ["p@appodeal.com"]
+
+  spec.summary       = %q{This gem make more comfortable working with slack}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/appodeal/slack_mailer"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16.a"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "slack-notifier", "~> 2.3.2"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: slack_mailer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Appodeal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+- !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: slack-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+description: ''
+email:
+- p@appodeal.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/slack_mailer.rb
+- lib/slack_mailer/configuration.rb
+- lib/slack_mailer/delivery_worker.rb
+- lib/slack_mailer/version.rb
+- slack_mailer.gemspec
+homepage: https://github.com/appodeal/slack_mailer
+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.7.6
+signing_key: 
+specification_version: 4
+summary: This gem make more comfortable working with slack
+test_files: []