sidekiq_middlewares 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 58d19e122710ee61085ace66515a1f856e6303d9
+  data.tar.gz: 184c9d55a540287db3d3fa870681afe9199da7bd
+SHA512:
+  metadata.gz: d29cddfc92e9aec4dde97bfdce4f49f84c893f1b37d2e2abe72b0d6f7810bd28b8e7d603cd51334da966d4069a016034de99a6149b3c495e8bffab406b159ee8
+  data.tar.gz: 8d922e12bb3c3ccf27368d37dc55e3904d00565849fa096d1cad0c1cc2bdc379e305b82c13074cae41167ae73527a9f33ccb7accd4ad1157384d58de038d94d3

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_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,33 @@
+language: ruby
+script: rspec spec -f d
+
+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
+  - jruby-19mode
+
+  - ruby-head
+  - jruby-head
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+
+env:
+  global:
+    - VERBOSE=true
+    - TIMEOUT=1
+
+branches:
+  only:
+    - master

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at adamluzsi@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/README.md

@@ -0,0 +1,38 @@
+# sidekiq_middlewares
+[![Build Status](https://travis-ci.org/emartech/sidekiq_middlewares.svg?branch=master)](https://travis-ci.org/emartech/sidekiq_middlewares)
+
+Ruby Sidekiq Middlewares For common uses
+
+### Benchmarker
+
+#### Optiosn
+* logger
+  * required
+  * this will be the object that must respond to :info method
+* formatter
+  * optional
+  * 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'
+
+require 'json'
+require 'logger'
+
+json_logger = Logger.new(STDOUT)
+json_logger.formatter = proc do |severity, datetime, progname, msg|
+  JSON.dump(msg) + "\n"
+end
+
+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
+```

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 "sidekiq_middlewares"
+
+# 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/sidekiq_middlewares.rb

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

data/lib/sidekiq_middlewares/benchmarker.rb

@@ -0,0 +1,35 @@
+require 'benchmark'
+require 'sidekiq_middlewares'
+
+class SidekiqMiddlewares::Benchmarker
+
+  def initialize(opts = {})
+    @logger = opts[:logger] || raise(ArgumentError, 'missing keyword: logger')
+    @formatter = opts[:formatter] || proc { |message| message }
+  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
+
+  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 results_by(measurement)
+    { 'execution_time_sec' => measurement.real }
+  end
+end

data/lib/sidekiq_middlewares/version.rb

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

data/sidekiq_middlewares.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$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.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.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.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq_middlewares
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Emarsys Smart Insight Team
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+description: Commonly reused Sidekiq Middlewares such as Benchmarker
+email:
+- smart-insight-dev@emarsys.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sidekiq_middlewares.rb
+- lib/sidekiq_middlewares/benchmarker.rb
+- lib/sidekiq_middlewares/version.rb
+- sidekiq_middlewares.gemspec
+homepage: https://github.com/emartech/sidekiq_middlewares
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Commonly reused Sidekiq Middlewares such as Benchmarker
+test_files: []