message_queue 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d43c890e14170d4f2fbc39a359b155a2e4ea94d
-  data.tar.gz: a6501eccd4b0f1d3745f465360389594867bb062
+  metadata.gz: e139a22eb92dc83672337ded0224ee8ae245ddad
+  data.tar.gz: c78ce34bfdd40ddcde86691b35e599610621b5c4
 SHA512:
-  metadata.gz: 3345bb10af66d6872a97a4c1e527fd825c46fca4af09be6e818b05e02f71d94e8d258517a90515b4cee4f30377841d36c1424471318030a86603b317909b4133
-  data.tar.gz: 7b1a2f3b0966f6a7e79ae70210389aba52a07c4dff5220baf4a85ef4e4200a16fdc8d326a909092b33e1febd71b3a27399af69aa4ccf46132099cb003688aff0
+  metadata.gz: 5a2e5be7579e33fd0ac8bdef724eedeb8a78151128e0c7c5ec175b0e64833d56887308d5345c53c070cfdf2e8352ef097e535aefa41bc2dd5af728eb9eb77cd5
+  data.tar.gz: 804f366204e4bf1b979a2938e8bab9a760cac1085f6827986ae71da6a751f2d3e53bea12885fa218a41b523fe990dff4a561493ad2b06d6484bd658ea56974c6

data/Gemfile

@@ -2,3 +2,6 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in message_queue.gemspec
 gemspec
+
+gem "bunny"
+gem "msgpack"

data/README.md

@@ -1,6 +1,6 @@
 # MessageQueue
 
-TODO: Write a gem description
+A common interface to multiple message queues libraries.
 
 ## Installation
 
