wellness 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 92603932dbccf29905140576d88df9122d0f6b5b
-  data.tar.gz: 67903699abe0a4d32ec6a59110c51dfea511273b
+  metadata.gz: 76f9b1fdc9a32250719692af2a9edee4def359f8
+  data.tar.gz: d3bbe4583ca4819d3384c6393cba810f50fe38d4
 SHA512:
-  metadata.gz: 055987a1113450d41b444c847a86ae88302873be09728810cff488d53e43abdb30081b2fc92505c8cdb71c8d0ff70433305169f9f16077a6920d6c9c15ed423b
-  data.tar.gz: 6d568347a584ed37b388593e16442e23f2dd4574a0b383290a6820d4958de20115cdc02480e4d0f75866fe83bd93b2c576c0bf1cd7d06047e6347ca69db99be6
+  metadata.gz: 2797c1c8566fcd651ea5e0700b702ac0527f364cc446e356a881d98f623369420e38b9dd3842a2bc66d8542a73ddad1c4e37d80103f006c00ac3876f157e1a54
+  data.tar.gz: e5d938acabfa64b940ae2c37fdee7b8a07c87b6649fce5b58cb075f7915285be1f4ee943c42210ec95ac126e3dfc5c4434087ae43f577981ef80ac132df8ecf4

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+ - 2.0.0
+ - 1.9.3
+notifications:
+  irc: "chat.freenode.net#warmwaffles"
+env:
+  - CODECLIMATE_REPO_TOKEN=6212f00d1b8f97c85cf1e6478e12dafbb7325b3b51c6a3979aea7ea55e619c03
+  - CODECLIMATE_REPO_TOKEN=6212f00d1b8f97c85cf1e6478e12dafbb7325b3b51c6a3979aea7ea55e619c03

data/DOCUMENTATION.md

@@ -0,0 +1,78 @@
+# HTTP Applications
+
+Services **MUST** supply an endpoint for determining their health. Health and
+status information **MUST** be supplied under the `/health` path. Responses for
+health and status information **MUST** be valid json by default. Services
+**MAY** be provided in other formats by supplying a `format` parameter with
+appropriate values such as `xml`.
+
+## Status
+
+A summarized status for a given application **MUST** be available from the
+route `/health/status`. The response **MUST** be one of the following:
+
+- `{ "status": "HEALTHY" }` with HTTP status code `200`
+- `{ "status": "UNHEALTHY" }` with HTTP status code `500`
+
+## Details
+
+Detailed status for a given application **MUST** be available from the route
+`/health/details`. The response **MUST** be returned with in the following
+format:
+
+```json
+{
+  "status": "HEALTHY",
+  "details": {
+    "requests": {
+      "last_hour": 512,
+      "last_day": 12288
+    },
+    "top_consumers": {
+      "last_hour": {
+        "foo": 128,
+        "bar": 64,
+        "baz": 32
+      },
+      "last_day": {
+        "foo": 3072,
+        "bar": 1536,
+        "baz": 768
+      }
+    }
+  },
+  "dependencies": {
+    "cache": {
+      "status": "HEALTHY"
+    },
+    "database": {
+      "status": "HEALTHY",
+      "details": {
+        "connection": "read_write",
+        "reads": {
+          "last_hour": 1234,
+          "last_day": 29616
+        }
+      }
+    }
+  }
+}
+```
+
+## Requirements
+
+Top level keys, `status` and `dependencies` are **REQUIRED**.
+
+* The `status` key **MUST** have one of the values listed in the specification
+  for the `/health/status` response
+* A `details` key is **RECOMMENDED** to be included which contains a dictionary
+  of any metrics the service has.
+* The `dependencies` key **MUST** contain a dictionary of all services on which
+  your service depends on.
+  * Keys **MUST** be unique for each service.
+  * Values **MUST** be a dictionary containing at least the key `status`
+    * Valid values for `status`:
+      * `HEALTHY`
+      *`UNHEALTHY`
+  * A `details` key **MAY** be added with any additional information to report
+    on the service.

data/README.md

@@ -1,5 +1,9 @@
 # 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)
+
+
 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
 own.

data/Rakefile

@@ -1 +1,5 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/lib/wellness.rb

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

data/lib/wellness/services/sidekiq_service.rb

@@ -8,7 +8,7 @@ module Wellness
       def check
         sidekiq_stats = Sidekiq::Stats.new
         queue = Sidekiq::Queue.new
-        redis = Redis.new(host: params[:redis_host])
+        redis = Redis.new(self.params.fetch(:redis))
         redis_stats = redis.info.select { |k, _| KEYS.include?(k) }
         workers_size = redis.scard("workers").to_i
 

data/lib/wellness/version.rb

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

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
 require 'rspec'
 require 'wellness'
 

data/wellness.gemspec

@@ -21,4 +21,5 @@ 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')
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wellness
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Matthew Johnston
@@ -52,6 +52,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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
 email:
 - warmwaffles@gmail.com
@@ -63,12 +77,13 @@ files:
 - .rspec
 - .ruby-gemset
 - .ruby-version
+- .travis.yml
+- DOCUMENTATION.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/wellness.rb
-- lib/wellness/checker.rb
 - lib/wellness/middleware.rb
 - lib/wellness/services/base.rb
 - lib/wellness/services/postgres_service.rb

data/lib/wellness/checker.rb

@@ -1,7 +0,0 @@
-require 'wellness/middleware'
-
-module Wellness
-  # Backwards compatibility. This isn't a proper name for something that is
-  # supposed to be in the middleware.
-  Checker = Wellness::Middleware
-end