rapporteur 3.0.2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18491d6668aca4eab9adff7243c0ec9368453052
-  data.tar.gz: 9e11081bda92072f1121f7d681feb89cb4e8558f
+  metadata.gz: 740374b415d28c691af4809b890ea97cc8123608
+  data.tar.gz: 4807f028b631e7eeb3140164ac6568a61743f731
 SHA512:
-  metadata.gz: 377f759129b400cc99c6a6e67b6273d1dcb713b25deae97774bfc3bf01aa4d0709f6916e200f2b57a91c7113826639121afd076066edf954d2657336e4ed2aa7
-  data.tar.gz: 534a635a0f4c185662135a09ef0996e4e21a62f7834095997e4a291a853570ecd0c9cf6fcae2509b20fdfa6b495db679c5203d1388fe2e3ffc3404719c4976f9
+  metadata.gz: 427a910ae0ed9b2f33dfbbb2a3440b96b50c5d5ceb8af606a5eaf66d71001de2da7bd669807624bba663c940f1ac9ed0d87da485d4328c080e657895363acc76
+  data.tar.gz: b92fe37f5c3887638cecd112d537208ed258e8d42d920e721ca5500a48552b2312c718d2d945f7c87acd7866fb471a2036386621ac95d8dd2b8d346d02c5957d

data/.travis.yml

@@ -1,11 +1,9 @@
 language: ruby
 rvm:
   - 1.9.3
-  - 2.0.0
-  - 2.1.0
+  - 2.1.2
   - jruby-19mode
 gemfile:
-  - gemfiles/rails3.1.gemfile
   - gemfiles/rails3.2.gemfile
   - gemfiles/rails4.x.gemfile
 notifications:

data/Appraisals

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

data/CHANGELOG.md

@@ -4,6 +4,17 @@
 
 * No significant changes.
 
+## [3.1.0][v3.1.0] / 2014-07-03
+
+* Remove the explicit railties dependency (was at `'>= 3.1', '< 4.2'`). This
+  allows Rapporteur to be used in Sinatra applications without loading
+  railties, actionpack, etc.
+* Update the packaged RSpec matchers to allow matching against regular
+  expressions or strings.
+* Add support for deprecation-less RSpec 3 by introducing rapporteur/rspec3.
+* Removed official support for Rails 3.1.x, as it is no longer supported by the
+  Rails core team.
+
 ## [3.0.2][v3.0.2] / 2014-05-17
 
 * Test for and allow compatibility with railties 4.1.
@@ -81,7 +92,8 @@
 * Initial public release.
 
 
-[unreleased]: https://github.com/codeschool/rapporteur/compare/v3.0.2...master
+[unreleased]: https://github.com/codeschool/rapporteur/compare/v3.1.0...master
+[v3.1.0]: https://github.com/codeschool/rapporteur/compare/v3.0.2...v3.1.0
 [v3.0.2]: https://github.com/codeschool/rapporteur/compare/v3.0.1...v3.0.2
 [v3.0.1]: https://github.com/codeschool/rapporteur/compare/v3.0.0...v3.0.1
 [v3.0.0]: https://github.com/codeschool/rapporteur/compare/v2.1.0...v3.0.0

data/README.md

@@ -1,8 +1,10 @@
 # Rapporteur (rap-or-TUHR)
 
