goodguide-pinglish 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 21349b68ac1102b95ac9e8e37ce9a8199af64d56
-  data.tar.gz: 65b356ff81337fa6e66d58547cec1eb8b1ff3fa5
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MzVmMGY0ODBmZTRmZGMwOTI3OTg2MDY5MGU5NDllMzNjZjkwZTk1OQ==
+  data.tar.gz: !binary |-
+    NzI2YTdjODVlYTk4YmRiYjU1OGZhZjg2OWIwYWRkZGE5ZWU1YmRlNg==
 SHA512:
-  metadata.gz: c6923231c568bcc36da5dc6569b57d23118fd64e14238a05b365409c2f82b189e3df45d8ba729b810e92f866cef66d59b83600b5e489b05b2afddfdad26cce05
-  data.tar.gz: 88ec461eeac036dcfde251f0b62fae7f3ad6a9cb5c17598528b9e20baae72b5d22743815208df81f323b40e7aab81b82f20b79956916f45be7bdd7143cdb0166
+  metadata.gz: !binary |-
+    M2Q0M2RlYWUyOWI0NDVkMDQxZTQ0NWU4Nzg1M2NkZGMyMTkwZDdiZDE4MmQz
+    MjI4ZmZmZmQ3MmViNWVhNjk5MWYzZjdhYzRkNzJkYjk2YzQ2ODczMzhhYjg1
+    NzA5YTk3Yjc5YTVjM2E1MTI1ZjlhMWJiNzk5Y2U5ZWNhMmQ2NGY=
+  data.tar.gz: !binary |-
+    ZGI5MWVhYmE0ZDI0NGRhYThjNTIxMDJkMDQ2NWVkZWZhMGIzZDA2MGM1NGMy
+    MjRjZjRlNDI3M2ZiNmQ0MThmZGI3ZTlhMjVmZTZkNGFlYTc4YzA1MDcxY2My
+    Yjc5OTFhYzU1NWIxYjk1YjM0YWI5NGY3MzZlMmY2MWY0MDhhY2E=

data/.gitignore

