rapporteur 3.5.1 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8784fb86dab0544971bd66b4ca106ca445175da
-  data.tar.gz: dfb30e4b43f0d6c58632e2f6e5f46fa2459901a8
+  metadata.gz: 7f822623e2116b6242b2c03aa79dfdf9dd9de3bf
+  data.tar.gz: '081da8aa11cdc0c58897950ccb92e3628c6ca2dd'
 SHA512:
-  metadata.gz: 8e9542d1ad27f7da7f64985128486c4c9dd2faf1550e6659987f37700b5a17949df6df9b840581b9531a914fc72307678ef3d42b11fc38e281a072cf88171fc3
-  data.tar.gz: 858b38cdc1dc8a297f1bac3769108163f2700af467739d537c5e682e9bfd6e77d40541df280dae42c141e92286d799286e1e8860aa0768f58f82adc88409bcfb
+  metadata.gz: c466833304272ab37c828c7aac7032f4addaf309c8ecad0b10404212720f0291be2b3b1a773da101bfd1484c9e4559a9bfab1df19a479882a02a666cf9dff89d
+  data.tar.gz: 7f6ac5829be1f11e402f462254e5de17bf478a4f27f8ce79177eae5ec4bc771e7da3fd2871a530c0be002baccabddbd5784a019bc6caed587ec4cc2a1b6f2e6f

data/.gitignore

