wellness 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc67d265fe3b43ff86c235e0317c32e20ccd0971
-  data.tar.gz: d7a96511cebbaeee9926489760d3bcf7667227f9
+  metadata.gz: 92603932dbccf29905140576d88df9122d0f6b5b
+  data.tar.gz: 67903699abe0a4d32ec6a59110c51dfea511273b
 SHA512:
-  metadata.gz: ee1f255adf40cdd1f3ba90a31e28ae4f8b0fb5c9b6e9d31eb23f41c9646e71c0d53cf415ba8d9170b537a96eaea7c44fce3214aebab15c71bba0fe491b02cda3
-  data.tar.gz: 368f138e36a57ae792b92f9d7d6d2d934033a64219aef4686c99945c93f115bf982a096d54f09eef63b76207028d162288eb24f4497aa6f0d94e6ba003e984d4
+  metadata.gz: 055987a1113450d41b444c847a86ae88302873be09728810cff488d53e43abdb30081b2fc92505c8cdb71c8d0ff70433305169f9f16077a6920d6c9c15ed423b
+  data.tar.gz: 6d568347a584ed37b388593e16442e23f2dd4574a0b383290a6820d4958de20115cdc02480e4d0f75866fe83bd93b2c576c0bf1cd7d06047e6347ca69db99be6

data/.rspec

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

data/lib/wellness/middleware.rb

@@ -1,3 +1,5 @@
+require 'json'
+
 module Wellness
 
   # This is to be put into the Rack environment.
@@ -16,24 +18,25 @@ module Wellness
     def call(env)
       case env['PATH_INFO']
         when @health_status_path
-          health_status(env)
+          health_status_check
         when @health_details_path
-          health_details(env)
+          health_details_check
         else
           @app.call(env)
       end
     end
 
-    def health_status(env)
+    private
+
+    def health_status_check
       if @system.check
         [200, {'Content-Type' => 'text/json'}, [{status: 'HEALTHY'}.to_json]]
       else
         [500, {'Content-Type' => 'text/json'}, [{status: 'UNHEALTHY'}.to_json]]
       end
-
     end
 
-    def health_details(env)
+    def health_details_check
       if @system.check
         [200, {'Content-Type' => 'text/json'}, [@system.to_json]]
       else

data/lib/wellness/version.rb

@@ -1,3 +1,3 @@
 module Wellness
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

data/spec/spec_helper.rb

@@ -1,2 +1,3 @@
 require 'rspec'
 require 'wellness'
+

data/spec/wellness/middleware_spec.rb

@@ -0,0 +1,141 @@
+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' => {}
+      }
+    end
+  end
+
+  class FailingMockService < Wellness::Services::Base
+    def check
+      failed_check
+      {
+        'status' => 'UNHEALTHY',
+        'details' => {}
+      }
+    end
+  end
+
+  describe '#call' do
+    context 'when the PATH_INFO is 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' => 'text/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' => 'text/json' })
+        end
+
+        it 'returns HEALTHY' do
+          data = JSON.parse(subject[2].first)
+          expect(data).to eq({ 'status' => 'HEALTHY' })
+        end
+      end
+    end
+
+    context 'when the PATH_INFO is 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' => 'text/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' => 'text/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
+      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
+        middleware.call(env)
+        expect(app).to have_received(:call).with(env)
+      end
+    end
+  end
+end

data/spec/wellness/system_spec.rb

@@ -4,6 +4,26 @@ describe Wellness::System do
   let(:name) { 'testing-app' }
   let(:system) { described_class.new(name) }
 
+  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' => {}
+      }
+    end
+  end
+
   describe '#name' do
     subject { system.name }
     it 'equals "testing-app"' do
@@ -12,7 +32,7 @@ describe Wellness::System do
   end
 
   describe '#add_service' do
-    let(:service) { double('Service')  }
+    let(:service) { double('Service') }
     subject { system.add_service('foo', service) }
 
     it 'adds the service to the system' do
@@ -21,7 +41,7 @@ describe Wellness::System do
   end
 
   describe '#remove_service' do
-    let(:service) { double('Service')  }
+    let(:service) { double('Service') }
     subject { system.remove_service('foo') }
     before { system.add_service('foo', service) }
     it 'removes the service from the system' do
@@ -29,4 +49,52 @@ describe Wellness::System do
     end
   end
 
+  describe '#check' do
+    subject { system.check }
+
+    context 'when no services are registered' do
+      it 'returns true' do
+        expect(subject).to be_true
+      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
+      end
+    end
+
+    context 'when a failing service is registered' do
+      before { system.add_service('failing', FailingMockService.new) }
+
+      it 'returns false' do
+        expect(subject).to be_false
+      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
+
+      it 'returns false' do
+        expect(subject).to be_false
+      end
+    end
+
+    context 'when all services are passing' do
+      before do
+        system.add_service('passing one', PassingMockService.new)
+        system.add_service('passing two', PassingMockService.new)
+      end
+
+      it 'returns true' do
+        expect(subject).to be_true
+      end
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wellness
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Matthew Johnston
@@ -60,6 +60,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - .ruby-gemset
 - .ruby-version
 - Gemfile
@@ -76,7 +77,7 @@ files:
 - lib/wellness/system.rb
 - lib/wellness/version.rb
 - spec/spec_helper.rb
-- spec/wellness/checker_spec.rb
+- spec/wellness/middleware_spec.rb
 - spec/wellness/system_spec.rb
 - wellness.gemspec
 homepage: https://github.com/warmwaffles/wellness
@@ -105,5 +106,5 @@ specification_version: 4
 summary: A rack middleware health check
 test_files:
 - spec/spec_helper.rb
-- spec/wellness/checker_spec.rb
+- spec/wellness/middleware_spec.rb
 - spec/wellness/system_spec.rb

data/spec/wellness/checker_spec.rb

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