bunny-mock 1.0.0

data/lib/bunny_mock/exchange.rb

@@ -0,0 +1,266 @@
+module BunnyMock
+	class Exchange
+
+		##
+		# Create a new {BunnyMock::Exchange} instance
+		#
+		# @param [BunnyMock::Channel] channel Channel this exchange will use
+		# @param [String] name Name of exchange
+		# @param [Hash] opts Creation options
+		#
+		# @option opts [Boolean] :durable (false) Should this exchange be durable?
+		# @option opts [Boolean] :auto_delete (false) Should this exchange be automatically deleted when it is no longer used?
+		# @option opts [Boolean] :arguments ({}) Additional optional arguments (typically used by RabbitMQ extensions and plugins)
+		#
+		# @return [BunnyMock::Exchange] A new exchange
+		# @see BunnyMock::Channel#exchange
+		# @api public
+		#
+		def self.declare(channel, name = '', opts = {})
+
+			# get requested type
+			type = opts.fetch :type, :direct
+
+			# get needed class type
+			klazz = BunnyMock::Exchanges.const_get type.to_s.capitalize
+
+			# create exchange of desired type
+			klazz.new channel, name, type, opts
+		end
+
+		#
+		# API
+		#
+
+		# @return [BunnyMock::Channel] Channel used by exchange
+		attr_reader :channel
+
+		# @return [String] Exchange name
+		attr_reader :name
+
+		# @return [String] Exchange type
+		attr_reader :type
+
+		# @return [Hash] Creation options
+		attr_reader :opts
+
+		# @private
+		# @return [Boolean] If exchange has been deleted
+		attr_reader :deleted
+
+		# @private
+		def initialize(channel, name, type, opts)
+
+			# store creation information
+			@channel		= channel
+			@name			= name
+			@opts			= opts
+			@type			= type
+
+			# get options
+			@durable		= @opts[:durable]
+			@auto_delete	= @opts[:auto_delete]
+			@internal		= @opts[:internal]
+			@arguments		= @opts[:arguments]
+
+			# create binding storage
+			@routes			= Hash.new
+		end
+
+		# @group Bunny API
+
+		# @return [Boolean] true if this exchange was declared as durable, false otherwise
+		# @api public
+		def durable?
+			@durable
+		end
+
+		# @return [Boolean] true if this exchange was set to auto delete, false otherwise
+		# @api public
+		def auto_delete?
+			@auto_delete
+		end
+
+		# @return [Boolean] true if this exchange was declared as internal, false otherwise
+		# @api public
+		def internal?
+			@internal
+		end
+
+		# @return [Hash] Additional option arguments
+		# @api public
+		def arguments
+			@arguments
+		end
+
+		##
+		# Publish a message
+		#
+		# @param [Object] payload Message payload
+		# @param [Hash] opts Message properties
+		#
+		# @option opts [String] :routing_key Routing key
+		# @option opts [Boolean] :persistent Should the message be persisted to disk?
+		# @option opts [Boolean] :mandatory Should the message be returned if it cannot be routed to any queue?
+		# @option opts [Integer] :timestamp A timestamp associated with this message
+		# @option opts [Integer] :expiration Expiration time after which the message will be deleted
+		# @option opts [String] :type Message type, e.g. what type of event or command this message represents. Can be any string
+		# @option opts [String] :reply_to Queue name other apps should send the response to
+		# @option opts [String] :content_type Message content type (e.g. application/json)
+		# @option opts [String] :content_encoding Message content encoding (e.g. gzip)
+		# @option opts [String] :correlation_id Message correlated to this one, e.g. what request this message is a reply for
+		# @option opts [Integer] :priority Message priority, 0 to 9. Not used by RabbitMQ, only applications
+		# @option opts [String] :message_id Any message identifier
+		# @option opts [String] :user_id Optional user ID. Verified by RabbitMQ against the actual connection username
+		# @option opts [String] :app_id Optional application ID
+		#
+		# @return [BunnyMock::Exchange] self
+		# @see {BunnyMock::Exchanges::Direct#deliver}
+		# @see {BunnyMock::Exchanges::Topic#deliver}
+		# @see {BunnyMock::Exchanges::Fanout#deliver}
+		# @see {BunnyMock::Exchanges::Headers#deliver}
+		# @api public
+		#
+		def publish(payload, opts = {})
+
+			# handle message sending, varies by type
+			deliver payload, opts, opts.fetch(:routing_key, '')
+
+			self
+		end
+
+		##
+		# Delete this exchange
+		#
+		# @param [Hash] opts Options (insignificant)
+		#
+		# @api public
+		#
+		def delete(opts = {})
+			@deleted = true
+		end
+
+		##
+		# Bind this exchange to another exchange
+		#
+		# @param [BunnyMock::Exchange,String] exchange Exchange to bind to
+		# @param [Hash] opts Binding properties
+		#
+		# @option opts [String] :routing_key Custom routing key
+		#
+		# @return [BunnyMock::Exchange] self
+		# @api public
+		#
+		def bind(exchange, opts = {})
+
+			if exchange.respond_to?(:add_route)
+
+				# we can do the binding ourselves
+				exchange.add_route opts.fetch(:routing_key, @name), self
+
+			else
+
+				# we need the channel to look up the exchange
+				@channel.xchg_bind self, opts.fetch(:routing_key, @name), exchange
+			end
+
+			self
+		end
+
+		##
+		# Unbind this exchange from another exchange
+		#
+		# @param [BunnyMock::Exchange,String] exchange Exchange to unbind from
+		# @param [Hash] opts Binding properties
+		#
+		# @option opts [String] :routing_key Custom routing key
+		#
+		# @api public
+		#
+		def unbind(exchange, opts = {})
+
+			if exchange.respond_to?(:remove_route)
+
+				# we can do the unbinding ourselves
+				exchange.remove_route opts.fetch(:routing_key, @name)
+
+			else
+
+				# we need the channel to look up the exchange
+				@channel.xchg_unbind opts.fetch(:routing_key, @name), exchange
+			end
+		end
+
+		# @endgroup
+
+		##
+		# Check if this exchange is bound to another exchange
+		#
+		# @param [BunnyMock::Exchange,String] exchange Exchange to check
+		# @param [Hash] opts Binding properties
+		#
+		# @option opts [String] :routing_key Routing key from binding
+		#
+		# @return [Boolean] true if this exchange is bound to the given exchange, false otherwise
+		# @api public
+		#
+		def bound_to?(exchange, opts = {})
+
+			if exchange.respond_to?(:has_binding?)
+
+				# we can find out on the exchange object
+				exchange.has_binding? self, opts
+
+			else
+
+				# we need the channel to look up the exchange
+				@channel.xchg_bound_to? self, opts.fetch(:routing_key, @name), exchange
+			end
+		end
+
+		##
+		# Check if a queue is bound to this exchange
+		#
+		# @param [BunnyMock::Queue,String] exchange_or_queue Exchange or queue to check
+		# @param [Hash] opts Binding properties
+		#
+		# @option opts [String] :routing_key Custom routing key
+		#
+		# @return [Boolean] true if the given queue or exchange matching options is bound to this exchange, false otherwise
+		# @api public
+		#
+		def has_binding?(exchange_or_queue, opts = {})
+
+			route = exchange_or_queue.respond_to?(:name) ? exchange_or_queue.name : exchange_or_queue
+
+			@routes.key? opts.fetch(:routing_key, route)
+		end
+
+		##
+		# Deliver a message to routes
+		#
+		# @see {BunnyMock::Exchanges::Direct#deliver}
+		# @see {BunnyMock::Exchanges::Topic#deliver}
+		# @see {BunnyMock::Exchanges::Fanout#deliver}
+		# @see {BunnyMock::Exchanges::Headers#deliver}
+		# @api public
+		#
+		def deliver(payload, opts, key)
+			# noOp
+		end
+
+		#
+		# Implementation
+		#
+
+		# @private
+		def add_route(key, xchg_or_queue)
+			@routes[key] = xchg_or_queue
+		end
+
+		# @private
+		def remove_route(key)
+			@routes.delete key
+		end
+	end
+end

