wellness 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4dfb06c69ae9ad383213314a083e3d45f29494bc
-  data.tar.gz: da02f76f57427872ec6aee0758f47f888cd22aa0
+  metadata.gz: 3b9c9d8b20440639156bfee90743eddc5ba49188
+  data.tar.gz: bc55f4040c571be2d5b4d15557b1dcdcfb6f66e2
 SHA512:
-  metadata.gz: 2b0bbb5258a83a3c434857e6f1625c1e957937a2db2af93f4de2f24298ef736ad8f4f2757c3f74858c84d0384f80e185653810242cc928723109993c3c9fbdca
-  data.tar.gz: 8ea9833a6380a18562e24c752b0a21f8a932279c2a793ed4c653b1f04c3394f4f6c61dd260645c02ef0e349252e8648f3586eec1208e37333fc47b75f7eae97d
+  metadata.gz: d11e691c8048d2f2a61fb5d5abfc19ed38d62f2cb5d5153cb3ac87a433dd675bc069c2cd05dd37e53cbdfe47bf8b3d9e4289cea1869922b44ea6c9a4a0171a9f
+  data.tar.gz: 68080655a8da97463ba809c5e4dd9a93a13cae97b2aff071f328a7b9fc20fabaad1dd447c49ba72615ba42bf2d958bc04716799135100120c03ee194c5255407

data/.travis.yml

@@ -4,6 +4,3 @@ rvm:
  - 1.9.3
 notifications:
   irc: "chat.freenode.net#warmwaffles"
-env:
-  - CODECLIMATE_REPO_TOKEN=6212f00d1b8f97c85cf1e6478e12dafbb7325b3b51c6a3979aea7ea55e619c03
-  - CODECLIMATE_REPO_TOKEN=6212f00d1b8f97c85cf1e6478e12dafbb7325b3b51c6a3979aea7ea55e619c03

data/README.md

