wellness 1.0.2 → 2.0.0

metadata

@@ -1,111 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: wellness
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Matthew Johnston
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-05 00:00:00.000000000 Z
+date: 2014-08-18 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'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !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: '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: 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:
-    - - '>='
+    - - ">="
       - !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 rack middleware health check
@@ -115,11 +87,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .ruby-gemset
-- .ruby-version
-- .travis.yml
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
 - DOCUMENTATION.md
 - Gemfile
 - LICENSE.txt
@@ -127,26 +98,22 @@ files:
 - Rakefile
 - lib/wellness.rb
 - lib/wellness/detail.rb
-- lib/wellness/factory.rb
+- lib/wellness/detailed_report.rb
 - lib/wellness/middleware.rb
-- lib/wellness/report.rb
-- lib/wellness/services.rb
+- lib/wellness/service.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/simple_report.rb
 - lib/wellness/system.rb
 - lib/wellness/version.rb
 - spec/spec_helper.rb
-- spec/support/services_support.rb
-- spec/wellness/detail_spec.rb
-- spec/wellness/middleware_spec.rb
-- spec/wellness/report_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
+- test/test_helper.rb
+- test/wellness/detail_test.rb
+- test/wellness/detailed_report_test.rb
+- test/wellness/simple_report_test.rb
+- test/wellness/system_test.rb
 - wellness.gemspec
 homepage: https://github.com/warmwaffles/wellness
 licenses:
@@ -158,28 +125,24 @@ 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.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A rack middleware health check
 test_files:
 - spec/spec_helper.rb
-- spec/support/services_support.rb
-- spec/wellness/detail_spec.rb
-- spec/wellness/middleware_spec.rb
-- spec/wellness/report_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
+- test/test_helper.rb
+- test/wellness/detail_test.rb
+- test/wellness/detailed_report_test.rb
+- test/wellness/simple_report_test.rb
+- test/wellness/system_test.rb

data/.rspec

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

data/lib/wellness/factory.rb

@@ -1,14 +0,0 @@
-module Wellness
-  # A simple class that builds the provided class with the provided arguments
-  # @author Matthew A. Johnston (warmwaffles)
-  class Factory
-    def initialize(klass, *args)
-      @klass = klass
-      @args  = args
-    end
-
-    def build
-      @klass.new(*@args)
-    end
-  end
-end

data/lib/wellness/report.rb

@@ -1,59 +0,0 @@
-module Wellness
-  # A simple presenter for the services and details of the Wellness System.
-  #
-  # @author Matthew A. Johnston (warmwaffles)
-  class Report
-    # @param services [Hash]
-    # @param details [Hash]
-    def initialize(services, details)
-      @services = services
-      @details = details
-    end
-
-    # @return [Hash]
-    def detailed
-      {
-        status: status,
-        services: services,
-        details: details
-      }
-    end
-
-    # @return [Hash]
-    def simple
-      {
-        status: status
-      }
-    end
-
-    # Returns the {#detailed} hash in json form
-    #
-    # @return [String]
-    def to_json(*)
-      detailed.to_json
-    end
-
-    # @return [String]
-    def status
-      healthy? ? 'HEALTHY' : 'UNHEALTHY'
-    end
-
-    # @return [Integer]
-    def status_code
-      healthy? ? 200 : 500
-    end
-
-    # @return [TrueClass,FalseClass]
-    def healthy?
-      @services.all?(&:healthy?)
-    end
-
-    def services
-      Hash[@services.map { |s| [s.name, s.result] }]
-    end
-
-    def details
-      Hash[@details.map { |d| [d.name, d.result] }]
-    end
-  end
-end

data/lib/wellness/services.rb

@@ -1,6 +0,0 @@
-module Wellness
-  module Services
-  end
-end
-
-require 'wellness/services/base'

data/spec/support/services_support.rb

@@ -1,17 +0,0 @@
-class UnhealthyService < Wellness::Services::Base
-  def check
-    { status: 'UNHEALTHY' }
-  end
-end
-
-class HealthyService < Wellness::Services::Base
-  def check
-    { status: 'HEALTHY' }
-  end
-end
-
-class MockedDetail < Wellness::Detail
-  def check
-    { 'data' => 'here' }
-  end
-end

data/spec/wellness/detail_spec.rb

@@ -1,26 +0,0 @@
-require 'spec_helper'
-
-describe Wellness::Detail do
-  let(:detail) { MockedDetail.new('test_detail') }
-
-  describe '#name' do
-    subject { detail.name }
-    it 'returns "test_detail"' do
-      expect(subject).to eq('test_detail')
-    end
-  end
-
-  describe '#call' do
-    subject { detail.call }
-    it 'sets the result' do
-      expect { subject }.to change(detail, :result)
-    end
-  end
-
-  describe '#check' do
-    subject { detail.check }
-    it 'returns a hash' do
-      expect(subject).to be_a(Hash)
-    end
-  end
-end

