rapporteur 2.0.1 → 2.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjUxY2VjMWI5YWZjZWQ0OTY1NzAzOTlhYmVhZDIwMjczNGFkOTZkMw==
+    Y2MzZjBlZWExMWYyZGZhNDU1YTI2MTc2NzUxYjQ2YTg2N2IzMWQwMA==
   data.tar.gz: !binary |-
-    M2NhMjU1NWY4NTc4N2E3NjQ3YjA5YmQ2NGNlYjk2YTY0NGU5YjQ2YQ==
+    Mjk0ODE3NWFmMWE0Yzg5M2NiNTM5YWE1MDRjYTlmYTliOTk5NDFhZg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MmFlY2NmMjdkZWZiNjhkNGM0OTFmMDg4OTM1OTkzMDU0Mjg5ODU4YzcwYWVk
-    MzUxYzBlMTFiZjUyNTM4Mjk3YzgwNmE4N2E2MGFjNzcyYzk3NjNmMDg1MzJl
-    NDIyMjg3ZDA2Mzg1ZmE1NjE0NjA2MDdhZTEwZWY4ZjM4OTMzZmE=
+    MTc2M2M2ZDIxMzMzNjRlNGEyMmE4YjllZTZlZDkzMGQ0YTUyODNmNGMyMmIz
+    OTNiNzVjYjMzMTY1YWZlODg3YTcyMjY4NDFhNzI2MmE5YTVkY2VlOGVkMjI4
+    NmQzMWJmYTVmZjczNDY1YjEyYjcxOThkYjJhNzQyMGNkNmEwMTA=
   data.tar.gz: !binary |-
-    YjljMTM4YzhhNWY1MGQwMjg1Mzk5ZTI0OWJkOWY5NjE1OTZkNjM1OTNlOWM5
-    ODUzNjlhZDM4M2QxNTdhZGNmOGVlOTg2MjIxZDc3OTFiOTJkNGY3NzVhZDcx
-    M2ZjNTQ3OGIyMDE0YmU1NjRmMDExMDA1Zjg1NWYzYTExNmZiZGI=
+    MzEwMTc4Y2NjODViMGQ0ZmQ4ZjA0YjFlMTc0ZGFiMzY2Njg5MDM0NDY2ZTAz
+    M2I1MDdkOTlhYmZiMGZiYTNkNTBiZTA0NGJhMjZiMDAwYWQyZjRkOTBlZjA5
+    NTdjMTk4YzQ2YjFiNDhlN2RmZTc1ZDg1NjY3MTc2YTM4YTEzMTg=

data/.travis.yml

@@ -1,11 +1,12 @@
 language: ruby
 rvm:
-  - 1.9.2
   - 1.9.3
-  - jruby
+  - 2.0.0
+  - jruby-19mode
 gemfile:
   - gemfiles/rails3.1.gemfile
   - gemfiles/rails3.2.gemfile
+  - gemfiles/rails4.0.gemfile
 notifications:
   email: false
   campfire:

data/Appraisals

@@ -5,3 +5,7 @@ end
 appraise "rails3.2" do
   gem "railties", "~> 3.2.0"
 end
+
+appraise "rails4.0" do
+  gem "railties", "~> 4.0.0"
+end

data/CHANGELOG.md

@@ -4,6 +4,12 @@
 
 * No significant changes.
 
+## [2.1.0][v2.1.0] / 2013-06-28
+
+* Update the gemspec to allow for Rails 4.0 environments.
+* Update the packaged Responder to properly handle Rails 4.0.
+* Fix deprecation notice for Checker.clear.
+
 ## [2.0.1][v2.0.1] / 2013-05-31
 
 * Fix NoMethodError in CheckerDeprecations#clear.
@@ -47,7 +53,8 @@
 * Initial public release.
 
 
-[unreleased]: https://github.com/codeschool/rapporteur/compare/v2.0.1...master
+[unreleased]: https://github.com/codeschool/rapporteur/compare/v2.1.0...master
+[v2.1.0]: https://github.com/codeschool/rapporteur/compare/v2.0.1...v2.1.0
 [v2.0.1]: https://github.com/codeschool/rapporteur/compare/v2.0.0...v2.0.1
 [v2.0.0]: https://github.com/codeschool/rapporteur/compare/v1.1.0...v2.0.0
 [v1.1.0]: https://github.com/codeschool/rapporteur/compare/v1.0.1...v1.1.0

data/README.md

@@ -1,4 +1,4 @@
-# Rapporteur
+# 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)
@@ -25,7 +25,7 @@ validations:
 ```json
 {
   "errors": {
-    "base": ["The application database is inaccessible or unavailable"]
+    "database": ["The application database is inaccessible or unavailable"]
   }
 }
 ```
@@ -34,22 +34,28 @@ validations:
 
 Supported Ruby versions:
 
-* MRI 1.9.2
+* MRI 2.0.0
 * MRI 1.9.3
+* MRI 1.9.2
 * JRuby 1.7.4
 
 Supported Rails versions:
 
-* Rails 3.1.x.
+* Rails 4.0.x.
 * Rails 3.2.x.
+* Rails 3.1.x.
 
 To install, add this line to your application's Gemfile:
 
