rservicebus 0.0.31 → 0.0.32

data/lib/rservicebus/Agent/Beanstalk.rb

@@ -23,7 +23,7 @@ class Agent_Beanstalk
 		@beanstalk.put( serialized_object )
 	end
 
-# Gives an agent a mean to receive replies
+# Gives an agent the means to receive a reply
 #
 # @param [String] queueName the name of the queue to monitor for messages
 	def checkForReply( queueName )

data/lib/rservicebus/Host.rb

@@ -6,16 +6,16 @@ module RServiceBus
     
     #Host process for rservicebus
     class Host
-        
+
         @handlerList
         @resourceByHandlerNameList
-        
+
         @subscriptions
-        
+
         @mq
-        
+
         @appResources
-        
+
         @config
         
         @subscriptionManager
@@ -34,13 +34,13 @@ module RServiceBus
             @appResources = ConfigureAppResource.new.getResources( ENV )
             return self;
         end
-        
+
         def connectToMq
             @mq = ConfigureMQ.new.get( @config.mqHost + "/" + @config.localQueueName, @config.queueTimeout )
-            
+
             return self
         end
-        
+
         #Subscriptions are specified by adding events to the
         #msg endpoint mapping
         def sendSubscriptions

data/lib/rservicebus/Message.rb

@@ -7,8 +7,8 @@ class Message
 
 # Constructor
 #
-# @param [Object] msg The calling function msg to be sent
-# @param [Object] returnAddress A queue that the receiving message handler can send replies to
+# @param [Object] msg The msg to be sent
+# @param [Object] returnAddress A queue to which the destination message handler can send replies
 	def initialize( msg, returnAddress )
 		@_msg=YAML::dump(msg)
 		@returnAddress=returnAddress
@@ -19,11 +19,14 @@ class Message
 		@errorList = Array.new
 	end
 
-# Capture information when an exception has occurred, to help with diagnosing the error.
-# Once the error has been diagnosed, the msg may be able to be returned to the sourceQueue
+# If an error occurs while processing the message, this method allows details of the error to held
+# next to the msg.
 #
-# @param [Object] sourceQueue The name of the queue to return the msg to
-# @param [Object] errorString A queue that the receiving message handler can send replies to
+# Error(s) are held in an array, which allows current error information to be held, while still
+# retaining historical error messages.
+#
+# @param [Object] sourceQueue The name of the queue to which the msg should be returned
+# @param [Object] errorString A readible version of what occured
 	def addErrorMsg( sourceQueue, errorString )
 		@errorList << RServiceBus::ErrorMessage.new( sourceQueue, errorString )
 	end
@@ -35,6 +38,7 @@ class Message
 		return @errorList.last
 	end
 
+# @return [Object] The msg to be sent
 	def msg
 		return YAML::load( @_msg )
 	end

data/lib/rservicebus/SubscriptionStorage.rb

@@ -7,21 +7,34 @@ require "uri"
 class SubscriptionStorage
 	@appName
 
-# Specified using URI.
-#
-# @param [String] uri a location for the resource to which we will attach, eg redis://127.0.0.1/foo
+    # Constructor
+    #
+    # @param [String] appName Name of the application, which is used as a Namespace
+    # @param [String] uri a location for the resource to which we will attach, eg redis://127.0.0.1/foo
 	def initialize(appName, uri)
 		@appName = appName
 	end
 
+    # Get a list of all subscription, as an Array
+    #
+    # @param [String] appName Name of the application, which is used as a Namespace
+    # @param [String] uri a location for the resource to which we will attach, eg redis://127.0.0.1/foo
 	def getAll
 		raise "Method, getResource, needs to be implemented for resource"
 	end
 
+    # Add a new subscription
+    #
+    # @param [String] eventName Name of the event for which the subscriber has asked for notification
+    # @param [String] queueName the queue to which the event should be sent
 	def add( eventName, queueName )
 		raise "Method, add, needs to be implemented for this subscription storage"
 	end
 
+    # Remove an existing subscription
+    #
+    # @param [String] eventName Name of the event for which the subscriber has asked for notification
+    # @param [String] queueName the queue to which the event should be sent
 	def remove( eventName, queueName )
 		raise "Method, remove, needs to be implemented for this subscription storage"
 	end

data/lib/rservicebus/SubscriptionStorage/Redis.rb

@@ -7,6 +7,10 @@ class SubscriptionStorage_Redis<SubscriptionStorage
 
 	@redis
 
+    # Constructor
+    #
+    # @param [String] appName Name of the application, which is used as a Namespace
+    # @param [String] uri a location for the resource to which we will attach, eg redis://127.0.0.1/foo
 	def initialize( appName, uri )
 		super(appName, uri)
         port = uri.port.nil? ? 6379 : uri.port
@@ -37,7 +41,6 @@ class SubscriptionStorage_Redis<SubscriptionStorage
 	end
 
 	def add( eventName, queueName )
-#		RServiceBus.log "Storing subscrption for, " + eventName + ", to, " + queueName
 		content = @redis.get( @appName + ".Subscriptions" )
 		if content.nil? then
 			subscriptions = Hash.new

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rservicebus
 version: !ruby/object:Gem::Version
-  version: 0.0.31
+  version: 0.0.32
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-31 00:00:00.000000000 Z
+date: 2012-11-05 00:00:00.000000000 Z
 dependencies: []
 description: A Ruby interpretation of NServiceBus
 email: guy@guyirvine.com