rapporteur 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NDgwNmQ2Yjc2Yzc3Y2NhMTk5YmMwMmFjNWNhZTQ3YWY2NGM0OTFjNw==
+  data.tar.gz: !binary |-
+    NDg0Njg3NTBiZmYyZmM0ODVjOGY0ZTIzYWE5MTcyMmI0M2U4ZjJjOQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NTE4NWFlODVmMjcxZjg3YTExZGIxMDQyNmI1OWM3ZmQxMGU5MzgyMmVjNDlk
+    MjMyYzE2NGYzMTQ0YzdjM2Q5ZTNhNmMzNGEyOTUwZDM5NjAyYzU2Y2ExNzY5
+    ZjQ5YTlmZWRiNWZhODQ4YjcxNzJkOTlmNWMxOWExODNiMTdiYzQ=
+  data.tar.gz: !binary |-
+    YjM5OTIzNjM0MDI5ODU1YjA3ZTc2ZDYwM2RlYWIwYTIzODljMmViY2YwNzg5
+    YThmMThkMzExMzAxOGZkMWU1YmQxMmE0NTMzNTg4N2E3M2ZlOTMxYTU3OGY5
+    MWIwNjUwNTJlODQ2OTAyZGU5NWNjYjBlNjZkMmM1ODMyMDU4Nzg=

data/.gitignore

@@ -0,0 +1,22 @@
+.rvmrc
+.ruby-version
+.ruby-gemset
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+*.gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.sqlite

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+gemfile:
+  - gemfiles/rails3.1.gemfile
+  - gemfiles/rails3.2.gemfile
+notifications:
+  email: false
+  campfire:
+    on_success: change
+    on_failure: always
+    rooms:
+      - secure: "gxEt3SeVn1kup6PfB6hiQu6eWsefmMEdd8U1qPSS6vlRjsM7Xy2IrXdz9gdl\n0nrrRgESvOxT3sqMh4/opH6M1kbtCyl3M0yvjF2QUtjWQ+4BStJGhNyXlDTp\nNAas19fuEUPBNxNqoy7aTVBiFpQRs0NisEZTS3+N3eA2tz757Qk="

data/Appraisals

@@ -0,0 +1,7 @@
+appraise "rails3.1" do
+  gem "railties", "~> 3.1.0"
+end
+
+appraise "rails3.2" do
+  gem "railties", "~> 3.2.0"
+end

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Rapporteur
+
+## [HEAD][unreleased] / unreleased
+
+* No significant changes.
+
+## 1.0.0 / 2013-05-19
+
+* Initial public release.
+
+
+[unreleased]: https://github.com/codeschool/rapporteur/compare/v1.0.0...master

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Envy Labs LLC and Code School LLC
+
+MIT License
+
+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.md

