proby 2.0.0 → 2.1.0

data/.gitignore

@@ -1,3 +1,4 @@
 *.swp
-doc
 .yardoc
+doc
+pkg

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    proby (2.0.0)
+    proby (2.1.0)
       chronic (~> 0.6.7)
       httparty (~> 0.8.1)
       multi_json (~> 1.2.0)
@@ -16,6 +16,9 @@ GEM
       multi_json (~> 1.0)
       multi_xml
     json (1.6.6)
+    metaclass (0.0.1)
+    mocha (0.10.5)
+      metaclass (~> 0.0.1)
     multi_json (1.2.0)
     multi_xml (0.4.4)
     rake (0.9.2.2)
@@ -30,6 +33,7 @@ DEPENDENCIES
   bundler (>= 1.0.0)
   fakeweb (~> 1.3.0)
   json (~> 1.6.6)
+  mocha (~> 0.10.5)
   proby!
   rake (~> 0.9.0)
   shoulda (~> 2.11.3)

data/HISTORY.md

@@ -0,0 +1,9 @@
+2.1.0
+-----
+* Added Proby.monitor method
+
+2.0.0
+-----
+* Initial import from proby_notifier codebase.
+* Re-wrote core internals.
+* Added Proby::ProbyTask to wrap the Task API.

data/README.md

@@ -39,15 +39,19 @@ In addition, you can optionally give Proby a logger to use.
 
 Sending Notifications
 ---------------------
-To send a start notification
+The easiest way to have Proby monitor your task is by wrapping your code in a call to Proby's `monitor` function.
 
-    Proby.send_start_notification(task_api_id)
+    Proby.monitor(task_api_id) do
+      # Do something here
+    end
 
-To send a finish notification
+You can also send the start and finish notifications manually via calls to `send_start_notification` and `send_finish_notification`.
 
+    Proby.send_start_notification(task_api_id)
+    # Do something here
     Proby.send_finish_notification(task_api_id)
 
-Specifying the `task_api_id` when calling the notification methods is optional.  If it is not provided,
+Specifying the `task_api_id` when calling any of the the notification methods is optional.  If it is not provided,
 Proby will use the value of the `PROBY_TASK_ID` environment variable.  If no task id is specified
 in the method call, and no value is set in the `PROBY_TASK_ID` environment variable, then no notification
 will be sent.

data/lib/proby/resque_plugin.rb

@@ -47,18 +47,10 @@ module Proby
     end
 
     def around_perform_proby(*args)
-      failed = false
-      error_message = nil
       _proby_id = proby_id(*args)
-      Proby.send_start_notification(_proby_id)
-      yield
-    rescue Exception => e
-      failed = true
-      error_message = "#{e.class.name}: #{e.message}"
-      error_message << "\n#{e.backtrace.join("\n")}" if e.backtrace
-      raise e
-    ensure
-      Proby.send_finish_notification(_proby_id, :failed => failed, :error_message => error_message)
+      Proby.monitor(_proby_id) do
+        yield
+      end
     end
   end
 end

data/lib/proby/version.rb

@@ -1,3 +1,3 @@
 module Proby
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/lib/proby.rb

@@ -70,6 +70,28 @@ module Proby
       Notifier.send_notification('finish', proby_task_id, options)
     end
 
+    # Surround the block of code with Proby start and finish notifications.  If an exception
+    # is raised in the block of code, then the task will be marked as failed, and the
+    # exception's message and backtrace will be sent to Proby as the task's error message.
+    #
+    # @param [String] proby_task_id The id of the task to be notified. If nil, the
+    #                               value of the +PROBY_TASK_ID+ environment variable will be used.
+    def monitor(proby_task_id=nil)
+      failed = false
+      error_message = nil
+      begin
+        Proby.send_start_notification(proby_task_id)
+        yield
+      rescue Exception => e
+        failed = true
+        error_message = "#{e.class.name}: #{e.message}"
+        error_message << "\n#{e.backtrace.join("\n")}" if e.backtrace
+        raise e
+      ensure
+        Proby.send_finish_notification(proby_task_id, :failed => failed, :error_message => error_message)
+      end
+    end
+
   end
 end
 

data/proby.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "yard", "~> 0.6.4"
   s.add_development_dependency "bluecloth", "~> 2.1.0"
   s.add_development_dependency "fakeweb", "~> 1.3.0"
+  s.add_development_dependency "mocha", "~> 0.10.5"
   s.add_development_dependency "shoulda", "~> 2.11.3"
   s.add_development_dependency "json", "~> 1.6.6"
 

data/test/notifier_test.rb

@@ -55,6 +55,21 @@ class NotifierTest < Test::Unit::TestCase
       FakeWeb.register_uri(:post, Proby::ProbyHttpApi.base_uri + "/api/v1/tasks/iii999ooo222/finish.json", :status => ["200", "OK"])
       assert_equal 200, Proby.send_finish_notification
     end
+
+    should "send a start and finish notificaiton when using the monitor method" do
+      Proby.expects(:send_start_notification).with("abc123xyz456")
+      Proby.expects(:send_finish_notification).with() { |param1, param2| param1 == "abc123xyz456" && param2[:failed] == false && param2[:error_message].nil? }
+      assert_equal "foo", Proby.monitor("abc123xyz456") { "foo" }
+    end
+
+    should "include error information in the finish notification if the block passed to monitor raises an exception" do
+      Proby.expects(:send_start_notification).with("abc123xyz456")
+      Proby.expects(:send_finish_notification).with() { |param1, param2| param1 == "abc123xyz456" && param2[:failed] == true && param2[:error_message].include?("This is the error message") }
+      e = assert_raise Exception do
+        Proby.monitor("abc123xyz456") { raise Exception.new("This is the error message") }
+      end
+      assert_equal "This is the error message", e.message
+    end
   end
 
 end

data/test/test_helper.rb

@@ -11,6 +11,7 @@ end
 require 'test/unit'
 require 'fakeweb'
 require 'shoulda'
+require 'mocha'
 
 require 'proby'
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: proby
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 11
   prerelease: 
   segments: 
   - 2
+  - 1
   - 0
-  - 0
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors: 
 - John Wood
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-27 00:00:00 -05:00
+date: 2012-04-30 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -150,6 +150,22 @@ dependencies:
 - !ruby/object:Gem::Dependency 
   prerelease: false
   version_requirements: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 61
+        segments: 
+        - 0
+        - 10
+        - 5
+        version: 0.10.5
+  type: :development
+  requirement: *id009
+  name: mocha
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -161,11 +177,11 @@ dependencies:
         - 3
         version: 2.11.3
   type: :development
-  requirement: *id009
+  requirement: *id010
   name: shoulda
 - !ruby/object:Gem::Dependency 
   prerelease: false
-  version_requirements: &id010 !ruby/object:Gem::Requirement 
+  version_requirements: &id011 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -177,7 +193,7 @@ dependencies:
         - 6
         version: 1.6.6
   type: :development
-  requirement: *id010
+  requirement: *id011
   name: json
 description: A simple library for working with the Proby task monitoring application.
 email: 
@@ -193,6 +209,7 @@ files:
 - .gitignore
 - Gemfile
 - Gemfile.lock
+- HISTORY.md
 - README.md
 - Rakefile
 - lib/proby.rb