cogent-healthcheck 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1ecbf7b77655855e459bb6977bde06dd0657d273
+  data.tar.gz: 337646fd147f89d13b878bf20bbd89b0df54df01
+SHA512:
+  metadata.gz: 8b141840f06a806fc0e3a85d5466dfb24b746234891857f2fab320ad42b3fdefb15794556dd2244e66aa9c6ac887c9b3cfa3764f600b2907da9f3b8f93ea0fdd
+  data.tar.gz: 0b4e45a9738b0b43344086e2a2575d227b1001e95a9551c1ba4690bc4a413f5c2df03253a84c2b562db45ed3cf152583f664f141548160b3f0272da0f7fef466

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Rob Mitchell
+
+MIT License
+
+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,44 @@
+# Healthcheck
+
+Provides a mechanism to add healthchecks to your application as a Rack endpoint.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cogent-healthcheck', require: 'healthcheck'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cogent-healthcheck
+
+## Usage
+Add the gem as a rack app to your config.ru file as follows:
+
+	map '/healthcheck' do
+	  use Cogent::Healthcheck::Check
+	end
+using any endpoint you'd like.
+The default endpoint responds to checks, returning a json list of available checks and their urls. Calling each check will either respond with a 200 if everything is ok, or a 500 with a json representation of the errors.
+
+##Configuration
+Implementing your own checks is easy. Simple create a class that has name and description class methods. The name method is used for the endpoint and is required. Implement an execute method, that either returns a valid response or raises an exception in the case of an error.
+
+Add the check to healthcheck as follows in any config file:
+	Cogent::Healthcheck.configure do |config|
+  	  config.add_check(Salesforce::Check)
+	end
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/healthcheck/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/healthcheck.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'healthcheck/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cogent-healthcheck"
+  spec.version       = Healthcheck::VERSION
+  spec.authors       = ["Rob Mitchell"]
+  spec.email         = ["robm.mitchell@gmail.com"]
+  spec.summary       = %q{Healthcheck gem to expose the health of specific parts of your app}
+  spec.description   = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/healthcheck.rb

@@ -0,0 +1,26 @@
+require "healthcheck/version"
+require 'healthcheck/configuration'
+require 'healthcheck/check'
+Dir.glob(File.join(File.dirname(__FILE__), '/healthcheck/checks/**/*.rb')).each { |r| require r}
+
+module Cogent
+  module Healthcheck
+
+    def self.configure(&block)
+      block.call(self.config)
+    end
+
+    def self.initialize_config
+      return if @config
+      @config = Cogent::Healthcheck::Configuration.new
+      @config.add_check(Cogent::Healthcheck::Checks::Alive)
+    end
+
+    def self.config
+      initialize_config
+      @config
+    end
+
+    initialize_config
+  end
+end

data/lib/healthcheck/check.rb

@@ -0,0 +1,60 @@
+module Cogent
+
+  module Healthcheck
+
+    class Check
+
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        path_info = env['PATH_INFO']
+        if path_info == '/checks'
+          response('200', checks(env).to_json, env)
+        elsif path_info =~ /\/checks\//
+          check_name = path_info.split('/').last
+          check(check_name, env)          
+        else
+          @app.call(env)
+        end
+      end
+
+      private
+      def check(name, env)
+        check = Cogent::Healthcheck.config.checks.find{|check| check.name  == name}
+        begin
+          check.new.execute
+        rescue => e
+          response('500', {error: e.backtrace}.to_json, env)
+        end
+          response('200', '', env)
+      end
+
+      def checks(env)
+        base_uri = [env['rack.url_scheme'], '://',env['HTTP_HOST'], env['REQUEST_PATH']].join
+        checks = Cogent::Healthcheck.config.checks.map do |check|
+          uri = [base_uri, '/', check.name].join
+          {
+            name: check.name,
+            description: check.description,
+            href: uri
+          }
+        end
+      end
+
+      def response(status_code, body, env)
+        content_type = 'application/json'
+        if env['QUERY_STRING'] && env['QUERY_STRING'] =~ /callback/
+          query_string = env['QUERY_STRING'].gsub(/callback=/, '')
+          callback = query_string.split('&')[0]
+          body = "#{callback}(#{body})"
+          content_type = 'application/javascript'
+        end
+        [status_code, {'Content-Type' => content_type}, [body]]
+      end
+    end
+
+  end
+
+end

data/lib/healthcheck/checks/alive.rb

@@ -0,0 +1,31 @@
+module Cogent
+
+	module Healthcheck
+
+    module Checks
+
+      class Alive
+
+        class << self
+          
+          def name
+            'alive'
+          end
+
+          def description
+            'Will always return a 200 to check that the site is alive'
+          end
+
+        end
+
+        def execute
+          true
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/healthcheck/configuration.rb

@@ -0,0 +1,28 @@
+module Cogent
+
+  module Healthcheck
+
+    class Configuration
+
+      attr_reader :checks
+
+      def initialize
+        @checks = []
+      end
+
+      def add_check(check)
+        @checks << check if is_valid?(check)
+      end
+
+      private
+      def is_valid?(check)
+        class_methods = [:name, :description]
+        valid = check.methods & class_methods == class_methods && check.instance_methods.include?(:execute)
+        raise StandardError.new('Check must have name and description class methods as well as an execute instance method') unless valid
+        valid
+      end
+    end
+
+  end
+  
+end

data/lib/healthcheck/version.rb

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

data/spec/healthcheck_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Healthcheck do
+  it 'has a version number' do
+    expect(Healthcheck::VERSION).not_to be nil
+  end
+
+  it "has an alive check by default" do
+    expect(Cogent::Healthcheck.config.checks.first.name).to eql('alive')
+  end
+
+  describe 'configuration' do
+    let(:check) {
+      class Check
+
+        def self.name
+        end
+
+        def self.description
+        end
+
+        def execute
+        end
+      end
+      Check
+    }
+    before do
+      Cogent::Healthcheck.configure do |config|
+        config.add_check(check)
+      end
+    end
+
+    it "allows new checks to be added" do
+      expect(Cogent::Healthcheck.config.checks).to include(check)
+    end
+  end
+    
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'healthcheck'

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: cogent-healthcheck
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rob Mitchell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: ''
+email:
+- robm.mitchell@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- healthcheck.gemspec
+- lib/healthcheck.rb
+- lib/healthcheck/check.rb
+- lib/healthcheck/checks/alive.rb
+- lib/healthcheck/configuration.rb
+- lib/healthcheck/version.rb
+- spec/healthcheck_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Healthcheck gem to expose the health of specific parts of your app
+test_files:
+- spec/healthcheck_spec.rb
+- spec/spec_helper.rb