sidekiq-notifications 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 41685c6396bed4ed353e43cd749e2ec5b9153b49
+  data.tar.gz: baf9ba95c3ef18c610204b279caea5f5167b905a
+SHA512:
+  metadata.gz: 890c9c9dd869bce47554bccdb1091af31316eaf4262faeda8ea1994aa7302a46c02d470f6577577b93eac630d8adb75bc951af73e1d042b0a70a47702881e688
+  data.tar.gz: 629b719dd4a4f3bc9d64f85722348e2b34eeb01cdad0e65f789589fb0db3eef23a57d8f9294031b6ed844eed6164daf190967c74034dbf8ddda0e027163dcbe3

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Allen Madsen
+
+MIT License
+
+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,33 @@
+# Sidekiq::Notifications
+
+[![Circle CI](https://circleci.com/gh/lintci/sidekiq-notifications.svg?style=svg)](https://circleci.com/gh/lintci/sidekiq-notifications)
+
+Adds ActiveSupport/Notifications support to sidekiq.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq-notifications'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq-notifications
+
+## Usage
+
+Provides two events to subscribe to: `app.worker.enqueue` and `app.worker.perform` with ActiveSupport::Notifications. The payload contains a `title` like `MyWorker#perform_async` and `MyWorker#perform`. The payload also contains the `job` information directly from sidekiq.
+
+## Contributing
+
+1. Fork it ( https://github.com/lintci/sidekiq-notifications/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/lib/sidekiq-notifications.rb

@@ -0,0 +1 @@
+require_relative 'sidekiq/notifications'

data/lib/sidekiq/notifications.rb

@@ -0,0 +1,20 @@
+require 'sidekiq'
+
+require_relative 'notifications/version'
+require_relative 'notifications/client_middleware'
+require_relative 'notifications/server_middleware'
+
+Sidekiq.configure_client do |config|
+  config.client_middleware do |chain|
+    chain.add Sidekiq::Notifications::ClientMiddleware
+  end
+end
+
+Sidekiq.configure_server do |config|
+  config.client_middleware do |chain|
+    chain.add Sidekiq::Notifications::ClientMiddleware
+  end
+  config.server_middleware do |chain|
+    chain.add Sidekiq::Notifications::ServerMiddleware
+  end
+end

data/lib/sidekiq/notifications/client_middleware.rb

@@ -0,0 +1,15 @@
+require 'active_support/notifications'
+
+module Sidekiq
+  module Notifications
+    class ClientMiddleware
+      def call(worker_class, job, queue, redis_pool)
+        method = job['at'] ? 'perform_in' : 'perform_async'
+
+        ActiveSupport::Notifications.instrument('app.worker.enqueue', title: "#{worker_class.to_s}##{method}", job: job) do
+          yield
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/notifications/server_middleware.rb

@@ -0,0 +1,13 @@
+require 'active_support/notifications'
+
+module Sidekiq
+  module Notifications
+    class ServerMiddleware
+      def call(worker, job, queue)
+         ActiveSupport::Notifications.instrument('app.worker.perform', title: "#{worker.class.to_s}#perform", job: job) do
+          yield
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/notifications/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module Notifications
+    VERSION = "0.0.1"
+  end
+end

data/sidekiq-notifications.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidekiq/notifications/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq-notifications"
+  spec.version       = Sidekiq::Notifications::VERSION
+  spec.authors       = ["Allen Madsen"]
+  spec.email         = ["blatyo@gmail.com"]
+  spec.summary       = %q{Adds ActiveSupport/Notifications support to sidekiq.}
+  spec.homepage      = "https://github.com/lintci/sidekiq-notifications"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'sidekiq', '>= 3.3.0'
+  spec.add_runtime_dependency 'activesupport', '>= 4.2.0'
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/spec/sidekiq/notifications/client_middleware_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Sidekiq::Notifications::ClientMiddleware do
+  subject(:middleware){described_class.new}
+  let(:job){{}}
+
+  FakeWorker = Class.new
+
+  it 'wraps block in skylight instrument' do
+    expect(::ActiveSupport::Notifications).to receive(:instrument).with(
+      'app.worker.enqueue',
+      title: 'FakeWorker#perform_async',
+      job: job
+    ){|&block| block.call}
+
+    expect{|probe| middleware.call(FakeWorker, job, double(:queue), double(:redis_pool), &probe)}.to yield_control
+  end
+end

data/spec/sidekiq/notifications/server_middleware_spec.rb

@@ -0,0 +1,16 @@
+describe Sidekiq::Notifications::ServerMiddleware do
+  subject(:middleware){described_class.new}
+  let(:job){{}}
+
+  FakeWorker = Class.new
+
+  it 'wraps block in skylight instrument' do
+    expect(::ActiveSupport::Notifications).to receive(:instrument).with(
+      'app.worker.perform',
+      title: 'FakeWorker#perform',
+      job: job
+    ){|&block| block.call}
+
+    expect{|probe| middleware.call(FakeWorker.new, job, double(:queue), &probe)}.to yield_control
+  end
+end

data/spec/sidekiq/notifications_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Sidekiq::Notifications do
+  it 'has a version number' do
+    expect(Sidekiq::Notifications::VERSION).not_to be nil
+  end
+
+  it 'adds Notifications as last server middleware' do
+    expect(Sidekiq.server_middleware.entries.last.klass).to eq(Sidekiq::Notifications::ServerMiddleware)
+  end
+
+  it 'adds Notifications as last client middleware' do
+    expect(Sidekiq.client_middleware.entries.last.klass).to eq(Sidekiq::Notifications::ClientMiddleware)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+# Require necessary files for sidekiq to believe it's running in server mode
+require 'celluloid'
+require 'sidekiq/cli'
+require 'sidekiq/launcher'
+
+require 'sidekiq/notifications'

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-notifications
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Allen Madsen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- blatyo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sidekiq-notifications.rb
+- lib/sidekiq/notifications.rb
+- lib/sidekiq/notifications/client_middleware.rb
+- lib/sidekiq/notifications/server_middleware.rb
+- lib/sidekiq/notifications/version.rb
+- sidekiq-notifications.gemspec
+- spec/sidekiq/notifications/client_middleware_spec.rb
+- spec/sidekiq/notifications/server_middleware_spec.rb
+- spec/sidekiq/notifications_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/lintci/sidekiq-notifications
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Adds ActiveSupport/Notifications support to sidekiq.
+test_files:
+- spec/sidekiq/notifications/client_middleware_spec.rb
+- spec/sidekiq/notifications/server_middleware_spec.rb
+- spec/sidekiq/notifications_spec.rb
+- spec/spec_helper.rb