okcomputer 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,61 @@
+# OK Computer
+
+Inspired by the ease of installing and setting up [fitter-happier] as a Rails
+application's health check, but frustrated by its lack of flexibility, OK
+Computer was born. It provides a robust endpoint to perform server health
+checks with a set of built-in plugins, as well as a simple interface to add
+your own custom checks.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'okcomputer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install okcomputer
+
+## Usage
+
+To perform the default checks (application running and database connection), do nothing other than adding to your application's Gemfile.
+
+### Registering Additional Checks
+
+Register additional checks in an initializer, like do:
+
+```ruby
+# config/initializers/okcomputer.rb
+OKComputer::Registry.register "resque", OKComputer::Checks::Resque
+OKComputer::Registry.register "load", OKComputer::Checks::CPULoad
+```
+
+TODO: Figure out interface for configuring checks (e.g., Resque looking for more than 100 jobs in the "critical" queue)
+
+### Registering Custom Checks
+
+TODO: Figre out interface for custom checks
+
+## Performing Checks
+
+* Perform a simple up check: http://example.com/okcomputer
+* Perform all installed checks: http://example.com/okcomputer/all
+* Perform a specific installed check: http://example.com/okcomputer/database
+
+Checks are available as plain text (by default) or JSON by appending .json, e.g.:
+* http://example.com/okcomputer.json
+* http://example.com/okcomputer/all.json
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+[fitter-happier]:https://rubygems.org/gems/fitter-happier

data/Rakefile

@@ -0,0 +1,24 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+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
+
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+namespace :spec do
+  RSpec::Core::RakeTask.new(:docs) do |t|
+    t.rspec_opts = ["--format doc"]
+  end
+end
+

data/app/controllers/ok_computer_controller.rb

@@ -0,0 +1,21 @@
+class OkComputerController < ApplicationController
+  layout nil
+  respond_to :text, :json
+
+  def index
+    checks = OKComputer::Registry.all
+
+    respond_with checks, status: status_code(checks)
+  end
+
+  def show
+    check = OKComputer::Registry.fetch(params[:check])
+
+    respond_with check, status: status_code(check)
+  end
+
+  def status_code(check)
+    check.success? ? :ok : :error
+  end
+  private :status_code
+end

data/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+  match "/okcomputer" => "ok_computer#show", defaults: {check: "default", format: "text"}
+  match "/okcomputer/all(.:format)" => "ok_computer#index", defaults: {format: "text"}
+  match "/okcomputer/(:check)(.:format)" => "ok_computer#show", defaults: {format: "text"}
+end

data/lib/okcomputer.rb

@@ -0,0 +1,17 @@
+require "okcomputer/engine"
+require "okcomputer/check"
+require "okcomputer/check_collection"
+require "okcomputer/registry"
+
+# and the built-in checks
+require "okcomputer/built_in_checks/default_check"
+require "okcomputer/built_in_checks/database_check"
+require "okcomputer/built_in_checks/resque_backed_up_check"
+require "okcomputer/built_in_checks/resque_down_check"
+
+module OKComputer
+end
+
+OKComputer::Registry.register "default", OKComputer::DefaultCheck.new
+OKComputer::Registry.register "database", OKComputer::DatabaseCheck.new
+

data/lib/okcomputer/built_in_checks/database_check.rb

@@ -0,0 +1,22 @@
+module OKComputer
+  class DatabaseCheck < Check
+    # Public: Return the schema version of the database
+    def call
+      "Schema version: #{schema_version}"
+    rescue ConnectionFailed => e
+      mark_failure
+      "Failed to connect: '#{e}'"
+    end
+
+    # Public: The scema version of the app's database
+    #
+    # Returns a String with the version number
+    def schema_version
+      ActiveRecord::Migrator.current_version
+    rescue => e
+      raise ConnectionFailed, e
+    end
+
+    ConnectionFailed = Class.new(StandardError)
+  end
+end

data/lib/okcomputer/built_in_checks/default_check.rb

@@ -0,0 +1,8 @@
+module OKComputer
+  class DefaultCheck < Check
+    # Public: Check that Rails can render anything at all
+    def call
+      "OKComputer Site Check Passed"
+    end
+  end
+end

data/lib/okcomputer/built_in_checks/resque_backed_up_check.rb

@@ -0,0 +1,31 @@
+module OKComputer
+  class ResqueBackedUpCheck < Check
+    attr_accessor :queue
+    attr_accessor :threshold
+
+    # Public: Initialize a check for a backed-up Resque queue
+    #
+    # queue - The name of the Resque queue to check
+    # threshold - An Integer to compare the queue's count against to consider
+    #   it backed up
+    def initialize(queue, threshold)
+      self.queue = queue
+      self.threshold = Integer(threshold)
+    end
+
+    # Public: Check whether the given queue is backed up
+    def call
+      if count <= threshold
+        "Resque queue '#{queue}' at reasonable level (#{count})"
+      else
+        mark_failure
+        "Resque queue '#{queue}' backed up! (#{count})"
+      end
+    end
+
+    # Public: The number of jobs in the check's queue
+    def count
+      Resque.size(queue)
+    end
+  end
+end

data/lib/okcomputer/built_in_checks/resque_down_check.rb