@@ -18,7 +18,37 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+MessageQueue.with_connection(:adapter => :bunny, :serializer => :message_pack) do |conn|
+  publisher = conn.new_publisher(
+    :exchange => {
+      :name => "time",
+      :type => :topic
+    },
+    :message => {
+      :routing_key => "time.now"
+    }
+  )
+
+  consumer = conn.new_consumer(
+    :queue => {
+      :name => "print_time_now"
+    },
+    :exchange => {
+      :name => "time",
+      :routing_key => "time.#"
+    }
+  )
+
+  consumer.subscribe do |delivery_info, metadata, payload|
+    puts "Received message: #{payload}"
+  end
+
+  publisher.publish Time.now.to_s
+
+  sleep 1
+end
+```
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,37 @@
 require "bundler/gem_tasks"
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################

data/examples/consumer.rb

@@ -0,0 +1,20 @@
+require_relative "../lib/message_queue"
+
+MessageQueue.with_connection(:adapter => :bunny, :serializer => :message_pack) do |conn|
+  consumer = conn.new_consumer(
+    :queue => {
+      :name => "print_time_now"
+    },
+    :exchange => {
+      :name => "time",
+      :routing_key => "time.#"
+    },
+    :subscribe => {
+      :block => true
+    }
+  )
+
+  consumer.subscribe do |delivery_info, metadata, payload|
+    puts "Received message: #{payload}"
+  end
+end

data/examples/publisher.rb

@@ -0,0 +1,15 @@
+require_relative "../lib/message_queue"
+
+MessageQueue.with_connection(:adapter => :bunny, :serializer => :message_pack) do |conn|
+  publisher = conn.new_publisher(
+    :exchange => {
+      :name => "time",
+      :type => :topic
+    },
+    :message => {
+      :routing_key => "time.now"
+    }
+  )
+
+  publisher.publish Time.now.to_s
+end

data/lib/message_queue.rb

@@ -1,5 +1,81 @@
 require "message_queue/version"
+require "message_queue/adapter"
+require "message_queue/serializer"
 
 module MessageQueue
-  # Your code goes here...
+  extend self
+
+  ADAPTERS = [:bunny]
+  SERIALIZERS = [:plain, :message_pack]
+
+  # Public: Initialize a connection to a message queue.
+  #
+  # options - The Hash options used to initialize a connection
+  #           :adapter - The Symbol adapter, currently only :bunny is supported.
+  #                      Detailed options see individual adapter implementation.
+  #           :serializer - The Symbol serializer for serialization.
+  #
+  # Returns the connection for the specified message queue.
+  # Raises a RuntimeError if an adapter can't be found.
+  def new_connection(options = {})
+    adapter = load_adapter(options[:adapter])
+    raise "Missing adapter #{options[:adapter]}" unless adapter
+
+    serializer = load_serializer(options[:serializer])
+    raise "Missing serializer #{options[:serializer]}" unless serializer
+
+    adapter.new_connection(serializer, options)
+  end
+
+  # Public: Initialize a connection to a message queue, connect and execute code in a block.
+  #
+  # options - The Hash options used to initialize a connection
+  #           :adapter - The Symbol adapter, currently only :bunny is supported.
+  #                      Detailed options see individual adapter implementation.
+  #           :serializer - The Symbol serializer for serialization.
+  # block   - The code to execute. The connection object with be passed in.
+  #
+  # Returns nothing
+  # Raises a RuntimeError if an adapter can't be found.
+  def with_connection(options = {}, &block)
+    connection = new_connection(options)
+    connection.with_connection(&block)
+  end
+
+  # Internal: Load an adapter by name
+  #
+  # Returns the adapter or nil if it can't find it
+  def load_adapter(name)
+    ADAPTERS.each do |a|
+      if a.to_s == name.to_s
+        require_relative "message_queue/adapters/#{name}"
+        klass_name = klass_name_for(name)
+        return MessageQueue::Adapters.const_get(klass_name)
+      end
+    end
+
+    nil
+  end
+
+  # Internal: Load a serializer by name
+  #
+  # Returns the serializer or nil if it can't find it
+  def load_serializer(name)
+    SERIALIZERS.each do |s|
+      if s.to_s == name.to_s
+        require_relative "message_queue/serializers/#{name}"
+        klass_name = klass_name_for(name)
+        return MessageQueue::Serializers.const_get(klass_name)
+      end
+    end
+
+    nil
+  end
+
+  # Internal: Return the class name for name
+  #
+  # Returns the class name for specified string
+  def klass_name_for(name)
+    name.to_s.split("_").map(&:capitalize) * ""
+  end
 end

data/lib/message_queue/adapter.rb

@@ -0,0 +1,15 @@
+require "singleton"
+
+module MessageQueue
+  module Adapters
+    class Adapter
+      include Singleton
+
+      class << self
+        def new_connection(serializer, options = {})
+          instance.new_connection(serializer, options)
+        end
+      end
+    end
+  end
+end

data/lib/message_queue/adapters/bunny.rb

@@ -0,0 +1,21 @@
+require "bunny"
+
+module MessageQueue
+  module Adapters
+    class Bunny < Adapter
+      # Public: Initialize a RabbitMQ connection.
+      #
+      # options - The Hash options used to initialize a connection.
+      #           :uri - The String URI described in http://rubybunny.info/articles/connecting.html.
+      #
+      # Returns MessageQueue::Adapters::Bunny::Connection if the options are valid.
+      # Raises ArgumentError when connection URI schema is not amqp or amqps, or the path contains multiple segments.
+      def new_connection(serializer, options = {})
+        settings = options[:uri] ? AMQ::Settings.parse_amqp_url(options[:uri]).merge(options) : options
+        Connection.new(serializer, settings)
+      end
+    end
+  end
+end
+
+require "message_queue/adapters/bunny/connection"

data/lib/message_queue/adapters/bunny/connection.rb

@@ -0,0 +1,64 @@
+class MessageQueue::Adapters::Bunny::Connection
+  attr_reader :serializer, :settings, :connection
+
+  # Public: Initialize a new Bunny connection.
+  #
+  # serializer - The Serializer for dumping and loading payload.
+  #
+  # settings   - The Hash settings used to connect with Bunny.
+  #              Details in http://rubybunny.info/articles/connecting.html.
+  #
+  # Returns a Connection wrapper for Bunny.
+  def initialize(serializer, settings)
+    @serializer = serializer
+    @settings = settings
+  end
+
+  # Public: Connect to RabbitMQ
+  #
+  # Returns the Bunny instance
+  def connect
+    @connection ||= begin
+                      bunny = ::Bunny.new(settings)
+                      bunny.start
+                      bunny
+                    end
+  end
+
+  # Public: Disconnect from RabbitMQ
+  #
+  # Returns nothing
+  def disconnect
+    if @connection
+      @connection.close if @connection.open?
+      @connection = nil
+    end
+  end
+
+  # Public: Connect to RabbitMQ, execute the block and disconnect
+  #
+  # Returns nothing
+  def with_connection(&block)
+    begin
+      connect
+      block.call(self)
+    ensure
+      disconnect
+    end
+  end
+
+  def new_publisher(options)
+    raise "No connection to RabbitMQ" unless connection
+
+    Publisher.new(self, options)
+  end
+
+  def new_consumer(options)
+    raise "No connection to RabbitMQ" unless connection
+
+    Consumer.new(self, options)
+  end
+end
+
+require "message_queue/adapters/bunny/publisher"
+require "message_queue/adapters/bunny/consumer"

data/lib/message_queue/adapters/bunny/consumer.rb

@@ -0,0 +1,61 @@
+class MessageQueue::Adapters::Bunny::Connection::Consumer
+  attr_reader :connection
+  attr_reader :queue_options, :queue_name
+  attr_reader :exchange_options, :exchange_name, :exchange_routing_key
+  attr_reader :subscribe_options
+
+  # Public: Initialize a new Bunny consumer.
+  #
+  # connection - The Bunny Connection.
+  # options    - The Hash options used to initialize the exchange
+  #              of a consumer:
+  #              :queue -
+  #                 :name    - The String queue name.
+  #                 :durable - The Boolean queue durability.
+  #              :exchange -
+  #                 :name        - The String exchange name.
+  #                 :routing_key - The String exchange routing key.
+  #              :subscribe -
+  #                 :ack   - The Boolean indicate if it acks.
+  #                 :block - The Boolean indicate if it blocks.
+  #              Detailed options see
+  #              https://github.com/ruby-amqp/bunny/blob/master/lib/bunny/queue.rb
+  #              and
+  #              https://github.com/ruby-amqp/bunny/blob/master/lib/bunny/exchange.rb.
+  #
+  # Returns a Consumer.
+  def initialize(connection, options = {})
+    @connection = connection
+
+    options = options.dup
+
+    @queue_options = options.fetch(:queue)
+    @queue_name = queue_options.delete(:name) || (raise "Missing queue name")
+
+    @exchange_options = options.fetch(:exchange)
+    @exchange_name = exchange_options.delete(:name) || (raise "Missing exchange name")
+    @exchange_routing_key = exchange_options.delete(:routing_key) || queue_name
+
+    @subscribe_options = options.fetch(:subscribe, {})
+  end
+
+  def subscribe(options = {}, &block)
+    @subscription = queue.subscribe(subscribe_options.merge(options)) do |delivery_info, metadata, payload|
+      block.call(delivery_info, metadata, connection.serializer.load(payload))
+    end
+  end
+
+  def unsubscribe
+    @subscription.cancel if @subscription
+  end
+
+  def queue
+    @queue ||= channel.queue(queue_name, queue_options).bind(exchange_name, :routing_key => exchange_routing_key)
+  end
+
+  private
+
+  def channel
+    connection.connection.create_channel
+  end
+end

data/lib/message_queue/adapters/bunny/publisher.rb

@@ -0,0 +1,40 @@
+class MessageQueue::Adapters::Bunny::Connection::Publisher
+  attr_reader :connection, :exchange
+  attr_reader :exchange_options, :exchange_name, :exchange_type
+  attr_reader :message_options
+
+  # Public: Initialize a new Bunny publisher.
+  #
+  # connection - The Bunny Connection.
+  # options    - The Hash options used to initialize the exchange
+  #              of a publisher:
+  #              :exchange -
+  #                 :name    - The String exchange name.
+  #                 :type    - The Symbol exchange type.
+  #                 :durable - The Boolean exchange durability.
+  #              :message -
+  #                 :routing_key - The String message routing key.
+  #                 :persistent  - The Boolean indicate if the
+  #                 message persisted to disk .
+  #              Detailed options see
+  #              https://github.com/ruby-amqp/bunny/blob/master/lib/bunny/exchange.rb.
+  #
+  # Returns a Publisher.
+  def initialize(connection, options = {})
+    @connection = connection
+
+    options = options.dup
+
+    @exchange_options = options.fetch(:exchange)
+    @exchange_name = exchange_options.delete(:name) || (raise "Missing exchange name")
+    @exchange_type = exchange_options.delete(:type) || (raise "Missing exchange type")
+
+    @message_options = options.fetch(:message)
+
+    @exchange = connection.connection.default_channel.send(exchange_type, exchange_name, exchange_options)
+  end
+
+  def publish(payload, options = {})
+    exchange.publish(connection.serializer.dump(payload), message_options.merge(options))
+  end
+end

data/lib/message_queue/serializer.rb

@@ -0,0 +1,19 @@
+require "singleton"
+
+module MessageQueue
+  module Serializers
+    class Serializer
+      include Singleton
+
+      class << self
+        def load(string, options = {})
+          instance.load(string, options)
+        end
+
+        def dump(object, options = {})
+          instance.dump(object, options)
+        end
+      end
+    end
+  end
+end

data/lib/message_queue/serializers/message_pack.rb

@@ -0,0 +1,15 @@
+require "msgpack"
+
+module MessageQueue
+  module Serializers
+    class MessagePack < Serializer
+      def load(string, options = {})
+        ::MessagePack.unpack(string)
+      end
+
+      def dump(object, options = {})
+        ::MessagePack.pack(object)
+      end
+    end
+  end
+end

data/lib/message_queue/serializers/plain.rb

@@ -0,0 +1,13 @@
+module MessageQueue
+  module Serializers
+    class Plain < Serializer
+      def load(string, options = {})
+        string
+      end
+
+      def dump(object, options = {})
+        object
+      end
+    end
+  end
+end

data/lib/message_queue/version.rb

@@ -1,3 +1,3 @@
 module MessageQueue
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/message_queue.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |spec|
   spec.version       = MessageQueue::VERSION
   spec.authors       = ["Jingwen Owen Ou"]
   spec.email         = ["jingweno@gmail.com"]
-  spec.description   = %q{A command interface to multiple message queues libraries.}
-  spec.summary       = %q{A command interface to multiple message queues libraries.}
-  spec.homepage      = ""
+  spec.description   = %q{A common interface to multiple message queues libraries.}
+  spec.summary       = %q{A common interface to multiple message queues libraries.}
+  spec.homepage      = "https://github.com/jingweno/message_queue"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
@@ -18,6 +18,5 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
 end

data/test/adapters/bunny_test.rb

@@ -0,0 +1,82 @@
+require_relative "../test_helper"
+require_relative "../../lib/message_queue/serializers/plain"
+require_relative "../../lib/message_queue/adapters/bunny"
+
+class BunnyTest < Test::Unit::TestCase
+  def test_new_connection
+    connection = MessageQueue::Adapters::Bunny.new_connection(
+      MessageQueue::Serializers::Plain,
+      :uri => "amqp://user:pass@host/vhost",
+      :tls_certificates => ["path"])
+    assert_equal "amqp", connection.settings[:scheme]
+    assert_equal ["path"], connection.settings[:tls_certificates]
+
+    connection = MessageQueue::Adapters::Bunny.new_connection MessageQueue::Serializers::Plain
+    bunny = connection.connect
+    assert bunny.open?
+
+    connection.disconnect
+    assert bunny.closed?
+  end
+
+  def test_new_publisher
+    connection = MessageQueue::Adapters::Bunny.new_connection MessageQueue::Serializers::Plain
+    connection.with_connection do |conn|
+      publisher = conn.new_publisher(
+        :exchange => {
+          :name => "test",
+          :type => :direct
+        },
+        :message => {
+          :routing_key => "test"
+        }
+      )
+
+      assert_equal "test", publisher.exchange_name
+      assert_equal :direct, publisher.exchange_type
+      assert_equal "test",  publisher.message_options[:routing_key]
+
+      msg = Time.now.to_s
+      publisher.publish msg
+
+      ch = connection.connection.create_channel
+      queue = ch.queue("test")
+      _, _, m = queue.pop
+
+      assert_equal msg, m
+    end
+  end
+
+  def test_new_consumer
+    connection = MessageQueue::Adapters::Bunny.new_connection MessageQueue::Serializers::Plain
+    connection.with_connection do |conn|
+      consumer = conn.new_consumer(
+        :queue => {
+          :name => "test"
+        },
+        :exchange => {
+          :name => "test"
+        }
+      )
+
+      assert_equal "test", consumer.queue_name
+      assert_equal "test", consumer.exchange_name
+
+      publisher = conn.new_publisher(
+        :exchange => {
+          :name => "test",
+          :type => :direct
+        },
+        :message => {
+          :routing_key => "test"
+        }
+      )
+
+      msg = Time.now.to_s
+      publisher.publish msg
+
+      _, _, m = consumer.queue.pop
+      assert_equal msg, m
+    end
+  end
+end

data/test/message_queue_test.rb

@@ -0,0 +1,30 @@
+require_relative "test_helper"
+
+class MessageQueueTest < Test::Unit::TestCase
+  def test_load_adapter
+    adapter = MessageQueue.load_adapter(:bunny)
+    assert_equal "MessageQueue::Adapters::Bunny", adapter.name
+
+    adapter = MessageQueue.load_adapter(:foo)
+    assert_nil adapter
+  end
+
+  def test_load_serializer
+    serializer = MessageQueue.load_serializer(:message_pack)
+    assert_equal "MessageQueue::Serializers::MessagePack", serializer.name
+
+    serializer = MessageQueue.load_serializer(:foo)
+    assert_nil serializer
+  end
+
+  def test_new_connection
+    assert_raises RuntimeError do
+      MessageQueue.new_connection(:adapter => :foo)
+    end
+
+    connection = MessageQueue.new_connection(:adapter => :bunny,
+                                             :serializer => :message_pack,
+                                             :uri => "amqp://user:pass@host/vhost")
+    assert_equal "MessageQueue::Adapters::Bunny::Connection", connection.class.to_s
+  end
+end

data/test/serializers/message_pack_test.rb

@@ -0,0 +1,10 @@
+require_relative "../test_helper"
+require_relative "../../lib/message_queue/serializers/message_pack"
+
+class MessagePackTest < Test::Unit::TestCase
+  def test_dump_and_load
+    dump = MessageQueue::Serializers::MessagePack.dump "foo" => "bar"
+    loaded = MessageQueue::Serializers::MessagePack.load dump
+    assert_equal "bar", loaded["foo"]
+  end
+end

data/test/serializers/plain_test.rb

@@ -0,0 +1,10 @@
+require_relative "../test_helper"
+require_relative "../../lib/message_queue/serializers/plain"
+
+class PlainTest < Test::Unit::TestCase
+  def test_dump_and_load
+    dump = MessageQueue::Serializers::Plain.dump "foo" => "bar"
+    loaded = MessageQueue::Serializers::Plain.load dump
+    assert_equal "bar", loaded["foo"]
+  end
+end

data/test/support/message_queue.yml

@@ -0,0 +1,2 @@
+adapter: bunny
+url: amqp://user:pass@host/vhost

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require "test/unit"
+require_relative "../lib/message_queue"

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: message_queue
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jingwen Owen Ou
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-23 00:00:00.000000000 Z
+date: 2013-09-03 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -38,7 +24,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: A command interface to multiple message queues libraries.
+description: A common interface to multiple message queues libraries.
 email:
 - jingweno@gmail.com
 executables: []
@@ -50,10 +36,26 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/consumer.rb
+- examples/publisher.rb
 - lib/message_queue.rb
+- lib/message_queue/adapter.rb
+- lib/message_queue/adapters/bunny.rb
+- lib/message_queue/adapters/bunny/connection.rb
+- lib/message_queue/adapters/bunny/consumer.rb
+- lib/message_queue/adapters/bunny/publisher.rb
+- lib/message_queue/serializer.rb
+- lib/message_queue/serializers/message_pack.rb
+- lib/message_queue/serializers/plain.rb
 - lib/message_queue/version.rb
 - message_queue.gemspec
-homepage: ''
+- test/adapters/bunny_test.rb
+- test/message_queue_test.rb
+- test/serializers/message_pack_test.rb
+- test/serializers/plain_test.rb
+- test/support/message_queue.yml
+- test/test_helper.rb
+homepage: https://github.com/jingweno/message_queue
 licenses:
 - MIT
 metadata: {}
@@ -76,5 +78,11 @@ rubyforge_project:
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: A command interface to multiple message queues libraries.
-test_files: []
+summary: A common interface to multiple message queues libraries.
+test_files:
+- test/adapters/bunny_test.rb
+- test/message_queue_test.rb
+- test/serializers/message_pack_test.rb
+- test/serializers/plain_test.rb
+- test/support/message_queue.yml
+- test/test_helper.rb