okcomputer 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b812534cc64ea2d62713fc45f157328f39cc65bd
-  data.tar.gz: 9491b4230918e0f3a5ee6b659894df6d4175db77
+  metadata.gz: 3a38df5e1069db78fedda2655d6b741d26e2df89
+  data.tar.gz: 71173a3054b80f1eb1b63c0f41881543affa4184
 SHA512:
-  metadata.gz: d13b8ef6db3eef841b9004e50ce131e9b9bc9facfdd891926ad23b92a506ad2b1ccfba87ad3a870697b6b228980444a16cc7ba77a5a227130b94995db60004c7
-  data.tar.gz: 8b03ede46d95b674fe64dade6ca95a3579ea74c97452bc129be28ab54bae7e9445b4d25304ee59abf7376166d46d006700d9a8980cc69a9e47ec4599c4d89940
+  metadata.gz: 62a0d7a18575982c768012957c05482a2ad1c159741aef7de3c5349bc0bf97b375745ea718b3ffecbfeb1c5f374d1cad8bbd94f37195882d5f901259257d6833
+  data.tar.gz: 429ab7284ea63dcd63eb8959712d0953bdf708cb85986562d7d7638aa2780746bceb037f1cdcfc581bb9c47aa9f430d5970cef126dadc66bd613ad8780e69f51

data/README.markdown

@@ -40,12 +40,12 @@ We also include a MongoidCheck, but do not register it. If you use Mongoid,
 replace the default ActiveRecord check like so:
 
 ```ruby
-OKComputer::Registry.register "database", OKComputer::MongoidCheck.new
+OkComputer::Registry.register "database", OkComputer::MongoidCheck.new
 ```
 
 If you use another database adapter, see Registering Custom Checks below to
 build your own database check and register it with the name "database" to
-replace the built-in check, or use `OKComputer::Registry.deregister "database"`
+replace the built-in check, or use `OkComputer::Registry.deregister "database"`
 to stop checking your database altogether.
 
 ### Requiring Authentication
@@ -54,7 +54,29 @@ Optionally require HTTP Basic authentication to view the results of checks in an
 
 ```ruby
 # config/initializers/okcomputer.rb
-OKComputer.require_authentication("username", "password")
+OkComputer.require_authentication("username", "password")
+```
+
+### Changing the OkComputer Route
+
+By default, OkComputer routes are mounted at `/okcomputer`. If you'd like to use an alternate route,
+you can configure it with:
+
+```ruby
+# config/initializers/okcomputer.rb
+OkComputer.mount_at = 'health_checks'    # mounts at /health_checks
+```
+
+For more control of adding OkComputer to your routes, set `OkComputer.mount_at
+= false` to disable automatic mounting, and you can manually mount the engine
+in your `routes.rb`.
+
+```ruby
+# config/initializers/okcomputer.rb
+OkComputer.mount_at = false
+
+# config/routes.rb, at any priority that suits you
+mount OkComputer::Engine, at: "/custom_path"
 ```
 
 ### Registering Additional Checks
@@ -63,20 +85,20 @@ Register additional checks in an initializer, like so:
 
 ```ruby
 # config/initializers/okcomputer.rb
-OKComputer::Registry.register "resque_down", OKComputer::ResqueDownCheck.new
-OKComputer::Registry.register "resque_backed_up", OKComputer::ResqueBackedUpCheck.new("critical", 100)
+OkComputer::Registry.register "resque_down", OkComputer::ResqueDownCheck.new
+OkComputer::Registry.register "resque_backed_up", OkComputer::ResqueBackedUpCheck.new("critical", 100)
 ```
 
 ### Registering Custom Checks
 
 The simplest way to register a check unique to your application is to subclass
-OKComputer::Check and implement your own `#check` method, which sets the
+OkComputer::Check and implement your own `#check` method, which sets the
 display message with `mark_message`, and calls `mark_failure` if anything is
 wrong.
 
 ```ruby
 # config/initializers/okcomputer.rb
-class MyCustomCheck < OKComputer::Check
+class MyCustomCheck < OkComputer::Check
   def check
     if rand(10).even?
       mark_message "Even is great!"
@@ -87,7 +109,7 @@ class MyCustomCheck < OKComputer::Check
   end
 end
 
-OKComputer::Registry.register "check_for_odds", MyCustomCheck.new
+OkComputer::Registry.register "check_for_odds", MyCustomCheck.new
 ```
 
 ## Performing Checks
@@ -102,19 +124,22 @@ Checks are available as plain text (by default) or JSON by appending .json, e.g.
 
 ## OkComputer NewRelic Ignore
 
-If you use OKComputer for uptime checks, it will start to artificially bring your
-request time down on NewRelic. To avoid that, check out
-[this gem](https://github.com/sportngin/okcomputer-newrelic-ignore).
+If NewRelic is installed, OkComputer automatically disables NewRelic monitoring for uptime checks,
+as it will start to artificially bring your request time down.
+
+If you'd like to intentionally count OkComputer requests in your NewRelic analytics, set:
+
+```
+# config/initializers/okcomputer.rb
+OkComputer.analytics_ignore = false
+```
 
 ## Deprecations and Breaking Changes
 
-#### Deprecation of Check#call
+#### Namespace change from `OKComputer` to `OkComputer`
 
-Versions before 0.2.0 implemented a "#call" method which returned the message.
-This has been deprecated and will be removed in a future version. Please
-define a #check method which calls `mark_failure` and `mark_message` as
-appropriate. In the meantime, OKComputer displays a warning and uses the result
-of the #call method as the message.
+OkComputer has changed its namespace from `OKComputer` (uppercase K) to `OkComputer` (lowercase k)
+as of version 0.7.0. Please update your configuration accordingly.
 
 #### Breaking Changes of JSON Output
 
@@ -145,6 +170,14 @@ example:
 {"check": "result", "other": "result"}
 ```
 
+#### Deprecation of Check#call
+
+Versions before 0.2.0 implemented a "#call" method which returned the message.
+This has been deprecated and will be removed in a future version. Please
+define a #check method which calls `mark_failure` and `mark_message` as
+appropriate. In the meantime, OkComputer displays a warning and uses the result
+of the #call method as the message.
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -5,9 +5,6 @@ rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
-load 'rails/tasks/engine.rake'
-
 Bundler::GemHelper.install_tasks
 
 task :default => :spec

data/app/controllers/ok_computer/ok_computer_controller.rb

@@ -0,0 +1,55 @@
+module OkComputer
+  class OkComputerController < ActionController::Base
+    layout nil
+    respond_to :text, :html, :json
+
+    before_filter :authenticate
+
+    if OkComputer.analytics_ignore && defined?(NewRelic::Agent::Instrumentation::ControllerInstrumentation)
+      include NewRelic::Agent::Instrumentation::ControllerInstrumentation
+      newrelic_ignore if respond_to?(:newrelic_ignore)
+    end
+
+    rescue_from OkComputer::Registry::CheckNotFound do |e|
+      respond_to do |f|
+        f.any(:text, :html) { render text: e.message, status: :not_found }
+        f.json { render json: { error: e.message }, status: :not_found }
+      end
+    end
+
+    def index
+      checks = OkComputer::Registry.all
+      checks.run
+
+      respond checks, status_code(checks)
+    end
+
+    def show
+      check = OkComputer::Registry.fetch(params[:check])
+      check.run
+
+      respond check, status_code(check)
+    end
+
+  private
+
+    def respond(data, status)
+      respond_to do |format|
+         format.any(:text, :html) { render text: data, status: status }
+         format.json { render json: data, status: status }
+      end
+    end
+
+    def status_code(check)
+      check.success? ? :ok : :error
+    end
+
+    def authenticate
+      if OkComputer.requires_authentication?(params)
+        authenticate_or_request_with_http_basic do |username, password|
+          OkComputer.authenticate(username, password)
+        end
+      end
+    end
+  end
+end

data/config/routes.rb

@@ -1,5 +1,12 @@
-Rails.application.routes.draw do
-  match "/okcomputer" => "ok_computer#show", defaults: {check: "default"}, via: [:get, :options]
-  match "/okcomputer/all" => "ok_computer#index", via: [:get, :options]
-  match "/okcomputer/:check" => "ok_computer#show", via: [:get, :options]
+OkComputer::Engine.routes.draw do
+  root to: "ok_computer#show", defaults: {check: "default"}, via: [:get, :options]
+  match "/all" => "ok_computer#index", via: [:get, :options]
+  match "/:check" => "ok_computer#show", via: [:get, :options]
+end
+
+if OkComputer.mount_at
+  # prepend sets at a higher priority than "catchall" routes
+  Rails.application.routes.prepend do
+    mount OkComputer::Engine => OkComputer.mount_at, as: "okcomputer"
+  end
 end

data/lib/{okcomputer → ok_computer}/built_in_checks/active_record_check.rb

@@ -1,4 +1,4 @@
-module OKComputer
+module OkComputer
   class ActiveRecordCheck < Check
     # Public: Return the schema version of the database
     def check

data/lib/ok_computer/built_in_checks/cache_check.rb

@@ -0,0 +1,32 @@
+module OkComputer
+  class CacheCheck < Check
+
+    ConnectionFailed = Class.new(StandardError)
+
+    # Public: Check whether the cache is active
+    def check
+      mark_message "Cache is available (#{stats})"
+    rescue ConnectionFailed => e
+      mark_failure
+      mark_message "Error: '#{e}'"
+    end
+
+    # Public: Outputs stats string for cache
+    def stats
+      stats    = Rails.cache.stats
+      host     = stats.select{|k,v| k =~ Regexp.new(Socket.gethostname) }.values[0]
+      mem_used = to_megabytes host['bytes']
+      mem_max  = to_megabytes host['limit_maxbytes']
+      return "#{mem_used} / #{mem_max} MB, #{stats.count - 1} peers"
+    rescue => e
+      raise ConnectionFailed, e
+    end
+
+    private
+
+    # Private: Convert bytes to megabytes
+    def to_megabytes(bytes)
+      bytes.to_i / (1024 * 1024)
+    end
+  end
+end

data/lib/{okcomputer → ok_computer}/built_in_checks/default_check.rb

@@ -1,4 +1,4 @@
-module OKComputer
+module OkComputer
   class DefaultCheck < Check
     # Public: Check that Rails can render anything at all
     def check

data/lib/{okcomputer → ok_computer}/built_in_checks/delayed_job_backed_up_check.rb

@@ -1,4 +1,4 @@
-module OKComputer
+module OkComputer
   class DelayedJobBackedUpCheck < SizeThresholdCheck
     attr_accessor :priority
     attr_accessor :threshold
@@ -22,7 +22,11 @@ module OKComputer
 
     # Public: How many delayed jobs are pending within the given priority
     def size
-      Delayed::Job.where("priority <= ?", priority).where(:locked_at => nil, :last_error => nil).count
+      if defined?(::Delayed::Backend::Mongoid::Job) && Delayed::Worker.backend == Delayed::Backend::Mongoid::Job
+        Delayed::Job.lte(priority: priority).where(:locked_at => nil, :last_error => nil).count
+      else
+        Delayed::Job.where("priority <= ?", priority).where(:locked_at => nil, :last_error => nil).count
+      end
     end
   end
 end

data/lib/{okcomputer → ok_computer}/built_in_checks/mongoid_check.rb

@@ -1,4 +1,4 @@
-module OKComputer
+module OkComputer
   class MongoidCheck < Check
     # Public: Return the status of the mongodb
     def check
@@ -12,7 +12,11 @@ module OKComputer
     #
     # Returns a hash with the status of the db
     def mongodb_stats
-      Mongoid.database.stats
+      if Mongoid.respond_to?(:default_session)
+        Mongoid.default_session.command(dbStats: 1) # Mongoid 3+
+      else
+        Mongoid.database.stats # Mongoid 2
+      end
     rescue => e
       raise ConnectionFailed, e
     end
@@ -27,4 +31,3 @@ module OKComputer
     ConnectionFailed = Class.new(StandardError)
   end
 end
-

data/lib/{okcomputer → ok_computer}/built_in_checks/resque_backed_up_check.rb

@@ -1,4 +1,4 @@
-module OKComputer
+module OkComputer
   class ResqueBackedUpCheck < SizeThresholdCheck
     attr_accessor :queue
     attr_accessor :threshold

data/lib/{okcomputer → ok_computer}/built_in_checks/resque_down_check.rb

@@ -1,4 +1,4 @@
-module OKComputer
+module OkComputer
   class ResqueDownCheck < Check
     # Public: Check whether Resque workers are working
     def check

data/lib/{okcomputer → ok_computer}/built_in_checks/ruby_version_check.rb

@@ -1,4 +1,4 @@
-module OKComputer
+module OkComputer
   class RubyVersionCheck < Check
     def check
       mark_message "Ruby #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"

data/lib/{okcomputer → ok_computer}/built_in_checks/size_threshold_check.rb

@@ -1,4 +1,4 @@
-module OKComputer
+module OkComputer
   class SizeThresholdCheck < Check
     attr_accessor :size_proc
     attr_accessor :threshold

data/lib/{okcomputer → ok_computer}/check.rb

@@ -1,4 +1,4 @@
-module OKComputer
+module OkComputer
   class Check
     CALL_DEPRECATION_MESSAGE = "Deprecation warning: Please define #check rather than defining #call"
 

data/lib/{okcomputer → ok_computer}/check_collection.rb

@@ -1,4 +1,4 @@
-module OKComputer
+module OkComputer
   class CheckCollection
     attr_accessor :registry
 

data/lib/{okcomputer → ok_computer}/configuration.rb

@@ -1,4 +1,4 @@
-module OKComputer
+module OkComputer
   # Public: Configure HTTP Basic authentication
   #
   # username - Username required to view checks
@@ -8,10 +8,10 @@ module OKComputer
   #
   # Examples:
   #
-  #     OKComputer.require_authentication("foo", "bar")
+  #     OkComputer.require_authentication("foo", "bar")
   #     # => Require authentication with foo:bar for all checks
   #
-  #     OKComputer.require_authentication("foo", "bar", except: %w(default nonsecret))
+  #     OkComputer.require_authentication("foo", "bar", except: %w(default nonsecret))
   #     # => Require authentication with foo:bar for all checks except the checks named "default" and "nonsecret"
   def self.require_authentication(username, password, options = {})
     self.username = username
@@ -31,7 +31,7 @@ module OKComputer
     username == username_try && password == password_try
   end
 
-  # Public: Whether OKComputer is configured to require authentication
+  # Public: Whether OkComputer is configured to require authentication
   #
   # Returns a Boolean
   def self.requires_authentication?(params={})
@@ -40,41 +40,28 @@ module OKComputer
     username && password
   end
 
-  # attr_accessor isn't doing what I want inside a module, so here we go.
+  # Public: The route to automatically mount the OkComputer engine. Setting to false
+  # prevents OkComputer from automatically mounting itself.
+  mattr_accessor :mount_at
+  self.mount_at = 'okcomputer'
 
-  # Private: The username configured for access to checks
-  def self.username
-    @username
-  end
-  private_class_method :username
+  # Public: Option to disable third-party app performance tools (.e.g NewRelic) from counting OkComputer routes towards their total.
+  mattr_accessor :analytics_ignore
+  self.analytics_ignore = true
 
-  # Private: Configure the username to access checks
-  def self.username=(username)
-    @username = username
-  end
+  # Private: The username for access to checks
+  mattr_accessor :username
+  private_class_method :username
   private_class_method :username=
 
-  # Private: The password configured for access to checks
-  def self.password
-    @password
-  end
+  # Private: The password for access to checks
+  mattr_accessor :password
   private_class_method :password
-
-  # Private: Configure the password to access checks
-  def self.password=(password)
-    @password = password
-  end
   private_class_method :password=
 
-  # Private: Set, you know, options
-  def self.options=(options)
-    @options = options
-  end
-
-  # Private: Get, you know, options
-  def self.options
-    @options || {}
-  end
+  # Private: The options container
+  mattr_accessor :options
+  self.options = {}
 
   # Private: Configure a whitelist of checks to skip authentication
   def self.whitelist

data/lib/ok_computer/engine.rb

@@ -0,0 +1,5 @@
+module OkComputer
+  class Engine < ::Rails::Engine
+    isolate_namespace OkComputer
+  end
+end

data/lib/{okcomputer → ok_computer}/registry.rb

@@ -1,8 +1,8 @@
-# Private: Storage of the checks which have been registered with OKComputer.
+# Private: Storage of the checks which have been registered with OkComputer.
 #
 # No one is expected to interact directly with this class, but rather through
-# the outer OKComputer interface.
-module OKComputer
+# the outer OkComputer interface.
+module OkComputer
   class Registry
     # Public: Return the check registered to the given name
     #
@@ -22,7 +22,7 @@ module OKComputer
       CheckCollection.new registry
     end
 
-    # Public: Register the given check with OKComputer
+    # Public: Register the given check with OkComputer
     #
     # check_name - The name of the check to retrieve
     # check_object - Instance of Checker to register

data/lib/ok_computer/version.rb

@@ -0,0 +1,3 @@
+module OkComputer
+  VERSION = "0.7.0"
+end

data/lib/okcomputer.rb

@@ -1,22 +1,26 @@
-require "okcomputer/engine"
-require "okcomputer/configuration"
-require "okcomputer/check"
-require "okcomputer/check_collection"
-require "okcomputer/registry"
+require "ok_computer/engine"
+require "ok_computer/configuration"
+require "ok_computer/check"
+require "ok_computer/check_collection"
+require "ok_computer/registry"
 
 # and the built-in checks
-require "okcomputer/built_in_checks/size_threshold_check"
-require "okcomputer/built_in_checks/active_record_check"
-require "okcomputer/built_in_checks/default_check"
-require "okcomputer/built_in_checks/mongoid_check"
-require "okcomputer/built_in_checks/resque_backed_up_check"
-require "okcomputer/built_in_checks/resque_down_check"
-require "okcomputer/built_in_checks/delayed_job_backed_up_check"
-require "okcomputer/built_in_checks/ruby_version_check"
+require "ok_computer/built_in_checks/size_threshold_check"
+require "ok_computer/built_in_checks/active_record_check"
+require "ok_computer/built_in_checks/default_check"
+require "ok_computer/built_in_checks/mongoid_check"
+require "ok_computer/built_in_checks/resque_backed_up_check"
+require "ok_computer/built_in_checks/resque_down_check"
+require "ok_computer/built_in_checks/delayed_job_backed_up_check"
+require "ok_computer/built_in_checks/ruby_version_check"
+require "ok_computer/built_in_checks/cache_check"
 
+# Remove the following code in version 1.0.0
 module OKComputer
+  def self.method_missing(*args)
+    raise 'Please replace all usages of `OKComputer` with `OkComputer` (lowercase `k`)'
+  end
 end
 
-OKComputer::Registry.register "default", OKComputer::DefaultCheck.new
-OKComputer::Registry.register "database", OKComputer::ActiveRecordCheck.new
-
+OkComputer::Registry.register "default", OkComputer::DefaultCheck.new
+OkComputer::Registry.register "database", OkComputer::ActiveRecordCheck.new

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: okcomputer
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Patrick Byrne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-26 00:00:00.000000000 Z
+date: 2014-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
@@ -65,29 +65,33 @@ files:
 - MIT-LICENSE
 - README.markdown
 - Rakefile
-- app/controllers/ok_computer_controller.rb
+- app/controllers/ok_computer/ok_computer_controller.rb
 - config/routes.rb
+- lib/ok_computer/built_in_checks/active_record_check.rb
+- lib/ok_computer/built_in_checks/cache_check.rb
+- lib/ok_computer/built_in_checks/default_check.rb
+- lib/ok_computer/built_in_checks/delayed_job_backed_up_check.rb
+- lib/ok_computer/built_in_checks/mongoid_check.rb
+- lib/ok_computer/built_in_checks/resque_backed_up_check.rb
+- lib/ok_computer/built_in_checks/resque_down_check.rb
+- lib/ok_computer/built_in_checks/ruby_version_check.rb
+- lib/ok_computer/built_in_checks/size_threshold_check.rb
+- lib/ok_computer/check.rb
+- lib/ok_computer/check_collection.rb
+- lib/ok_computer/configuration.rb
+- lib/ok_computer/engine.rb
+- lib/ok_computer/registry.rb
+- lib/ok_computer/version.rb
 - lib/okcomputer.rb
-- lib/okcomputer/built_in_checks/active_record_check.rb
-- lib/okcomputer/built_in_checks/default_check.rb
-- lib/okcomputer/built_in_checks/delayed_job_backed_up_check.rb
-- lib/okcomputer/built_in_checks/mongoid_check.rb
-- lib/okcomputer/built_in_checks/resque_backed_up_check.rb
-- lib/okcomputer/built_in_checks/resque_down_check.rb
-- lib/okcomputer/built_in_checks/ruby_version_check.rb
-- lib/okcomputer/built_in_checks/size_threshold_check.rb
-- lib/okcomputer/check.rb
-- lib/okcomputer/check_collection.rb
-- lib/okcomputer/configuration.rb
-- lib/okcomputer/engine.rb
-- lib/okcomputer/registry.rb
-- lib/okcomputer/version.rb
-- lib/tasks/okcomputer_tasks.rake
 homepage: https://github.com/sportngin/okcomputer
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: |
+  OkComputer Namespace Change (v0.7.0)
+  ------------------------------------
+  OkComputer has changed its namespace from `OKComputer` (uppercase K) to `OkComputer` (lowercase k)
+  as of version 0.7.0. Please update your configuration accordingly.
 rdoc_options: []
 require_paths:
 - lib
@@ -103,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A simple, extensible health-check monitor

data/app/controllers/ok_computer_controller.rb

@@ -1,48 +0,0 @@
-class OkComputerController < ActionController::Base
-  layout nil
-  respond_to :text, :html, :json
-
-  before_filter :authenticate
-
-  rescue_from OKComputer::Registry::CheckNotFound do |e|
-    respond_to do |f|
-      f.any(:text, :html) { render text: e.message, status: :not_found }
-      f.json { render json: { error: e.message }, status: :not_found }
-    end
-  end
-
-  def index
-    checks = OKComputer::Registry.all
-    checks.run
-
-    respond checks, status_code(checks)
-  end
-
-  def show
-    check = OKComputer::Registry.fetch(params[:check])
-    check.run
-
-    respond check, status_code(check)
-  end
-
-private
-
-  def respond(data, status)
-    respond_to do |format|
-       format.any(:text, :html) { render text: data, status: status }
-       format.json { render json: data, status: status }
-    end
-  end
-
-  def status_code(check)
-    check.success? ? :ok : :error
-  end
-
-  def authenticate
-    if OKComputer.requires_authentication?(params)
-      authenticate_or_request_with_http_basic do |username, password|
-        OKComputer.authenticate(username, password)
-      end
-    end
-  end
-end

data/lib/okcomputer/engine.rb

@@ -1,7 +0,0 @@
-module OKComputer
-  class Engine < ::Rails::Engine
-    config.generators do |g|
-      g.test_framework :rspec, :view_specs => false
-    end
-  end
-end

data/lib/okcomputer/version.rb

@@ -1,3 +0,0 @@
-module OKComputer
-  VERSION = "0.6.0"
-end

data/lib/tasks/okcomputer_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :okcomputer do
-#   # Task goes here
-# end