service_jynx 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 32660d4e2cf251e609d2bc945d5872a56f921386
+  data.tar.gz: 6f1f999edb6108361c6105dced1c2ced1e22c382
+SHA512:
+  metadata.gz: 0ac8fd3e814b6b26bfa1f5f176257d5541a3bedfecbf3c3e61e5d02743248f2a870cdac7b99d91c5e971999833a375bfbd063149d677e8ae9e5e5de622294b13
+  data.tar.gz: c800ab4f465a5f3bc97fc6711dbdf215a7483b1994f22e37c219e1b83b1ebc65ba7df5db06a995a5f64cdd570e295a3120d541e81cd6f350568ce7a4a0c069e2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-gemset

@@ -0,0 +1 @@
+jynx_gemset

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p247

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'rspec'
+  gem 'pry'
+  gem 'pry-debugger'
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Avner Cohen
+
+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,52 @@
+# Service-Jynx
+
+Eurasian Wryneck - ***Jynx torquilla***
+
+![Eurasian Wryneck](jynx.jpg)
+
+**Jinx** - ***A condition or period of bad luck that appears to have been caused by a specific person or thing.***
+
+A simple (yet powerfull) solution, to allow a Ruby application to manage automatic failover and block calls to an external service and return a stubbed data when service is reported as down.
+
+The code is MRI depended and is not thread safe, is is also designed specifically to run on a single VM and manage in memory hashes of data, though it can very well be executed with an external shared persistance counters such as, say, Redis.
+
+
+````ruby
+
+  if ServiceJynx.alive?(:amazon_s3_service)
+     begin
+       HttpParty.get "s3://bucke:username@password/whatever.jpg"
+     rescue ResponseError => e
+      ServiceJynx.failure!(:amazon_s3_service)
+     end
+  else
+    "S3 is currently unreachable"
+  end
+
+````
+
+## Defaults
+
+Defined when registering a service:
+
+***time_window_in_seconds***: **10**
+
+***max_errors***: **40**
+
+***grace_period***: **360**
+
+
+Defaults means that *40 errors* during *10 seconds*	would turn the service automatically off, for 5 minutes.
+
+## Methods
+
+````ruby
+
+ServiceJynx.register!(:name, {time_window_in_seconds: 360,  max_errors: 40})
+ServiceJynx.alive?(:name)
+ServiceJynx.failure!(:name)
+ServiceJynx.down!(:name)
+ServiceJynx.up!(:name)
+
+````
+

data/lib/logger_jynx.rb

@@ -0,0 +1,21 @@
+module LoggerJynx
+  def self.logger
+    @logger ||= (rails_logger || default_logger)
+  end
+
+  def self.rails_logger
+    (defined?(Rails) && Rails.respond_to?(:logger) && Rails.logger) ||
+    (defined?(RAILS_DEFAULT_LOGGER) && RAILS_DEFAULT_LOGGER.respond_to?(:debug) && RAILS_DEFAULT_LOGGER)
+  end
+
+  def self.default_logger
+    require 'logger'
+    l = Logger.new(STDOUT)
+    l.level = Logger::INFO
+    l
+  end
+
+  def self.logger=(logger)
+    @logger = logger
+  end
+end

data/lib/service_jynx/version.rb

@@ -0,0 +1,3 @@
+module ServiceJynx
+  VERSION = "0.0.1"
+end

data/lib/service_jynx.rb

@@ -0,0 +1,85 @@
+require "service_jynx/version"
+
+module ServiceJynx
+
+  @counters = {}
+  def self.counters
+    @counters
+  end
+
+  def self.register!(name, options = {})
+    @counters[name] = Jynx.new(name, options)
+  end  
+
+  def self.flush!
+    @counters = {}
+  end
+
+  def self.alive?(name)
+    @counters[name].alive? == true
+  end
+
+  def self.down!(name, reason)
+    @counters[name].down!(reason)
+  end
+
+  def self.up!(name)
+    @counters[name].up!
+  end
+
+  def self.failure!(name)
+    jynx = @counters[name]
+    now = Time.now.to_i
+    jynx.errors << now
+    jynx.clean_aged(now)
+    down!(name, "Max error count (#{jynx.max_errors}) reached at #{Time.now}.") if jynx.errors.count > jynx.max_errors
+  end
+
+
+  class Jynx
+    attr_accessor :errors, :name, :time_window_in_seconds, :max_errors, :alive, :down_at, :grace_period
+    def initialize(name, options)
+      @name = name
+      @down_at = 0
+      @alive = true
+      @errors = []
+      opts = {
+        time_window_in_seconds: 10,
+        max_errors: 40,
+        grace_period: 360
+        }.merge!(options)
+      @time_window_in_seconds = opts[:time_window_in_seconds]
+      @max_errors = opts[:max_errors]
+      @grace_period = opts[:grace_period]
+    end
+
+    ## clean up errors that are older than time_window_in_secons
+    def clean_aged(time_now)
+      near_past = time_now - @time_window_in_seconds
+      @errors = @errors.reverse.select{|time_stamp| time_stamp  > near_past }.reverse.to_a
+    end
+
+    def down!(reason)
+      @alive = false
+      @down_at = Time.now.to_i
+      LoggerJynx.logger.error "Shutting down [#{@name}] #{reason} at #{@down_at}."      
+    end
+
+    def up!
+      LoggerJynx.logger.error "Upping [#{@name}]."      
+      @alive = true
+      @down_at = 0
+    end
+
+    def alive?
+      return true if @alive
+      near_past = Time.now.to_i - @grace_period
+      up! if (@down_at < near_past) and return true
+      false
+    end
+
+  end
+
+
+
+end

data/run_test

