wellness 0.2.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b9c9d8b20440639156bfee90743eddc5ba49188
-  data.tar.gz: bc55f4040c571be2d5b4d15557b1dcdcfb6f66e2
+  metadata.gz: 92be2479007d38b17c45cdc5a0b40b83875f4489
+  data.tar.gz: 37d30c24be4446ccb60de012daa4368566b247ba
 SHA512:
-  metadata.gz: d11e691c8048d2f2a61fb5d5abfc19ed38d62f2cb5d5153cb3ac87a433dd675bc069c2cd05dd37e53cbdfe47bf8b3d9e4289cea1869922b44ea6c9a4a0171a9f
-  data.tar.gz: 68080655a8da97463ba809c5e4dd9a93a13cae97b2aff071f328a7b9fc20fabaad1dd447c49ba72615ba42bf2d958bc04716799135100120c03ee194c5255407
+  metadata.gz: 5fa52e4ef5da3267dce1855e53e2a2a8eedf70bff366776584bdca5627cc739c3422efd6a37a07689d940e2de2bb2f42c7bb78f73279c2a84a6734a5f3b1c399
+  data.tar.gz: 991e99f1e18ec611701cdec10765d7e8169b859c7e04b77bc50945bc2fbf1fb8e41aab850cbda8ac95342f613f08966edeaf01e7a85e7ff54852e2f2b62086c1

data/README.md

@@ -15,26 +15,20 @@ external dependencies that need to be loaded, that your application may not
 necessarily have.
 
 ```rb
-# app/config/application.rb
-
-# Add this to the top just below the bundler requires
-require 'wellness/services/postgres_service'
-require 'wellness/services/redis_service'
-
 # Within the configuration block
+
 system = Wellness::System.new('my-uber-duber-app')
-pg = Wellness::Services::PostgresService.new({
-  host: ENV['POSTGRESQL_HOST'],
-  port: ENV['POSTGRESQL_PORT'],
+system.use(Wellness::Services::PostgresService, 'database', {
+  host:     ENV['POSTGRESQL_HOST'],
+  port:     ENV['POSTGRESQL_PORT'],
   database: ENV['POSTGRESQL_DATABASE'],
-  user: ENV['POSTGRESQL_USERNAME'],
+  user:     ENV['POSTGRESQL_USERNAME'],
   password: ENV['POSTGRESQL_PASSWORD']
 })
-redis = Wellness::Services::RedisService.new({
+system.use(Wellness::Services::RedisService, 'redis', {
   host: ENV['REDIS_HOST']
 })
-system.add_service('database', pg)
-system.add_service('redis', redis)
+
 config.middleware.insert_before('::ActiveRecord::QueryCache', 'Wellness::Middleware', system)
 ```
 
@@ -42,22 +36,18 @@ config.middleware.insert_before('::ActiveRecord::QueryCache', 'Wellness::Middlew
 
 ```ruby
 require 'wellness'
-require 'wellness/services/postgres_service'
-require 'wellness/services/redis_service'
 
 system = Wellness::System.new('my-uber-duber-app')
-pg = Wellness::Services::PostgresService.new({
-  host: ENV['POSTGRESQL_HOST'],
-  port: ENV['POSTGRESQL_PORT'],
+system.use(Wellness::Services::PostgresService, 'database', {
+  host:     ENV['POSTGRESQL_HOST'],
+  port:     ENV['POSTGRESQL_PORT'],
   database: ENV['POSTGRESQL_DATABASE'],
-  user: ENV['POSTGRESQL_USERNAME'],
+  user:     ENV['POSTGRESQL_USERNAME'],
   password: ENV['POSTGRESQL_PASSWORD']
 })
-redis = Wellness::Services::RedisService.new({
+system.use(Wellness::Services::RedisService, 'redis', {
   host: ENV['REDIS_HOST']
 })
-system.add_service('database', pg)
-system.add_service('redis', redis)
 
 use(Wellness::Middleware, system)
 ```
@@ -115,12 +105,10 @@ run time. It can lead to unintended consequences, and weird bugs.
 class MyCustomService < Wellness::Services::Base
   def check
     if params[:foo]
-      passed_check
       {
         'status': 'HEALTHY'
       }
     else
-      failed_check
       {
         'status': 'UNHEALTHY'
       }
@@ -130,8 +118,29 @@ end
 
 # Initialize the wellness system
 system = Wellness::System.new('my-app')
-service = MyCustomService.new({foo: 'bar'})
-system.add_service('some service', service)
+system.use(MyCustomService, 'some service', {foo: 'bar'})
+
+# Load it into your rack
+use(Wellness::Middleware, system)
+```
+
+## Custom Details
+
+```ruby
+# Your custom detail component
+class MyDetail < Wellness::Detail
+  def check
+    {
+      'foo' => 12,
+      'bar' => 31,
+      'qux' => options[:qux]
+    }
+  end
+end
+
+# Initialize the wellness system
+system = Wellness::System.new('my-app')
+system.use(MyDetail, 'something', { qux: 9000 })
 
 # Load it into your rack
 use(Wellness::Middleware, system)

data/lib/wellness/detail.rb

@@ -0,0 +1,24 @@
+module Wellness
+  # The parent class of all details that need to run.
+  #
+  # @author Matthew A. Johnston (warmwaffles)
+  class Detail
+    attr_reader :name, :options, :result
+
+    def initialize(name, options={})
+      @name = name
+      @options = options
+      @result = {}
+    end
+
+    def call
+      @result = self.check
+      self
+    end
+
+    # @return [Hash]
+    def check
+      {}
+    end
+  end
+end

data/lib/wellness/factory.rb

@@ -0,0 +1,14 @@
+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/middleware.rb

@@ -6,38 +6,25 @@ module Wellness
     def initialize(app, system, options={})
       @app = app
       @system = system
-
-      # Optional arguments
-      @health_status_path = options[:status_path] || '/health/status'
-      @health_details_path = options[:details_path] || '/health/details'
+      @options = options
     end
 
-    def call(env)
-      case env['PATH_INFO']
-      when @health_status_path
-        health_status_check
-      when @health_details_path
-        health_details_check
-      else
-        @app.call(env)
-      end
+    def health_status_path
+      @options[:status_path] || '/health/status'
     end
 
-    private
-
-    def health_status_check
-      if @system.check
-        [200, { 'Content-Type' => 'application/json' }, [{ status: 'HEALTHY' }.to_json]]
-      else
-        [500, { 'Content-Type' => 'application/json' }, [{ status: 'UNHEALTHY' }.to_json]]
-      end
+    def health_details_path
+      @options[:details_path] || '/health/details'
     end
 
-    def health_details_check
-      if @system.check
-        [200, { 'Content-Type' => 'application/json' }, [@system.to_json]]
+    def call(env)
+      case env['PATH_INFO']
+      when health_status_path
+        @system.simple_check
+      when health_details_path
+        @system.detailed_check
       else
-        [500, { 'Content-Type' => 'application/json' }, [@system.to_json]]
+        @app.call(env)
       end
     end
   end

data/lib/wellness/report.rb

@@ -0,0 +1,59 @@
+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/base.rb

@@ -2,7 +2,7 @@ module Wellness
   module Services
     # @author Matthew A. Johnston
     class Base
-      attr_reader :params
+      attr_reader :params, :result, :name
 
       # Load dependencies when the class is loaded. This makes putting requires
       # at the top of the file unnecessary. It plays nicely with the
@@ -12,51 +12,37 @@ module Wellness
       end
 
       # @param params [Hash]
-      def initialize(params={})
+      def initialize(name, params={})
+        @name = name
         @params = params
-        @health = false
-        @mutex = Mutex.new
+        @result = {}
       end
 
-      # Flags the check as failed
-      # @return [FalseClass]
-      def failed_check
-        @mutex.synchronize do
-          @health = false
-        end
+      # Returns true if the service is healthy, otherwise false
+      # @return [TrueClass,FalseClass]
+      def healthy?
+        @result.fetch(:status, 'UNHEALTHY') == 'HEALTHY'
       end
 
-      # Flags the check as passed
-      # @return [TrueClass]
       def passed_check
-        @mutex.synchronize do
-          @health = true
-        end
+        warn('#passed_check has been deprecated')
       end
 
-      # Returns true if the service is healthy, otherwise false
-      # @return [TrueClass,FalseClass]
-      def healthy?
-        @mutex.synchronize do
-          !!@health
-        end
+      def failed_check
+        warn('#failed_check has been deprecated')
       end
 
-      # @return [Hash]
+      # @return [Wellness::Services::Base]
       def call
-        @last_check = self.check
+        @result = self.check
+        self
       end
 
       # @return [Hash]
       def check
-        {}
-      end
-
-      # @return [Hash]
-      def last_check
-        @mutex.synchronize do
-          @last_check ||= {}
-        end
+        {
+          status: 'UNHEALTHY'
+        }
       end
     end
   end

data/lib/wellness/services/postgres_service.rb

@@ -6,8 +6,9 @@ module Wellness
         require('pg')
       end
 
+      # @return [Hash]
       def check
-        case ping
+        case PG::Connection.ping(connection_options)
         when PG::Constants::PQPING_NO_ATTEMPT
           ping_failed('no attempt made to ping')
         when PG::Constants::PQPING_NO_RESPONSE
@@ -21,10 +22,6 @@ module Wellness
 
       private
 
-      def ping
-        PG::Connection.ping(connection_options)
-      end
-
       # @return [Hash]
       def connection_options
         {
@@ -39,7 +36,6 @@ module Wellness
       # @param message [String] the reason it failed
       # @return [Hash]
       def ping_failed(message)
-        failed_check
         {
           status: 'UNHEALTHY',
           details: {
@@ -50,7 +46,6 @@ module Wellness
 
       # @return [Hash]
       def ping_successful
-        passed_check
         {
           status: 'HEALTHY',
           details: {

data/lib/wellness/services/redis_service.rb

@@ -22,17 +22,29 @@ module Wellness
         require('redis')
       end
 
+      # @return [Hash]
       def check
         client = build_client
         details = client.info.select { |k, _| KEYS.include?(k) }
+        passed(details)
+      rescue Redis::BaseError => error
+        failed(error)
+      rescue Exception => error
+        failed(error)
+      end
 
-        passed_check
+      def build_client
+        Redis.new(self.params)
+      end
+
+      def passed(details)
         {
           status: 'HEALTHY',
           details: details
         }
-      rescue Redis::BaseError => error
-        failed_check
+      end
+
+      def failed(error)
         {
           status: 'UNHEALTHY',
           details: {
@@ -40,10 +52,6 @@ module Wellness
           }
         }
       end
-
-      def build_client
-        Redis.new(self.params)
-      end
     end
   end
 end

data/lib/wellness/services/sidekiq_service.rb

@@ -9,14 +9,14 @@ module Wellness
         require 'sidekiq'
       end
 
+      # @return [Hash]
       def check
         sidekiq_stats = Sidekiq::Stats.new
         queue = Sidekiq::Queue.new
         redis = Redis.new(self.params.fetch(:redis))
         redis_stats = redis.info.select { |k, _| KEYS.include?(k) }
-        workers_size = redis.scard("workers").to_i
+        workers_size = redis.scard('workers').to_i
 
-        passed_check
         {
           status: 'HEALTHY',
           details: {
@@ -31,7 +31,6 @@ module Wellness
           }
         }
       rescue => error
-        failed_check
         {
           status: 'UNHEALTHY',
           details: {

data/lib/wellness/system.rb

@@ -1,61 +1,49 @@
 module Wellness
-  # @author Matthew A. Johnston
+  # @author Matthew A. Johnston (warmwaffles)
   class System
-    attr_reader :name, :services
-
-    attr_accessor :details
+    attr_reader :name
 
     # @param name [String] the name of the system
     def initialize(name)
       @name = name
-      @services = Hash.new
-      @details = Hash.new
-    end
-
-    # Add a service to this system
-    #
-    # @param name [String, Symbol] the name of the service
-    # @param service [Wellness::Service] the service you wish to add
-    def add_service(name, service)
-      @services[name] = service
+      @services = []
+      @details = []
+      @mutex = Mutex.new
     end
 
-    # Remove a service from this system
-    #
-    # @param name [String, Symbol]
-    # @return [Wellness::Service] the service removed, else nil
-    def remove_service(name)
-      @services.delete(name)
+    def use(klass, *args)
+      @mutex.synchronize do
+        factory = Factory.new(klass, *args)
+        if klass <= Wellness::Services::Base
+          @services << factory
+        else
+          @details << factory
+        end
+      end
     end
 
-    # Checks all of the services
-    # @return
-    def check
-      @services.values.each { |service| service.call }
-      healthy?
+    def detailed_check
+      report = build_report
+      [report.status_code, { 'Content-Type' => 'application/json' }, [report.detailed.to_json]]
     end
 
-    # Returns true if the system is healthy, false otherwise
-    #
-    # @return [Boolean]
-    def healthy?
-      @services.values.all? { |service| service.healthy? }
+    def simple_check
+      report = build_report
+      [report.status_code, { 'Content-Type' => 'application/json' }, [report.simple.to_json]]
     end
 
-    def to_json(*)
-      dependencies = Hash.new
-
-      @services.each do |name, service|
-        dependencies[name] = service.last_check
+    def build_report
+      @mutex.synchronize do
+        Wellness::Report.new(services.map(&:call), details.map(&:call))
       end
+    end
 
-      data = {
-        status: (healthy? ? 'HEALTHY' : 'UNHEALTHY'),
-        details: @details,
-        dependencies: dependencies
-      }
+    def services
+      @services.map(&:build)
+    end
 
-      data.to_json
+    def details
+      @details.map(&:build)
     end
   end
 end

data/lib/wellness.rb

@@ -1,9 +1,12 @@
 require 'json'
 
 module Wellness
-  VERSION = '0.2.3'
+  VERSION = '1.0.0'
 
   autoload :Services,   'wellness/services'
   autoload :Middleware, 'wellness/middleware'
   autoload :System,     'wellness/system'
+  autoload :Detail,     'wellness/detail'
+  autoload :Report,     'wellness/report'
+  autoload :Factory,    'wellness/factory'
 end

data/spec/spec_helper.rb

@@ -1,7 +1,10 @@
 require 'simplecov'
 SimpleCov.start do
+  add_filter('/spec')
   add_group('Services', 'wellness/services')
 end
 
+Dir[Dir.pwd.concat('/spec/support/**/*.rb')].each { |f| require f }
+
 require 'rspec'
 require 'wellness'

data/spec/support/services_support.rb

@@ -0,0 +1,17 @@
+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

@@ -0,0 +1,26 @@
+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,138 +1,66 @@
 require 'spec_helper'
 
 describe Wellness::Middleware do
-  let(:app) { double('Application', call: true) }
-  let(:system) { Wellness::System.new('testing') }
-  let(:middleware) { Wellness::Middleware.new(app, system) }
-
-  class PassingMockService < Wellness::Services::Base
-    def check
-      passed_check
-      {
-        'status' => 'HEALTHY',
-        'details' => {}
-      }
+  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
 
-  class FailingMockService < Wellness::Services::Base
-    def check
-      failed_check
-      {
-        'status' => 'UNHEALTHY',
-        'details' => {}
-      }
+  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
-    context 'when the PATH_INFO is the health status path' 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' } }
-      subject { middleware.call(env) }
-
-      context 'when the system check is unhealthy' do
-        before { system.stub(check: false) }
-
-        it 'returns a 500 status' do
-          expect(subject[0]).to eq(500)
-        end
-
-        it 'returns a json content type' do
-          expect(subject[1]).to eq({ 'Content-Type' => 'application/json' })
-        end
-
-        it 'returns UNHEALTHY' do
-          data = JSON.parse(subject[2].first)
-          expect(data).to eq({ 'status' => 'UNHEALTHY' })
-        end
-      end
-
-      context 'when the system check is healthy' do
-        before { system.stub(check: true) }
-
-        it 'returns a 200 status' do
-          expect(subject[0]).to eq(200)
-        end
-
-        it 'returns a json content type' do
-          expect(subject[1]).to eq({ 'Content-Type' => 'application/json' })
-        end
-
-        it 'returns HEALTHY' do
-          data = JSON.parse(subject[2].first)
-          expect(data).to eq({ 'status' => 'HEALTHY' })
-        end
+      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 is the health details path' do
+    context 'when the PATH_INFO matches the health_details_path' do
       let(:env) { { 'PATH_INFO' => '/health/details' } }
-      subject { middleware.call(env) }
-
-      context 'when the system check is unhealthy' do
-        before do
-          system.add_service('mock service', FailingMockService.new)
-        end
-
-        it 'returns a 500 status' do
-          expect(subject[0]).to eq(500)
-        end
-
-        it 'returns a json content type' do
-          expect(subject[1]).to eq({ 'Content-Type' => 'application/json' })
-        end
-
-        it 'returns UNHEALTHY' do
-          expected = {
-            'status' => 'UNHEALTHY',
-            'details' => {},
-            'dependencies' => {
-              'mock service' => {
-                'status' => 'UNHEALTHY',
-                'details' => {}
-              }
-            }
-          }
-
-          data = JSON.parse(subject[2].first)
-          expect(data).to eq(expected)
-        end
-      end
-      context 'when the system check is healthy' do
-        before do
-          system.add_service('mock service', PassingMockService.new)
-        end
-
-        it 'returns a 200 status' do
-          expect(subject[0]).to eq(200)
-        end
-
-        it 'returns a json content type' do
-          expect(subject[1]).to eq({ 'Content-Type' => 'application/json' })
-        end
-
-        it 'returns UNHEALTHY' do
-          expected = {
-            'status' => 'HEALTHY',
-            'details' => {},
-            'dependencies' => {
-              'mock service' => {
-                'status' => 'HEALTHY',
-                'details' => {}
-              }
-            }
-          }
-
-          data = JSON.parse(subject[2].first)
-          expect(data).to eq(expected)
-        end
+      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 is /who/cares' do
-      let(:env) { { 'PATH_INFO' => '/who/cares' } }
-
-      it 'passes the request to the next rack' do
+    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

data/spec/wellness/report_spec.rb

@@ -0,0 +1,87 @@
+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,40 +1,51 @@
 require 'spec_helper'
 
 describe Wellness::Services::Base do
-  let(:params) { { test: 'data' } }
+  let(:params) { { foo: 'bar' } }
   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)
+
+  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
-    it 'flags the service as unhealthy' do
-      expect { subject }.to change(service, :healthy?).from(true).to(false)
+    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 '#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)
+  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
-  end
 
-  describe '#params' do
-    subject { service.params }
-    it 'returns the params that it was constructed with' do
-      expect(subject).to eq(params)
+    it 'sets the result' do
+      expect { subject }.to change { service.result }.to(result)
     end
   end
 
   describe '#check' do
     subject { service.check }
-    it 'returns an empty hash' do
-      expect(subject).to eq({})
+    it 'returns a status of UNHEALTHY' do
+      expect(subject).to include(status: 'UNHEALTHY')
     end
   end
 end

data/spec/wellness/services/redis_service_spec.rb

@@ -27,21 +27,5 @@ describe Wellness::Services::RedisService do
       '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
+  pending
 end

data/spec/wellness/system_spec.rb

@@ -1,100 +1,78 @@
 require 'spec_helper'
 
 describe Wellness::System do
-  let(:name) { 'testing-app' }
-  let(:system) { described_class.new(name) }
+  let(:system) { described_class.new('test_system') }
 
-  class PassingMockService < Wellness::Services::Base
-    def check
-      passed_check
-      {
-        'status' => 'HEALTHY',
-        'details' => {}
-      }
-    end
-  end
-
-  class FailingMockService < Wellness::Services::Base
-    def check
-      failed_check
-      {
-        'status' => 'UNHEALTHY',
-        'details' => {}
-      }
+  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
-  end
-
-  describe '#name' do
-    subject { system.name }
-    it 'equals "testing-app"' do
-      expect(subject).to eq(name)
+    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 '#add_service' do
-    let(:service) { double('Service') }
-    subject { system.add_service('foo', service) }
-
-    it 'adds the service to the system' do
-      expect { subject }.to change(system.services, :length).to(1)
+  describe '#build_report' do
+    subject { system.build_report }
+    it 'returns a Wellness::Report' do
+      expect(subject).to be_a(Wellness::Report)
     end
   end
 
-  describe '#remove_service' do
-    let(:service) { double('Service') }
-    subject { system.remove_service('foo') }
-    before { system.add_service('foo', service) }
-    it 'removes the service from the system' do
-      expect { subject }.to change(system.services, :length).to(0)
-    end
-  end
+  describe '#detailed_check' do
+    let(:headers) { { 'Content-Type' => 'application/json' } }
+    subject { system.detailed_check }
 
-  describe '#check' do
-    subject { system.check }
+    context 'when the check is HEALTHY' do
+      before { system.use(HealthyService, 'test_service') }
 
-    context 'when no services are registered' do
-      it 'returns true' do
-        expect(subject).to be_true
+      it 'responds with a 200' do
+        expect(subject[0]).to eq(200)
       end
-    end
-
-    context 'when a passing service is registered' do
-      before { system.add_service('passing', PassingMockService.new) }
-
-      it 'returns true' do
-        expect(subject).to be_true
+      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') }
 
-    context 'when a failing service is registered' do
-      before { system.add_service('failing', FailingMockService.new) }
-
-      it 'returns false' do
-        expect(subject).to be_false
+      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
 
-    context 'when one service is failing and the other is passing' do
-      before do
-        system.add_service('passing', PassingMockService.new)
-        system.add_service('failing', FailingMockService.new)
-      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 'returns false' do
-        expect(subject).to be_false
+      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') }
 
-    context 'when all services are passing' do
-      before do
-        system.add_service('passing one', PassingMockService.new)
-        system.add_service('passing two', PassingMockService.new)
+      it 'responds with a 500' do
+        expect(subject[0]).to eq(500)
       end
-
-      it 'returns true' do
-        expect(subject).to be_true
+      it 'sets the "Content-Type" to "application/json"' do
+        expect(subject[1]).to eq(headers)
       end
     end
   end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wellness
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Matthew Johnston
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-30 00:00:00.000000000 Z
+date: 2014-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -126,7 +126,10 @@ files:
 - README.md
 - Rakefile
 - lib/wellness.rb
+- lib/wellness/detail.rb
+- lib/wellness/factory.rb
 - lib/wellness/middleware.rb
+- lib/wellness/report.rb
 - lib/wellness/services.rb
 - lib/wellness/services/base.rb
 - lib/wellness/services/postgres_service.rb
@@ -134,7 +137,10 @@ files:
 - lib/wellness/services/sidekiq_service.rb
 - lib/wellness/system.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
@@ -167,7 +173,10 @@ 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