rapporteur 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 740374b415d28c691af4809b890ea97cc8123608
-  data.tar.gz: 4807f028b631e7eeb3140164ac6568a61743f731
+  metadata.gz: 633181a4b53c700cdd2d1c2c0f8a9f6a5f08acda
+  data.tar.gz: 7b29ca2a1e7c9a57424d246ff8c4aa48732cabce
 SHA512:
-  metadata.gz: 427a910ae0ed9b2f33dfbbb2a3440b96b50c5d5ceb8af606a5eaf66d71001de2da7bd669807624bba663c940f1ac9ed0d87da485d4328c080e657895363acc76
-  data.tar.gz: b92fe37f5c3887638cecd112d537208ed258e8d42d920e721ca5500a48552b2312c718d2d945f7c87acd7866fb471a2036386621ac95d8dd2b8d346d02c5957d
+  metadata.gz: 8641338d699725b6612887fa2a3b2cd5b8d3d0b76f66b6e28e0f8960356d3bf674422f1056224fba79d41c877abace918c183e53fe7fc9286350bef659edb659
+  data.tar.gz: ddf0fe2836eb103f1a0af23d039df8a0fb66eec99fd6d01d66b5589de23526569db5d8c561bce60f1c636633e726fe3afe2c46d2c147b242a932d64a9ade2023

data/.rspec

@@ -1,2 +1,3 @@
 --color
 --format progress
+--warnings

data/.travis.yml

@@ -6,6 +6,7 @@ rvm:
 gemfile:
   - gemfiles/rails3.2.gemfile
   - gemfiles/rails4.x.gemfile
+  - gemfiles/sinatra1.x.gemfile
 notifications:
   email: false
   campfire:

data/Appraisals

@@ -5,3 +5,7 @@ end
 appraise "rails4.x" do
   gem "railties", "~> 4.0"
 end
+
+appraise "sinatra1.x" do
+  gem "sinatra", "~> 1.4"
+end

data/CHANGELOG.md

@@ -1,9 +1,22 @@
 # Rapporteur changelog
 