@@ -2,6 +2,7 @@
 /.yardoc
 /Gemfile.lock
 /gemfiles/*.lock
+/gemfiles/.bundle/
 /_yardoc/
 /coverage/
 /doc/
@@ -9,5 +10,8 @@
 /spec/reports/
 /tmp/
 
+# rspec failure tracking
+.rspec_status
+
 /.ruby-version
 *.sqlite

data/.travis.yml

@@ -1,30 +1,17 @@
-before_install: gem install bundler -v 1.14.3
+before_install: gem install bundler -v 1.15.1
 cache: bundler
 gemfile:
-  - gemfiles/rails3.2.gemfile
-  - gemfiles/rails4.x.gemfile
+  - gemfiles/rails4.2.x.gemfile
   - gemfiles/rails5.x.gemfile
   - gemfiles/sinatra1.x.gemfile
+  - gemfiles/sinatra2.x.gemfile
 language: ruby
 matrix:
-  allow_failures:
-    # json 1.8.3 fails to build under 2.4.0
-    - rvm: 2.4.0
-      gemfile: gemfiles/rails3.2.gemfile
-    - rvm: 2.4.0
-      gemfile: gemfiles/rails4.x.gemfile
-    - rvm: 2.4.0
-      gemfile: gemfiles/sinatra1.x.gemfile
-  exclude:
-    # rails 5 requires Ruby 2.2.2+
-    - rvm: 2.1.10
-      gemfile: gemfiles/rails5.x.gemfile
   fast_finish: true
 notifications:
   email: false
 rvm:
-  - 2.1.10
-  - 2.2.6
-  - 2.3.3
-  - 2.4.0
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1
 sudo: false

data/Appraisals

@@ -1,10 +1,5 @@
-appraise "rails3.2" do
-  gem "railties", "~> 3.2.0"
-  gem "test-unit", "~> 3.0"
-end
-
-appraise "rails4.x" do
-  gem "railties", "~> 4.0"
+appraise "rails4.2.x" do
+  gem "railties", "~> 4.2.0"
 end
 
 appraise "rails5.x" do
@@ -14,3 +9,7 @@ end
 appraise "sinatra1.x" do
   gem "sinatra", "~> 1.4"
 end
+
+appraise "sinatra2.x" do
+  gem "sinatra", "~> 2.0"
+end

data/CHANGELOG.md

@@ -10,6 +10,12 @@
 
 * No significant changes.
 
+## [3.6.0][] / 2017-06-10
+
+* Add `expires_now` to the Rails controller's status response. This ensures the
+  `Cache-Control` header instructs the client to not cache the response and
+  avoids the `ETag` header being generated.
+
 ## [3.5.1][] / 2016-02-08
 
 * Fix automatic Rapporteur mount detection logic under Rails 4.0 and 4.1. The
@@ -155,4 +161,5 @@
 [3.4.0]: https://github.com/envylabs/rapporteur/compare/v3.3.0...v3.4.0
 [3.5.0]: https://github.com/envylabs/rapporteur/compare/v3.4.0...v3.5.0
 [3.5.1]: https://github.com/envylabs/rapporteur/compare/v3.5.0...v3.5.1
-[HEAD]: https://github.com/envylabs/rapporteur/compare/v3.5.1...master
+[3.6.0]: https://github.com/envylabs/rapporteur/compare/v3.5.1...v3.6.0
+[HEAD]: https://github.com/envylabs/rapporteur/compare/v3.6.0...master

data/Gemfile

@@ -1,5 +1,5 @@
 source 'https://rubygems.org'
 gemspec
 
-gem "activerecord-jdbcsqlite3-adapter",  :platforms => :jruby
-gem "sqlite3",                           :platforms => :ruby
+gem 'activerecord-jdbcsqlite3-adapter', platforms: :jruby
+gem 'sqlite3', platforms: :ruby

data/README.md

@@ -54,16 +54,16 @@ Supported Ruby versions:
 * MRI 2.4
 * MRI 2.3
 * MRI 2.2
-* MRI 2.1
 
-Supported Rails versions:
+Supported frameworks:
 
 * Rails 5.x.
-* Rails 4.x.
-* Rails 3.2.x.
+* Rails 4.2+.
+* Sinatra 2.x.
+* Sinatra 1.x.
 
-Non-Rails environments are also supported (such as Sinatra), see Usage below
-for details.
+Older versions of Ruby and frameworks may also work with this library, however
+they are not officially supported.
 
 ## Usage
 

data/app/controllers/rapporteur/statuses_controller.rb

@@ -1,6 +1,7 @@
 module Rapporteur
   class StatusesController < ApplicationController
     def show
+      expires_now
       respond_to do |format|
         format.json do
           resource = Rapporteur.run

data/bin/console

@@ -11,4 +11,4 @@ require "rapporteur"
 # Pry.start
 
 require "irb"
-IRB.start
+IRB.start(__FILE__)

data/gemfiles/rails4.2.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 "railties", "~> 4.2.0"
+
+gemspec path: "../"

data/gemfiles/rails5.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", "~> 5.0"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/sinatra1.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 "sinatra", "~> 1.4"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/sinatra2.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", "~> 2.0"
+
+gemspec path: "../"

data/lib/rapporteur/rspec.rb

@@ -7,8 +7,18 @@ shared_examples_for 'a successful status response' do
     expect(response.response_code).to(eq(200))
   end
 
-  it 'responds with a JSON content header' do
-    expect(response.content_type).to(eq(Mime[:json]))
+  context 'the response headers' do
+    it 'contains a Content-Type JSON header' do
+      expect(response.content_type).to(eq(Mime[:json]))
+    end
+
+    it 'does not contain an ETag header' do
+      expect(response.headers).not_to have_key('ETag')
+    end
+
+    it 'contains a Cache-Control header which disables client caching' do
+      expect(response.headers.fetch('Cache-Control')).to eq('no-cache')
+    end
   end
 
   context 'the response payload' do
@@ -25,13 +35,25 @@ shared_examples_for 'an erred status response' do
     expect(response.response_code).to(eq(500))
   end
 
-  it 'responds with a JSON content header' do
-    expect(response.content_type).to(eq(Mime[:json]))
+  context 'the response headers' do
+    it 'contains a Content-Type JSON header' do
+      expect(response.content_type).to(eq(Mime[:json]))
+    end
+
+    it 'does not contain an ETag header' do
+      expect(response.headers).not_to have_key('ETag')
+    end
+
+    it 'contains a Cache-Control header which disables client caching' do
+      expect(response.headers.fetch('Cache-Control')).to eq('no-cache')
+    end
   end
 
-  it 'contains errors' do
-    expect(parsed_body).to(have_key('errors'))
-    expect(parsed_body.fetch('errors')).not_to(be_empty)
+  context 'the response payload' do
+    it 'contains errors' do
+      expect(parsed_body).to(have_key('errors'))
+      expect(parsed_body.fetch('errors')).not_to(be_empty)
+    end
   end
 end
 

data/lib/rapporteur/rspec3.rb

@@ -7,8 +7,18 @@ shared_examples_for 'a successful status response' do
     expect(response.response_code).to(eq(200))
   end
 
-  it 'responds with a JSON content header' do
-    expect(response.content_type).to(eq(Mime[:json]))
+  context 'the response headers' do
+    it 'contains a Content-Type JSON header' do
+      expect(response.content_type).to(eq(Mime[:json]))
+    end
+
+    it 'does not contain an ETag header' do
+      expect(response.headers).not_to have_key('ETag')
+    end
+
+    it 'contains a Cache-Control header which disables client caching' do
+      expect(response.headers.fetch('Cache-Control')).to eq('no-cache')
+    end
   end
 
   context 'the response payload' do
@@ -25,13 +35,25 @@ shared_examples_for 'an erred status response' do
     expect(response.response_code).to(eq(500))
   end
 
-  it 'responds with a JSON content header' do
-    expect(response.content_type).to(eq(Mime[:json]))
+  context 'the response headers' do
+    it 'contains a Content-Type JSON header' do
+      expect(response.content_type).to(eq(Mime[:json]))
+    end
+
+    it 'does not contain an ETag header' do
+      expect(response.headers).not_to have_key('ETag')
+    end
+
+    it 'contains a Cache-Control header which disables client caching' do
+      expect(response.headers.fetch('Cache-Control')).to eq('no-cache')
+    end
   end
 
-  it 'contains errors' do
-    expect(parsed_body).to(have_key('errors'))
-    expect(parsed_body.fetch('errors')).not_to(be_empty)
+  context 'the response payload' do
+    it 'contains errors' do
+      expect(parsed_body).to(have_key('errors'))
+      expect(parsed_body.fetch('errors')).not_to(be_empty)
+    end
   end
 end
 

data/lib/rapporteur/version.rb

@@ -1,3 +1,3 @@
 module Rapporteur
-  VERSION = "3.5.1".freeze
+  VERSION = "3.6.0".freeze
 end

data/rapporteur.gemspec

@@ -23,9 +23,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'i18n', '~> 0.6'
 
   spec.add_development_dependency "appraisal", "~> 2.1"
-  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "combustion", "~> 0.5", ">= 0.5.1"
   spec.add_development_dependency "rails", ">= 3.1", "< 6"
-  spec.add_development_dependency "rspec-rails", "~> 3.2"
+  spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "rspec-collection_matchers", "~> 1.0"
+  spec.add_development_dependency "rspec-rails", "~> 3.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rapporteur
 version: !ruby/object:Gem::Version
-  version: 3.5.1
+  version: 3.6.0
 platform: ruby
 authors:
 - Envy Labs
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-09 00:00:00.000000000 Z
+date: 2017-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -45,14 +45,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '1.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: combustion
   requirement: !ruby/object:Gem::Requirement
@@ -94,19 +94,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '6'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rspec-collection_matchers
   requirement: !ruby/object:Gem::Requirement
@@ -121,6 +121,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
 description: An engine that provides common status polling endpoint.
 email:
 - ''
@@ -144,10 +158,10 @@ files:
 - config.ru
 - config/locales/en.yml
 - config/routes.rb
-- gemfiles/rails3.2.gemfile
-- gemfiles/rails4.x.gemfile
+- gemfiles/rails4.2.x.gemfile
 - gemfiles/rails5.x.gemfile
 - gemfiles/sinatra1.x.gemfile
+- gemfiles/sinatra2.x.gemfile
 - lib/rapporteur.rb
 - lib/rapporteur/check_list.rb
 - lib/rapporteur/checker.rb
@@ -181,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: An engine that provides common status polling endpoint.

data/gemfiles/rails3.2.gemfile

@@ -1,10 +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.2.0"
-gem "test-unit", "~> 3.0"
-
-gemspec :path => "../"

data/gemfiles/rails4.x.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", "~> 4.0"
-
-gemspec :path => "../"