@@ -1,8 +1,7 @@
 # Wellness
 
 [![Build Status](https://travis-ci.org/warmwaffles/wellness.png?branch=master)](https://travis-ci.org/warmwaffles/wellness)
-[![Code Climate](https://codeclimate.com/repos/52d700d0e30ba038a9003919/badges/057ded44ac30dfe1950e/gpa.png)](https://codeclimate.com/repos/52d700d0e30ba038a9003919/feed)
-
+[![Code Climate](https://codeclimate.com/github/warmwaffles/wellness.png)](https://codeclimate.com/github/warmwaffles/wellness)
 
 A rack middleware library that adds a health check to your service. It comes
 with pre made services and has the option and flexibility for you to make your

data/lib/wellness/middleware.rb

@@ -1,5 +1,3 @@
-require 'json'
-
 module Wellness
   # This is to be put into the Rack environment.
   #

data/lib/wellness/services/base.rb

@@ -2,29 +2,44 @@ module Wellness
   module Services
     # @author Matthew A. Johnston
     class Base
+      attr_reader :params
+
+      # Load dependencies when the class is loaded. This makes putting requires
+      # at the top of the file unnecessary. It plays nicely with the
+      # auto loader.
+      def self.dependency
+        yield if block_given?
+      end
+
+      # @param params [Hash]
       def initialize(params={})
         @params = params
         @health = false
+        @mutex = Mutex.new
       end
 
       # Flags the check as failed
+      # @return [FalseClass]
       def failed_check
-        @health = false
+        @mutex.synchronize do
+          @health = false
+        end
       end
 
       # Flags the check as passed
+      # @return [TrueClass]
       def passed_check
-        @health = true
-      end
-
-      def params
-        @params.dup
+        @mutex.synchronize do
+          @health = true
+        end
       end
 
       # Returns true if the service is healthy, otherwise false
-      # @return [Boolean]
+      # @return [TrueClass,FalseClass]
       def healthy?
-        !!@health
+        @mutex.synchronize do
+          !!@health
+        end
       end
 
       # @return [Hash]
@@ -39,7 +54,9 @@ module Wellness
 
       # @return [Hash]
       def last_check
-        @last_check || {}
+        @mutex.synchronize do
+          @last_check ||= {}
+        end
       end
     end
   end

data/lib/wellness/services/postgres_service.rb

@@ -1,10 +1,11 @@
-require 'pg'
-require 'wellness/services/base'
-
 module Wellness
   module Services
     # @author Matthew A. Johnston
-    class PostgresService < Wellness::Services::Base
+    class PostgresService < Base
+      dependency do
+        require('pg')
+      end
+
       def check
         case ping
         when PG::Constants::PQPING_NO_ATTEMPT

data/lib/wellness/services/redis_service.rb

@@ -1,9 +1,6 @@
-require 'redis'
-require 'wellness/services/base'
-
 module Wellness
   module Services
-    class RedisService < Wellness::Services::Base
+    class RedisService < Base
       KEYS = [
         'used_memory_human',
         'connected_clients',
@@ -21,8 +18,12 @@ module Wellness
         'uptime_in_days'
       ]
 
+      dependency do
+        require('redis')
+      end
+
       def check
-        client = Redis.new(self.params)
+        client = build_client
         details = client.info.select { |k, _| KEYS.include?(k) }
 
         passed_check
@@ -39,6 +40,10 @@ module Wellness
           }
         }
       end
+
+      def build_client
+        Redis.new(self.params)
+      end
     end
   end
 end

data/lib/wellness/services/sidekiq_service.rb

@@ -1,13 +1,14 @@
-require 'redis'
-require 'sidekiq'
-require 'wellness/services/base'
-
 module Wellness
   module Services
     # @author Matthew A. Johnston
-    class SidekiqService < Wellness::Services::Base
+    class SidekiqService < Base
       KEYS = %w(redis_stats uptime_in_days connected_clients used_memory_human used_memory_peak_human)
 
+      dependency do
+        require 'redis'
+        require 'sidekiq'
+      end
+
       def check
         sidekiq_stats = Sidekiq::Stats.new
         queue = Sidekiq::Queue.new

data/lib/wellness/services.rb

@@ -0,0 +1,8 @@
+module Wellness
+  module Services
+    autoload :Base,            'wellness/services/base'
+    autoload :PostgresService, 'wellness/services/postgres_service'
+    autoload :RedisService,    'wellness/services/redis_service'
+    autoload :SidekiqService,  'wellness/services/sidekiq_service'
+  end
+end

data/lib/wellness.rb

@@ -1,7 +1,9 @@
+require 'json'
+
 module Wellness
-end
+  VERSION = '0.2.3'
 
-require 'wellness/version'
-require 'wellness/services/base'
-require 'wellness/system'
-require 'wellness/middleware'
+  autoload :Services,   'wellness/services'
+  autoload :Middleware, 'wellness/middleware'
+  autoload :System,     'wellness/system'
+end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
-require "codeclimate-test-reporter"
-CodeClimate::TestReporter.start
+require 'simplecov'
+SimpleCov.start do
+  add_group('Services', 'wellness/services')
+end
 
 require 'rspec'
 require 'wellness'
-

data/spec/wellness/services/base_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe Wellness::Services::Base do
+  let(:params) { { test: 'data' } }
+  let(:service) { described_class.new(params) }
+  describe '#failed_check' do
+    before { service.passed_check }
+    subject { service.failed_check }
+    it 'returns false' do
+      expect(subject).to eq(false)
+    end
+    it 'flags the service as unhealthy' do
+      expect { subject }.to change(service, :healthy?).from(true).to(false)
+    end
+  end
+
+  describe '#passed_check' do
+    subject { service.passed_check }
+    it 'returns true' do
+      expect(subject).to eq(true)
+    end
+    it 'flags the service as healthy' do
+      expect { subject }.to change(service, :healthy?).from(false).to(true)
+    end
+  end
+
+  describe '#params' do
+    subject { service.params }
+    it 'returns the params that it was constructed with' do
+      expect(subject).to eq(params)
+    end
+  end
+
+  describe '#check' do
+    subject { service.check }
+    it 'returns an empty hash' do
+      expect(subject).to eq({})
+    end
+  end
+end

data/spec/wellness/services/postgres_service_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Wellness::Services::PostgresService do
+  pending
+end

data/spec/wellness/services/redis_service_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Wellness::Services::RedisService do
+  let(:params) {
+    {
+      redis: {
+        url: 'redis://127.0.0.1:6379/0'
+      }
+    }
+  }
+  let(:service) { described_class.new(params) }
+  let(:redis_info) {
+    {
+      'uptime_in_seconds' => '612488',
+      'uptime_in_days' => '7',
+      'connected_clients' => '1',
+      'used_memory_human' => '979.22K',
+      'total_connections_received' => '2',
+      'total_commands_processed' => '1',
+      'rejected_connections' => '0',
+      'sync_full' => '0',
+      'sync_partial_ok' => '0',
+      'sync_partial_err' => '0',
+      'expired_keys' => '0',
+      'evicted_keys' => '0',
+      'keyspace_hits' => '0',
+      'keyspace_misses' => '0'
+    }
+  }
+  describe '#check' do
+    subject { service.check }
+    context 'when redis can\'t connect' do
+      it 'fails the health check' do
+        expect(subject).to include(status: 'UNHEALTHY')
+      end
+    end
+    context 'when redis returns the its details' do
+      let(:client) { double('Redis', info: redis_info) }
+      before do
+        service.stub(build_client: client)
+      end
+      it 'passes the health check' do
+        expect(subject).to include(status: 'HEALTHY')
+      end
+    end
+  end
+end

data/spec/wellness/services/sidekiq_service_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Wellness::Services::SidekiqService do
+  pending
+end

data/wellness.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'wellness/version'
+require 'wellness'
 
 Gem::Specification.new do |spec|
   spec.name          = 'wellness'
@@ -21,5 +21,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency('bundler', '~> 1.3')
   spec.add_development_dependency('rake')
   spec.add_development_dependency('rspec')
-  spec.add_development_dependency('codeclimate-test-reporter')
+  spec.add_development_dependency('simplecov')
+
+  # service dependencies
+  spec.add_development_dependency('pg')
+  spec.add_development_dependency('sidekiq')
+  spec.add_development_dependency('redis')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wellness
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Matthew Johnston
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-16 00:00:00.000000000 Z
+date: 2014-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,7 +53,49 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  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: pg
+  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: sidekiq
+  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: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -85,14 +127,18 @@ files:
 - Rakefile
 - lib/wellness.rb
 - lib/wellness/middleware.rb
+- lib/wellness/services.rb
 - lib/wellness/services/base.rb
 - lib/wellness/services/postgres_service.rb
 - lib/wellness/services/redis_service.rb
 - lib/wellness/services/sidekiq_service.rb
 - lib/wellness/system.rb
-- lib/wellness/version.rb
 - spec/spec_helper.rb
 - spec/wellness/middleware_spec.rb
+- spec/wellness/services/base_spec.rb
+- spec/wellness/services/postgres_service_spec.rb
+- spec/wellness/services/redis_service_spec.rb
+- spec/wellness/services/sidekiq_service_spec.rb
 - spec/wellness/system_spec.rb
 - wellness.gemspec
 homepage: https://github.com/warmwaffles/wellness
@@ -122,4 +168,8 @@ summary: A rack middleware health check
 test_files:
 - spec/spec_helper.rb
 - spec/wellness/middleware_spec.rb
+- spec/wellness/services/base_spec.rb
+- spec/wellness/services/postgres_service_spec.rb
+- spec/wellness/services/redis_service_spec.rb
+- spec/wellness/services/sidekiq_service_spec.rb
 - spec/wellness/system_spec.rb

data/lib/wellness/version.rb

@@ -1,3 +0,0 @@
-module Wellness
-  VERSION = '0.2.2'
-end