sidekiq-scheduler-notification 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ef1c2d1a43626cddfcde1433cc2d94dad8fc9579
+  data.tar.gz: 20b4914852b731b67a705256dbb3c0109e582677
+SHA512:
+  metadata.gz: b1f37c76794848447e54d689ec7fdeeb3529988b045933fa1e6cefb738b258ce2c8ae7c5dd233b2babdb6486c3e3f5123ae21a56ee7e7df677820ebcb01bbf42
+  data.tar.gz: 6297d9090c53b13af9214f0711fbfb43cc26b11e7b13fcb2c35413b3f26624536ed115f44d1269e3b2b3297097b6f6d3e8c8a5dd81e9ca251ca89879769da81a

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+  - ruby-head
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 SHIBATA Hiroshi
+
+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 @@
+# Sidekiq::Scheduler::Notification
+
+Simple notification middleware with slack when invoke/error/finish to sidekiq jobs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq-scheduler-notification'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq-scheduler-notification
+
+## Usage
+
+Added following configuration to initializer like `config/initializer/sidekiq.rb`
+
+```rb
+Sidekiq::Scheduler.notify_webhook = "https://hooks.slack.com/services/xxx/yyyzzz"
+```
+
+and append `notification` variable like this
+
+```yaml
+NotificationJob:
+  cron: "15 * * * *"
+  notification: true
+```
+
+You can get notification from sidekiq to slack channnel.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hsbt/sidekiq-scheduler-notification.
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sidekiq/scheduler/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

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/sidekiq/middleware/server/slack_notification.rb

@@ -0,0 +1,26 @@
+require 'slack-notifier'
+
+module Sidekiq
+  module Middleware
+    module Server
+      class SlackNotification
+        def call(_worker, job, _queue)
+          if Sidekiq::Scheduler.notify_classes.include? job['wrapped']
+            notifier ||= Slack::Notifier.new(Sidekiq::Scheduler.notify_webhook)
+            notifier.username = 'Sidekiq Notification'
+            begin
+              notifier.ping "Start : #{job['wrapped']}"
+              yield
+            rescue => e
+              notifier.ping "Error : #{job['wrapped']}: #{e.message}"
+            ensure
+              notifier.ping "Finish: #{job['wrapped']}"
+            end
+          else
+            yield
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/scheduler/notification.rb

@@ -0,0 +1,36 @@
+require 'sidekiq-scheduler'
+require 'sidekiq/middleware/server/slack_notification'
+require 'sidekiq/scheduler/notification/version'
+
+module Sidekiq
+  class Scheduler
+    class << self
+      attr_accessor :notify_classes, :notify_webhook
+    end
+  end
+end
+
+module SidekiqSchedulerNotification
+  module ClassMethods
+    def load_schedule!
+      super
+      if enabled && Sidekiq.schedule
+        Sidekiq::Scheduler.notify_classes = Sidekiq.schedule.select{|_,v| v["notification"] }.map{|k,_| k}
+      end
+    end
+  end
+
+  def self.prepended(base)
+    class << base
+      prepend ClassMethods
+    end
+  end
+end
+
+Sidekiq::Scheduler.prepend SidekiqSchedulerNotification
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add Sidekiq::Middleware::Server::SlackNotification
+  end
+end

data/lib/sidekiq/scheduler/notification/version.rb

@@ -0,0 +1,7 @@
+module Sidekiq
+  class Scheduler
+    module Notification
+      VERSION = "0.1.0"
+    end
+  end
+end

data/sidekiq-scheduler-notification.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidekiq/scheduler/notification/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq-scheduler-notification"
+  spec.version       = Sidekiq::Scheduler::Notification::VERSION
+  spec.authors       = ["SHIBATA Hiroshi"]
+  spec.email         = ["hsbt@ruby-lang.org"]
+
+  spec.summary       = %q{Slack notification middleware for sidekiq-scheduler}
+  spec.description   = %q{Slack notification middleware for sidekiq-scheduler}
+  spec.homepage      = "https://github.com/hsbt/sidekiq-scheduler-notification"
+  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 'sidekiq-scheduler'
+  spec.add_dependency 'slack-notifier'
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-scheduler-notification
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- SHIBATA Hiroshi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq-scheduler
+  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: slack-notifier
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Slack notification middleware for sidekiq-scheduler
+email:
+- hsbt@ruby-lang.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sidekiq/middleware/server/slack_notification.rb
+- lib/sidekiq/scheduler/notification.rb
+- lib/sidekiq/scheduler/notification/version.rb
+- sidekiq-scheduler-notification.gemspec
+homepage: https://github.com/hsbt/sidekiq-scheduler-notification
+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 notification middleware for sidekiq-scheduler
+test_files: []