@@ -0,0 +1,219 @@
+# Rapporteur
+
+This gem provides a singular, status-checking endpoint to your application. The
+endpoint provides a JSON response with either an HTTP 200 or an HTTP 500
+response, depending on the current application environment.
+
+When the environment tests successfully, an HTTP 200 response is returned with
+the current application Git revision and server time:
+
+```json
+{
+  "revision": "906731e6467ea381ba5bc70f103b85ed4178fee7",
+  "time": "2013-05-19T05:38:46Z"
+}
+```
+
+When an application validation fails, an HTTP 500 response is returned with a
+collection of error messages, similar to the default Rails responders for model
+validations:
+
+```json
+{
+  "errors": {
+    "base": ["The application database is inaccessible or unavailable"]
+  }
+}
+```
+
+## Installation
+
+Supported Ruby versions:
+
+* MRI 1.9.2
+* MRI 1.9.3
+
+Supported Rails versions:
+
+* Rails 3.1.x.
+* Rails 3.2.x.
+
+To install, add this line to your application's Gemfile:
+
+    gem 'rapporteur'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Simply adding the gem requirement to your Gemfile is enough to install and
+automatically load and configure the gem. Technically speaking, the gem is a
+Rails Engine, so it auto-initializes with Rails starts up. There is no further
+configuration necessary.
+
+By default, there are no application checks that run and the status endpoint
+simply reports the current application revision and time. This is useful for a
+basic connectivity check to be watched by a third party service like Pingdom
+for a very simple, non-critical application.
+
+You may optionally use any of the pre-defined checks (such as the ActiveRecord
+connection check) to expand the robustness of the status checks. Adding a check
+will execute that check each time the status endpoint is requested, so be
+somewhat wary of doing _too_ much. See more in the [Adding checks
+section](#adding-checks), below.
+
+Further, you can define your own checks which could be custom to your
+application or environment and report their own, unique errors.  The only
+requirement is that the check objects are callable (respond to `#call`, like a
+Proc). See more in the [Creating custom checks
+section](#creating-custom-checks), below.
+
+### The endpoint
+
+This gem provides a new, single endpoint in your application. Specifically, it
+creates a named `/status.json` route, with the "status" name. It does not match
+on any other format or variation, which isolates the pollution of your
+application routes.
+
+If you'd like to link to the status endpoint from within your application (why,
+I couldn't guess), you can use a standard Rails URL helper:
+
+```ruby
+link_to status_path
+```
+
+Were you already using the `/status.json` endpoint or the "status" route name?
+Hmm. Well... you just broke it.
+
+## Customization
+
+### Adding checks
+
+This gem ships with the following checks tested and packaged:
+
+* **Rapporteur::Checks::ActiveRecordCheck** - Performs a trivial test
+  of the current `ActiveRecord::Base.connection` to ensure basic database
+  connectivity.
+
+To add checks to your application, define the checks you'd like to run in your
+environment or application configuration files or initializers, such as:
+
+```ruby
+# config/initializers/rapporteur.rb
+Rapporteur::Checker.add_check(Rapporteur::Checks::ActiveRecordCheck)
+```
+
+Or, make an environment specific check with:
+
+```ruby
+# config/environments/production.rb
+MyApplication.configure do
+  config.to_prepare do
+    Rapporteur::Checker.add_check(Rapporteur::Checks::ActiveRecordCheck)
+  end
+end
+```
+
+### Creating custom checks
+
+It is simple to add a custom check to the status endpoint. All that is required
+is that you give the checker an object that is callable. In your object, simply
+check for the state of the world that you're interested in, and if you're not
+happy with it, add an error to the given `checker` instance:
+
+```ruby
+# config/initializers/rapporteur.rb
+
+my_proc_check = lambda { |checker|
+  checker.add_error("You have bad luck!") if rand(10) > 5
+}
+
+Rapporteur::Checker.add_check(my_proc_check)
+
+class MyClassCheck
+  def self.call(checker)
+    @@counter ||= 0
+    checker.add_error("Stop calling me!!") if @@counter > 50
+  end
+end
+
+Rapporteur::Checker.add_check(MyClassCheck)
+```
+
+Certainly, the definition and registration of the checks do not need to occur
+within the same file, but you get the idea. Also: Please make your checks more
+useful than those defined above. ;)
+
+You could create a checker for your active Redis connection, Memcached
+connections, disk usage percentage, process count, memory usage, or really
+anything you like. Again, because these checks get executed every time the
+status endpoint is called, **be mindful of the tradeoffs when making a check that
+may be resource intensive**.
+
+### Customizing the revision
+
+If you need to customize the way in which the current application revision is
+calculated (by default it runs a `git rev-parse HEAD`), you may do so by
+modifying the necessary environment file or creating an initializer in your
+Rails application:
+
+```ruby
+# config/initializers/rapporteur.rb
+Rapporteur::Revision.current = "revision123"
+```
+
+```ruby
+# config/environments/production.rb
+MyApplication.configure do
+  config.to_prepare do
+    Rapporteur::Revision.current = "revision123"
+  end
+end
+```
+
+You may pass a String or a callable object (Proc) to `.current=` and it will be
+executed and memoized. Useful examples of this are:
+
+```ruby
+# Read a Capistrano REVISION file
+Rapporteur::Revision.current = Rails.root.join("REVISION").read.strip
+
+# Force a particular directory and use Git
+Rapporteur::Revision.current = `cd "#{Rails.root}" && git rev-parse HEAD`.strip
+
+# Use an ENV variable (Heroku)
+Rapporteur::Revision.current = ENV["REVISION"]
+
+# Do some crazy calculation
+Rapporteur::Revision.current = lambda { MyRevisionCalculator.execute! }
+```
+
+### Customizing the error messages
+
+The error messages displayed in the event that application validations fail are
+all collected through I18n. There are default localization strings provided
+with the gem, but you may override them as necessary, simply by redefining them
+in a locales file within your local application.
+
+For example, to override the database check failure message:
+
+```yaml
+en:
+  activemodel:
+    errors:
+      models:
+        rapporteur/checker:
+          attributes:
+            base:
+              database_unavailable: "Something went wrong"
+```
+
+## 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

data/Rakefile

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

data/app/controllers/statuses_controller.rb

@@ -0,0 +1,10 @@
+class StatusesController < ActionController::Base
+  self.responder = Rapporteur::Responder
+  respond_to :json
+
+  def show
+    respond_with(Rapporteur::Checker.run, {
+      serializer: Rapporteur::Serializer
+    })
+  end
+end

data/config/locales/en.yml

@@ -0,0 +1,8 @@
+en:
+  activemodel:
+    errors:
+      models:
+        rapporteur/checker:
+          attributes:
+            base:
+              database_unavailable: "The application database is inaccessible or unavailable"

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  get 'status.json', to: 'statuses#show', defaults: {format: 'json'}, as: :status
+end

data/config.ru

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+Combustion.initialize!
+run Combustion::Application

data/gemfiles/rails3.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "railties", "~> 3.1.0"
+
+gemspec :path=>"../"

data/gemfiles/rails3.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "railties", "~> 3.2.0"
+
+gemspec :path=>"../"

data/lib/rapporteur/checker.rb

@@ -0,0 +1,111 @@
+require 'singleton'
+require 'set'
+
+module Rapporteur
+  # The center of the Rapporteur library, Checker manages holding and running
+  # the custom checks, holding any application error messages, and provides the
+  # controller with that data for rendering.
+  #
+  class Checker
+    include Singleton
+    include ActiveModel::Validations
+    include ActiveModel::SerializerSupport
+
+
+    # Public: Add a pre-built or custom check to your status endpoint. These
+    # checks are used to test the state of the world of the application, and
+    # need only respond to `#call`.
+    #
+    # Once added, the given check will be called and passed an instance of this
+    # checker. If everything is good, do nothing! If there is a problem, use
+    # `add_error` to add an error message to the checker.
+    #
+    # Examples
+    #
+    #   Rapporteur::Checker.add_check(lambda { |checker|
+    #     checker.add_error("Bad luck.") if rand(2) == 1
+    #   })
+    #
+    # Returns Rapporteur::Checker.
+    # Raises ArgumentError if the given check does not respond to call.
+    #
+    def self.add_check(object)
+      raise ArgumentError, "A check must respond to #call." unless object.respond_to?(:call)
+      instance.checks << object
+      self
+    end
+
+    # Public: Empties all configured checks from the checker. This may be
+    # useful for testing and for cases where you might've built up some basic
+    # checks but for one reason or another (environment constraint) need to
+    # start from scratch.
+    #
+    # Returns Rapporteur::Checker.
+    #
+    def self.clear
+      instance.checks.clear
+      self
+    end
+
+    # Public: This is the primary execution point for this class. Use run to
+    # exercise the configured checker and collect any application errors or
+    # data for rendering.
+    #
+    # Returns a Rapporteur::Checker instance.
+    #
+    def self.run
+      instance.errors.clear
+      instance.run
+    end
+
+
+    # Public: Add an error message to the checker in order to have it rendered
+    # in the status request.
+    #
+    # It is suggested that you use I18n and locale files for these messages, as
+    # is done with the pre-built checks. If you're using I19n, you'll need to
+    # define `activemodel.errors.models.rapporteur/checker.attributes.base.<your key>`.
+    #
+    # Examples
+    #
+    #   checker.add_error("You failed.")
+    #   checker.add_error(:i18n_key_is_better)
+    #
+    # Returns the Rapporteur::Checker instance.
+    #
+    def add_error(message)
+      errors.add(:base, message)
+      self
+    end
+
+    # Public: Returns the Set of checks currently configured.
+    #
+    def checks
+      @checks ||= Set.new
+    end
+
+    # Public: Returns a String containing the current revision of the
+    # application.
+    #
+    def revision
+      Revision.current
+    end
+
+    # Public: Executes the configured checks.
+    #
+    # Returns the Rapporteur::Checker instance.
+    #
+    def run
+      checks.each do |object|
+        object.call(self)
+      end
+      self
+    end
+
+    # Public: Returns a Time instance containing the current system time.
+    #
+    def time
+      Time.now
+    end
+  end
+end

data/lib/rapporteur/checks/active_record_check.rb

@@ -0,0 +1,11 @@
+module Rapporteur
+  module Checks
+    class ActiveRecordCheck
+      def self.call(checker)
+        ActiveRecord::Base.connection.execute("SELECT current_time AS time").first.fetch('time')
+      rescue
+        checker.add_error(:database_unavailable)
+      end
+    end
+  end
+end

data/lib/rapporteur/checks.rb

@@ -0,0 +1,5 @@
+module Rapporteur
+  module Checks
+    autoload :ActiveRecordCheck, 'rapporteur/checks/active_record_check'
+  end
+end

data/lib/rapporteur/engine.rb

@@ -0,0 +1,4 @@
+module Rapporteur
+  class Engine < Rails::Engine
+  end
+end

data/lib/rapporteur/responder.rb

@@ -0,0 +1,32 @@
+module Rapporteur
+  # A customization of the default Rails ActionController::Responder.
+  # Primarily, this is used to smooth out the differences between Rails
+  # responder versions and allow for error messages in GET requests.
+  #
+  class Responder < ActionController::Responder
+    # Internal: Overrides the default behavior by ignoring the HTTP verb and
+    # always responding with errors if the rendering resource contains errors.
+    #
+    def to_format
+      if has_errors?
+        display_errors
+      else
+        super
+      end
+    end
+
+
+    protected
+
+
+    if Rails::VERSION::MAJOR == 3 && Rails::VERSION::MINOR == 1
+      def display_errors
+        controller.render format => {errors: resource.errors}, status: :internal_server_error
+      end
+    elsif Rails::VERSION::MAJOR == 3 && Rails::VERSION::MINOR == 2
+      def display_errors
+        controller.render format => resource_errors, status: :internal_server_error
+      end
+    end
+  end
+end

data/lib/rapporteur/revision.rb

@@ -0,0 +1,56 @@
+module Rapporteur
+  # Manages memoizing and maintaining the current application revision.
+  #
+  class Revision
+    class_attribute :_current
+
+    # Public: Returns the current revision as a String.
+    #
+    def self.current
+      self._current ||= calculate_current
+    end
+
+    # Public: Forcibly sets the current application revision.
+    #
+    # revision - Either a String or a callable object (Proc, for example) to
+    #            use your own environment logic to determine the revision.
+    #
+    # Examples
+    #
+    #   Rapporteur::Revision.current = ENV['REVISION'].strip
+    #   Rapporteur::Revision.current = Rails.root.join("REVISION").read.strip
+    #
+    # Returns the revision given.
+    #
+    def self.current=(revision)
+      self._current = calculate_current(revision)
+    end
+
+    # Internal: The default method of determining the current revision. This
+    # assumes a git executable is in the current PATH and that the process
+    # context is running the the appropriate git application directory.
+    #
+    # Returns a String containing the current git revision, hopefully.
+    #
+    def self.default_revision_source
+      `git rev-parse HEAD 2>/dev/null`.strip
+    rescue
+    end
+
+    # Internal: Calculates the current revision from the configured revision
+    # source.
+    #
+    def self.calculate_current(revision = default_revision_source)
+      case revision
+      when String
+        revision
+      when Proc
+        revision.call.to_s
+      when NilClass
+        "You must provide a Rapporteur::Revision.current= String or Proc"
+      else
+        raise ArgumentError, "Unknown revision type given: #{revision.inspect}"
+      end
+    end
+  end
+end

data/lib/rapporteur/rspec.rb

@@ -0,0 +1,68 @@
+require 'rapporteur'
+
+shared_examples_for 'a successful status response' do
+  it 'responds with HTTP 200' do
+    expect(subject.response_code).to(eq(200))
+  end
+
+  it 'responds with a JSON content header' do
+    expect(subject.content_type).to(eq(Mime::JSON))
+  end
+
+  it 'responds with valid JSON' do
+    expect { JSON.parse(subject.body) }.not_to(raise_error)
+  end
+
+  context 'the response payload' do
+    subject { get(status_path) ; JSON.parse(response.body) }
+
+    it 'does not contain errors' do
+      expect(subject).not_to(have_key('errors'))
+    end
+
+    it 'contains the current application revision' do
+      expect(subject.fetch('revision')).to(match(/^[a-f0-9]{40}$/))
+    end
+
+    it 'contains the current time in ISO8601' do
+      time = Time.now
+      Time.stub(:now).and_return(time)
+      expect(subject.fetch('time')).to(match(/^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$/))
+      expect(subject.fetch('time')).to(eq(time.utc.iso8601))
+    end
+  end
+end
+
+shared_examples_for 'an erred status response' do
+  it 'responds with HTTP 500' do
+    expect(subject.response_code).to(eq(500))
+  end
+
+  it 'responds with a JSON content header' do
+    expect(subject.content_type).to(eq(Mime::JSON))
+  end
+
+  it 'responds with valid JSON' do
+    expect { JSON.parse(subject.body) }.not_to(raise_error)
+  end
+
+  it 'contains errors' do
+    expect(JSON.parse(subject.body)).to(have_key('errors'))
+    expect(JSON.parse(subject.body).fetch('errors')).not_to(be_empty)
+  end
+end
+
+RSpec::Matchers.define :include_status_error_message do |message|
+  match do |response|
+    @body = JSON.parse(response.body)
+    @body.fetch('errors', {}).fetch('base').include?(message)
+  end
+
+  failure_message_for_should do |actual|
+    "expected #{@body.inspect} to include a #{message.inspect} error message"
+  end
+
+  failure_message_for_should_not do |actual|
+    "expected #{@body.inspect} to not include a #{message.inspect} error message"
+  end
+end

data/lib/rapporteur/serializer.rb

@@ -0,0 +1,20 @@
+module Rapporteur
+  # An ActiveModel::Serializer used to serialize the checker data for JSON
+  # rendering.
+  #
+  class Serializer < ActiveModel::Serializer
+    self.root = false
+
+    attributes :revision,
+               :time
+
+    # Internal: Converts the checker instance time into UTC to provide a
+    # consistent public representation.
+    #
+    # Returns a Time instance in UTC.
+    #
+    def time
+      object.time.utc
+    end
+  end
+end

data/lib/rapporteur/version.rb

@@ -0,0 +1,3 @@
+module Rapporteur
+  VERSION = "1.0.0"
+end

data/lib/rapporteur.rb

@@ -0,0 +1,15 @@
+require 'active_model_serializers'
+
+require "rapporteur/engine" if defined?(Rails)
+require "rapporteur/version"
+
+# Rapporteur is a Rails Engine which provides your application with an
+# application status endpoint.
+#
+module Rapporteur
+  autoload :Checker, 'rapporteur/checker'
+  autoload :Checks, 'rapporteur/checks'
+  autoload :Responder, 'rapporteur/responder'
+  autoload :Revision, 'rapporteur/revision'
+  autoload :Serializer, 'rapporteur/serializer'
+end

data/rapporteur.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rapporteur/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rapporteur"
+  spec.version       = Rapporteur::VERSION
+  spec.authors       = ["Envy Labs", "Code School"]
+  spec.email         = [""]
+  spec.description   = %q{An engine that provides common status polling endpoint.}
+  spec.summary       = %q{An engine that provides common status polling endpoint.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'active_model_serializers', '>= 0.8'
+  spec.add_dependency 'railties', '~> 3.0'
+
+  spec.add_development_dependency "appraisal", "~> 0.5"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "combustion", "~> 0.5"
+  spec.add_development_dependency "rails", "~> 3.0"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec-rails", "~> 2.0"
+  spec.add_development_dependency "sqlite3"
+end

data/spec/internal/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter:  sqlite3
+  database: db/combustion_test.sqlite

data/spec/internal/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  #
+end

data/spec/internal/db/schema.rb

@@ -0,0 +1,3 @@
+ActiveRecord::Schema.define do
+  #
+end

data/spec/internal/log/.gitignore

@@ -0,0 +1 @@
+*.log

data/spec/requests/active_record_check_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe 'A status request with an ActiveRecordCheck' do
+  before do
+    Rapporteur::Checker.add_check(Rapporteur::Checks::ActiveRecordCheck)
+  end
+
+  subject { get(status_path) ; response }
+
+  context 'with an unerring ActiveRecord connection' do
+    it_behaves_like 'a successful status response'
+  end
+
+  context 'with a failed ActiveRecord connection' do
+    before do
+      ActiveRecord::Base.connection.stub(:execute).
+        and_raise(ActiveRecord::ConnectionNotEstablished)
+    end
+
+    it_behaves_like 'an erred status response'
+
+    it 'contains a message regarding the database failure' do
+      expect(subject).to include_status_error_message(I18n.t('activemodel.errors.models.rapporteur/checker.attributes.base.database_unavailable'))
+    end
+  end
+end

data/spec/requests/no_checks_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe 'A status request with no checks' do
+  before { Rapporteur::Checker.clear }
+
+  subject { get(status_path) ; response }
+
+  it_behaves_like 'a successful status response'
+end

data/spec/routing/routes_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper.rb'
+
+describe "status routes" do
+  it 'routes /status.json to statuses#show' do
+    expect({ get: '/status.json'}).to route_to({
+      action: 'show',
+      controller: 'statuses',
+      format: 'json',
+    })
+  end
+
+  it 'does not route /status' do
+    expect({ get: '/status'}).to_not be_routable
+  end
+
+  it 'does not route /status.html' do
+    expect({ get: '/status.html'}).to_not be_routable
+  end
+
+  it 'does not route /status.xml' do
+    expect({ get: '/status.xml'}).to_not be_routable
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'combustion'
+
+ENV["RAILS_ENV"] ||= 'test'
+Combustion.initialize! :action_controller, :active_record
+
+require 'rspec/rails'
+require 'rapporteur/rspec'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.order = 'random'
+
+  config.before { Rapporteur::Checker.clear }
+end

metadata

@@ -0,0 +1,215 @@
+--- !ruby/object:Gem::Specification
+name: rapporteur
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Envy Labs
+- Code School
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_model_serializers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: An engine that provides common status polling endpoint.
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Appraisals
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/controllers/statuses_controller.rb
+- config.ru
+- config/locales/en.yml
+- config/routes.rb
+- gemfiles/rails3.1.gemfile
+- gemfiles/rails3.2.gemfile
+- lib/rapporteur.rb
+- lib/rapporteur/checker.rb
+- lib/rapporteur/checks.rb
+- lib/rapporteur/checks/active_record_check.rb
+- lib/rapporteur/engine.rb
+- lib/rapporteur/responder.rb
+- lib/rapporteur/revision.rb
+- lib/rapporteur/rspec.rb
+- lib/rapporteur/serializer.rb
+- lib/rapporteur/version.rb
+- rapporteur.gemspec
+- spec/internal/config/database.yml
+- spec/internal/config/routes.rb
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitignore
+- spec/internal/public/favicon.ico
+- spec/requests/active_record_check_spec.rb
+- spec/requests/no_checks_spec.rb
+- spec/routing/routes_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.0.3
+signing_key: 
+specification_version: 4
+summary: An engine that provides common status polling endpoint.
+test_files:
+- spec/internal/config/database.yml
+- spec/internal/config/routes.rb
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitignore
+- spec/internal/public/favicon.ico
+- spec/requests/active_record_check_spec.rb
+- spec/requests/no_checks_spec.rb
+- spec/routing/routes_spec.rb
+- spec/spec_helper.rb