whinytasks 0.0.1 → 0.0.2

data/History.txt

@@ -1,6 +1,6 @@
 === 1.0.0 / 2008-09-06
 
-* 1 major enhancement
+* added whine_if config var to allow conditional whining based on the environment (production, dev, etc)
 
   * Birthday!
 

data/Manifest.txt

@@ -2,6 +2,5 @@ History.txt
 Manifest.txt
 README.txt
 Rakefile
-bin/whinytasks
 lib/whinytasks.rb
-test/test_whinytasks.rb
+test/test_whinytasks.rb

data/README.txt

@@ -1,26 +1,41 @@
 = whinytasks
 
-* FIX (url)
+* http://adamthorsen.com/whinytasks
 
 == DESCRIPTION:
 
-FIX (describe your package)
+WhinyTasks is sort of like ExceptionMailer but specifically designed for rake tasks that
+run in the background.  With any website, background jobs tend to accumulate and sometimes
+it's hard to tell if they're working properly.  WhinyTasks defines the whiny_task method,
+which can be used in place of the task method and results in tasks that send emails to
+a designated address when an exception occurrs during the execution of the task.
 
 == FEATURES/PROBLEMS:
 
-* FIX (list of features or problems)
+* Sends an email to a configurable address if an exception occurs during the
+execution of a rake task.
 
 == SYNOPSIS:
 
-  FIX (code sample of usage)
+    WhinyTasks::CONFIG = {
+                              :to => "alice@example.com", 
+                              :to_alias => "Alice",
+                              :from => "no-reply@example.com",
+                              :from_alias => "Site Exception Notifier"
+                              :whine_if => "Merb.environment == 'production'"
+                          }
+
+    whiny_task :run_background_jobs => :environment do
+        raise "Uh oh!"
+    end
 
 == REQUIREMENTS:
 
-* FIX (list of requirements)
+* requires rake
 
 == INSTALL:
 
-* FIX (sudo gem install, anything else)
+    sudo gem install whinytasks
 
 == LICENSE:
 

data/Rakefile

@@ -4,7 +4,7 @@ require 'rubygems'
 require 'hoe'
 require './lib/whinytasks.rb'
 
-Hoe.new('whinytasks', Whinytasks::VERSION) do |p|
+Hoe.new('whinytasks', WhinyTasks::VERSION) do |p|
    p.developer('Adam Thorsen', 'adam.thorsen@gmail.com')
 end
 

data/lib/whinytasks.rb

@@ -1,31 +1,29 @@
-class Whinytasks
-  VERSION = '0.0.1'
+module WhinyTasks
+    VERSION = '0.0.2'
 end
 
-WHINY_CONFIG={:from_alias => "Leads", :from => "admin@halogenguides.com",
-              :to_alias => "administrators", :to => "adam@halogenguides.com"}
 class Object
     def whine(subject, message)
         msg = <<END_OF_MESSAGE
-        From: #{WHINY_CONFIG[:from_alias]} <#{WHINY_CONFIG[:from]}>
-        To: #{WHINY_CONFIG[:to_alias]} <#{WHINY_CONFIG[:to]}>
+        From: #{WhinyTasks::CONFIG[:from_alias]} <#{WhinyTasks::CONFIG[:from]}>
+        To: #{WhinyTasks::CONFIG[:to_alias]} <#{WhinyTasks::CONFIG[:to]}>
         Subject: #{subject}
 
         #{message}
 END_OF_MESSAGE
         
     Net::SMTP.start('localhost') do |smtp|
-            smtp.send_message msg, WHINY_CONFIG[:from], WHINY_CONFIG[:to]
+            smtp.send_message msg, WhinyTasks::CONFIG[:from], WhinyTasks::CONFIG[:to]
         end
     end
 
     def whiny_task(deps, &block)
-        if RAILS_ENV == "production"
+        if eval(WhinyTasks::CONFIG[:whine_if])
             block_with_exception_handling = Proc.new do 
                 begin
                     block.call
                 rescue Exception => e 
-                    whine(e.message, "this is the message")
+                    whine(e.message, e.backtrace.join("\n"))
                 end
             end 
             task deps, &block_with_exception_handling

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: whinytasks
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Adam Thorsen
@@ -22,11 +22,11 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.7.0
     version: 
-description: FIX (describe your package)
+description: WhinyTasks is sort of like ExceptionMailer but specifically designed for rake tasks that run in the background.  With any website, background jobs tend to accumulate and sometimes it's hard to tell if they're working properly.  WhinyTasks defines the whiny_task method, which can be used in place of the task method and results in tasks that send emails to a designated address when an exception occurrs during the execution of the task.
 email: 
 - adam.thorsen@gmail.com
-executables: 
-- whinytasks
+executables: []
+
 extensions: []
 
 extra_rdoc_files: 
@@ -38,11 +38,10 @@ files:
 - Manifest.txt
 - README.txt
 - Rakefile
-- bin/whinytasks
 - lib/whinytasks.rb
 - test/test_whinytasks.rb
 has_rdoc: true
-homepage: FIX (url)
+homepage: http://adamthorsen.com/whinytasks
 post_install_message: 
 rdoc_options: 
 - --main
@@ -67,6 +66,6 @@ rubyforge_project: whinytasks
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: FIX (describe your package)
+summary: WhinyTasks is sort of like ExceptionMailer but specifically designed for rake tasks that run in the background
 test_files: 
 - test/test_whinytasks.rb