data/spec/wellness/middleware_spec.rb

@@ -1,69 +0,0 @@
-require 'spec_helper'
-
-describe Wellness::Middleware do
-  let(:app) { double('Application') }
-  let(:system) { Wellness::System.new('test_system') }
-
-  describe '#health_status_path' do
-    subject { middleware.health_status_path }
-    context 'when the status_path is not passed' do
-      let(:middleware) { described_class.new(app, system) }
-      it 'returns "/health/status"' do
-        expect(subject).to eq('/health/status')
-      end
-    end
-    context 'when the status_path is passed' do
-      let(:options) { {status_path: '/path/to/status' } }
-      let(:middleware) { described_class.new(app, system, options) }
-      it 'returns "/path/to/status"' do
-        expect(subject).to eq('/path/to/status')
-      end
-    end
-  end
-
-  describe '#health_details_path' do
-    context 'when the details_path is not passed' do
-      let(:middleware) { described_class.new(app, system) }
-      subject { middleware.health_details_path }
-      it 'returns "/health/details"' do
-        expect(subject).to eq('/health/details')
-      end
-    end
-    context 'when the details_path is passed' do
-      let(:options) { {details_path: '/path/to/status' } }
-      let(:middleware) { described_class.new(app, system, options) }
-      subject { middleware.health_details_path }
-      it 'returns "/path/to/status"' do
-        expect(subject).to eq('/path/to/status')
-      end
-    end
-  end
-
-  describe '#call' do
-    let(:middleware) { described_class.new(app, system) }
-    context 'when the PATH_INFO matches the health_status_path' do
-      let(:env) { { 'PATH_INFO' => '/health/status' } }
-      before { system.stub(simple_check: true) }
-      it 'calls #simple_check on the system' do
-        middleware.call(env)
-        expect(system).to have_received(:simple_check).once
-      end
-    end
-    context 'when the PATH_INFO matches the health_details_path' do
-      let(:env) { { 'PATH_INFO' => '/health/details' } }
-      before { system.stub(detailed_check: true) }
-      it 'calls #detailed_check on the system' do
-        middleware.call(env)
-        expect(system).to have_received(:detailed_check).once
-      end
-    end
-    context 'when the PATH_INFO doesn\'t match any of the paths' do
-      let(:env) { { 'PATH_INFO' => '/different/path' } }
-      before { app.stub(call: true) }
-      it 'calls #detailed_check on the system' do
-        middleware.call(env)
-        expect(app).to have_received(:call).with(env)
-      end
-    end
-  end
-end

data/spec/wellness/report_spec.rb

@@ -1,87 +0,0 @@
-require 'spec_helper'
-
-describe Wellness::Report do
-  let(:report) { described_class.new({}, {}) }
-
-  describe '#to_json' do
-    subject { report.to_json }
-    it 'returns a json string' do
-      expect(JSON.parse(subject)).to be_a(Hash)
-    end
-  end
-
-  describe '#detailed' do
-    subject { report.detailed }
-    it 'returns a hash' do
-      expect(subject).to be_a(Hash)
-    end
-  end
-
-  describe '#simple' do
-    subject { report.simple }
-    it 'returns a hash' do
-      expect(subject).to be_a(Hash)
-    end
-  end
-
-  describe '#status' do
-    subject { report.status }
-    context 'when the report is healthy' do
-      before { report.stub(:healthy? => true) }
-      it 'returns HEALTHY' do
-        expect(subject).to eq('HEALTHY')
-      end
-    end
-    context 'when the report is not healthy' do
-      before { report.stub(:healthy? => false) }
-      it 'returns UNHEALTHY' do
-        expect(subject).to eq('UNHEALTHY')
-      end
-    end
-  end
-
-  describe '#status_code' do
-    subject { report.status_code }
-    context 'when the report is healthy' do
-      before { report.stub(:healthy? => true) }
-      it 'returns 200' do
-        expect(subject).to eq(200)
-      end
-    end
-    context 'when the report is not healthy' do
-      before { report.stub(:healthy? => false) }
-      it 'returns 500' do
-        expect(subject).to eq(500)
-      end
-    end
-  end
-
-  describe '#healthy?' do
-    subject { report.healthy? }
-    context 'when all of the report are healthy' do
-      let(:services) { [HealthyService.new('service-a'), HealthyService.new('service-b')] }
-      let(:report) { described_class.new(services, []) }
-      before { services.collect(&:call) }
-      it 'returns true' do
-        expect(subject).to eq(true)
-      end
-    end
-    context 'when one of the reports are not healthy' do
-      let(:services) { [HealthyService.new('service-a'), UnhealthyService.new('service-b')] }
-      let(:report) { described_class.new(services, []) }
-      before { services.collect(&:call) }
-      it 'returns false' do
-        expect(subject).to eq(false)
-      end
-    end
-    context 'when all of the reports are not healthy' do
-      let(:services) { [UnhealthyService.new('service-a'), UnhealthyService.new('service-b')] }
-      let(:report) { described_class.new(services, []) }
-      before { services.collect(&:call) }
-      it 'returns false' do
-        expect(subject).to eq(false)
-      end
-    end
-  end
-end
-

