shift-circuit-breaker 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 651e358b83decf16c453e4a4e8acb9c93361b9fb
+  data.tar.gz: 179821b9d09dab46c7a00d1dfbaa3433b01bee41
+SHA512:
+  metadata.gz: cd5f81d3de621ba2497bea816fae35594d63a078c94c0b6791377c99da4d27492df3abb0fddb3abf7228d6d1da120e02a433903584dd057fd8fc6927642f6fb7
+  data.tar.gz: 87c4cc0637dbe2bc66a5b0a5be972283c8d8110f9bbf3596f7241a9cf231a4d8dc3ee5a878afc59f59ada23456796489798f8b9c7fcf36f4423f3303ef73b75e

data/.codeclimate.yml

@@ -0,0 +1,11 @@
+version: "2"
+plugins:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+  reek:
+    enabled: true
+  rubocop:
+    enabled: true

data/.gitignore

@@ -0,0 +1,13 @@
+**.DS_Store
+/.bundle
+/coverage/*
+/doc/*
+.env
+*.gem
+Gemfile.lock
+.idea
+/log/*
+/pkg/*
+/tmp/*
+/.yardoc
+/_yardoc/*

data/.reek

@@ -0,0 +1,21 @@
+Attribute:
+  enabled: false
+
+LongParameterList:
+  enabled: true
+  max_statements: 5
+  exclude:
+    - initialize
+    - "self.call"
+
+ManualDispatch:
+  enabled: false
+
+IrresponsibleModule:
+  enabled: false
+
+UtilityFunction:
+  public_methods_only: true
+
+exclude_paths:
+  - spec

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,21 @@
+# To find more info about this,
+# please read the following line
+# http://www.rubydoc.info/github/bbatsov/rubocop/Rubocop
+
+inherit_from:
+  - config/rubocop/.layout_rubocop.yml
+  - config/rubocop/.lint_rubocop.yml
+  - config/rubocop/.metrics_rubocop.yml
+  - config/rubocop/.naming_rubocop.yml
+  - config/rubocop/.performance_rubocop.yml
+  - config/rubocop/.style_rubocop.yml
+
+AllCops:
+  Exclude:
+    - "bin/*"
+    - "config/*"
+    - "Gemfile"
+    - "Gemfile.lock"
+    - "spec/*"
+    - "tmp/*"
+  TargetRubyVersion: 2.3

data/CONTRIBUTING.md

@@ -0,0 +1,80 @@
+Contributing to Shift Circuit Breaker
+=====================
+
+Feel free to contribute to the project by submitting a [pull request](https://github.com/shiftcommerce/shift-circuit-breaker/pulls) or [proposing features and discuss issues](https://github.com/shiftcommerce/shift-circuit-breaker/issues).
+
+#### Fork the Project
+
+Fork the [project on Github](https://github.com/shiftcommerce/shift-circuit-breaker) and check out your copy.
+
+```
+$ git https://github.com/shiftcommerce/shift-circuit-breaker.git
+$ cd shift-circuit-breaker
+$ git remote add upstream https://github.com/shiftcommerce/shift-circuit-breaker.git
+```
+
+#### Create a Branch
+
+Make sure your fork is up-to-date and create a branch for your feature or bug fix.
+
+```
+git checkout master
+git pull upstream master
+git checkout -b my-feature-branch
+```
+
+#### Bundle Install and Run Specs
+
+Ensure that you can build the project and run specs successfully before starting.
+
+```
+$ ./bin/setup
+$ bundle exec rspec
+```
+
+Run `bin/console` for an interactive prompt that will allow you to experiment.
+
+#### Write Tests
+
+Please make sure that there is test coverage for the changes made /or issue fixed.
+
+#### Write Code
+
+Implement your feature or bug fix and make sure that specs complete without errors.
+
+#### Write Documentation
+
+Update the documentation as per the changes made in the [README](README.md).
+
+#### Commit Changes
+
+Please write good commit logs. A commit log should describe what changed and why.
+
+```
+$ git add ...
+$ git commit
+```
+
+#### Push Changes
+
+```
+$ git push origin my-feature-branch
+```
+
+#### Make a Pull Request
+
+Visit your forked repo and click the 'New pull request' button. Select your feature branch, fill out the form, and click the 'Create pull request' button.
+
+#### Rebase
+
+If you have been working on a change for a while, rebase with upstream/master.
+
+```
+$ git fetch upstream
+$ git rebase upstream/master
+$ git push origin my-feature-branch -f
+```
+
+#### Pull Request Review
+
+The team will review the pull request. In the case that a change request has been made, please update please update the PR in order for the feature or bug fix to be merged. 

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Shift Commerce
+
+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,81 @@
+[ ![Codeship Status for shiftcommerce/shift-circuit-breaker](https://app.codeship.com/projects/76d6b9e0-ecaa-0135-f112-7a88d47e1dcf/status?branch=master)](https://app.codeship.com/projects/270371) [![Maintainability](https://api.codeclimate.com/v1/badges/7d52af723c1579961280/maintainability)](https://codeclimate.com/github/shiftcommerce/shift-circuit-breaker/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/7d52af723c1579961280/test_coverage)](https://codeclimate.com/github/shiftcommerce/shift-circuit-breaker/test_coverage)
+
+# Shift Circuit Breaker
+
+The Shift Circuit Breaker library implements a generic mechanism for detecting, monitoring and controlling external service calls that will most-likely fail at some point (e.g. timeout) and cause request queuing.
+
+Although a plethora of Ruby circuit breaker libraries exist, those that are frequently updated have a dependency on Redis for persistence. We required a solution that did not depend on persisting to a shared data store, i.e. a library that stores counters in local memory. As a result, the Shift Circuit Breaker was born.
+
+Similar to a conventional circuit breaker, when a circuit is closed it allows operations to flow through. When the number of sequential errors exceeds the `error_threshold`, the circuit is then opened for the defined `skip_duration` – no operations are executed and the provided `fallback` is called.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+  $ gem "shift-circuit-breaker"
+```
+
+And then execute:
+
+```
+  $ bundle
+```
+
+Or install it yourself as:
+
+```
+  $ gem install shift-circuit-breaker
+```
+
+## Usage
+
+Example usage is as follows - 
+
+```ruby
+  class MyClass
+    CIRCUIT_BREAKER = Shift::CircuitBreaker.new(:some_identifier, 
+                                                error_threshold: 10, 
+                                                skip_duration: 60, 
+                                                additional_exception_classes: [ 
+                                                  ::Faraday::ClientError
+                                                ]
+                                              )
+
+    def do_something
+      CIRCUIT_BREAKER.call
+        operation: -> { SomeService.new(name: 'test').perform_task },
+        fallback:  -> { [ 1, 2, 3, 4, 5 ].sum }
+    end
+  end
+```
+
+***Note:***  the `operation` and `fallback` should implement the public method `#call` or wrapped in a `Proc/Lambda`.
+
+With regards to monitoring and logging, integration with New Relic and Sentry is included. To enable any of these features, please set the relevant configurations in an initializer (eg. `shift_circuit_breaker.rb`) as follows -
+
+```ruby
+  require "shift/circuit_breaker"
+
+  Shift::CircuitBreaker.configure do |config|
+    config.new_relic_license_key = ENV["NEW_RELIC_LICENSE_KEY"]
+    config.new_relic_app_name    = ENV["NEW_RELIC_APP_NAME"]
+    config.sentry_dsn            = ENV["SENTRY_DSN"]
+    config.sentry_environments   = %w[ production ]
+  end
+```
+
+***Note:*** both integrations can be overriden when instantiating the `Shift::CircuitMonitor` and `Shift::CircuitLogger` services, eg.
+
+```ruby
+  CIRCUIT_BREAKER = Shift::CircuitBreaker.new(:some_identifier, 
+                                              error_threshold: 10, 
+                                              skip_duration: 60, 
+                                              logger: Shift::CircuitBreaker::CircuitLogger.new(remote_logger: CUSTOM_LOGGER),
+                                              monitor: Shift::CircuitBreaker::CircuitMonitor.new(monitor: CUSTOM_MONITOR)
+                                            )
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome. Please read our documentation on [CONTRIBUTING](CONTRIBUTING.md).

data/Rakefile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+# -*- encoding: utf-8 -*-
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task default: %w(spec)

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "shift/circuit_breaker"
+require "irb"
+
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+set -euo pipefail
+
+IFS=$'\n\t'
+
+bundle install

data/config/newrelic.yml

@@ -0,0 +1,28 @@
+# For full documentation of agent configuration options, please refer to
+# https://docs.newrelic.com/docs/agents/ruby-agent/installation-configuration/ruby-agent-configuration
+common: &default_settings
+  license_key: <%= Shift::CircuitBreaker.config.new_relic_license_key  %>
+  app_name: <%= Shift::CircuitBreaker.config.new_relic_app_name  %>
+  agent_enabled: <%= Shift::CircuitBreaker.config.new_relic_license_key.present? %>
+  
+  log_level: info
+  
+  browser_monitoring:
+    auto_instrument: true
+
+development:
+  <<: *default_settings
+
+  developer_mode: true
+  agent_enabled: true
+
+test:
+  <<: *default_settings
+
+  monitor_mode: false
+
+staging:
+  <<: *default_settings
+
+production:
+  <<: *default_settings

data/config/rubocop/.layout_rubocop.yml

@@ -0,0 +1,2 @@
+Layout/DotPosition:
+  EnforcedStyle: trailing

data/config/rubocop/.lint_rubocop.yml

@@ -0,0 +1,47 @@
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Lint/HandleExceptions:
+  Enabled: false
+
+Lint/EndAlignment:
+  Enabled: false
+
+Lint/AmbiguousOperator:
+  Enabled: false
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Lint/ConditionPosition:
+  Enabled: false
+
+Lint/DeprecatedClassMethods:
+  Enabled: false
+
+Lint/ElseLayout:
+  Enabled: false
+
+Lint/HandleExceptions:
+  Enabled: false
+
+Lint/LiteralInInterpolation:
+  Enabled: false
+
+Lint/Loop:
+  Enabled: false
+
+Lint/ParenthesesAsGroupedExpression:
+  Enabled: false
+
+Lint/RequireParentheses:
+  Enabled: false
+
+Lint/UnderscorePrefixedVariableName:
+  Enabled: false
+
+Lint/Void:
+  Enabled: false

data/config/rubocop/.metrics_rubocop.yml

@@ -0,0 +1,39 @@
+Metrics/BlockLength:
+  Exclude:
+    - "Rakefile"
+    - "**/*.rake"
+    - "spec/**/*"
+    - "shift-circuit-breaker.gemspec"
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 150
+
+Metrics/MethodLength:
+  Max: 40
+
+Metrics/ClassLength:
+  Max: 500
+
+Metrics/AbcSize:
+  Max: 50
+
+Metrics/CyclomaticComplexity:
+  Max: 10