-    gem 'rapporteur'
+```ruby
+gem 'rapporteur'
+```
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
 ## Usage
 
@@ -136,8 +142,8 @@ Rapporteur.add_check do |checker|
 end
 
 my_proc_check = lambda { |checker|
-  checker.add_error("You have bad luck!") if rand(10) > 5
-  checker.add_message(:luck, "good")
+  checker.add_error(:luck, :bad) if rand(2) > 0
+  checker.add_message(:luck, :good)
 }
 
 Rapporteur.add_check(my_proc_check)
@@ -145,7 +151,7 @@ Rapporteur.add_check(my_proc_check)
 class MyClassCheck
   def self.call(checker)
     @@counter ||= 0
-    checker.add_error("Stop calling me!!") if @@counter > 50
+    checker.add_error(:count, :exceeded) if @@counter > 50
   end
 end
 
@@ -211,13 +217,10 @@ For example, to override the database check failure message:
 
 ```yaml
 en:
-  activemodel:
+  rapporteur:
     errors:
-      models:
-        rapporteur/checker:
-          attributes:
-            base:
-              database_unavailable: "Something went wrong"
+      database:
+        unavailable: "Something went wrong"
 ```
 
 ## Contributing

data/gemfiles/rails4.0.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.0.0"
+
+gemspec :path=>"../"

data/lib/rapporteur/checker.rb

@@ -28,7 +28,7 @@ module Rapporteur
     # Examples
     #
     #   Rapporteur.add_check { |checker|
-    #     checker.add_error("Bad luck.") if rand(2) == 1
+    #     checker.add_error(:luck, :bad) if rand(2) == 1
     #   }
     #
     # Returns self.
@@ -89,13 +89,19 @@ module Rapporteur
     # 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>`.
+    # is done with the pre-built checks. If you're using I18n, you'll need to
+    # define `rapporteur.errors.<your key>.<your message>`.
     #
     # Examples
     #
-    #   checker.add_error("You failed.")
-    #   checker.add_error(:i18n_key_is_better)
+    #   checker.add_error(:you, "failed.")
+    #   checker.add_error(:using, :i18n_key_is_better)
+    #
+    #   en:
+    #     rapporteur:
+    #       errors:
+    #         using:
+    #           i18n_key_is_better: 'Look, localization!'
     #
     # Returns self.
     #

data/lib/rapporteur/checker_deprecations.rb

@@ -8,7 +8,7 @@ module Rapporteur
     end
 
     def clear
-      ActiveSupport::Deprecation.warn("use Rapporteur.clear", caller)
+      ActiveSupport::Deprecation.warn("use Rapporteur.clear_checks", caller)
       Rapporteur.clear_checks
     end
 

data/lib/rapporteur/checks.rb

@@ -2,7 +2,30 @@ module Rapporteur
   module Checks
     autoload :ActiveRecordCheck, 'rapporteur/checks/active_record_check'
 
+    # A check which simply reports the current clock time in UTC. This check is
+    # useful because it shows that the status end point is not being cached and
+    # allows you to determine if your server clocks are abnormally skewed.
+    #
+    # This check has no failure cases.
+    #
+    # Examples
+    #
+    #   {
+    #     time: "2013-06-21T05:18:59Z"
+    #   }
+    #
     TimeCheck = lambda { |checker| checker.add_message(:time, Time.now.utc) }
+
+    # A check which reports the current revision of the running application.
+    #
+    # This check has no failure cases.
+    #
+    # Examples
+    #
+    #   {
+    #     revision: "c74edd04f64b25ff6691308bcfdefcee149aa4b5"
+    #   }
+    #
     RevisionCheck = lambda { |checker| checker.add_message(:revision, Revision.current) }
   end
 end

data/lib/rapporteur/responder.rb

@@ -23,7 +23,7 @@ module Rapporteur
       def display_errors
         controller.render format => {errors: resource.errors}, status: :internal_server_error
       end
-    elsif Rails::VERSION::MAJOR == 3 && Rails::VERSION::MINOR == 2
+    else
       def display_errors
         controller.render format => resource_errors, status: :internal_server_error
       end

data/lib/rapporteur/version.rb

@@ -1,3 +1,3 @@
 module Rapporteur
-  VERSION = "2.0.1"
+  VERSION = "2.1.0"
 end

data/rapporteur.gemspec

@@ -18,12 +18,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'railties', '~> 3.1'
+  spec.add_dependency 'railties', '>= 3.1', '< 4.1'
   spec.add_dependency 'activesupport'
 
   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.1"
+  spec.add_development_dependency "rails", ">= 3.1", "< 4.1"
   spec.add_development_dependency "rspec-rails", "~> 2.11"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rapporteur
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Envy Labs
@@ -9,22 +9,28 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-31 00:00:00.000000000 Z
+date: 2013-06-29 00:00:00.000000000 Z
 dependencies:
 - !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.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.1'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -85,16 +91,22 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.1'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.1'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -131,6 +143,7 @@ files:
 - config/routes.rb
 - gemfiles/rails3.1.gemfile
 - gemfiles/rails3.2.gemfile
+- gemfiles/rails4.0.gemfile
 - lib/rapporteur.rb
 - lib/rapporteur/checker.rb
 - lib/rapporteur/checker_deprecations.rb