-[![Gem Version](https://badge.fury.io/rb/rapporteur.png)](http://badge.fury.io/rb/rapporteur)
-[![Build Status](https://travis-ci.org/codeschool/rapporteur.png?branch=master)](https://travis-ci.org/codeschool/rapporteur)
-[![Code Climate](https://codeclimate.com/github/codeschool/rapporteur.png)](https://codeclimate.com/github/codeschool/rapporteur)
+[![Gem Version](http://img.shields.io/gem/v/rapporteur.svg)](http://rubygems.org/gems/rapporteur)
+[![Build Status](http://img.shields.io/travis/codeschool/rapporteur/master.svg)](https://travis-ci.org/codeschool/rapporteur)
+[![Code Climate](http://img.shields.io/codeclimate/github/codeschool/rapporteur.svg)](https://codeclimate.com/github/codeschool/rapporteur)
+[![Dependency Status](https://gemnasium.com/codeschool/rapporteur.svg)](https://gemnasium.com/codeschool/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
@@ -48,7 +50,7 @@ $ bundle install
 
 Supported Ruby versions:
 
-* MRI 2.1.0
+* MRI 2.1
 * MRI 2.0.0
 * MRI 1.9.3
 * MRI 1.9.2
@@ -59,14 +61,11 @@ Supported Rails versions:
 * Rails 4.1.x.
 * Rails 4.0.x.
 * Rails 3.2.x.
-* Rails 3.1.x.
 
-## Usage
+Non-Rails environments are also supported (such as Sinatra), see Usage below
+for details.
 
-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.
+## Usage
 
 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
@@ -102,6 +101,39 @@ link_to status_path
 Were you already using the `/status.json` endpoint or the "status" route name?
 Hmm. Well... you just broke it.
 
+### Usage without Rails (i.e. Sinatra)
+
+If your application does not have Rails loaded, the Rails Engine logic will be
+bypassed. In this case, you must configure and run your Rapporteur reports
+manually because, in the very least, your status route will not be
+automatically generated as previously described.
+
+So, here is an example usage in Sinatra:
+
+```ruby
+require 'rapporteur'
+require 'my_app/api/endpoint'
+
+module MyApp
+  module API
+    module Endpoints
+      class Status < Endpoint
+        get "/status.json" do
+          status 200
+          json Rapporteur.run.as_json
+        end
+      end
+    end
+  end
+end
+```
+
+Require `rapporteur` and then, at some point, call `Rapporteur.run` to execute
+the configured checks. `as_json` will convert the result of the `run` into a
+Hash which is ready for JSON generation. At that point, do whatever you need to
+do with the Hash to have your framework of choice generate and respond with
+JSON.
+
 ## Customization
 
 ### Adding checks

data/Rakefile

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

data/gemfiles/rails3.2.gemfile

@@ -2,8 +2,8 @@
 
 source "https://rubygems.org"
 
-gem "activerecord-jdbcsqlite3-adapter", :platforms=>:jruby
-gem "sqlite3", :platforms=>:ruby
+gem "activerecord-jdbcsqlite3-adapter", :platforms => :jruby
+gem "sqlite3", :platforms => :ruby
 gem "railties", "~> 3.2.0"
 
-gemspec :path=>"../"
+gemspec :path => "../"

data/gemfiles/rails4.x.gemfile

@@ -2,8 +2,8 @@
 
 source "https://rubygems.org"
 
-gem "activerecord-jdbcsqlite3-adapter", :platforms=>:jruby
-gem "sqlite3", :platforms=>:ruby
+gem "activerecord-jdbcsqlite3-adapter", :platforms => :jruby
+gem "sqlite3", :platforms => :ruby
 gem "railties", "~> 4.0"
 
-gemspec :path=>"../"
+gemspec :path => "../"

data/lib/rapporteur/rspec.rb

@@ -44,7 +44,7 @@ end
 RSpec::Matchers.define :include_status_error_message do |attribute, message|
   match do |response|
     @body = JSON.parse(response.body)
-    @body.fetch('errors', {}).fetch(attribute.to_s).include?(message)
+    @body.fetch('errors', {}).fetch(attribute.to_s).match(message)
   end
 
   failure_message_for_should do |actual|
@@ -59,7 +59,7 @@ end
 RSpec::Matchers.define :include_status_message do |name, message|
   match do |response|
     @body = JSON.parse(response.body)
-    @body.has_key?(name) && @body.fetch(name).include?(message)
+    @body.has_key?(name) && @body.fetch(name).match(message)
   end
 
   failure_message_for_should do |actual|

data/lib/rapporteur/rspec3.rb

@@ -0,0 +1,69 @@
+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
+  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 |attribute, message|
+  match do |response|
+    @body = JSON.parse(response.body)
+    @body.fetch('errors', {}).fetch(attribute.to_s).match(message)
+  end
+
+  failure_message_when_negated do |actual|
+    "expected #{@body.inspect} to not include a #{attribute}:#{message.inspect} error message"
+  end
+end
+
+RSpec::Matchers.define :include_status_message do |name, message|
+  match do |response|
+    @body = JSON.parse(response.body)
+
+    @body.has_key?(name) && @body.fetch(name).match(message)
+  end
+
+  failure_message do |actual|
+    "expected #{@body.inspect} to include a #{name.inspect}: #{message.inspect} message"
+  end
+
+  failure_message_when_negated do |actual|
+    "expected #{@body.inspect} to not include a #{name.inspect}: #{message.inspect} message"
+  end
+end

data/lib/rapporteur/version.rb

@@ -1,3 +1,3 @@
 module Rapporteur
-  VERSION = "3.0.2"
+  VERSION = "3.1.0"
 end

data/rapporteur.gemspec

@@ -19,11 +19,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'i18n', '~> 0.6'
-  spec.add_dependency 'railties', '>= 3.1', '< 4.2'
 
-  spec.add_development_dependency "appraisal", "~> 0.5"
+  spec.add_development_dependency "appraisal", "~> 1.0"
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "combustion", "~> 0.5", ">= 0.5.1"
-  spec.add_development_dependency "rails", ">= 3.1", "< 4.1"
-  spec.add_development_dependency "rspec-rails", "~> 2.11"
+  spec.add_development_dependency "rails", ">= 3.1", "< 4.2"
+  spec.add_development_dependency "rspec-rails", "~> 3.0"
+  spec.add_development_dependency "rspec-collection_matchers", "~> 1.0"
 end

data/spec/models/check_list_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Rapporteur::CheckList do
+describe Rapporteur::CheckList, :type => :model do
   let(:list) { described_class.new }
 
   context '#add' do

data/spec/models/message_list_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Rapporteur::MessageList do
+describe Rapporteur::MessageList, :type => :model do
   let(:list) { Rapporteur::MessageList.new(:errors) }
 
   before { I18n.backend.reload! }

data/spec/requests/active_record_check_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe 'A status request with an ActiveRecordCheck' do
+describe 'A status request with an ActiveRecordCheck', :type => :request do
   before do
     Rapporteur.add_check(Rapporteur::Checks::ActiveRecordCheck)
   end
@@ -13,7 +13,7 @@ describe 'A status request with an ActiveRecordCheck' do
 
   context 'with a failed ActiveRecord connection' do
     before do
-      ActiveRecord::Base.connection.stub(:execute).
+      allow(ActiveRecord::Base.connection).to receive(:execute).
         and_raise(ActiveRecord::ConnectionNotEstablished)
     end
 

data/spec/requests/halt_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe 'A check calling #halt!' do
+describe 'A check calling #halt!', :type => :request do
   before do
     Rapporteur.add_check { |checker| checker.add_message(:one, 1) }
     Rapporteur.add_check { |checker| checker.add_message(:two, 2).halt! }

data/spec/requests/messsage_addition_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe 'A status request with a check that modifies messages' do
+describe 'A status request with a check that modifies messages', :type => :request do
   subject { get(status_path) ; response }
 
   context 'creating a message with a block' do

data/spec/requests/no_checks_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe 'A status request with no checks' do
+describe 'A status request with no checks', :type => :request do
   subject { get(status_path) ; response }
 
   it_behaves_like 'a successful status response'

data/spec/requests/revision_check_spec.rb

@@ -1,8 +1,8 @@
 require 'spec_helper'
 
-describe 'A status request with a RevisionCheck' do
+describe 'A status request with a RevisionCheck', :type => :request do
   before do
-    Rapporteur::Revision.stub(:current) { 'revisionidentifier' }
+    allow(Rapporteur::Revision).to receive(:current).and_return('revisionidentifier')
     Rapporteur.add_check(Rapporteur::Checks::RevisionCheck)
   end
 

data/spec/requests/time_check_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe 'A status request with a TimeCheck' do
+describe 'A status request with a TimeCheck', :type => :request do
   before do
     Rapporteur.add_check(Rapporteur::Checks::TimeCheck)
   end
@@ -11,8 +11,8 @@ describe 'A status request with a TimeCheck' do
 
   context 'the response payload' do
     it 'contains the time in ISO8601' do
-      Time.stub(:now).and_return(Time.gm(2013,8,23))
-      expect(subject).to include_status_message('time', Time.gm(2013,8,23).iso8601)
+      allow(Time).to receive(:now).and_return(Time.gm(2013,8,23))
+      expect(subject).to include_status_message('time', /^2013-08-23T00:00:00(?:.000)?Z$/)
     end
   end
 end

data/spec/routing/routes_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper.rb'
 
-describe "status routes" do
+describe "status routes", :type => :routing do
   it 'routes /status.json to statuses#show' do
     expect({ :get => '/status.json'}).to route_to({
       :action => 'show',

data/spec/spec_helper.rb

@@ -6,10 +6,10 @@ ENV["RAILS_ENV"] ||= 'test'
 Combustion.initialize! :action_controller, :active_record
 
 require 'rspec/rails'
-require 'rapporteur/rspec'
+require 'rspec/collection_matchers'
+require 'rapporteur/rspec3'
 
 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
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rapporteur
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.1.0
 platform: ruby
 authors:
 - Envy Labs
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-17 00:00:00.000000000 Z
+date: 2014-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -25,40 +25,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: railties
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -102,7 +82,7 @@ dependencies:
         version: '3.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '4.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -112,21 +92,35 @@ dependencies:
         version: '3.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.11'
+        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: rspec-collection_matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '1.0'
 description: An engine that provides common status polling endpoint.
 email:
 - ''
@@ -147,7 +141,6 @@ files:
 - config.ru
 - config/locales/en.yml
 - config/routes.rb
-- gemfiles/rails3.1.gemfile
 - gemfiles/rails3.2.gemfile
 - gemfiles/rails4.x.gemfile
 - lib/rapporteur.rb
@@ -161,6 +154,7 @@ files:
 - lib/rapporteur/responder.rb
 - lib/rapporteur/revision.rb
 - lib/rapporteur/rspec.rb
+- lib/rapporteur/rspec3.rb
 - lib/rapporteur/version.rb
 - rapporteur.gemspec
 - spec/internal/config/database.yml
@@ -198,7 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.3.0
 signing_key: 
 specification_version: 4
 summary: An engine that provides common status polling endpoint.

data/gemfiles/rails3.1.gemfile

@@ -1,9 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activerecord-jdbcsqlite3-adapter", :platforms=>:jruby
-gem "sqlite3", :platforms=>:ruby
-gem "railties", "~> 3.1.0"
-
-gemspec :path=>"../"