rapporteur 1.0.1 → 1.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OWE5YTkzNGY2ZWI4NGU3YTI2ZjA1MWJmM2NjMzE0M2FjNmIyZDliYw==
+    MzI4YmEwOWRmNDc4MjQwNjVhNWI3MDNiZGM2MDg3NGZmYjYxODEwYw==
   data.tar.gz: !binary |-
-    NzdhY2YxYmY3NDNhYTVhYzI5NDE4ZTgwMjk0NGNhZGE5ZmE1YzgzOQ==
+    NzdiMGZhZmFiODMyNTRiZGJmMjYxOWI0MTJhMjRjMzg0NWVhODM4Zg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MmMyMTFlNTRhODJkNTYyODY2ZjYwNjFjZmMyNzQ4NGY2YjFiYzE0ZTYwOTgx
-    MDhlOGMzNTEzZTYyMWQ0Y2RlZGQ3NDIyNzhkNTRkYTA4MTFiZWRiZmVhOWRk
-    NjMyMDZlYmE2NGFlZDcwOTYxMDEwYzdjN2MzZTk2ZDIxNGUyYTA=
+    ZGVkMTcyMzZhMWU0OGY3ZjNkZmUyNzI5MDJkYTc3ZWRkNzhlNWUzMzI0ZDdh
+    NDk1MzllN2Y0YWY0YWJjODYxMDFlNGJiYjE3MzczNjdkM2U0ZTUxY2Q1ZmM0
+    NTYyZWFiNzAwMjQ0MGU2MTdmMjhlZDQwM2I2NmY1YmQ5NDNhZDA=
   data.tar.gz: !binary |-
-    YTk2ZDMyZmRkMDE1Y2ZiYTkxZWQ2ZDgzMTUzMDFjMGJhMGNkYWUzYTJhNDYy
-    N2E0NzNmOGYxZmZjNTNmOTU1M2ZjYmEyZTgxYWI2Y2I5MzhiZDdhNWIyMGQ1
-    YzE5N2JiN2NjYTA4ZjYxZmY5ZjgxZjUwNzlkNTY2ZTQ2MTQzNGI=
+    M2U4Y2IzYzhkYTQ3OTkzYTc0NGFhYmM2NjIwNTRhNjliN2JmMTc2MGUyMGJi
+    M2ViNDU4ZGQ1Y2M5Y2Q5MTI1YTRmNTk1OGIxNWZlOTQ3ZmIxMzFkNDIxM2I5
+    MDExN2YzNDc4NjVhZTZiYjEwN2VjYzk3OGU2ZDgyMzMxODFiODI=

data/CHANGELOG.md

@@ -4,6 +4,12 @@
 
 * No significant changes.
 
+## [1.1.0][v1.1.0] / 2013-05-30
+
+* Add the ability to define custom successful response messages via
+  add_message. This allows Check authors to relay automated information forward
+  to other external systems.
+
 ## [1.0.1][v1.0.1] / 2013-05-20
 
 * Improve the gemspec's minimum runtime- and development-dependency version
@@ -14,5 +20,6 @@
 * Initial public release.
 
 
-[unreleased]: https://github.com/codeschool/rapporteur/compare/v1.0.1...master
+[unreleased]: https://github.com/codeschool/rapporteur/compare/v1.1.0...master
+[v1.1.0]: https://github.com/codeschool/rapporteur/compare/v1.0.1...v1.1.0
 [v1.0.1]: https://github.com/codeschool/rapporteur/compare/v1.0.0...v1.0.1

data/README.md

@@ -132,6 +132,7 @@ happy with it, add an error to the given `checker` instance:
 
 my_proc_check = lambda { |checker|
   checker.add_error("You have bad luck!") if rand(10) > 5
+  checker.add_message(:luck, "good")
 }
 
 Rapporteur::Checker.add_check(my_proc_check)

data/lib/rapporteur/checker.rb

@@ -54,6 +54,7 @@ module Rapporteur
     # Returns a Rapporteur::Checker instance.
     #
     def self.run
+      instance.messages.clear
       instance.errors.clear
       instance.run
     end
@@ -78,12 +79,38 @@ module Rapporteur
       self
     end
 