+[![Gem Version](http://img.shields.io/gem/v/rapporteur.svg?style=flat)](http://rubygems.org/gems/rapporteur)
+[![Build Status](http://img.shields.io/travis/codeschool/rapporteur/master.svg?style=flat)](https://travis-ci.org/codeschool/rapporteur)
+[![Code Climate](http://img.shields.io/codeclimate/github/codeschool/rapporteur.svg?style=flat)](https://codeclimate.com/github/codeschool/rapporteur)
+[![Dependency Status](https://gemnasium.com/codeschool/rapporteur.svg)](https://gemnasium.com/codeschool/rapporteur)
+[![Inline docs](http://inch-ci.org/github/codeschool/rapporteur.svg?branch=master)](http://inch-ci.org/github/codeschool/rapporteur)
+
 ## [HEAD][unreleased] / unreleased
 
 * No significant changes.
 
+## [3.2.0][v3.2.0] / 2015-02-02
+
+* Update the Rails route definition to force (and default) a JSON format. The
+  intent is to fix an issue where Rails auto-appended a `(.:format)` segment to
+  the fixed route and broke `/status.json` route matching. See
+  [codeschool/rapporteur#9](https://github.com/codeschool/rapporteur/issues/9).
+
 ## [3.1.0][v3.1.0] / 2014-07-03
 
 * Remove the explicit railties dependency (was at `'>= 3.1', '< 4.2'`). This
@@ -92,7 +105,8 @@
 * Initial public release.
 
 
-[unreleased]: https://github.com/codeschool/rapporteur/compare/v3.1.0...master
+[unreleased]: https://github.com/codeschool/rapporteur/compare/v3.2.0...master
+[v3.2.0]: https://github.com/codeschool/rapporteur/compare/v3.1.0...v3.2.0
 [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

data/README.md

@@ -1,9 +1,10 @@
 # Rapporteur (rap-or-TUHR)
 
-[![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)
+[![Gem Version](http://img.shields.io/gem/v/rapporteur.svg?style=flat)](http://rubygems.org/gems/rapporteur)
+[![Build Status](http://img.shields.io/travis/codeschool/rapporteur/master.svg?style=flat)](https://travis-ci.org/codeschool/rapporteur)
+[![Code Climate](http://img.shields.io/codeclimate/github/codeschool/rapporteur.svg?style=flat)](https://codeclimate.com/github/codeschool/rapporteur)
 [![Dependency Status](https://gemnasium.com/codeschool/rapporteur.svg)](https://gemnasium.com/codeschool/rapporteur)
+[![Inline docs](http://inch-ci.org/github/codeschool/rapporteur.svg?branch=master)](http://inch-ci.org/github/codeschool/rapporteur)
 
 
 This gem provides a singular, status-checking endpoint to your application. The
@@ -111,19 +112,13 @@ 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
+require "rapporteur"
+require "sinatra/base"
+
+class MyApp < Sinatra::Base
+  get "/status.json" do
+    content_type :json
+    body Rapporteur.run.as_json.to_json
   end
 end
 ```

data/config/routes.rb

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

data/gemfiles/sinatra1.x.gemfile

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

data/lib/rapporteur.rb

@@ -46,6 +46,7 @@ module Rapporteur
     end
     @checker
   end
+  @checker = nil
 
   # 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

data/lib/rapporteur/version.rb

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

data/spec/requests/sinatra_spec.rb

@@ -0,0 +1,59 @@
+require "spec_helper"
+
+ENV["RACK_ENV"] = "test"
+
+begin
+  require "sinatra/base"
+  require "rack/test"
+
+  describe "Sinatra" do
+    include Rack::Test::Methods
+
+
+    class TestApp < Sinatra::Base
+      get "/status.json" do
+        content_type :json
+        body Rapporteur.run.as_json.to_json
+      end
+    end
+
+
+    def app
+      TestApp
+    end
+
+    before do
+      Rapporteur.add_check(Rapporteur::Checks::TimeCheck)
+    end
+
+
+    subject { get("/status.json") ; last_response }
+
+    it 'responds with HTTP 200' do
+      expect(subject.status).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
+
+    it 'contains the time in ISO8601' do
+      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
+
+    context 'the response payload' do
+      subject { get("/status.json") ; JSON.parse(last_response.body) }
+
+      it 'does not contain errors' do
+        expect(subject).not_to(have_key('errors'))
+      end
+
+    end
+  end
+rescue LoadError
+end

data/spec/routing/routes_spec.rb

@@ -20,4 +20,8 @@ describe "status routes", :type => :routing do
   it 'does not route /status.xml' do
     expect({ :get => '/status.xml'}).to_not be_routable
   end
+
+  it 'does not route /status.json.json' do
+    expect({ :get => '/status.json.json'}).to_not be_routable
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rapporteur
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Envy Labs
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-03 00:00:00.000000000 Z
+date: 2015-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -143,6 +143,7 @@ files:
 - config/routes.rb
 - gemfiles/rails3.2.gemfile
 - gemfiles/rails4.x.gemfile
+- gemfiles/sinatra1.x.gemfile
 - lib/rapporteur.rb
 - lib/rapporteur/check_list.rb
 - lib/rapporteur/checker.rb
@@ -169,6 +170,7 @@ files:
 - spec/requests/messsage_addition_spec.rb
 - spec/requests/no_checks_spec.rb
 - spec/requests/revision_check_spec.rb
+- spec/requests/sinatra_spec.rb
 - spec/requests/time_check_spec.rb
 - spec/routing/routes_spec.rb
 - spec/spec_helper.rb
@@ -192,7 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.3.0
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: An engine that provides common status polling endpoint.
@@ -209,6 +211,7 @@ test_files:
 - spec/requests/messsage_addition_spec.rb
 - spec/requests/no_checks_spec.rb
 - spec/requests/revision_check_spec.rb
+- spec/requests/sinatra_spec.rb
 - spec/requests/time_check_spec.rb
 - spec/routing/routes_spec.rb
 - spec/spec_helper.rb