sidekiq_middlewares 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 58d19e122710ee61085ace66515a1f856e6303d9
-  data.tar.gz: 184c9d55a540287db3d3fa870681afe9199da7bd
+  metadata.gz: 5ce493c5d4b804657ed9b78b09bc19c796f29991
+  data.tar.gz: f67f58242c92f348aed2517783634c06130fcde0
 SHA512:
-  metadata.gz: d29cddfc92e9aec4dde97bfdce4f49f84c893f1b37d2e2abe72b0d6f7810bd28b8e7d603cd51334da966d4069a016034de99a6149b3c495e8bffab406b159ee8
-  data.tar.gz: 8d922e12bb3c3ccf27368d37dc55e3904d00565849fa096d1cad0c1cc2bdc379e305b82c13074cae41167ae73527a9f33ccb7accd4ad1157384d58de038d94d3
+  metadata.gz: c672f9bf8978c7867d08f228011023383a7769f95014a1718210f64b6ce735618531d1fa9768fea6453b0fdedd31faac3e0a1c24ab0616e8055090ed2d1731e1
+  data.tar.gz: 12da02767215af852fe6c297c5d66f0701f6a08ad08cbcac8a34c3fcea78578a58aad40a720072f959a1d0b790a2a4da0bac9c5b4a2a53f2844d0e9d9cefafc8

data/.rspec

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

data/.travis.yml

@@ -1,18 +1,18 @@
 language: ruby
-script: rspec spec -f d
+script: bundle exec rake
+
+before_install:
+  - gem update --system --no-document
 
 install:
   - gem update bundler
   - bundle install
 
 rvm:
-  - 1.9
-  - 2.0.0
-  - 2.1.1
-  - 2.1.2
   - 2.2.2
   - 2.3.1
   - 2.4.1
+  - 2.5.1
   - jruby-19mode
 
   - ruby-head

data/README.md

@@ -14,25 +14,38 @@ Ruby Sidekiq Middlewares For common uses
   * this proc will receive one argument, a message object which is a Hash type
   * If the logger can handle Hash messages, such as TwP's [logging](https://github.com/TwP/logging) libary, than you don't need this
 
-```ruby
-require 'json'
-require 'logger'
+first you need a logger that respond to :info method, and format the message object into an expected format.
 
+For simplicity, in the example this will be json.
+```ruby
 require 'json'
 require 'logger'
-
 json_logger = Logger.new(STDOUT)
 json_logger.formatter = proc do |severity, datetime, progname, msg|
   JSON.dump(msg) + "\n"
 end
+```
+
+Than you can use it with the Benchmarker middleware like this:
 
+```ruby
 Sidekiq.configure_server do |config|
   config.redis = sidekiq_redis_config
 
   config.server_middleware do |chain|
     chain.add SidekiqMiddlewares::Benchmarker, logger: json_logger
