mini_check 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,4 @@
 ---
-SHA1:
-  metadata.gz: 20ef9ea5afbc7e220b1e81163a628c15267ae813
-  data.tar.gz: 5d4cdbf4c58aaa06595f0d3a7e239a3a8fee0de2
 SHA512:
-  metadata.gz: e5c6612eb00859f651ac8c40caeda10379651e323dd88ab6ebbca6e15223ab9dc72c45aeae31995990284ecc39951b964c60d370377ac10c623aa3c8148d5f59
-  data.tar.gz: 35521fa95e56d56b3ba71fd8dde9ac053a660369cba356c2909a6b7ab89fdd370b7215f68361f3e01d11f97bb2fd4f81a1f619f4965fa299f54165113b7c6a3d
+  metadata.gz: 83267501018ff124cfca7c5ba8c3744e0fe7ba9c5aea728ac4e0f45290726d71c35b2eec8d9943f60d8d25e5463e511f7081f3fe4fbb6cf08afbe4ed6b45af4b
+  data.tar.gz: a9eaa048760beafe2a288d36e02198457d696d47d9efc9f5f36c995b17fd840905529296fcbc9d4272f0867d4a0765836c415a1ab342712d30db272f4aa4f57d

data/.travis.yml

@@ -4,7 +4,9 @@ rvm:
   - jruby-19mode
   - 2.0.0
   - 2.1.0
+  - 2.2.0
+  - 2.3.0
 cache: bundler
-addons:
-  code_climate:
-    repo_token: f85fa0b767dbe803b9dba53e89c729db785240245aac0e17f88462581596bc93
+before_install:
+  - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
+  - gem install bundler -v '< 2'

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+## 0.4.1, release 2019-01-27
+
+* Fixed broken build due Rake upgrade.
+* Removed Code Climate as current implementation is being deprecated.
+* Removed warning messages when running the tests.
+* No code changes were made.
+
+## 0.4.0
+
+* Times on checks and slight refactor
+
+## 0.3.0
+
+* Extend gem to support mounting a new endpoint to provide versioning info.
+
+## 0.2.0
+
+* Added support for middleware mounting.
+
 ## 0.1.1, release 2014-03-22
 
 * Supporting Travis CI and Code Climate

data/Gemfile

@@ -4,8 +4,8 @@ gemspec
 
 group :test, :development do
   gem 'rake'
-  gem 'rspec', '~> 2.14.0'
+  gem 'rspec', '~> 3.0'
   gem 'pry'
   gem 'rack-test'
-  gem 'codeclimate-test-reporter', require: false
+  gem 'rack', '~> 1.0'
 end

data/README.md