@@ -0,0 +1 @@
+rspec ./spec/**.*

data/service_jynx.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'service_jynx/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "service_jynx"
+  spec.version       = ServiceJynx::VERSION
+  spec.authors       = ["Avner Cohen"]
+  spec.email         = ["israbirding@gmail.com"]
+  spec.summary       = %q{Use errors count over sliding windows to block calls to an external service or method, or whatever.}
+  spec.description   = %q{Use errors count over sliding windows to block calls to an external service or method, or whatever.}
+  spec.homepage      = "https://github.com/AvnerCohen/service-jynx"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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"]
+
+end

data/spec/service_jynx_spec.rb

@@ -0,0 +1,104 @@
+require 'spec_helper'
+
+# Add when debugging
+# require 'pry'
+# require 'pry-debugger'
+
+describe ServiceJynx do
+  before(:all) do
+    ServiceJynx.flush!
+  end
+
+
+  it "should add new services to counter when registerd" do
+    jynx = ServiceJynx.counters.fetch(:dummy_service, :ServiceNotFound)
+    jynx.should eq(:ServiceNotFound)
+    ServiceJynx.register!(:dummy_service)
+    jynx = ServiceJynx.counters.fetch(:dummy_service)
+    jynx.errors == 0
+  end
+
+  it "should allow registering with options" do
+    ServiceJynx.register!(:dummy_service, {max_errors: 5})
+    jynx = ServiceJynx.counters.fetch(:dummy_service, :ServiceNotFound)
+    jynx.max_errors.should eq(5)
+  end
+
+  it "should allow checking if service is alive" do
+    ServiceJynx.register!(:dummy_service)
+    ServiceJynx.alive?(:dummy_service).should eq(true)
+  end
+
+  it "should allow shutting down a service" do
+    ServiceJynx.register!(:dummy_service)
+    ServiceJynx.alive?(:dummy_service).should eq(true)
+    ServiceJynx.down!(:dummy_service, "Because of testing")
+    ServiceJynx.alive?(:dummy_service).should eq(false)
+  end
+
+  it "should allow upping a service" do
+    ServiceJynx.register!(:dummy_service)
+    ServiceJynx.alive?(:dummy_service).should eq(true)
+    ServiceJynx.down!(:dummy_service, "Because of testing")
+    ServiceJynx.alive?(:dummy_service).should eq(false)
+    ServiceJynx.up!(:dummy_service)
+    ServiceJynx.alive?(:dummy_service).should eq(true)
+  end
+
+  it "should allow marking a failure" do
+    ServiceJynx.register!(:dummy_service)
+    jynx = ServiceJynx.counters.fetch(:dummy_service)
+    jynx.errors.length.should eq(0)
+    ServiceJynx.failure!(:dummy_service)
+    jynx.errors.length.should eq(1)
+  end
+
+  it "should allow marking multiple failures" do
+    ServiceJynx.register!(:dummy_service)
+    jynx = ServiceJynx.counters.fetch(:dummy_service)
+    jynx.errors.length.should eq(0)
+    10.times {ServiceJynx.failure!(:dummy_service)}
+    jynx.errors.length.should eq(10)
+  end
+
+  it "should allow overrding defaults" do
+    ServiceJynx.register!(:dummy_service, {time_window_in_seconds: 999})
+    jynx = ServiceJynx.counters.fetch(:dummy_service)
+    jynx.time_window_in_seconds.should eq(999)
+  end
+
+  it "should clean old errors" do
+    ServiceJynx.register!(:dummy_service, {time_window_in_seconds: 2})
+    jynx = ServiceJynx.counters.fetch(:dummy_service)
+    jynx.errors.length.should eq(0)
+    10.times {ServiceJynx.failure!(:dummy_service)}
+    jynx.errors.length.should eq(10)
+    sleep 5 ## make sure aged errors are cleaned
+    10.times {ServiceJynx.failure!(:dummy_service)}
+    jynx.errors.length.should eq(10)
+  end
+
+  it "should auto disable when errors limit reached old errors" do
+    ServiceJynx.register!(:dummy_service, {time_window_in_seconds: 2, max_errors: 20})
+    jynx = ServiceJynx.counters.fetch(:dummy_service)
+    ServiceJynx.alive?(:dummy_service).should eq(true)
+    10.times {ServiceJynx.failure!(:dummy_service)}
+    ServiceJynx.alive?(:dummy_service).should eq(true)
+    11.times {ServiceJynx.failure!(:dummy_service)}
+    ServiceJynx.alive?(:dummy_service).should eq(false)
+  end 
+
+  it "should auto disable when errors limit reached old errors and restart again when grace period passes" do
+    ServiceJynx.register!(:dummy_service, {time_window_in_seconds: 2, max_errors: 20, grace_period: 5})
+    jynx = ServiceJynx.counters.fetch(:dummy_service)
+    ServiceJynx.alive?(:dummy_service).should eq(true)
+    10.times {ServiceJynx.failure!(:dummy_service)}
+    ServiceJynx.alive?(:dummy_service).should eq(true)
+    11.times {ServiceJynx.failure!(:dummy_service)}
+    ServiceJynx.alive?(:dummy_service).should eq(false)
+    sleep 7
+    ServiceJynx.alive?(:dummy_service).should eq(true)
+  end 
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'rspec'
+
+Dir["#{File.dirname(__FILE__)}/../lib/**/*.rb"].each { |f| load(f)  }

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: service_jynx
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Avner Cohen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-02 00:00:00.000000000 Z
+dependencies: []
+description: Use errors count over sliding windows to block calls to an external service
+  or method, or whatever.
+email:
+- israbirding@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- jynx.jpg
+- lib/logger_jynx.rb
+- lib/service_jynx.rb
+- lib/service_jynx/version.rb
+- run_test
+- service_jynx.gemspec
+- spec/service_jynx_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/AvnerCohen/service-jynx
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Use errors count over sliding windows to block calls to an external service
+  or method, or whatever.
+test_files:
+- spec/service_jynx_spec.rb
+- spec/spec_helper.rb