-    # or
-    # chain.add SidekiqMiddlewares::Benchmarker, logger: Logger.new(STDOUT), formatter: proc { |m| JSON.dump(m) + "\n" }
+  end
+end
+```
+
+Or if you don't want to provide logger who also know about how to format, you can give an optional formatter to the middleware.
+
+```ruby
+Sidekiq.configure_server do |config|
+  config.redis = sidekiq_redis_config
+
+  config.server_middleware do |chain|
+    chain.add SidekiqMiddlewares::Benchmarker, logger: Logger.new(STDOUT), formatter: proc { |m| JSON.dump(m) + "\n" }
   end
 end
 ```

data/lib/sidekiq_middlewares.rb

@@ -1,4 +1,6 @@
 require "sidekiq_middlewares/version"
+
 module SidekiqMiddlewares
   autoload :Benchmarker, "sidekiq_middlewares/benchmarker"
+  autoload :MdcCleaner, "sidekiq_middlewares/mdc_cleaner"
 end

data/lib/sidekiq_middlewares/benchmarker.rb

@@ -1,35 +1,37 @@
-require 'benchmark'
-require 'sidekiq_middlewares'
+module SidekiqMiddlewares
+  class Benchmarker
 
-class SidekiqMiddlewares::Benchmarker
+    def initialize(opts = {})
+      @logger = opts[:logger] || raise(ArgumentError, 'missing keyword: logger')
+      @formatter = opts[:formatter] || proc { |message| message }
+    end
 
-  def initialize(opts = {})
-    @logger = opts[:logger] || raise(ArgumentError, 'missing keyword: logger')
-    @formatter = opts[:formatter] || proc { |message| message }
-  end
+    def call(_worker, job, _queue)
+      start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      yield
+    ensure
+      elapsed_time = Process.clock_gettime(Process::CLOCK_MONOTONIC) - start_time
+      @logger.info(@formatter.call(message_to_log(job, elapsed_time)))
+    end
 
-  def call(_worker, job, _queue, &next_middleware_call)
-    measurement = Benchmark.measure(&next_middleware_call)
-    @logger.info(@formatter.call(message_to_log(job, measurement)))
-  end
+    private
 
-  private
+    def message_to_log(job, measurement)
+      base_by(job).merge(results_by(measurement))
+    end
 
-  def message_to_log(job, measurement)
-    base_by(job).merge(results_by(measurement))
-  end
-
-  def base_by(job)
-    {
-      'jid' => job['jid'],
-      'queue' => job['queue'],
-      'worker_class' => job['class'],
-      'created_at' => job['created_at'],
-      'enqueued_at' => job['enqueued_at']
-    }
-  end
+    def base_by(job)
+      {
+        'jid' => job['jid'],
+        'queue' => job['queue'],
+        'worker_class' => job['class'],
+        'created_at' => job['created_at'],
+        'enqueued_at' => job['enqueued_at']
+      }
+    end
 
-  def results_by(measurement)
-    { 'execution_time_sec' => measurement.real }
+    def results_by(elapsed_time)
+      {'execution_time_sec' => elapsed_time}
+    end
   end
 end

data/lib/sidekiq_middlewares/mdc_cleaner.rb

@@ -0,0 +1,8 @@
+module SidekiqMiddlewares
+  class MdcCleaner
+    def call(*_args)
+      Logging.mdc.clear if defined? Logging
+      yield
+    end
+  end
+end

data/lib/sidekiq_middlewares/version.rb

@@ -1,3 +1,3 @@
 module SidekiqMiddlewares
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/sidekiq_middlewares.gemspec

@@ -5,21 +5,22 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'sidekiq_middlewares/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = 'sidekiq_middlewares'
-  spec.version       = SidekiqMiddlewares::VERSION
-  spec.authors       = ['Emarsys Smart Insight Team']
-  spec.email         = ['smart-insight-dev@emarsys.com']
+  spec.name                  = 'sidekiq_middlewares'
+  spec.version               = SidekiqMiddlewares::VERSION
+  spec.authors               = ['Emarsys Smart Insight Team']
+  spec.email                 = ['smart-insight-dev@emarsys.com']
 
-  spec.summary       = 'Commonly reused Sidekiq Middlewares such as Benchmarker'
-  spec.description   = 'Commonly reused Sidekiq Middlewares such as Benchmarker'
-  spec.homepage      = 'https://github.com/emartech/sidekiq_middlewares'
+  spec.summary               = 'Commonly reused Sidekiq Middlewares such as Benchmarker'
+  spec.description           = 'Commonly reused Sidekiq Middlewares such as Benchmarker'
+  spec.homepage              = 'https://github.com/emartech/sidekiq_middlewares'
+  spec.required_ruby_version = ">= 2.2.2"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files                 = `git ls-files -z`.split("\x0").reject do |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.bindir                = 'exe'
+  spec.executables           = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths         = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 1.14'
   spec.add_development_dependency 'rake', '~> 10.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_middlewares
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Emarsys Smart Insight Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-01 00:00:00.000000000 Z
+date: 2018-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,6 +70,7 @@ files:
 - bin/setup
 - lib/sidekiq_middlewares.rb
 - lib/sidekiq_middlewares/benchmarker.rb
+- lib/sidekiq_middlewares/mdc_cleaner.rb
 - lib/sidekiq_middlewares/version.rb
 - sidekiq_middlewares.gemspec
 homepage: https://github.com/emartech/sidekiq_middlewares
@@ -83,7 +84,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -91,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Commonly reused Sidekiq Middlewares such as Benchmarker