@@ -2,11 +2,10 @@
 
 MiniCheck provides a simple Rack application for adding simple health checks to your app.
 The JSON output is similar to the one provided by the [Metrics](http://metrics.codahale.com/) Java library.
-It was started at [Workshare ltd.](http://www.workshare.com) as an easy way of providing monitoring to our Rack based applciations.
+It was started at [Workshare ltd.](http://www.workshare.com) as an easy way of providing monitoring to our Rack based applications.
 
 [![Gem Version](https://badge.fury.io/rb/mini_check.png)](http://badge.fury.io/rb/mini_check)
-[![Build Status](https://secure.travis-ci.org/workshare/mini-check.png)](http://travis-ci.org/workshare/mini-check) 
-[![Code Climate](https://codeclimate.com/github/workshare/mini-check.png)](https://codeclimate.com/github/workshare/mini-check)
+[![Build Status](https://secure.travis-ci.org/workshare/mini-check.png)](http://travis-ci.org/workshare/mini-check)
 
 ## Quick Start
 
@@ -31,10 +30,12 @@ If you now visit `http://localhost:XXXX/healthcheck` you should get something li
 ```json
 {
   "health.db_connection": {
-    "healthy": true
+    "healthy": true,
+    "time": 0.111403303
   },
   "health.redis_client": {
-    "healthy": true
+    "healthy": true,
+    "time": 4.41e-05
   }
 }
 ```
@@ -56,11 +57,13 @@ The registered lambdas should do any of the following things:
         "/home/manuel/sd/my_app/vendor/bundle/ruby/1.9.1/gems/sequel-4.7.0/lib/sequel/adapters/mysql2.rb:77:in `block in _execute'",
         "/home/manuel/sd/my_app/vendor/bundle/ruby/1.9.1/gems/sequel-4.7.0/lib/sequel/database/logging.rb:37:in `log_yield'",
         "..."
-      ]
+      ],
+      "time": 4.61e-05
     }
   },
   "health.redis_client": {
-    "healthy": true
+    "healthy": true,
+    "time": 1.23e-04
   }
 }
 ```
@@ -96,7 +99,7 @@ If you now visit `http://localhost:XXXX/admin/version` you should get something
 
 ## Maintaining
 
-Here is a good tutorial on this: 
+Here is a good tutorial on this:
 [Developing a RubyGem using Bundler](https://github.com/radar/guides/blob/master/gem-development.md).
 
 ## License

data/lib/mini_check/check.rb

@@ -1,8 +1,11 @@
+require 'benchmark'
+
 module MiniCheck
   class Check
     attr_accessor :name
     attr_accessor :healthy
     attr_accessor :action
+    attr_accessor :time
     attr_accessor :exception
 
     def initialize args = {}, &block
@@ -17,24 +20,31 @@ module MiniCheck
     end
 
     def run
-      begin
-        self.healthy = action.call
-        self.exception = nil
-      rescue Exception => e
-        self.healthy = false
-        self.exception = e
-      end
+      self.time = Benchmark.measure do
+        begin
+          do_run
+          self.exception = nil
+        rescue Exception => e
+          self.healthy = false
+          self.exception = e
+        end
+      end.real
     end
 
     def to_hash
       {}.tap do |h|
         h[:healthy] = healthy?
+        h[:time] = time
         h[:error] = error_hash if exception
       end
     end
 
     private
 
+    def do_run
+      self.healthy = action.call
+    end
+
     def error_hash
       {
         message: exception.message,

data/lib/mini_check/rack_app.rb

@@ -3,6 +3,11 @@ module MiniCheck
     attr_accessor :checks
     attr_accessor :path
 
+    CONTENT_TYPE_HEADER = 'Content-Type'.freeze
+    JSON_MIME_TYPE = 'application/json'.freeze
+    REQUEST_METHOD = 'REQUEST_METHOD'.freeze
+    PATH_INFO = 'PATH_INFO'.freeze
+
     def initialize args = {}
       set_attributes args
     end
@@ -12,10 +17,10 @@ module MiniCheck
     end
 
     def call env
-      case "#{env['REQUEST_METHOD']} #{env['PATH_INFO']}"
+      case "#{env[REQUEST_METHOD]} #{env[PATH_INFO]}"
       when "GET #{path}"
         checks.run
-        [status, headers, [body]]
+        [status, default_headers, [body]]
       else
         host_app.call(env)
       end
@@ -26,23 +31,23 @@ module MiniCheck
     end
 
     def new(app)
-      copy = self.dup
-      copy.host_app = app
-      copy
+      dup.tap do |copy|
+        copy.host_app = app
+      end
     end
 
     private
 
+    def default_headers
+      { CONTENT_TYPE_HEADER => JSON_MIME_TYPE }
+    end
+
     def set_attributes args = {}
       args.each do |k,v|
         send("#{k}=", v)
       end
     end
 
-    def headers
-      {'Content-Type' => 'application/json'}
-    end
-
     def body
       checks.to_hash.to_json
     end
@@ -56,7 +61,7 @@ module MiniCheck
     attr_accessor :host_app
 
     def host_app
-      @host_app ||= lambda{|env|  [404, {}, []]}
+      @host_app ||= lambda { |env|  [404, {}, []] }
     end
   end
 end

data/lib/mini_check/version.rb

@@ -1,3 +1,3 @@
 module MiniCheck
-  VERSION = '0.3.0'
+  VERSION = '0.4.1'.freeze
 end

data/lib/mini_check/version_rack_app.rb

@@ -4,16 +4,23 @@ module MiniCheck
   class VersionRackApp
     attr_accessor :path, :build_file
 
+    REQUEST_METHOD = 'REQUEST_METHOD'.freeze
+    PATH_INFO = 'PATH_INFO'.freeze
+    APP_KEY = 'Application Name'.freeze
+    CONTENT_TYPE_HEADER = 'Content-Type'.freeze
+    JSON_MIME_TYPE = 'application/json'.freeze
+    TEXT_MIME_TYPE = 'text/plain'.freeze
+
     def initialize args = {}
       set_attributes args
     end
-    
+
     def metadata
       @metadata ||= Hash.new
     end
-    
+
     def call env
-      case "#{env['REQUEST_METHOD']} #{env['PATH_INFO']}"
+      case "#{env[REQUEST_METHOD]} #{env[PATH_INFO]}"
       when "GET #{path}.json"
         JsonResponse.render(output_hash)
       when "GET #{path}"
@@ -33,7 +40,7 @@ module MiniCheck
     private
 
     def name= name
-      metadata["Application Name"] = name
+      metadata[APP_KEY] = name
     end
 
     def set_attributes args = {}
@@ -41,47 +48,76 @@ module MiniCheck
         send("#{k}=", v)
       end
     end
-    
+
     def output_hash
       metadata.merge(file_hash)
     end
-    
+
     def file_hash
-      if (content = YAML.load_file(build_file)).instance_of?(Hash)
+      if (content = file_content(build_file)).instance_of?(Hash)
         content
       else
-        content = IO.read(build_file).split("\n")
+        content = raw_file_content(build_file).split("\n")
         Hash[content.map{ |pair| pair.split("=") }]
       end
     rescue => ex
       { error: ex.message }
     end
-    
-    
+
+    def self.file_content(build_file)
+      @file_content ||= YAML.load_file(build_file)
+    end
+
+    def self.raw_file_content(build_file)
+      @raw_file_content ||= IO.read(build_file)
+    end
+
+    def file_content(build_file)
+      self.class.file_content(build_file)
+    end
+
+    def raw_file_content(build_file)
+      self.class.raw_file_content(build_file)
+    end
+
     protected
 
     attr_accessor :host_app
 
     def host_app
-      @host_app ||= lambda{|env|  [404, {}, []]}
+      @host_app ||= lambda { |env|  [404, {}, []] }
     end
-    
-    
+
+
     class JsonResponse
-      def self.render hash
-        [200, {'Content-Type' => 'application/json'}, [hash.to_json]]
+      class << self
+        def render hash
+          [200, default_headers, [hash.to_json]]
+        end
+
+        private
+
+        def default_headers
+          { CONTENT_TYPE_HEADER => JSON_MIME_TYPE }
+        end
       end
     end
-    
+
     class PlainTextResponse
-      def self.render hash
-        [200, {'Content-Type' => 'text/plain'}, [parse(hash)]]
-      end
-      
-      private
-      
-      def self.parse hash
-        hash.map{ |key,value| "#{key}=#{value}" }.join("\n")
+      class << self
+        def render hash
+          [200, default_headers, [parse(hash)]]
+        end
+
+        private
+
+        def parse hash
+          hash.map{ |key,value| "#{key}=#{value}" }.join("\n")
+        end
+
+        def default_headers
+          { CONTENT_TYPE_HEADER => TEXT_MIME_TYPE }
+        end
       end
     end
   end

data/mini_check.gemspec

@@ -18,6 +18,6 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
-  spec.add_runtime_dependency 'json'
+  spec.add_development_dependency 'bundler'
+  spec.add_runtime_dependency 'json', '~> 1'
 end

data/spec/helper.rb

@@ -13,15 +13,11 @@ require 'rspec'
 require 'pry'
 
 RSpec.configure do |config|
-   config.color_enabled = true
    config.tty = true
-   config.formatter = :documentation # :documentation, :progress, :html, :textmate
+   config.formatter = :documentation
 end
 
 $LOAD_PATH.unshift File.expand_path('lib')
 require 'mini_check'
 
 $LOAD_PATH.unshift File.expand_path('spec/support')
-
-require 'codeclimate-test-reporter'
-CodeClimate::TestReporter.start

data/spec/mini_check/check_spec.rb

@@ -1,10 +1,10 @@
 require_relative '../helper'
 
 shared_examples_for 'check' do
-  it{ should respond_to(:to_hash) }
-  it{ should respond_to(:name) }
-  it{ should respond_to(:healthy?) }
-  it{ should respond_to(:run) }
+  it{ is_expected.to respond_to(:to_hash) }
+  it{ is_expected.to respond_to(:name) }
+  it{ is_expected.to respond_to(:healthy?) }
+  it{ is_expected.to respond_to(:run) }
 end
 
 describe MiniCheck::Check do
@@ -17,7 +17,7 @@ describe MiniCheck::Check do
 
   describe 'initialize' do
     it 'allows passing attributes as a hash' do
-      check = MiniCheck::Check.new name: name, action: action 
+      check = MiniCheck::Check.new name: name, action: action
       expect(check.name).to eq(name)
       expect(check.action).to eq(action)
     end
@@ -32,7 +32,7 @@ describe MiniCheck::Check do
 
   describe 'run' do
     it 'calls the action' do
-      action.should receive(:call)
+      expect(action).to receive(:call)
       subject.run
     end
 
@@ -92,6 +92,10 @@ describe MiniCheck::Check do
   end
 
   describe 'to_hash' do
+    before do
+      allow_any_instance_of(Benchmark::Tms).to receive(:real).and_return(1.0)
+    end
+
     context 'when the run was successful' do
       before :each do
         allow(action).to receive(:call).and_return(Object.new)
@@ -99,7 +103,7 @@ describe MiniCheck::Check do
 
       it 'returns the basic healthy hash' do
         subject.run
-        expect(subject.to_hash).to eq(healthy: true)
+        expect(subject.to_hash).to eq(healthy: true, time: 1.0)
       end
     end
 
@@ -110,13 +114,13 @@ describe MiniCheck::Check do
 
       it 'returns the basic healthy hash' do
         subject.run
-        expect(subject.to_hash).to eq(healthy: false)
+        expect(subject.to_hash).to eq(healthy: false, time: 1.0)
       end
     end
 
     context 'when the action raises an exception' do
       before :each do
-        exception.stub(backtrace: ['a'])
+        allow(exception).to receive(:backtrace).and_return ['a']
         allow(action).to receive(:call).and_raise(exception)
       end
 
@@ -124,11 +128,12 @@ describe MiniCheck::Check do
         subject.run
         expect(subject.to_hash).to eq(
           {
-            :healthy => false,
-            :error => {
-              :message => exception.message,
-              :stack => exception.backtrace,
-            }
+            healthy: false,
+            error: {
+              message: exception.message,
+              stack: exception.backtrace
+            },
+            time: 1.0
           }
         )
       end

data/spec/mini_check/checks_collection_spec.rb

@@ -1,10 +1,10 @@
 require_relative '../helper'
 
 shared_examples_for 'checks collection' do
-  it{ should respond_to(:to_hash) }
-  it{ should respond_to(:healthy?) }
-  it{ should respond_to(:<<) }
-  it{ should respond_to(:run) }
+  it{ is_expected.to respond_to(:to_hash) }
+  it{ is_expected.to respond_to(:healthy?) }
+  it{ is_expected.to respond_to(:<<) }
+  it{ is_expected.to respond_to(:run) }
 end
 
 describe MiniCheck::ChecksCollection do
@@ -18,7 +18,7 @@ describe MiniCheck::ChecksCollection do
     @name_counter ||= 0
     stubs[:name] = "name_#{@name_counter += 1}"
     stubs.merge! args
-    
+
     double(stubs[:name], stubs)
   end
 

data/spec/mini_check/rack_app_spec.rb

@@ -28,7 +28,7 @@ describe MiniCheck::RackApp do
   describe :call do
     it 'returns status, headers, body' do
       get '/'
-      expect(status).to be_a(Fixnum)
+      expect(status).to be_a(Integer)
       expect(headers).to be_a(Hash)
       expect(body).to be_a(String)
     end

data/spec/mini_check/version_rack_app_spec.rb

@@ -28,7 +28,7 @@ describe MiniCheck::VersionRackApp do
   describe :call do
     it 'returns status, headers, body' do
       get '/'
-      expect(status).to be_a(Fixnum)
+      expect(status).to be_a(Integer)
       expect(headers).to be_a(Hash)
       expect(body).to be_a(String)
     end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: mini_check
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Manuel Morales
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-16 00:00:00.000000000 Z
+date: 2019-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
 description: MiniCheck provides a simple Rack application for adding simple health
   checks to your app.
 email:
@@ -87,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: MiniCheck provides a simple Rack application for adding simple health checks
@@ -100,4 +100,3 @@ test_files:
 - spec/mini_check/version_rack_app_spec.rb
 - spec/mini_check_spec.rb
 - spec/support/build.yml
-has_rdoc: