rservicebus 0.0.6 → 0.0.7

data/lib/rservicebus/Agent.rb

@@ -1,6 +1,8 @@
 module RServiceBus
 require 'beanstalk-client'
 
+#A means for a stand-alone process to interact with the bus, without being a full
+#rservicebus application
 class Agent
 	@beanstalk
 	
@@ -8,6 +10,11 @@ class Agent
 		@beanstalk = Beanstalk::Pool.new(url)
 	end
 
+# Put a msg on the bus
+#
+# @param [Object] messageObj The msg to be sent
+# @param [String] queueName the name of the queue to be send the msg to
+# @param [String] returnAddress the name of a queue to send replies to
 	def sendMsg(messageObj, queueName, returnAddress=nil)
 		msg = RServiceBus::Message.new( messageObj, returnAddress )
 		serialized_object = YAML::dump(msg)
@@ -16,6 +23,9 @@ class Agent
 		@beanstalk.put( serialized_object )
 	end
 
+# Gives an agent a mean to receive replies
+#
+# @param [String] queueName the name of the queue to monitor for messages
 	def checkForReply( queueName )
 		@beanstalk.watch queueName
 		job = @beanstalk.reserve

data/lib/rservicebus/AppResource.rb

@@ -1,12 +1,21 @@
 require "uri"
 
+# Wrapper base class for resources used by applications, allowing rservicebus to configure the resource
+# - dependency injection.
+#
 class AppResource
 	@uri
 
+# Resources are attached resources, and can be specified using the URI syntax.
+#
+# @param [String] uri a location for the resource to which we will attach, eg redis://127.0.0.1/foo
 	def initialize( uri )
 		@uri = uri
 	end
 
+# The method which actually configures the resource.
+#
+# @return [Object] the configured object.	
 	def getResource
 		raise "Method, getResource, needs to be implemented for resource"
 	end

data/lib/rservicebus/Config.rb

@@ -1,10 +1,7 @@
 module RServiceBus
 
+#Collects and reports configuration information for an rservicebus host
 class Config
-#host:
-##	@appName: CreateUser
-##	errorQueueName: error
-#
 	attr_reader :appName, :messageEndpointMappings, :handlerPathList, :localQueueName, :errorQueueName, :maxRetries, :forwardReceivedMessagesTo, :verbose, :beanstalkHost
 
 	@appName
@@ -50,7 +47,7 @@ class Config
 	end
 
 	def loadHandlerPathList()
-		path = self.getValue( "MSGHANDLERPATH", "MessageHandler" )
+		path = self.getValue( "MSGHANDLERPATH", "./MessageHandler" )
 		handlerPathList = Array.new
 		path.split( ";" ).each do |path|
 			path = path.strip.chomp( "/" )
@@ -74,11 +71,11 @@ class Config
 	end
 
 	def loadContracts()
-		if self.getValue( "CONTRACTS" ).nil? then
+		if self.getValue( "CONTRACTS", "./Contract" ).nil? then
 			return self
 		end
 
-		self.getValue( "CONTRACTS" ).split( ";" ).each do |path|
+		self.getValue( "CONTRACTS", "./Contract" ).split( ";" ).each do |path|
 			puts "Loading contracts from, #{path}"
 			require path
 		end

data/lib/rservicebus/ConfigureAppResource.rb

@@ -1,5 +1,6 @@
 require "uri"
 
+#Configure AppResources for an rservicebus host
 class ConfigureAppResource
 
 	def getResources( env )

data/lib/rservicebus/HandlerLoader.rb

@@ -1,8 +1,12 @@
 module RServiceBus
 
+#Given a directory, this class is responsible for finding
+#	msgnames,
+#	handlernames, and
+#	loading handlers
 class HandlerLoader
 
-	attr_reader :messageName, :handler
+	attr_reader :handlerList
 
 	@host
 	@appResources
@@ -16,28 +20,22 @@ class HandlerLoader
 	@messageName
 	@handler
 
+	@handlerList
+
+# Constructor
+#
+# @param [RServiceBus::Host] host instance
+# @param [Hash] appResources As hash[k,v] where k is the name of a resource, and v is the resource
 	def initialize( host, appResources )
 		@host = host
 		@appResources = appResources
+		
+		@handlerList = Hash.new
 	end
 
-	def getMessageName( baseDir, fileName )
-		name = fileName.sub( baseDir + "/", "" )
-		if name.count( "/" ) == 0 then
-			return name.match( /(.+)\./ )[1]
-		end
-
-		if name.count( "/" ) == 1 then
-			return name.match( /\/(.+)\./ )[1]
-		end
-
-		puts "Filepath, " + fileName + ", not in the expected format."
-		puts "Expected format either,"
-		puts "MessageHandler/Hello.rb, or"
-		puts "MessageHandler/Hello/One.rb, or"
-		abort();
-	end
-
+# Cleans the given path to ensure it can be used for as a parameter for the require statement.
+#
+# @param [String] filePath the path to be cleaned
 	def getRequirePath( filePath )
 		if !filePath.start_with?( "/" ) then
 			filePath = "./" + filePath