+    ##
+    # Public: Adds a status message for inclusion in the success response.
+    #
+    # name - A String containing the name or identifier for your message. This
+    #        is unique and may be overriden by other checks using the name
+    #        message name key.
+    # message - A String or Numeric for the value of the message.
+    #
+    # Examples
+    #
+    #   checker.add_message(:repository, 'git@github.com/user/repo.git')
+    #   checker.add_message(:load, 0.934)
+    #
+    # Returns the Rapporteur::Checker instance.
+    #
+    def add_message(name, message)
+      messages[name] = message
+      self
+    end
+
     # Public: Returns the Set of checks currently configured.
     #
     def checks
       @checks ||= Set.new
     end
 
+    # Public: Returns the Hash of messages currently configured.
+    #
+    def messages
+      @messages ||= Hash.new
+    end
+
     # Public: Returns a String containing the current revision of the
     # application.
     #

data/lib/rapporteur/rspec.rb

@@ -66,3 +66,19 @@ RSpec::Matchers.define :include_status_error_message do |message|
     "expected #{@body.inspect} to not include a #{message.inspect} error message"
   end
 end
+
+RSpec::Matchers.define :include_status_message do |name, message|
+  match do |response|
+    @body = JSON.parse(response.body)
+    messages = @body.fetch('messages', {})
+    messages.has_key?(name) && messages.fetch(name) == message
+  end
+
+  failure_message_for_should do |actual|
+    "expected #{@body.inspect} to include a #{name.inspect}: #{message.inspect} message"
+  end
+
+  failure_message_for_should_not do |actual|
+    "expected #{@body.inspect} to not include a #{name.inspect}: #{message.inspect} message"
+  end
+end

data/lib/rapporteur/serializer.rb

@@ -6,7 +6,8 @@ module Rapporteur
     self.root = false
 
     attributes :revision,
-               :time
+               :time,
+               :messages
 
     # Internal: Converts the checker instance time into UTC to provide a
     # consistent public representation.
@@ -16,5 +17,14 @@ module Rapporteur
     def time
       object.time.utc
     end
+
+    # Internal: Used by ActiveModel::Serializer to determine whether or not to
+    # include the messages attribute.
+    #
+    # Returns false if the messages are empty.
+    #
+    def include_messages?
+      !object.messages.empty?
+    end
   end
 end

data/lib/rapporteur/version.rb

@@ -1,3 +1,3 @@
 module Rapporteur
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/spec/requests/messsage_addition_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe 'A status request with a check that modifies messages' do
+  subject { get(status_path) ; response }
+
+  context 'creating a message with a lambda' do
+    before do
+      Rapporteur::Checker.clear
+      Rapporteur::Checker.add_check(Proc.new { |checker| checker.add_message('git_repo', 'git@github.com:organization/repo.git') })
+    end
+
+    context 'with an unerring response' do
+      it_behaves_like 'a successful status response'
+
+      it 'responds with the check\'s messages' do
+        expect(subject).to include_status_message('git_repo', 'git@github.com:organization/repo.git')
+      end
+    end
+
+    context 'with an erring response' do
+      before do
+        Rapporteur::Checker.add_check(Proc.new { |checker| checker.add_error('failed') })
+      end
+
+      it_behaves_like 'an erred status response'
+
+      it 'does not respond with the check\'s messages' do
+        expect(subject).not_to include_status_message('git_repo', 'git@github.com:organization/repo.git')
+      end
+    end
+
+    context 'with no message-modifying checks' do
+      before { Rapporteur::Checker.clear }
+
+      it_behaves_like 'a successful status response'
+
+      it 'does not respond with a messages list' do
+        expect(JSON.parse(subject.body)).not_to(have_key('messages'))
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rapporteur
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Envy Labs
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-20 00:00:00.000000000 Z
+date: 2013-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_model_serializers
@@ -162,6 +162,7 @@ files:
 - spec/internal/log/.gitignore
 - spec/internal/public/favicon.ico
 - spec/requests/active_record_check_spec.rb
+- spec/requests/messsage_addition_spec.rb
 - spec/requests/no_checks_spec.rb
 - spec/routing/routes_spec.rb
 - spec/spec_helper.rb
@@ -196,6 +197,7 @@ test_files:
 - spec/internal/log/.gitignore
 - spec/internal/public/favicon.ico
 - spec/requests/active_record_check_spec.rb
+- spec/requests/messsage_addition_spec.rb
 - spec/requests/no_checks_spec.rb
 - spec/routing/routes_spec.rb
 - spec/spec_helper.rb