data/spec/wellness/services/base_spec.rb

@@ -1,51 +0,0 @@
-require 'spec_helper'
-
-describe Wellness::Services::Base do
-  let(:params) { { foo: 'bar' } }
-  let(:service) { described_class.new(params) }
-
-  describe '#healthy?' do
-    subject { service.healthy? }
-    context 'when the status key is missing' do
-      before { service.result.delete(:status) }
-      it 'returns false' do
-        expect(subject).to eq(false)
-      end
-    end
-    context 'when the status is UNHEALTHY' do
-      before { service.result[:status] = 'UNHEALTHY' }
-      it 'returns false' do
-        expect(subject).to eq(false)
-      end
-    end
-    context 'when the status is HEALTHY' do
-      before { service.result[:status] = 'HEALTHY' }
-      it 'returns true' do
-        expect(subject).to eq(true)
-      end
-    end
-  end
-
-  describe '#call' do
-    let(:result) { {status: 'HEALTHY'} }
-    subject { service.call }
-
-    before { service.stub(check: result) }
-
-    it 'receives the #call method' do
-      subject
-      expect(service).to have_received(:check).once
-    end
-
-    it 'sets the result' do
-      expect { subject }.to change { service.result }.to(result)
-    end
-  end
-
-  describe '#check' do
-    subject { service.check }
-    it 'returns a status of UNHEALTHY' do
-      expect(subject).to include(status: 'UNHEALTHY')
-    end
-  end
-end

data/spec/wellness/services/postgres_service_spec.rb

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

data/spec/wellness/services/redis_service_spec.rb

@@ -1,31 +0,0 @@
-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'
-    }
-  }
-  pending
-end

data/spec/wellness/services/sidekiq_service_spec.rb

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

data/spec/wellness/system_spec.rb

@@ -1,78 +0,0 @@
-require 'spec_helper'
-
-describe Wellness::System do
-  let(:system) { described_class.new('test_system') }
-
-  describe '#use' do
-    context 'when a Wellness::Services::Base is provided' do
-      subject { system.use(HealthyService, 'test_service') }
-      it 'adds the service to the list of services' do
-        expect { subject }.to change { system.services.count }.by(1)
-      end
-    end
-    context 'when a Wellness::Detail is provided' do
-      subject { system.use(MockedDetail, 'test_detail') }
-      it 'adds the detail to the list of details' do
-        expect { subject }.to change { system.details.count }.by(1)
-      end
-    end
-  end
-
-  describe '#build_report' do
-    subject { system.build_report }
-    it 'returns a Wellness::Report' do
-      expect(subject).to be_a(Wellness::Report)
-    end
-  end
-
-  describe '#detailed_check' do
-    let(:headers) { { 'Content-Type' => 'application/json' } }
-    subject { system.detailed_check }
-
-    context 'when the check is HEALTHY' do
-      before { system.use(HealthyService, 'test_service') }
-
-      it 'responds with a 200' do
-        expect(subject[0]).to eq(200)
-      end
-      it 'sets the "Content-Type" to "application/json"' do
-        expect(subject[1]).to eq(headers)
-      end
-    end
-    context 'when the check is UNHEALTHY' do
-      before { system.use(UnhealthyService, 'test_service') }
-
-      it 'responds with a 500' do
-        expect(subject[0]).to eq(500)
-      end
-      it 'sets the "Content-Type" to "application/json"' do
-        expect(subject[1]).to eq(headers)
-      end
-    end
-  end
-
-  describe '#simple_check' do
-    let(:headers) { { 'Content-Type' => 'application/json' } }
-    subject { system.simple_check }
-    context 'when the check is HEALTHY' do
-      before { system.use(HealthyService, 'test_service') }
-
-      it 'responds with a 200' do
-        expect(subject[0]).to eq(200)
-      end
-      it 'sets the "Content-Type" to "application/json"' do
-        expect(subject[1]).to eq(headers)
-      end
-    end
-    context 'when the check is UNHEALTHY' do
-      before { system.use(UnhealthyService, 'test_service') }
-
-      it 'responds with a 500' do
-        expect(subject[0]).to eq(500)
-      end
-      it 'sets the "Content-Type" to "application/json"' do
-        expect(subject[1]).to eq(headers)
-      end
-    end
-  end
-end