switch_gear_sidekiq-middleware 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e87a04410e84969c44b5f397b4385cc69fee127c
+  data.tar.gz: 1f139cd1d03d899224042904415aedf85114ef95
+SHA512:
+  metadata.gz: e1ea08a4b828a19576475dd0a4c7feacf4b4776406239c6a1ec6e74ea438d5e20cb4e8ae0bd705e5b157e778589781e233d2e4c241b66c4c4932c88ca3fc9e84
+  data.tar.gz: ca56bd84113390139da75fe13291b442a9211ccdd3b92ac881bbbfdb74bb6b29146341397cc5488b761257cdb3d4fea065e54fba38e792beb0b4805db103c2d6

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+coverage/
+.ruby-version
+*.swp

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.13.7

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 anthony.s.ross@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 switch_gear_sidekiq-middleware.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Anthony Ross
+
+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,64 @@
+# SwitchGearSidekiq::Middleware
+
+This gem is a small [Sidekiq](https://www.github.com/mperham/sidekiq) middlware that uses the [SwitchGear](https://www.github.com/allcentury/switch_gear) gem to allow for a circuit breaker to be used across sidekiq jobs.  This is done using the `Redis` client found in `SwitchGear`.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'switch_gear_sidekiq-middleware'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install switch_gear_sidekiq-middleware
+
+## Usage
+
+You need to add the middlware to your sidekiq initializer like so:
+
+```ruby
+# use your own redis connecton or checkout one from the sidekiq pool
+redis = Redis.new || Sidekiq::Client.new.redis_pool.checkout
+
+breaker = SwitchGearSidekiq::Breaker.new do |cb|
+  cb.client = redis
+  cb.worker = YourWorkerClass
+  cb.failure_limit = 2
+  cb.reset_timeout = 5
+  cb.logger = Sidekiq.logger
+end
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add SwitchGearSidekiq::Middleware, breakers: [breaker]
+  end
+end
+```
+
+You can pass an array of breakers to the middleware.  The middlware looks up the breaker by the worker class you pass in and needs to match the worker Sidekiq would initialize when it's popped off the queue.
+
+There is a helper class called `SwitchGearSidekiq::Breaker` which is a really thin wrapper around [SwitchGear::CircuitBreaker::Redis](https://www.github.com/allcentury/switch_gear).  Please see that gems documentation on what can be configured.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/allcentury/switch_gear_sidekiq-middleware. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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,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 "switch_gear_sidekiq/middleware"
+
+# 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/examples/sidekiq.rb

@@ -0,0 +1,37 @@
+require 'sidekiq'
+require 'switch_gear'
+require 'redis'
+
+class HardWorker
+  include Sidekiq::Worker
+  sidekiq_options retry: false
+
+  def perform(name)
+    http_result = ["Success!", "Fail"].sample
+    raise RuntimeError.new("Failed to fetch something for #{name}") if http_result == "Fail"
+    Sidekiq.logger.info "#{http_result} getting something for #{name}"
+  end
+end
+
+# use your own redis connecton or checkout one from the sidekiq pool
+redis = Redis.new || Sidekiq::Client.new.redis_pool.checkout
+Sidekiq.logger.level = :debug
+
+breaker = SwitchGearSidekiq::Breaker.new do |cb|
+  cb.client = redis
+  cb.worker = HardWorker
+  cb.failure_limit = 2
+  cb.reset_timeout = 5
+  cb.logger = Sidekiq.logger
+end
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add SwitchGearSidekiq::Middleware, breakers: [breaker]
+  end
+end
+
+["joe", "jane", "mary", "steve", "harry", "jeff", "sally", "tracy", "anna"].each { |handle| HardWorker.perform_async(handle) }
+
+# Run this file on the commandline via:
+# sidekiq -c 2 -r ./examples/sidekiq.rb

data/lib/switch_gear_sidekiq/breaker.rb

@@ -0,0 +1,33 @@
+require 'switch_gear'
+
+module SwitchGearSidekiq
+  class Breaker < ::SwitchGear::CircuitBreaker::Redis
+    attr_accessor :worker
+    def initialize
+      yield self
+      @namespace = "circuit_breaker_#{worker}"
+      @logger = logger || Sidekiq.logger
+      # dummy lambda to allow easy invocation of job
+      @circuit = circuit || -> (sk_job) { sk_job.call }
+      run_validations
+    end
+
+    def to_s
+      <<~EOF
+        [SwitchGearSidekiq::Breaker] - Breaker config
+        namespace: #{namespace}
+        logger: #{logger}
+        circuit: #{circuit}
+        reset_timeout: #{reset_timeout}
+        failure_limit: #{failure_limit}
+      EOF
+    end
+
+    private
+
+    def run_validations
+      msg = "please provider a worker"
+      raise(ArgumentError, msg) if !worker
+    end
+  end
+end

data/lib/switch_gear_sidekiq/middleware.rb

@@ -0,0 +1,38 @@
+require 'switch_gear_sidekiq/breaker'
+
+module SwitchGearSidekiq
+  class Middleware
+    VERSION = "0.1.0"
+
+    attr_reader :breakers
+
+    def initialize(breakers:)
+      @breakers = breakers.each_with_object({}) do |breaker, hash|
+        hash[breaker.worker] = breaker
+      end
+      run_validations
+    end
+
+    def call(worker, msg, queue, &block)
+      breaker = breakers[worker.class]
+      Sidekiq.logger.debug "Breaker being used: #{breaker}"
+
+      breaker.call(block)
+    rescue SwitchGear::CircuitBreaker::OpenError
+      retry_in = breaker.reset_timeout + 1
+      fail_msg = "Circuit is open for worker: #{breaker.worker} - blocking all calls;"
+      fail_msg += "  Jobs will try again in: #{retry_in} "
+      Sidekiq.logger.warn fail_msg
+
+      # Here we'll re-enqueue the job to be 1 second above the reset_timeout period
+      worker.class.perform_in(retry_in, *msg['args'])
+    end
+
+    private
+
+    def run_validations
+      msg = "You must pass in an instance of a SwitchGear::CircuitBreaker"
+      fail msg if breakers.any? { |klass, breaker| !breaker.is_a? SwitchGear::CircuitBreaker }
+    end
+  end
+end

data/switch_gear_sidekiq-middleware.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'switch_gear_sidekiq/middleware'
+
+Gem::Specification.new do |spec|
+  spec.name          = "switch_gear_sidekiq-middleware"
+  spec.version       = SwitchGearSidekiq::Middleware::VERSION
+  spec.authors       = ["Anthony Ross"]
+  spec.email         = ["anthony.s.ross@gmail.com"]
+
+  spec.summary       = %q{A Sidekiq middleware that implements the circuit breaker pattern}
+  spec.description   = %q{This gem allows for users of Sidekiq in a distributed system to use a common circuit breaker that can be used across any number of Sidekiq servers"}
+  spec.homepage      = "https://github.com/allcentury/switch_gear_sidekiq-middlware"
+  spec.license       = "MIT"
+
+  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_dependency 'sidekiq'
+  spec.add_dependency 'switch_gear', '~> 0.2.0'
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "simplecov", "~> 0.13"
+  spec.add_development_dependency "yard", "~> 0.9"
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: switch_gear_sidekiq-middleware
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anthony Ross
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  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: switch_gear
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: pry
+  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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: This gem allows for users of Sidekiq in a distributed system to use a
+  common circuit breaker that can be used across any number of Sidekiq servers"
+email:
+- anthony.s.ross@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/sidekiq.rb
+- lib/switch_gear_sidekiq/breaker.rb
+- lib/switch_gear_sidekiq/middleware.rb
+- lib/switch_gear_sidekiq/middleware/version.rb
+- switch_gear_sidekiq-middleware.gemspec
+homepage: https://github.com/allcentury/switch_gear_sidekiq-middlware
+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.6.8
+signing_key: 
+specification_version: 4
+summary: A Sidekiq middleware that implements the circuit breaker pattern
+test_files: []