@@ -50,12 +48,17 @@ class HandlerLoader
 		abort( "Filepath, " + filePath + ", given for MessageHandler require doesn't exist" );
 	end
 
-	def getHandlerName( baseDir, filePath )
-		handlerName = filePath.sub( ".rb", "").sub( baseDir, "MessageHandler" ).gsub( "/", "_" )
-		return handlerName
-	end
+# Instantiate the handler named in handlerName from the file name in filePath
+# Exceptions will be raised if encountered when loading handlers. This is a load time activity, 
+# so handlers should load correctly. As much information as possible is returned
+# to enable the handler to be fixed, or configuration corrected.
+#
+# @param [String] handlerName name of the handler to instantiate
+# @param [String] filePath the path to the file to be loaded
+# @return [RServiceBus::Handler] the loader
+	def loadHandlerFromFile( handlerName, filePath )
+		requirePath = self.getRequirePath( filePath )
 
-	def loadHandlerFromFile( requirePath, handlerName, filePath )
 		require requirePath
 		begin
 			handler = Object.const_get(handlerName).new();
@@ -69,40 +72,50 @@ class HandlerLoader
 		return handler
 	end
 	
-	def setBusAttributeIfRequested( handler, handlerName )
+# setBusAttributeIfRequested
+#
+# @param [RServiceBus::Handler] handler
+	def setBusAttributeIfRequested( handler )
 		if defined?( handler.Bus ) then
 			handler.Bus = @host
-			@host.log "Bus attribute set for: " + handlerName
+			@host.log "Bus attribute set for: " + handler.class.name
 		end
+		
+		return self
 	end
 
-	def setAppResources( handler, handlerName, appResources )
-		@host.log "Checking app resources for: #{handlerName}", true
+# Assigns appropriate resources to writable attributes in the handler that match keys in the resource hash
+#
+# @param [RServiceBus::Handler] handler
+# @param [Hash] appResources As hash[k,v] where k is the name of a resource, and v is the resource
+	def setAppResources( handler, appResources )
+		@host.log "Checking app resources for: #{handler.class.name}", true
 		appResources.each do |k,v|
 			if handler.class.method_defined?( k ) then 
 				handler.instance_variable_set( "@#{k}", v.getResource() )
-				@host.log "App resource attribute, #{k}, set for: " + handlerName
+				@host.log "App resource attribute, #{k}, set for: " + handler.class.name
 			end
 		end
+		
+		return self
 	end
 
-	def loadHandler(baseDir, filePath)
+# Wrapper function
+#
+# @param [String] filePath
+# @param [String] handlerName
+# @returns [RServiceBus::Handler] handler
+	def loadAndConfigureHandler(filePath, handlerName)
 		begin
-			requirePath = self.getRequirePath( filePath )
-			messageName = self.getMessageName( baseDir, filePath )
-			handlerName = self.getHandlerName( baseDir, filePath )
-
 			@host.log "filePath: " + filePath, true
-			@host.log "requirePath: " + requirePath, true
-			@host.log "messageName: " + messageName, true
 			@host.log "handlerName: " + handlerName, true
 
-			handler = self.loadHandlerFromFile( requirePath, handlerName, filePath )
-			self.setBusAttributeIfRequested( handler, handlerName )
-			self.setAppResources( handler, handlerName, @appResources )
-			@host.log "Loaded Handler: " + handlerName + ", for, " + messageName
+			handler = self.loadHandlerFromFile( handlerName, filePath )
+			self.setBusAttributeIfRequested( handler )
+			self.setAppResources( handler, @appResources )
+			@host.log "Loaded Handler: " + handlerName
 
-			return messageName, handler
+			return handler
 		rescue Exception => e
 			puts "Exception loading handler from file: " + filePath
 			puts e.message
@@ -113,6 +126,92 @@ class HandlerLoader
 
 	end
 