data/lib/bunny_mock/exchanges/direct.rb

@@ -0,0 +1,24 @@
+module BunnyMock
+	module Exchanges
+		class Direct < BunnyMock::Exchange
+
+			#
+			# API
+			#
+
+			##
+			# Deliver a message to route with direct key match
+			#
+			# @param [Object] payload Message content
+			# @param [Hash] opts Message properties
+			# @param [String] key Routing key
+			#
+			# @api public
+			#
+			def deliver(payload, opts, key)
+
+				@routes[key].publish payload, opts if @routes[key]
+			end
+		end
+	end
+end

data/lib/bunny_mock/exchanges/fanout.rb

@@ -0,0 +1,28 @@
+module BunnyMock
+	module Exchanges
+		class Fanout < BunnyMock::Exchange
+
+			#
+			# API
+			#
+
+			##
+			# Deliver a message to all routes
+			#
+			# @param [Object] payload Message content
+			# @param [Hash] opts Message properties
+			# @param [String] key Routing key
+			#
+			# @api public
+			#
+			def deliver(payload, opts, key)
+
+				@routes.each do |route, destination|
+
+					# send to all routes
+					destination.publish payload, opts
+				end
+			end
+		end
+	end
+end

data/lib/bunny_mock/exchanges/headers.rb