data/config/rubocop/.naming_rubocop.yml

@@ -0,0 +1,11 @@
+Naming/AccessorMethodName:
+  Enabled: false
+
+Naming/AsciiIdentifiers:
+  Enabled: false
+
+Naming/FileName:
+  Enabled: false
+
+Naming/HeredocDelimiterNaming:
+  Enabled: false 

data/config/rubocop/.performance_rubocop.yml

@@ -0,0 +1,60 @@
+Performance/CaseWhenSplat:
+  Enabled: true
+
+Performance/Casecmp:
+  Enabled: true
+
+Performance/CompareWithBlock:
+  Enabled: true
+
+Performance/Count:
+  Enabled: true
+
+Performance/Detect:
+  Enabled: true
+
+Performance/DoubleStartEndWith:
+  Enabled: true
+
+Performance/FlatMap:
+  Enabled: true
+
+Performance/HashEachMethods:
+  Enabled: true
+
+Performance/LstripRstrip:
+  Enabled: true
+
+Performance/RangeInclude:
+  Enabled: true
+
+Performance/RedundantBlockCall:
+  Enabled: true
+
+Performance/RedundantMatch:
+  Enabled: true
+
+Performance/RedundantMerge:
+  Enabled: false
+
+Performance/RedundantSortBy:
+  Enabled: true
+
+Performance/ReverseEach:
+  Enabled: true
+
+Performance/Sample:
+  Enabled: true
+
+Performance/Size:
+  Enabled: true
+
+Performance/StartWith:
+  Enabled: true
+
+Performance/StringReplacement:
+  Enabled: true
+
+Performance/TimesMap:
+  Enabled: true
+