sinatra-health-check 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 334bafa6e4d41f6204c4b8dd3c85c9ae0bcd7197
+  data.tar.gz: 177f9eb36abcbc83d387f6cf2893d60853bc45e4
+SHA512:
+  metadata.gz: 31e2492861672eb3e93bd0ebfce9ec1ae0c635d74dca19c9b10a85ccb8064cc14eef85aaf6ee57312e91912a5fc99120db96aa8c023f455f131e06b888ef5c93
+  data.tar.gz: 2cc30092da95700d7c10710b0594c97257c162518a0a9030ec364364b7c0466f842746870d3fd5119681615158d4006b051694e8f5423231b3065b36eadd5f4b

data/.cane

@@ -0,0 +1,3 @@
+--style-measure 120
+--color
+--parallel

data/.gitignore

@@ -0,0 +1,7 @@
+.bundle
+.DS_Store
+*.swp
+*.gem
+Gemfile.lock
+vendor
+coverage/

data/.simplecov

@@ -0,0 +1,5 @@
+SimpleCov.start do
+  add_group 'Library', 'lib'
+  add_filter '/vendor'
+  add_filter '/spec'
+end

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.5
+  - 2.2.0
+env:
+  global:
+    - CODECLIMATE_REPO_TOKEN=8143d01ffb9603990dea3670c8286ab5b7fcad8131d1c3c9dfd714134664e7c6
+script: bundle exec rake

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,41 @@
+sinatra-health-check
+====================
+
+[![Gem Version](https://badge.fury.io/rb/sinatra-health-check.svg)](http://badge.fury.io/rb/sinatra-health-check) [![travis-ci](https://travis-ci.org/otto-de/sinatra-health-check.png?branch=master)](https://travis-ci.org/otto-de/sinatra-health-check) [![Code Climate](https://codeclimate.com/github/otto-de/sinatra-health-check/badges/gpa.svg)](https://codeclimate.com/github/otto-de/sinatra-health-check) [![Test Coverage](https://codeclimate.com/github/otto-de/sinatra-health-check/badges/coverage.svg)](https://codeclimate.com/github/otto-de/sinatra-health-check)
+
+This tiny gem adds graceful stop to your sinatra application.
+
+Stopping apps gracefully allows your running requests to finish before killing the app. It gives some time to configure load balancers before shutting things down.
+
+Usage
+-----
+
+Initialize the health check:
+
+```ruby
+require 'sinatra-health-check'
+@checker = SinatraHealthCheck::Checker.new
+```
+
+Then use it inside your health check route:
+
+```ruby
+get "/ping" do
+  if @checker.healthy?
+    "pong"
+  else
+    status 503
+    "unhealthy"
+  end
+end
+```
+
+Contributing
+------------
+
+It's fast and simple: fork + PR.
+
+License
+-------
+
+This program is licensed under the MIT license. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
+
+require 'rake'
+require 'rspec/core/rake_task'
+require 'cane/rake_task'
+
+task :default => [:spec, :quality]
+
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+Cane::RakeTask.new(:quality) do |cane|
+  cane.canefile = '.cane'
+end

data/lib/sinatra-health-check.rb

@@ -0,0 +1,4 @@
+module SinatraHealthCheck
+  require_relative 'sinatra-health-check/version'
+  require_relative 'sinatra-health-check/checker'
+end

data/lib/sinatra-health-check/checker.rb

@@ -0,0 +1,73 @@
+# The application health check.
+# Create an instance and use .health to repond to your health check requests.
+class SinatraHealthCheck::Checker
+
+  DEFAULT_OPTS = {
+    :exit    => true,
+    :health  => true,
+    :logger  => nil,
+    :signals => %w[TERM INT],
+    :timeout => 10,
+    :wait    => 0,
+  }
+
+  require 'thread'
+
+  attr_accessor :health
+  alias :healthy? :health
+
+  # Create a health checker.
+  # Params:
+  # ++exit++: call ++exit++ at the end of ++graceful_stop++
+  # ++health++: initial health state
+  # ++logger++: a logger
+  # ++signals++: array of signals to register a graceful stop handler
+  # ++timeout++: timeout for graceful stop in seconds
+  def initialize(opts = DEFAULT_OPTS)
+    @opts = DEFAULT_OPTS.merge(opts)
+    @health = @opts[:health]
+    trap(@opts[:signals])
+  end
+
+  # Set application to unhealthy state and stop it after wating for ++@timeout++.
+  def graceful_stop
+    # set to unhealthy state
+    unless @stopper
+      # spawn a thread to stop application after a given time
+      @stopper = Thread.new do
+        if @opts[:wait] > 0
+          logger.info "asked to stop application, waiting for #{@opts[:wait]}s before doing so" if logger
+          sleep @opts[:wait]
+        end
+        logger.info "stopping application, waiting for #{@opts[:timeout]}s" if logger
+        @health = false
+        sleep @opts[:timeout]
+        logger.info "exit application" if logger
+        exit if @opts[:exit]
+      end
+    end
+  end
+
+  # Waits for the stopping thread to finish
+  def join
+    @stopper.join if @stopper
+  end
+
+  private
+
+  def logger
+    @opts[:logger]
+  end
+
+  # Register signal handler to stop application gracefully.
+  # Params:
+  # ++signals++: array of signal names
+  def trap(signals)
+    if signals and signals.size > 0
+      logger.info "register graceful stop handler for signals: #{signals.join(', ')}" if logger
+      signals.each do |sig|
+        Signal.trap(sig) { graceful_stop }
+      end
+    end
+  end
+end

data/lib/sinatra-health-check/version.rb

@@ -0,0 +1,3 @@
+module SinatraHealthCheck
+  VERSION = '0.1.0'
+end

data/sinatra-health-check.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/sinatra-health-check/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "sinatra-health-check"
+  gem.version       = SinatraHealthCheck::VERSION
+  gem.authors       = ["Felix Bechstein"]
+  gem.email         = %w{felix.bechstein@otto.de}
+  gem.description   = %q{A simple health check for sinatra applications}
+  gem.summary       = %q{This health check adds graceful stop to your sinatra applications}
+  gem.homepage      = 'https://github.com/otto-de/sinatra-health-check'
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = %w{lib}
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec', '~> 3.0'
+  gem.add_development_dependency 'rspec-its'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'cane'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'codeclimate-test-reporter'
+end

data/spec/sinatra-health-check/checker_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe SinatraHealthCheck::Checker do
+
+  describe '#init, default values' do
+    its(:health) { should == true }
+  end
+
+  describe '#init, custom values' do
+    subject { described_class.new(:timeout => 10, :health => false)}
+    its(:health) { should == false }
+  end
+
+  context '#graceful_stop' do
+    subject { described_class.new(:timeout => 12)}
+
+    it 'gracefully stops the app' do
+      # it's healthy before stopping
+      expect(subject.health).to be_truthy
+
+      expect(subject).to receive(:sleep).ordered.with(12) {
+        if subject.healthy?
+          puts 'health state should be false here'
+          raise Error, 'health state should be false here'
+        end
+      }
+      expect(subject).to receive(:exit).ordered
+      subject.graceful_stop
+      subject.join
+
+      # it's unhealthy after stopping
+      expect(subject.health).to be_falsey
+    end
+  end
+
+  context '#graceful_stop, w/ :wait' do
+    subject { described_class.new(:wait => 5)}
+
+    it 'does not call exit' do
+      expect(subject).to receive(:sleep).ordered.with(5)
+      expect(subject).to receive(:sleep).ordered.with(10)
+      expect(subject).to receive(:exit).ordered
+      subject.graceful_stop
+      subject.join
+    end
+  end
+
+  context '#graceful_stop, w/o exit' do
+    subject { described_class.new(:exit => false)}
+
+    it 'does not call exit' do
+      expect(subject).to receive(:sleep).with(10)
+      expect(subject).not_to receive(:exit)
+      subject.graceful_stop
+      subject.join
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rspec'
+require 'rspec/its'
+require 'simplecov'
+require 'codeclimate-test-reporter'
+require 'sinatra-health-check'
+
+CodeClimate::TestReporter.start
+
+RSpec.shared_context "local paths" do
+  def project_dir
+    File.expand_path(File.join(File.dirname(__FILE__), '..'))
+  end
+end
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |c|
+  c.mock_with :rspec
+  c.color = true
+  c.formatter = :documentation
+  c.tty = true
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-health-check
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Felix Bechstein
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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: rspec-its
+  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: 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: cane
+  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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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'
+description: A simple health check for sinatra applications
+email:
+- felix.bechstein@otto.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".cane"
+- ".gitignore"
+- ".simplecov"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- lib/sinatra-health-check.rb
+- lib/sinatra-health-check/checker.rb
+- lib/sinatra-health-check/version.rb
+- sinatra-health-check.gemspec
+- spec/sinatra-health-check/checker_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/otto-de/sinatra-health-check
+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.4.3
+signing_key: 
+specification_version: 4
+summary: This health check adds graceful stop to your sinatra applications
+test_files:
+- spec/sinatra-health-check/checker_spec.rb
+- spec/spec_helper.rb