@@ -0,0 +1,33 @@
+module BunnyMock
+	module Exchanges
+		class Header < BunnyMock::Exchange
+
+			# @private
+			# @return [Regexp] Any match
+			ANY = /^any$/i
+
+			# @private
+			# @return [Regexp] All match
+			ALL = /^all$/i
+
+			#
+			# API
+			#
+
+			##
+			# Deliver a message to routes with header matches
+			#
+			# @param [Object] payload Message content
+			# @param [Hash] opts Message properties
+			# @param [String] key Routing key
+			#
+			# @api public
+			#
+			def deliver(payload, opts, key)
+
+				# ~: proper headers exchange implementation
+				@routes[key].publish payload, opts if @routes[key]
+			end
+		end
+	end
+end

data/lib/bunny_mock/exchanges/topic.rb

@@ -0,0 +1,51 @@
+module BunnyMock
+	module Exchanges
+		class Topic < BunnyMock::Exchange
+
+			# @private
+			# @return [String] Multiple subdomain wildcard
+			MULTI_WILDCARD = '#'
+
+			# @private
+			# @return [String] Single subdomain wildcard
+			SINGLE_WILDCARD = '*'
+
+			#
+			# API
+			#
+
+			##
+			# Deliver a message to route with keys matching wildcards
+			#
+			# @param [Object] payload Message content
+			# @param [Hash] opts Message properties
+			# @param [String] key Routing key
+			#
+			# @api public
+			#
+			def deliver(payload, opts, key)
+
+				# escape periods with backslash for regex
+				key.gsub! '.', '\.'
+
+				# replace single wildcards with regex for a single domain
+				key.gsub! SINGLE_WILDCARD, '(\w+)'
+
+				# replace multi wildcards with regex for many domains separated by '.'
+				key.gsub! MULTI_WILDCARD, '\w+\.?'
+
+				# turn key into regex
+				key = Regexp.new key
+
+				# get all route keys for this exchange
+				delivery_keys = @routes.keys.dup
+
+				delivery_keys.each do |route|
+
+					# deliver to all matches
+					@routes[route].publish payload, opts if route =~ key
+				end
+			end
+		end
+	end
+end

data/lib/bunny_mock/queue.rb