@@ -1,3 +1,3 @@
-/*.gem
 /.bundle
 /Gemfile.lock
+/pkg

data/.travis.yml

@@ -0,0 +1,25 @@
+language: ruby
+rvm:
+  - 2.2.0
+  - 2.1.0
+  - 2.0.0
+  - jruby-20mode
+  - rbx-2
+  - ruby-head
+  - jruby-head
+before_install: gem install bundler
+
+bundler_args: --jobs=4 --retry=5
+
+deploy:
+  provider: rubygems
+  api_key:
+    secure: "qiQxYOFzzLDzrgovDfF+1QnpGA4cNrCbNJsQJvaQfEyAglbSdSTPHcz0jDp9gYcPrJiz/YytFhoRgsrp2tKduu32mr+fjuQdXuZZ/xAiJ9BQlxvwuB8zds7Nbqgr5XuQkJFy11yZvQLDwaxeuErrmx7KusFUPV8ZksKnZjU+drc="
+  gem: goodguide-pinglish
+  on:
+    repo: GoodGuide/pinglish
+    tags: true
+
+notifications:
+  slack:
+    secure: "uFaT+WAFDeXr6BCaNXExQx0Iqh7La4E9rG9NctqP3sP2EQGzFMndTLrnLJcQQm8jPHlczqSkL/Ct9BMUEYOt7C3B3d86rZ0ml21IYFjZD8wt3TEorVOh1XaE2WoEtpn587q7AbSWoVWcl5/66c8dlot8/GGNORkl/gjU9kIgDFY="

data/README.md

@@ -1,12 +1,10 @@
 # Pinglish
 
-A simple Rack middleware for checking application health. Pinglish
-exposes a `/_ping` resource via HTTP `GET`, returning JSON that
-conforms to the spec below.
+A simple Rack app for checking application health. Pinglish responds to `GET` requests, returning JSON that conforms to the spec below.
 
 ## The Spec
 
-0. The application __must__ respond to `GET /_ping` as an HTTP request.
+0. The application __must__ respond to `GET /` as an HTTP request.
 
 0. The request handler __should__ check the health of all services the
   application depends on, answering questions like, "Can I query
@@ -52,57 +50,48 @@ conforms to the spec below.
 
 ```javascript
 {
-
   // These two keys will always exist.
-
   "now": "1359055102",
   "status": "failures",
 
   // This key may only exist when a named check has failed.
-
   "failures": ["db"],
 
   // This key may only exist when a named check exceeds its timeout.
-
   "timeouts": ["really-long-check"],
 
   // Keys like this may exist to provide extra information about
   // healthy services, like the number of objects in an S3 bucket.
-
   "s3": "127"
 }
 ```
 
-## The Middleware
+## Configuring Checks
 
 ```ruby
 require "pinglish"
 
-use Pinglish do |ping|
-
-  # A single unnamed check is the simplest possible way to use
-  # Pinglish, and you'll probably never want combine it with other
-  # named checks. An unnamed check contributes to overall success or
-  # failure, but never adds additional data to the response.
-
+pinglish = Pinglish.new do |ping|
+  # A single unnamed check is the simplest possible way to use Pinglish, and
+  # you'll probably never want combine it with other named checks. An unnamed
+  # check contributes to overall success or failure, but never adds additional
+  # data to the response.
   ping.check do
     App.healthy?
   end
 
-  # A named check like this can provide useful summary information
-  # when it succeeds. In this case, a top-level "db" key will appear
-  # in the response containing the number of items in the database. If
-  # a check returns nil, no key will be added to the response.
-
+  # A named check like this can provide useful summary information when it
+  # succeeds. In this case, a top-level "db" key will appear in the response
+  # containing the number of items in the database. If a check returns nil, no
+  # key will be added to the response.
   ping.check :db do
     App.db.items.size
   end
 
-  # By default, checks time out after one second. You can override
-  # this with the :timeout option, but be aware that no combination of
-  # checks is ever allowed to exceed the overall 29 second limit.
-
-  ping.check :long, :timeout => 5 do
+  # By default, checks time out after one second. You can override this with the
+  # :timeout option, but be aware that no combination of checks is ever allowed
+  # to exceed the overall 29 second limit.
+  ping.check :long, timeout: 5 do
     App.dawdle
   end
 
@@ -115,5 +104,46 @@ use Pinglish do |ping|
   ping.check :false_fails do
     false
   end
+
+  # All checks run, by default. To create a check that is only run when
+  # requested, provide `false` for the `:enabled_by_default` option. Checks like
+  # this can be requested using the `checks` query parameter (see below).
+  ping.check :cpu_intensive_check, enabled_by_default: false do
+    App.check_all_the_things
+  end
 end
 ```
+
+## Usage
+
+Use in a Rack app is easy, just mount the app within a `map` block.
+
+```ruby
+# config.ru
+map '/_ping' do
+  run Pinglish.new { |ping|
+    ping.check do
+      App.healthy?
+    end
+  }
+end
+
+run App.new
+```
+
+Now requests to `GET /_ping` will return this response:
+
+```json
+{
+  "now": "1359055102",
+  "status": "ok"
+}
+```
+
+You can supply an optional `checks` query parameter (comma separated names) to select which checks to run. This can be used to run just a subset, or to select checks which have `enabled_by_default` set to `false`.
+
+```
+GET /_ping?checks=foo,bar,default
+```
+
+(In this case, an unnamed check is referred to as `default`, and is not treated specially -- you must specify `default` if you pass this parameter and want it to run.)

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+end
+
+task default: :test
+
+# rubygems releases are done by Travis
+Rake::Task['release:rubygem_push'].clear

data/goodguide-pinglish.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |gem|
   gem.name          = "goodguide-pinglish"
-  gem.version       = "1.0.0"
+  gem.version       = "1.1.0"
   gem.authors       = ["John Barnette", "Will Farrington"]
   gem.email         = ["jbarnette@github.com", "wfarr@github.com"]
   gem.description   = "A simple Rack middleware for checking app health."
@@ -14,6 +14,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_dependency "rack"
+  gem.add_development_dependency 'rake', '~> 10.4.0'
   gem.add_development_dependency "minitest", "~> 4.5"
   gem.add_development_dependency "rack-test", "~> 0.6"
 end

data/lib/pinglish/check.rb

@@ -1,21 +1,19 @@
 class Pinglish
   class Check
-    attr_reader :group
     attr_reader :name
     attr_reader :timeout
+    attr_reader :enabled_by_default
 
-    def initialize(name, options = nil, &block)
-      options ||= {}
-      @group    = options[:group]
-      @name     = name
-      @timeout  = options[:timeout] || 1
-      @block    = block
+    def initialize(name, options={}, &block)
+      @name = name
+      @timeout = options.fetch(:timeout, 1)
+      @enabled_by_default = !!options.fetch(:enabled_by_default, true)
+      @block = block
     end
 
     # Call this check's behavior, returning the result of the block.
-
     def call(*args, &block)
-      @block.call *args, &block
+      @block.call(*args, &block)
     end
   end
 end

data/lib/pinglish.rb

@@ -107,7 +107,7 @@ class Pinglish
       selected = selected.split(',').map(&:to_sym)
       return @checks.values_at(*selected).compact
     end
-    @checks.values
+    @checks.values.select(&:enabled_by_default)
   end
 
   # Add a new check with optional `name`. A `:timeout` option can be
@@ -115,7 +115,7 @@ class Pinglish
   # one second default. A previously added check with the same name
   # will be replaced.
 
-  def check(name = :default, options = nil, &block)
+  def check(name=:default, options={}, &block)
     @checks[name.to_sym] = Check.new(name, options, &block)
   end
 

data/test/check_test.rb

@@ -20,4 +20,15 @@ class PinglishCheckTest < MiniTest::Unit::TestCase
     check = Pinglish::Check.new(:db) { :result_of_block }
     assert_equal :result_of_block, check.call
   end
+
+  def test_enabled_by_default
+    check = Pinglish::Check.new(:foo)
+    assert_equal true, check.enabled_by_default
+
+    check = Pinglish::Check.new(:foo, enabled_by_default: false)
+    assert_equal false, check.enabled_by_default
+
+    check = Pinglish::Check.new(:foo, enabled_by_default: 'not boolean')
+    assert_equal true, check.enabled_by_default
+  end
 end

data/test/pinglish_test.rb

@@ -259,4 +259,48 @@ class PinglishTest < MiniTest::Unit::TestCase
     assert pinglish.timeout?(Pinglish::TooLong.new)
     refute pinglish.timeout?(Exception.new)
   end
+
+  def test_enabled_by_default_false
+    app = build_app do |ping|
+      ping.check(:db) { :ok }
+      ping.check(:intense, enabled_by_default: false) { :ok }
+    end
+
+    session = Rack::Test::Session.new(app)
+    session.get "/_ping"
+
+    assert_equal 200, session.last_response.status
+    assert_equal "application/json; charset=UTF-8",
+      session.last_response.content_type
+
+    json = JSON.load(session.last_response.body)
+    assert json.key?("now")
+    assert_equal "ok", json["status"]
+    assert_equal false, json.key?("timeouts")
+    assert_equal false, json.key?("failures")
+    assert_equal 'ok', json['db']
+    assert_equal false, json.key?("intense")
+  end
+
+  def test_enabled_by_default_selected
+    app = build_app do |ping|
+      ping.check(:db) { :ok }
+      ping.check(:intense, enabled_by_default: false) { :ok }
+    end
+
+    session = Rack::Test::Session.new(app)
+    session.get "/_ping?checks=db,intense"
+
+    assert_equal 200, session.last_response.status
+    assert_equal "application/json; charset=UTF-8",
+      session.last_response.content_type
+
+    json = JSON.load(session.last_response.body)
+    assert json.key?("now")
+    assert_equal "ok", json["status"]
+    assert_equal false, json.key?("timeouts")
+    assert_equal false, json.key?("failures")
+    assert_equal 'ok', json['db']
+    assert_equal 'ok', json["intense"]
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: goodguide-pinglish
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - John Barnette
@@ -9,48 +9,62 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-25 00:00:00.000000000 Z
+date: 2015-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.4.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4.5'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.6'
 description: A simple Rack middleware for checking app health.
@@ -61,10 +75,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
+- Rakefile
 - goodguide-pinglish.gemspec
 - lib/pinglish.rb
 - lib/pinglish/check.rb
@@ -83,22 +99,21 @@ 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.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: "/_ping your way to freedom."
+summary: /_ping your way to freedom.
 test_files:
 - test/check_test.rb
 - test/helper.rb
 - test/pinglish_test.rb
-has_rdoc: