bunny-mock 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 845c697ca137bf613dc4b11eccaeafdaad4d6cf8
+  data.tar.gz: 4b4322cf0a31e2557bf3088fc621e0d0d153087d
+SHA512:
+  metadata.gz: 7a7e65dea49c9844023700baf5fb46bd2b69255d2736c0b1dece7189698482bf7d538a411bfca438a82cfcb694e84697f8dae209f0f1295393f602da0a72fb33
+  data.tar.gz: 82c071096f87d173b139870b42e555f8ffc0219c1f662a77ef14eb94d6b3b6b1f245a44e237c4934d1316b308b2fe31b27b96dbc563c33ba8caa2bd2b07897f5

data/.gitignore

@@ -0,0 +1,23 @@
+.DS_Store
+.*.swp
+*.class
+*.rbc
+*.gem
+/doc/
+.yardoc
+.rvmrc
+Gemfile.lock
+.rbx/*
+.tags
+.tags_sorted_by_file
+.Apple*
+bin/*
+.bundle/*
+vendor/*
+playground/*
+*.org
+repl-*
+debug/*
+*.dump
+deploy.docs.sh
+.ruby-version

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format=documentation

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+bundler_args: --without development
+script: bundle exec rspec
+rvm:
+  - "2.0.0"
+  - "2.1.8"
+  - "2.3.0"
+branches:
+  only:
+    - master

data/.yardopts

@@ -0,0 +1,7 @@
+--no-private
+--protected
+--markup="markdown" lib/**/*.rb
+--main README.md
+--hide-tag todo
+-
+LICENSE

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+gem 'amq-protocol'
+
+group :development do
+
+	gem 'yard'
+end
+
+group :test do
+
+	gem 'rspec', '~> 3.4.0'
+end
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Andrew Rempe and contributors.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,151 @@
+Bunny Mock
+==========
+
+[![Build Status](https://travis-ci.org/arempe93/bunny-mock.svg?branch=master)](https://travis-ci.org/arempe93/bunny-mock)
+
+A mock client for RabbitMQ, modeled after the popular [Bunny client](https://github.com/ruby-amqp/bunny). It currently supports basic usage of Bunny for managing exchanges and queues, with the goal of being able to handle and test all Bunny use cases.
+
+## Usage
+
+BunnyMock can be injected into your RabbitMQ application in place of Bunny for testing.
+
+### Example
+
+Consider the following example of an RabibtMQ helper module, in Rails
+
+```ruby
+require 'bunny'
+
+module AMQP
+    module Factory
+
+		## Connection, can be mocked for tests
+		mattr_accessor :connection
+
+        ####################################################
+        #   Connection Management
+        ####################################################
+
+        def self.connect
+
+            # create bunny rmq client
+            @connection = Bunny.new Global.amqp.to_hash
+
+            # make connection
+            @connection.start
+
+            # return connection
+            @connection
+        end
+
+		def self.get_channel
+
+            # make connection if not connected
+            connect unless defined?(@connection) and @connection.open?
+
+            # get channel
+            @connection.channel
+        end
+
+		...
+	end
+end
+```
+
+In this case, to set up your tests, you can simply set `AMQP::Factory.connection = BunnyMock.new.start` to inject the mock library. Then you can use the mock helpers in your tests.
+
+### Publishing
+
+```ruby
+it 'should publish messages to queues' do
+
+	channel = BunnyMock.new.start.channel
+	queue = channel.queue 'queue.test'
+
+	queue.publish 'Testing message', priority: 5
+
+	expect(queue.message_count).to eq(1)
+
+	payload = queue.pop
+	expect(queue.message_count).to eq(0)
+
+	expect(payload[:message]).to eq('Testing message')
+	expect(payload[:options][:priority]).to eq(5)
+end
+```
+
+### Binding
+
+```ruby
+it 'should bind queues to exchanges' do
+
+	channel = BunnyMock.new.start.channel
+
+	queue = channel.queue 'queue.test'
+	xchg = channel.exchange 'xchg.test'
+
+	queue.bind xchg
+	expect(queue.bound_to?(xchg)).to be_truthy
+	expect(xchg.has_binding?(queue)).to be_truthy
+
+	queue.unbind xchg
+	expect(queue.bound_to?(xchg)).to be_falsey
+	expect(xchg.has_binding?(queue)).to be_falsey
+
+	queue.bind 'xchg.test'
+	expect(queue.bound_to?(xchg)).to be_truthy
+	expect(xchg.has_binding?(queue)).to be_truthy
+end
+
+it 'should bind exchanges to exchanges' do
+
+	channel = BunnyMock.new.start.channel
+
+	source = channel.exchange 'xchg.source'
+	receiver = channel.exchange 'xchg.receiver'
+
+	receiver.bind source
+	expect(receiver.bound_to?(source)).to be_truthy
+	expect(source.has_binding?(receiver)).to be_truthy
+
+	receiver.unbind source
+	expect(receiver.bound_to?(source)).to be_falsey
+	expect(xchg.has_binding?(receiver)).to be_falsey
+
+	receiver.bind 'xchg.source'
+	expect(receiver.bound_to?(source)).to be_truthy
+	expect(source.has_binding?(receiver)).to be_truthy
+end
+```
+
+## Installation
+
+### With RubyGems
+
+To install BunnyMock with RubyGems:
+
+```
+gem install bunny-mock
+```
+
+### With Bundler
+
+To use BunnyMock with a Bundler managed project:
+
+```
+gem 'bunny-mock'
+```
+
+## Documentation
+
+View the documentation on [RubyDoc](http://www.rubydoc.info/github/arempe93/bunny-mock)
+
+## Dependencies
+
+* Ruby version >= 2.0
+
+* [AMQ Protocol](https://github.com/ruby-amqp/amq-protocol) - Also a dependency of Bunny
+
+## License
+
+Released under the MIT license

data/bunny-mock.gemspec

@@ -0,0 +1,27 @@
+#!/usr/bin/env gem build
+# encoding: utf-8
+
+require 'base64'
+require File.expand_path("../lib/bunny_mock/version", __FILE__)
+
+Gem::Specification.new do |s|
+	s.name = 'bunny-mock'
+	s.version = BunnyMock::VERSION.dup
+	s.summary = 'Mocking for the popular Bunny client for RabbitMQ'
+	s.description = 'Easy to use mocking for testing the Bunny client for RabbitMQ'
+	s.license = 'MIT'
+	s.required_ruby_version = Gem::Requirement.new '>= 2.0'
+
+	s.authors = [ 'Andrew Rempe' ]
+	s.email =  [ Base64.encode64('YW5kcmV3cmVtcGVAZ21haWwuY29t\n') ]
+
+	# Dependencies
+	s.add_dependency 'amq-protocol', '>= 2.0.1'
+
+	# Files
+	s.has_rdoc = true
+	s.extra_rdoc_files = [ 'README.md' ]
+	s.files = `git ls-files`.split "\n"
+	s.test_files = `git ls-files -- spec/*`.split "\n"
+	s.require_paths = [ 'lib' ]
+end

data/lib/bunny-mock.rb

@@ -0,0 +1,48 @@
+require 'bunny_mock/version'
+require 'amq/protocol/client'
+
+require 'bunny_mock/session'
+require 'bunny_mock/channel'
+require 'bunny_mock/exchange'
+require 'bunny_mock/queue'
+
+require 'bunny_mock/exchanges/direct'
+require 'bunny_mock/exchanges/topic'
+require 'bunny_mock/exchanges/fanout'
+require 'bunny_mock/exchanges/headers'
+
+##
+# A mock RabbitMQ client based on Bunny
+#
+# @see https://github.com/ruby-amq/bunny
+#
+module BunnyMock
+
+	# AMQP protocol version
+	PROTOCOL_VERSION = AMQ::Protocol::PROTOCOL_VERSION
+
+	#
+	# API
+	#
+
+	##
+	# Instantiate a new mock Bunny session
+	#
+	# @return [BunnyMock::Session] Session instance
+	# @api public
+	def self.new(*args)
+
+		# return new mock session
+		BunnyMock::Session.new
+	end
+
+	# @return [String] Bunny mock version
+	def self.version
+		VERSION
+	end
+
+	# @return [String] AMQP protocol version
+	def self.protocol_version
+		AMQ::Protocol::PROTOCOL_VERSION
+	end
+end

data/lib/bunny_mock/channel.rb

@@ -0,0 +1,310 @@
+module BunnyMock
+	class Channel
+
+		#
+		# API
+		#
+
+		# @return [Integer] Channel identifier
+		attr_reader :id
+
+		# @return [BunnyMock::Session] Session this channel belongs to
+		attr_reader :connection
+
+		# @return [Symbol] Current channel state
+		attr_reader :status
+
+		# @return [Hash<String, BunnyMock::Exchange>] Exchanges created by this channel
+		attr_reader :exchanges
+
+		# @return [Hash<String, BunnyMock::Queue>] Queues created by this channel
+		attr_reader :queues
+
+		##
+		# Create a new {BunnyMock::Channel} instance
+		#
+		# @param [BunnyMock::Session] connection Mocked session instance
+		# @param [Integer] id Channel identifier
+		#
+		# @api public
+		#
+		def initialize(connection = nil, id = nil)
+
+			# store channel id
+			@id				= id
+
+			# store connection information
+			@connection		= connection
+
+			# initialize exchange and queue storage
+			@exchanges		= Hash.new
+			@queues			= Hash.new
+
+			# set status to opening
+			@status			= :opening
+		end
+
+		# @return [Boolean] true if status is open, false otherwise
+		# @api public
+		def open?
+			@status == :open
+		end
+
+		# @return [Boolean] true if status is closed, false otherwise
+		# @api public
+		def closed?
+			@status == :closed
+		end
+
+		##
+		# Sets status to open
+		#
+		# @return [BunnyMock::Channel] self
+		# @api public
+		#
+		def open
+
+			@status = :open
+
+			self
+		end
+
+		##
+		# Sets status to closed
+		#
+		# @return [BunnyMock::Channel] self
+		# @api public
+		#
+		def close
+
+			@status = :closed
+
+			self
+		end
+
+		# @return [String] Object representation
+		def to_s
+			"#<#{self.class.name}:#{self.object_id} @id=#{@id} @open=#{open?}>"
+		end
+		alias inspect to_s
+
+		# @group Exchange API
+
+		##
+		# Mocks an exchange
+		#
+		# @param [String] name Exchange name
+		# @param [Hash] opts Exchange parameters
+		#
+		# @option opts [Symbol,String] :type Type of exchange
+		# @option opts [Boolean] :durable
+		# @option opts [Boolean] :auto_delete
+		# @option opts [Hash] :arguments
+		#
+		# @return [BunnyMock::Exchange] Mocked exchange instance
+		# @api public
+		#
+		def exchange(name, opts = {})
+
+			xchg = find_exchange(name) || Exchange.declare(self, name, opts)
+
+			register_exchange xchg
+		end
+
+		##
+		# Mocks a fanout exchange
+		#
+		# @param [String] name Exchange name
+		# @param [Hash] opts Exchange parameters
+		#
+		# @option opts [Boolean] :durable
+		# @option opts [Boolean] :auto_delete
+		# @option opts [Hash] :arguments
+		#
+		# @return [BunnyMock::Exchange] Mocked exchange instance
+		# @api public
+		#
+		def fanout(name, opts = {})
+			self.exchange name, opts.merge(type: :fanout)
+		end
+
+		##
+		# Mocks a direct exchange
+		#
+		# @param [String] name Exchange name
+		# @param [Hash] opts Exchange parameters
+		#
+		# @option opts [Boolean] :durable
+		# @option opts [Boolean] :auto_delete
+		# @option opts [Hash] :arguments
+		#
+		# @return [BunnyMock::Exchange] Mocked exchange instance
+		# @api public
+		#
+		def direct(name, opts = {})
+			self.exchange name, opts.merge(type: :direct)
+		end
+
+		##
+		# Mocks a topic exchange
+		#
+		# @param [String] name Exchange name
+		# @param [Hash] opts Exchange parameters
+		#
+		# @option opts [Boolean] :durable
+		# @option opts [Boolean] :auto_delete
+		# @option opts [Hash] :arguments
+		#
+		# @return [BunnyMock::Exchange] Mocked exchange instance
+		# @api public
+		#
+		def topic(name, opts = {})
+			self.exchange name, opts.merge(type: :topic)
+		end
+
+		##
+		# Mocks a headers exchange
+		#
+		# @param [String] name Exchange name
+		# @param [Hash] opts Exchange parameters
+		#
+		# @option opts [Boolean] :durable
+		# @option opts [Boolean] :auto_delete
+		# @option opts [Hash] :arguments
+		#
+		# @return [BunnyMock::Exchange] Mocked exchange instance
+		# @api public
+		#
+		def header(name, opts = {})
+			self.exchange name, opts.merge(type: :header)
+		end
+
+		##
+		# Mocks RabbitMQ default exchange
+		#
+		# @return [BunnyMock::Exchange] Mocked default exchange instance
+		# @api public
+		#
+		def default_exchange
+			self.direct '', no_declare: true
+		end
+
+		# @endgroup
+
+		# @group Queue API
+
+		##
+		# Create a new {BunnyMock::Queue} instance, or find in channel cache
+		#
+		# @param [String] name Name of queue
+		# @param [Hash] opts Queue creation options
+		#
+		# @return [BunnyMock::Queue] Queue that was mocked or looked up
+		# @api public
+		#
+		def queue(name = '', opts = {})
+
+			queue = find_queue(name) || Queue.new(self, name, opts)
+
+			register_queue queue
+		end
+
+		##
+		# Create a new {BunnyMock::Queue} instance with no name
+		#
+		# @param [Hash] opts Queue creation options
+		#
+		# @return [BunnyMock::Queue] Queue that was mocked or looked up
+		# @see #queue
+		# @api public
+		#
+		def temporary_queue(opts = {})
+
+			queue '', opts.merge(exclusive: true)
+		end
+
+		# @endgroup
+
+		#
+		# Implementation
+		#
+
+		# @private
+		def find_queue(name)
+			@queues[name]
+		end
+
+		# @private
+		def register_queue(queue)
+			@queues[queue.name] = queue
+		end
+
+		# @private
+		def deregister_queue(queue)
+			@queues.delete queue.name
+		end
+
+		# @private
+		def queue_bind(queue, key, xchg)
+
+			exchange = @exchanges[xchg] || exchange(xchg)
+
+			exchange.add_route key, queue
+		end
+
+		# @private
+		def queue_unbind(key, xchg)
+
+			exchange = @exchanges[xchg] || exchange(xchg)
+
+			exchange.remove_route key
+		end
+
+		# @private
+		def xchg_bound_to?(receiver, key, name)
+
+			source = @exchanges[name] || exchange(name)
+
+			source.has_binding? receiver, routing_key: key
+		end
+
+		# @private
+		def xchg_has_binding?(key, xchg)
+
+			exchange = @exchanges[xchg] || exchange(xchg)
+
+			exchange.has_binding? key
+		end
+
+		# @private
+		def find_exchange(name)
+			@exchanges[name]
+		end
+
+		# @private
+		def register_exchange(xchg)
+			@exchanges[xchg.name] = xchg
+		end
+
+		# @private
+		def deregister_exchange(xchg)
+			@exchanges.delete xchg.name
+		end
+
+		# @private
+		def xchg_bind(receiver, routing_key, name)
+
+			source = @exchanges[name] || exchange(name)
+
+			source.add_route routing_key, receiver
+		end
+
+		# @private
+		def xchg_unbind(routing_key, name)
+
+			source = @exchanges[name] || exchange(name)
+
+			source.remove_route routing_key
+		end
+	end
+end