@@ -0,0 +1,208 @@
+module BunnyMock
+	class Queue
+
+		#
+		# API
+		#
+
+		# @return {BunnyMock::Channel} Channel used by queue
+		attr_reader :channel
+
+		# @return [String] Queue name
+		attr_reader :name
+
+		# @return [Hash] Creation options
+		attr_reader :opts
+
+		##
+		# Create a new [BunnyMock::Queue] instance
+		#
+		# @param [BunnyMock::Channel] channel Channel this queue will use
+		# @param [String] name Name of queue
+		# @param [Hash] opts Creation options
+		#
+		# @see BunnyMock::Channel#queue
+		#
+		def initialize(channel, name = '', opts = {})
+
+			# Store creation information
+			@channel	= channel
+			@name		= name
+			@opts		= opts
+
+			# Store messages
+			@messages	= Array.new
+		end
+
+		# @group Bunny API
+
+		##
+		# Publish a message
+		#
+		# @param [Object] payload Message payload
+		# @param [Hash] opts Message properties
+		#
+		# @option opts [String] :routing_key Routing key
+		# @option opts [Boolean] :persistent Should the message be persisted to disk?
+		# @option opts [Boolean] :mandatory Should the message be returned if it cannot be routed to any queue?
+		# @option opts [Integer] :timestamp A timestamp associated with this message
+		# @option opts [Integer] :expiration Expiration time after which the message will be deleted
+		# @option opts [String] :type Message type, e.g. what type of event or command this message represents. Can be any string
+		# @option opts [String] :reply_to Queue name other apps should send the response to
+		# @option opts [String] :content_type Message content type (e.g. application/json)
+		# @option opts [String] :content_encoding Message content encoding (e.g. gzip)
+		# @option opts [String] :correlation_id Message correlated to this one, e.g. what request this message is a reply for
+		# @option opts [Integer] :priority Message priority, 0 to 9. Not used by RabbitMQ, only applications
+		# @option opts [String] :message_id Any message identifier
+		# @option opts [String] :user_id Optional user ID. Verified by RabbitMQ against the actual connection username
+		# @option opts [String] :app_id Optional application ID
+		#
+		# @return [BunnyMock::Queue] self
+		# @see {BunnyMock::Exchange#publish}
+		# @api public
+		#
+		def publish(payload, opts = {})
+
+			check_queue_deleted!
+
+			# add to messages
+			@messages << { message: payload, options: opts }
+
+			self
+		end
+
+		##
+		# Bind this queue to an exchange
+		#
+		# @param [BunnyMock::Exchange,String] exchange Exchange to bind to
+		# @param [Hash] opts Binding properties
+		#
+		# @option opts [String] :routing_key Custom routing key
+		#
+		# @api public
+		#
+		def bind(exchange, opts = {})
+
+			check_queue_deleted!
+
+			if exchange.respond_to?(:add_route)
+
+				# we can do the binding ourselves
+				exchange.add_route opts.fetch(:routing_key, @name), self
+
+			else
+
+				# we need the channel to lookup the exchange
+				@channel.queue_bind self, opts.fetch(:routing_key, @name), exchange
+			end
+		end
+
+		##
+		# Unbind this queue from an exchange
+		#
+		# @param [BunnyMock::Exchange,String] exchange Exchange to unbind from
+		# @param [Hash] opts Binding properties
+		#
+		# @option opts [String] :routing_key Custom routing key
+		#
+		# @api public
+		#
+		def unbind(exchange, opts = {})
+
+			check_queue_deleted!
+
+			if exchange.respond_to?(:remove_route)
+
+				# we can do the unbinding ourselves
+				exchange.remove_route opts.fetch(:routing_key, @name)
+
+			else
+
+				# we need the channel to lookup the exchange
+				@channel.queue_unbind opts.fetch(:routing_key, @name), exchange
+			end
+		end
+
+		# @endgroup
+
+		##
+		# Check if this queue is bound to the exchange
+		#
+		# @param [BunnyMock::Exchange,String] exchange Exchange to test
+		# @param [Hash] opts Binding properties
+		#
+		# @option opts [String] :routing_key Routing key from binding
+		#
+		# @return [Boolean] true if this queue is bound to the given exchange, false otherwise
+		# @api public
+		#
+		def bound_to?(exchange, opts = {})
+
+			check_queue_deleted!
+
+			if exchange.respond_to?(:has_binding?)
+
+				# we can do the check ourselves
+				exchange.has_binding? opts.fetch(:routing_key, @name)
+
+			else
+
+				# we need the channel to lookup the exchange
+				@channel.xchg_has_binding? opts.fetch(:routing_key, @name), exchange
+			end
+		end
+
+		##
+		# Count of messages in queue
+		#
+		# @return [Integer] Number of messages in queue
+		# @api public
+		#
+		def message_count
+			@messages.count
+		end
+
+		##
+		# Get oldest message in queue
+		#
+		# @return [Hash] Message data
+		# @api public
+		#
+		def pop
+			@messages.shift
+		end
+
+		##
+		# Clear all messages in queue
+		#
+		# @api public
+		#
+		def purge
+			@messages = []
+		end
+
+		##
+		# Get all messages in queue
+		#
+		# @return [Array] All messages
+		# @api public
+		#
+		def all
+			@messages
+		end
+
+		##
+		# Deletes this queue
+		#
+		# @api public
+		#
+		def delete
+			@deleted = true
+		end
+
+		# @private
+		def check_queue_deleted!
+			raise 'Queue has been deleted' if @deleted
+		end
+	end
+end