wellness 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4552f48d89fb5d5af48f8356e21ed8f7639cee90
-  data.tar.gz: a01ecec7812e71fd197b4001e449a786de18bf34
+  metadata.gz: cc67d265fe3b43ff86c235e0317c32e20ccd0971
+  data.tar.gz: d7a96511cebbaeee9926489760d3bcf7667227f9
 SHA512:
-  metadata.gz: a4eae8f146fae81f2c589c7ac131999eed458923828e13633bff0559c578763c37aa85806cc71e013e51cd04694d7d162c25b5399728864bfdefe4de575d5190
-  data.tar.gz: cdef3cb99af66fd8c7565f5bd9a1b88a8108f368915ecc2aa3cac8585dc1cad64fe359b44dfffed2ded92252ff7d545ac93933975fca0098af7838d71d99b23f
+  metadata.gz: ee1f255adf40cdd1f3ba90a31e28ae4f8b0fb5c9b6e9d31eb23f41c9646e71c0d53cf415ba8d9170b537a96eaea7c44fce3214aebab15c71bba0fe491b02cda3
+  data.tar.gz: 368f138e36a57ae792b92f9d7d6d2d934033a64219aef4686c99945c93f115bf982a096d54f09eef63b76207028d162288eb24f4497aa6f0d94e6ba003e984d4

data/README.md

@@ -32,7 +32,7 @@ redis = Wellness::Services::RedisService.new({
 })
 system.add_service('database', pg)
 system.add_service('redis', redis)
-config.middleware.insert_before('::ActiveRecord::QueryCache', 'Wellness::Checker', system)
+config.middleware.insert_before('::ActiveRecord::QueryCache', 'Wellness::Middleware', system)
 ```
 
 ## Usage - Sinatra
@@ -56,7 +56,44 @@ redis = Wellness::Services::RedisService.new({
 system.add_service('database', pg)
 system.add_service('redis', redis)
 
-use(Wellness::Checker, system)
+use(Wellness::Middleware, system)
+```
+
+## Example Response
+
+```json
+{
+  "status":"UNHEALTHY",
+  "details":{
+
+  },
+  "dependencies":{
+    "database":{
+      "status":"UNHEALTHY",
+      "details":{
+        "error":"no response from ping"
+      }
+    },
+    "sidekiq":{
+      "status":"HEALTHY",
+      "details":{
+        "processed":0,
+        "failed":0,
+        "busy":0,
+        "enqueued":0,
+        "scheduled":0,
+        "retries":0,
+        "default_latency":0,
+        "redis":{
+          "uptime_in_days":"0",
+          "connected_clients":"1",
+          "used_memory_human":"979.22K",
+          "used_memory_peak_human":"1.02M"
+        }
+      }
+    }
+  }
+}
 ```
 
 ## Custom Services
@@ -94,7 +131,7 @@ service = MyCustomService.new({foo: 'bar'})
 system.add_service('some service', service)
 
 # Load it into your rack
-use(Wellness::Checker, system)
+use(Wellness::Middleware, system)
 ```
 
 ## Contributing

data/lib/wellness/checker.rb

@@ -1,42 +1,7 @@
-module Wellness
-
-  class Checker
-    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'
-    end
-
-    def call(env)
-      case env['PATH_INFO']
-        when @health_status_path
-          health_status(env)
-        when @health_details_path
-          health_details(env)
-        else
-          @app.call(env)
-      end
-    end
+require 'wellness/middleware'
 
-    def health_status(env)
-      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)
-      if @system.check
-        [200, {'Content-Type' => 'text/json'}, [@system.to_json]]
-      else
-        [500, {'Content-Type' => 'text/json'}, [@system.to_json]]
-      end
-    end
-  end
-
-end
+module Wellness
+  # Backwards compatibility. This isn't a proper name for something that is
+  # supposed to be in the middleware.
+  Checker = Wellness::Middleware
+end

data/lib/wellness/middleware.rb

@@ -0,0 +1,45 @@
+module Wellness
+
+  # This is to be put into the Rack environment.
+  #
+  # @author Matthew A. Johnston
+  class Middleware
+    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'
+    end
+
+    def call(env)
+      case env['PATH_INFO']
+        when @health_status_path
+          health_status(env)
+        when @health_details_path
+          health_details(env)
+        else
+          @app.call(env)
+      end
+    end
+
+    def health_status(env)
+      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)
+      if @system.check
+        [200, {'Content-Type' => 'text/json'}, [@system.to_json]]
+      else
+        [500, {'Content-Type' => 'text/json'}, [@system.to_json]]
+      end
+    end
+  end
+
+end

data/lib/wellness/version.rb

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

data/lib/wellness.rb

@@ -4,4 +4,5 @@ end
 require 'wellness/version'
 require 'wellness/services/base'
 require 'wellness/system'
+require 'wellness/middleware'
 require 'wellness/checker'

data/spec/wellness/checker_spec.rb

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

data/wellness.gemspec

@@ -18,8 +18,6 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency('rack', '~> 1.5')
-
   spec.add_development_dependency('bundler', '~> 1.3')
   spec.add_development_dependency('rake')
   spec.add_development_dependency('rspec')

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: wellness
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Matthew Johnston
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-14 00:00:00.000000000 Z
+date: 2014-01-15 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rack
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -82,6 +68,7 @@ files:
 - Rakefile
 - lib/wellness.rb
 - lib/wellness/checker.rb
+- lib/wellness/middleware.rb
 - lib/wellness/services/base.rb
 - lib/wellness/services/postgres_service.rb
 - lib/wellness/services/redis_service.rb