@@ -0,0 +1,36 @@
+module OKComputer
+  class ResqueDownCheck < Check
+    attr_accessor :queue
+
+    # Public: Initilize a check for whether Resque is running
+    #
+    # queue - The name of the Resque queue to check
+    def initialize(queue)
+      self.queue = queue
+    end
+
+    # Public: Check whether Resque workers are working
+    def call
+      if queued? and not working?
+        mark_failure
+        "Resque is DOWN. No workers are working the queue."
+      else
+        "Resque is working"
+      end
+    end
+
+    # Public: Whether the given Resque queue has jobs
+    #
+    # Returns a Boolean
+    def queued?
+      Resque.info.fetch(:pending) > 0
+    end
+
+    # Public: Whether the Resque has workers working on a job
+    #
+    # Returns a Boolean
+    def working?
+      Resque.info.fetch(:working) > 0
+    end
+  end
+end

data/lib/okcomputer/check.rb

@@ -0,0 +1,46 @@
+module OKComputer
+  class Check
+    # to be set by Registry upon registration
+    attr_accessor :name
+    # nil by default, only set to true if the check deems itself failed
+    attr_accessor :failure_occurred
+
+    # Public: Perform the appropriate check
+    #
+    # Your subclass of Check must define its own #call method. This method
+    # must return the string to render when performing the check.
+    def call
+      raise(CallNotDefined, "Your subclass must define its own #call.")
+    end
+
+    # Public: The text output of performing the check
+    #
+    # Returns a String
+    def to_text
+      "#{name}: #{call}"
+    end
+
+    # Public: The JSON output of performing the check
+    #
+    # Returns a String containing JSON
+    def to_json(*args)
+      # NOTE swallowing the arguments that Rails passes by default since we don't care. This may prove to be a bad idea
+      # Rails passes stuff like this: {:prefixes=>["ok_computer", "application"], :template=>"show", :layout=>#<Proc>}]
+      {name => call}.to_json
+    end
+
+    # Public: Whether the check passed
+    #
+    # Returns a boolean
+    def success?
+      not failure_occurred
+    end
+
+    # Public: Mark that this check has failed in some way
+    def mark_failure
+      self.failure_occurred = true
+    end
+
+    CallNotDefined = Class.new(StandardError)
+  end
+end

data/lib/okcomputer/check_collection.rb

@@ -0,0 +1,42 @@
+module OKComputer
+  class CheckCollection
+    attr_accessor :registry
+
+    # Public: Initialize a new CheckCollection
+    #
+    # registry - a Hash of checks, with keys being unique names and values
+    #   being Check instances
+    def initialize(registry={})
+      self.registry = registry
+    end
+
+    # Public: The list of checks in the collection
+    #
+    # Returns an Array of the registry's values
+    def checks
+      registry.values
+    end
+
+    # Public: The text of each check in the collection
+    #
+    # Returns a String
+    def to_text
+      checks.map(&:to_text).join("\n")
+    end
+
+    # Public: The JSON of each check in the collection
+    #
+    # Returns a String containing a JSON array of hashes
+    def to_json(*args)
+      # smooshing their #to_json objects into a JSON array
+      "[#{checks.map(&:to_json).join(",")}]"
+    end
+
+    # Public: Whether all the checks succeed
+    #
+    # Returns a Boolean
+    def success?
+      checks.all?(&:success?)
+    end
+  end
+end

data/lib/okcomputer/engine.rb

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

data/lib/okcomputer/registry.rb

@@ -0,0 +1,51 @@
+# 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
+  class Registry
+    # Public: Return the check registered to the given name
+    #
+    # check_name - The name of the check to retrieve
+    #
+    # Returns the registered check or raises Registry::CheckNotFound
+    def self.fetch(check_name)
+      registry.fetch(check_name)
+    rescue KeyError
+      raise CheckNotFound, "No check registered with '#{check_name}'"
+    end
+
+    # Public: Return an object containing all the registered checks
+    #
+    # Returns a CheckCollection instance
+    def self.all
+      CheckCollection.new registry
+    end
+
+    # Public: Register the given check with OKComputer
+    #
+    # check_name - The name of the check to retrieve
+    # check_object - Instance of Checker to register
+    def self.register(check_name, check_object)
+      check_object.name = check_name
+      registry[check_name] = check_object
+    end
+
+    # Public: Remove the check of the given name being checked
+    #
+    # check_name - The name of the check to retrieve
+    def self.deregister(check_name)
+      registry.delete(check_name)
+    end
+
+    # Private: The list of registered checks, keyed by their unique names
+    #
+    # Returns a Hash
+    def self.registry
+      @registry ||= {}
+    end
+
+    # used when fetching a check that has not been registered
+    CheckNotFound = Class.new(StandardError)
+  end
+end

data/lib/okcomputer/version.rb

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

data/lib/tasks/okcomputer_tasks.rake

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

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: okcomputer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Patrick Byrne
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! "\n    Inspired by the simplicity of Fitter Happier, but frustrated
+  by its lack of\n    flexibility, we built OK Computer. Create and register your
+  own custom\n    health checks, or choose from the built-in library of checks to
+  ensure your\n    app is working as intended.\n  "
+email:
+- patrick.byrne@tstmedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/controllers/ok_computer_controller.rb
+- config/routes.rb
+- lib/okcomputer/built_in_checks/database_check.rb
+- lib/okcomputer/built_in_checks/default_check.rb
+- lib/okcomputer/built_in_checks/resque_backed_up_check.rb
+- lib/okcomputer/built_in_checks/resque_down_check.rb
+- lib/okcomputer/check.rb
+- lib/okcomputer/check_collection.rb
+- lib/okcomputer/engine.rb
+- lib/okcomputer/registry.rb
+- lib/okcomputer/version.rb
+- lib/okcomputer.rb
+- lib/tasks/okcomputer_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.markdown
+homepage: https://github.com/tstmedia/okcomputer
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2558154404506305637
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2558154404506305637
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A simple, extensible health-check monitor
+test_files: []