okcomputer 0.2.0 → 0.3.0

data/README.markdown

@@ -1,3 +1,6 @@
+[![Code Climate](https://codeclimate.com/github/tstmedia/okcomputer.png)](https://codeclimate.com/github/tstmedia/okcomputer)
+[![Build Status](https://travis-ci.org/tstmedia/okcomputer.png)](https://travis-ci.org/tstmedia/okcomputer)
+
 # OK Computer
 
 Inspired by the ease of installing and setting up [fitter-happier] as a Rails
@@ -39,9 +42,18 @@ build your own database check and register it with the name "database" to
 replace the built-in check, or use `OKComputer::Registry.deregister "database"`
 to stop checking your database altogether.
 
+### Requiring Authentication
+
+Optionally require HTTP Basic authentication to view the results of checks in an initializer, like so:
+
+```ruby
+# config/initializers/okcomputer.rb
+OKComputer.require_authentication("username", "password")
+```
+
 ### Registering Additional Checks
 
-Register additional checks in an initializer, like do:
+Register additional checks in an initializer, like so:
 
 ```ruby
 # config/initializers/okcomputer.rb
@@ -72,6 +84,18 @@ end
 OKComputer::Registry.register "check_for_odds", MyCustomCheck.new
 ```
 
+## 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
+
+## Deprecations and Breaking Changes
+
 #### Deprecation of Check#call
 
 Versions before 0.2.0 implemented a "#call" method which returned the message.
@@ -80,15 +104,22 @@ 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.
 
-## Performing Checks
+#### Breaking Change of JSON Output
 
-* 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
+Versions before 0.3.0, when performing multiple checks, returned an Array of
+the check results, each being a JSON object. Starting with 0.3.0, these are
+combined into a single JSON object with each check having its own key. For
+example:
 
-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
+**before 0.3.0**
+```json
+[{"check": "result"}, {"other": "result"}]
+```
+
+**0.3.0 and above**
+```json
+{"check": "result", "other": "result"}
+```
 
 ## Contributing
 
@@ -99,3 +130,4 @@ Checks are available as plain text (by default) or JSON by appending .json, e.g.
 5. Create new Pull Request
 
 [fitter-happier]:https://rubygems.org/gems/fitter-happier
+

data/app/controllers/ok_computer_controller.rb

@@ -2,6 +2,15 @@ class OkComputerController < ActionController::Base
   layout nil
   respond_to :text, :json
 
+  before_filter :authenticate
+
+  rescue_from OKComputer::Registry::CheckNotFound do |e|
+    respond_to do |f|
+      f.text { 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
@@ -20,4 +29,13 @@ class OkComputerController < ActionController::Base
     check.success? ? :ok : :error
   end
   private :status_code
+
+  def authenticate
+    if OKComputer.requires_authentication?
+      authenticate_or_request_with_http_basic do |username, password|
+        OKComputer.authenticate(username, password)
+      end
+    end
+  end
+  private :authenticate
 end

data/lib/okcomputer.rb

@@ -1,4 +1,5 @@
 require "okcomputer/engine"
+require "okcomputer/configuration"
 require "okcomputer/check"
 require "okcomputer/check_collection"
 require "okcomputer/registry"

data/lib/okcomputer/check_collection.rb

@@ -33,8 +33,13 @@ module OKComputer
     #
     # 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(",")}]"
+      # smooshing their #to_json objects into one JSON hash
+      combined = {}
+      checks.each do |check|
+        combined.merge!(JSON.parse(check.to_json))
+      end
+
+      combined.to_json
     end
 
     # Public: Whether all the checks succeed

data/lib/okcomputer/configuration.rb

@@ -0,0 +1,55 @@
+module OKComputer
+  # Public: Configure HTTP Basic authentication
+  #
+  # username - Username required to view checks
+  # password - Password required to view checks
+  def self.require_authentication(username, password)
+    self.username = username
+    self.password = password
+  end
+
+  # Public: Attempt to authenticate against required username and password
+  #
+  # username - Username to authenticate with
+  # password - Password to authenticate with
+  #
+  # Returns a Boolean
+  def self.authenticate(username_try, password_try)
+    return true unless requires_authentication?
+
+    username == username_try && password == password_try
+  end
+
+  # Public: Whether OKComputer is configured to require authentication
+  #
+  # Returns a Boolean
+  def self.requires_authentication?
+    username && password
+  end
+
+  # attr_accessor isn't doing what I want inside a module, so here we go.
+
+  # Private: The username configured for access to checks
+  def self.username
+    @username
+  end
+  private_class_method :username
+
+  # Private: Configure the username to access checks
+  def self.username=(username)
+    @username = username
+  end
+  private_class_method :username=
+
+  # Private: The password configured for access to checks
+  def self.password
+    @password
+  end
+  private_class_method :password
+
+  # Private: Configure the password to access checks
+  def self.password=(password)
+    @password = password
+  end
+  private_class_method :password=
+end

data/lib/okcomputer/version.rb

@@ -1,3 +1,3 @@
 module OKComputer
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -2,14 +2,14 @@
 name: okcomputer
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Patrick Byrne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-04 00:00:00.000000000 Z
+date: 2013-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
@@ -78,6 +78,7 @@ files:
 - lib/okcomputer/built_in_checks/resque_down_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
@@ -99,7 +100,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1241122917546608114
+      hash: -2545106061881900479
   none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
@@ -108,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1241122917546608114
+      hash: -2545106061881900479
   none: false
 requirements: []
 rubyforge_project: