background_lite 0.1.0 → 0.2.0

data/lib/background_lite/background.rb

@@ -1,3 +1,6 @@
+require 'digest/sha1'
+require 'logger' 
+
 # This module holds methods for background handling
 module BackgroundLite
   # This class is for configuring defaults of the background processing
@@ -14,6 +17,9 @@ module BackgroundLite
     @@default_error_reporter = :stdout
     cattr_accessor :default_error_reporter
     
+    # Logger for debugging purposes 
+    cattr_writer :default_logger
+    
     def self.config #:nodoc:
       @config ||= YAML.load(File.read("#{RAILS_ROOT}/config/background.yml")) rescue { RAILS_ENV => {} }
     end
@@ -27,6 +33,17 @@ module BackgroundLite
         end
       end
     end
+
+    def self.default_logger #:nodoc:
+      fallback_logger = if Object.const_defined?("RAILS_DEFAULT_LOGGER")
+        RAILS_DEFAULT_LOGGER
+      else
+        logger = Logger.new(STDOUT)
+        logger.level = Logger::WARN
+        logger
+      end
+      @@default_logger ||= config['logger'] || fallback_logger
+    end
     
     def self.load(configuration) #:nodoc:
       if configuration.blank?
@@ -83,17 +100,25 @@ module BackgroundLite
       [options.delete(:handler) || config[:handler] || BackgroundLite::Config.default_handler].flatten
     end
     reporter = options.delete(:reporter) || config[:reporter] || BackgroundLite::Config.default_error_reporter
+    logger = options.delete(:logger) || config[:logger] || BackgroundLite::Config.default_logger
     
     handler.each do |hand|
-      options = {}
       if hand.is_a? Hash
         raise "Malformed handler options Hash" if hand.keys.size != 1
         options = hand.values.first
         hand = hand.keys.first
       end
+      options ||= {}
       
       begin
         BackgroundLite.disable do
+          if logger.debug?
+            # Transaction ID is currently only used for debugging to find corresponding
+            # messages on both sides of the queue. It is optional and should be expected 
+            # to be nil
+            options[:transaction_id] = Digest::SHA1.hexdigest(object.to_s + method.to_s + args.inspect + Time.now.to_s)
+            logger.debug("Sending to background: Object: #{object.inspect} Method: #{method} Args: #{args.inspect} Options: #{options.inspect}")      
+          end
           "BackgroundLite::#{hand.to_s.camelize}Handler".constantize.handle(object, method, args, options)
         end
         

data/lib/background_lite/core_ext/handlers/active_messaging_handler.rb

@@ -28,7 +28,7 @@ module BackgroundLite
     # queue:: The name of the queue to use to send the message to the background
     #         process.
     def self.handle(object, method, args, options = {})
-      ActiveMessaging::Gateway.publish((options[:queue] || self.queue_name).to_sym, Marshal.dump([object, method, args]))
+      ActiveMessaging::Gateway.publish((options[:queue] || self.queue_name).to_sym, Marshal.dump([object, method, args, options[:transaction_id]]))
     end
     
     # Decodes a marshalled message which was previously sent over
@@ -36,14 +36,14 @@ module BackgroundLite
     # as a string, and the method arguments.
     def self.decode(message)
       begin
-        object, method, args = Marshal.load(message)
+        object, method, args, transaction_id = Marshal.load(message)
       rescue ArgumentError => e
         # Marshal.load does not trigger const_missing, so we have to do this
         # ourselves.
         e.message.split(' ').last.constantize
         retry
       end
-      [object, method, args]
+      [object, method, args, transaction_id]
     end
     
     # Executes a marshalled message which was previously sent over
@@ -51,14 +51,19 @@ module BackgroundLite
     # passed.
     def self.execute(message)
       begin
-        object, method, args = self.decode(message)
-        puts "--- executing method: #{method}\n--- with variables: #{args.inspect}\n--- in object: #{object.class.name}, #{object.id}"
-
+        object, method, args, transaction_id = self.decode(message)
+        logger = BackgroundLite::Config.default_logger
+        if logger.debug?
+          logger.debug "--- executing method: #{method}"
+          logger.debug "--- with variables: #{args.inspect}"
+          logger.debug "--- in object: #{object.class.name}, #{object.id}"
+          logger.debug "--- Transaction ID: #{transaction_id}"
+        end
         object.send(method, *args)
-        puts "--- it happened!"
+        logger.debug "--- it happened!" if logger.debug?
       rescue Exception => e
-        puts e.message
-        puts e.backtrace
+        logger.fatal e.message
+        logger.fatal e.backtrace
       end
     end
   end

data/lib/background_lite/core_ext/handlers/resque_handler.rb

@@ -3,12 +3,16 @@ module BackgroundLite
   # Resque to the background process.
   class ResqueHandler
     @queue = :background
-    
+   
+    class << self
+      attr_accessor :queue
+    end
+
     # Marshals the method and the arguments and sends it through Resque
     # to the background process.
     def self.handle(object, method, args, options = {})
       require 'resque'
-      Resque.enqueue(self, Base64.encode64(Marshal.dump([object, method, args])))
+      Resque.enqueue(self, Base64.encode64(Marshal.dump([object, method, args, options[:transaction_id]])))
     end
     
     # Decodes a marshalled message which was previously sent over
@@ -16,14 +20,14 @@ module BackgroundLite
     # as a string, and the method arguments.
     def self.decode(message)
       begin
-        object, method, args = Marshal.load(Base64.decode64(message))
+        object, method, args, transaction_id = Marshal.load(Base64.decode64(message))
       rescue ArgumentError => e
         # Marshal.load does not trigger const_missing, so we have to do this
         # ourselves.
         e.message.split(' ').last.constantize
         retry
       end
-      [object, method, args]
+      [object, method, args, transaction_id]
     end
     
     # Executes a marshalled message which was previously sent over
@@ -31,14 +35,19 @@ module BackgroundLite
     # passed.
     def self.perform(message)
       begin
-        object, method, args = self.decode(message)
-        puts "--- executing method: #{method}\n--- with variables: #{args.inspect}\n--- in object: #{object.class.name}, #{object.id}"
-
+        object, method, args, transaction_id = self.decode(message)
+        logger = BackgroundLite::Config.default_logger
+        if logger.debug?
+          logger.debug "--- executing method: #{method}"
+          logger.debug "--- with variables: #{args.inspect}"
+          logger.debug "--- in object: #{object.class.name}, #{object.id}"
+          logger.debug "--- Transaction ID: #{transaction_id}"
+        end
         object.send(method, *args)
-        puts "--- it happened!"
+        logger.debug "--- it happened!" if logger.debug?
       rescue Exception => e
-        puts e.message
-        puts e.backtrace
+        logger.fatal e.message
+        logger.fatal e.backtrace
       end
     end
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: background_lite
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Thomas Kadauke
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-09 00:00:00 +02:00
+date: 2010-08-10 00:00:00 +02:00
 default_executable: 
 dependencies: []