+#This method is overloaded for unit tests
+#
+# @param [String] path directory to check
+# @return [Array] a list of paths to files found in the given path
+	def getListOfFilesForDir( path )
+		return Dir[path + "/*"];
+	end
+
+#Multiple handlers for the same msg can be placed inside a top level directory.
+#The msg name is than taken from the directory, and the handlers from the files inside that
+#directory
+#
+# @param [String] msgName name of message
+# @param [String] baseDir directory to check for handlers of the given msgName
+	def loadHandlersFromSecondLevelPath(msgName, baseDir)
+		self.getListOfFilesForDir(baseDir).each do |filePath|
+			if !filePath.end_with?( "." ) then
+				extName = File.extname( filePath )
+				if !File.directory?( filePath ) &&
+						extName == ".rb" then
+
+					fileName = File.basename( filePath ).sub( ".rb", "" )
+					handlerName = "MessageHandler_#{msgName}_#{fileName}"
+
+					handler = self.loadAndConfigureHandler( filePath, handlerName )
+					if !@handlerList.has_key?( msgName ) then
+						@handlerList[msgName] = Array.new
+					end
+
+					@handlerList[msgName] << handler;
+				end
+			end
+		end
+
+		return self
+	end
+
+
+#Extract the top level dir or file name as it is the msg name
+#
+# @param [String] filePath path to check - this can be a directory or file
+	def getMsgName( filePath )
+		baseName = File.basename( filePath )
+		extName = File.extname( baseName )
+		fileName = baseName.sub( extName, "" )
+
+		msgName = fileName
+		
+		return msgName
+	end
+
+#Load top level handlers from the given directory
+#
+# @param [String] baseDir directory to check - should not have trailing slash
+	def loadHandlersFromTopLevelPath(baseDir)
+		self.getListOfFilesForDir(baseDir).each do |filePath|
+			if !filePath.end_with?( "." ) then
+
+				msgName = self.getMsgName( filePath )
+				if File.directory?( filePath ) then
+					self.loadHandlersFromSecondLevelPath( msgName, filePath )
+				else
+					handlerName = "MessageHandler_#{msgName}"
+					handler = self.loadAndConfigureHandler( filePath, handlerName )
+
+					if !@handlerList.has_key?( msgName ) then
+						@handlerList[msgName] = Array.new
+					end
+
+					@handlerList[msgName] << handler;
+				end
+			end
+		end
+
+		return self
+	end
+
+#Entry point for loading handlers
+#
+# @param [String] baseDir directory to check - should not have trailing slash
+	def loadHandlersFromPath(baseDir)
+		self.loadHandlersFromTopLevelPath(baseDir)
+
+		return self
+	end
+
 end
 
 end

data/lib/rservicebus/Host.rb

@@ -67,40 +67,16 @@ class Host
 		return self
 	end
 
-	def loadHandlersFromPath(baseDir, subDir="")
-		log "Load Message Handlers from baseDir, " + baseDir + ", subDir, " + subDir
-		log "Checking, " + baseDir, true
-		handlerLoader = HandlerLoader.new( self, @appResources )
-
-		@handlerList = {};
-		Dir[baseDir + "/" + subDir + "*"].each do |filePath|
-			if !filePath.end_with?( "." ) then
-				log "Filepath, " + filePath, true
-
-				if File.directory?( filePath ) then
-					self.loadHandlersFromPath( filePath.sub( baseDir ) )
-				else
-					messageName, handler = handlerLoader.loadHandler( baseDir, filePath )
-
-					if !@handlerList.has_key?( messageName ) then
-						@handlerList[messageName] = Array.new
-					end
-
-					@handlerList[messageName] << handler;
-				end
-			end
-		end
-
-		return self
-	end
-
 	def loadHandlers()
 		log "Load Message Handlers"
+		handlerLoader = HandlerLoader.new( self, @appResources )
 
 		@config.handlerPathList.each do |path|
-			self.loadHandlersFromPath(path)
+			handlerLoader.loadHandlersFromPath(path)
 		end
 
+		@handlerList = handlerLoader.handlerList
+
 		return self
 	end
 

data/lib/rservicebus/Message.rb

@@ -1,9 +1,14 @@
 module RServiceBus
 
+#This is the top level message that is passed around the bus
 class Message
 
 	attr_reader :returnAddress, :msgId
 
+# 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
 	def initialize( msg, returnAddress )
 		@_msg=YAML::dump(msg)
 		@returnAddress=returnAddress
@@ -12,10 +17,18 @@ 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
+#
+# @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
 	def addErrorMsg( sourceQueue, errorString )
 		@errorList << RServiceBus::ErrorMessage.new( sourceQueue, errorString )
 	end
 
+# Convenience function
+#
+# @return [String] 
 	def getLastErrorMsg
 		return @errorList.last
 	end

data/lib/rservicebus/RedisAppResource.rb

@@ -1,5 +1,6 @@
 require "redis"
 
+#Implementation of an AppResource - Redis
 class RedisAppResource<AppResource
 
 	@connection

data/lib/rservicebus/Test/Bus.rb

@@ -6,7 +6,7 @@ class Test_Bus
 	@sendList
 	@replyList
 	@logList
-	
+
 	def initialize
 		@publishList = Array.new
 		@sendList = Array.new
@@ -22,9 +22,9 @@ class Test_Bus
 		@sendList << msg
 	end
 
-        def Reply( msg )
-                @replyList << msg
-        end
+	def Reply( msg )
+		@replyList << msg
+	end
 
 	def log( string, verbose=false )
 		item = Hash.new

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rservicebus
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-19 00:00:00.000000000 Z
+date: 2012-06-20 00:00:00.000000000 Z
 dependencies: []
 description: A ruby implementation of NServiceBus
 email: guy@guyirvine.com
@@ -61,3 +61,4 @@ signing_key:
 specification_version: 3
 summary: RServiceBus
 test_files: []
+has_rdoc: