amqp-hermes 1.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+gem "amqp", "~> 0.9"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "faker", "~> 1"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.8.3"
+end

data/Gemfile.lock

@@ -0,0 +1,45 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    amq-client (0.9.2)
+      amq-protocol (>= 0.9.0)
+      eventmachine
+    amq-protocol (0.9.0)
+    amqp (0.9.4)
+      amq-client (~> 0.9.2)
+      amq-protocol (>= 0.9.0)
+      eventmachine
+    diff-lcs (1.1.3)
+    eventmachine (0.12.10)
+    faker (1.0.1)
+      i18n (~> 0.4)
+    git (1.2.5)
+    i18n (0.6.0)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.6.5)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  amqp (~> 0.9)
+  bundler (~> 1.0.0)
+  faker (~> 1)
+  jeweler (~> 1.8.3)
+  rdoc (~> 3.12)
+  rspec (~> 2.8.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Wyngle, http://wyngle.com/
+
+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.rdoc

@@ -0,0 +1,75 @@
+= amqp-hermes
+
+A wrapper around ruby-amqp to make pub/sub live more easy.
+
+== Synopsis
+
+=== Sending a message
+
+  # plain and simple
+  tr = AMQP::Hermes::Transmitter.new("test.queue.testing")
+  tr.transmit "payload"
+
+  # or as json
+  tr.transmit { :foo => "bar", :quex => "stuff" }.to_json
+
+  # with AMQP options
+  tr.transmit "payload", :persistent => true
+
+  # on a different queue
+  tr.transmit "payload", :routing_key => "test.queue.real"
+  
+
+=== Receiving a message with the simple build in handler
+
+  re = AMQP::Hermes::Receiver.new("test.queue")  # will listen on routing_key
+                                                 # test.queue.* be default
+  while !re.messages.any?
+    sleep 0.1
+  end
+
+  puts re.messages.first.payload
+
+=== Receiving with a custom handler
+
+  class MyCustomHandler
+    def receive(message)
+      if message.headers.routing_key =~ /test/
+        $stderr.puts "Just a test, nothing to worry about"
+        $stderr.puts message.payload
+
+      else
+        # ... do something incredible
+
+      end
+    end
+  end
+
+  re = AMQP::Hermes::Receiver.new("test.queue",
+    :handler => MyCustomHandler.new
+  )
+
+  while(true); 
+    # the receiver is at the ball now
+  end
+
+== Contributing to amqp-hermes
+ 
+* Check out the latest master to make sure the feature hasn't been implemented
+  or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it
+  and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want
+  to have your own version, or is otherwise necessary, that is fine, but
+  please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Wyngle, http://wyngle.com/. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "amqp-hermes"
+  gem.homepage = "http://github.com/wyngle/amqp-hermes"
+  gem.license = "MIT"
+  gem.summary = %Q{Hermes; Messenger of the gods}
+  gem.description = %Q{Wrapper around ruby-amqp to make pub/sub easier}
+  gem.email = "hartog.de.mik@gmail.com"
+  gem.authors = ["Hartog C. de Mik"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "amqp-hermes #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/amqp-hermes.rb

@@ -0,0 +1,27 @@
+require 'amqp'
+
+require "amqp-hermes/version"
+require 'amqp-hermes/connectivity'
+require 'amqp-hermes/transmitter'
+require 'amqp-hermes/receiver'
+require 'amqp-hermes/message'
+
+module AMQP
+module Hermes
+  def self.wait_for(something, test, max=50)
+    res = something.send(test)
+    unless [ true, false ].include?(res)
+      raise "Can only wait for true or false"
+    end
+    return 0 if res == true
+
+    wait_count = 0
+    while !something.send(test)
+      raise "Waited long enough" if ( wait_count += 1 ) > max
+      sleep 0.1
+    end
+
+    return wait_count
+  end
+end
+end

data/lib/amqp-hermes/connectivity.rb

@@ -0,0 +1,48 @@
+module AMQP
+module Hermes
+  module Connectivity
+    def connection
+      @connection || open_connection
+    end
+
+    def open_connection
+      return @connection if self.open?
+
+      # start a ractor if non running
+      unless EventMachine.reactor_running?
+        Thread.new do
+          EventMachine.run
+        end
+
+        AMQP::Hermes.wait_for(EventMachine, :reactor_running?)
+      end
+
+      @connection = AMQP.connect
+    end
+
+    def open?
+      EventMachine.reactor_running? && !@connection.nil?
+    end
+
+    def channel
+      @channel || open_channel
+    end
+
+    def open_channel
+      @channel = AMQP::Channel.new(self.connection)
+    end
+
+    def close
+      return if !open?
+
+      @connection.close
+
+      AMQP.stop do
+        EventMachine.stop
+      end
+
+      @connection = nil
+    end
+  end
+end
+end

data/lib/amqp-hermes/message.rb

@@ -0,0 +1,12 @@
+module AMQP
+module Hermes
+  class Message
+    attr_reader :headers, :payload
+
+    def initialize(headers, payload)
+      @headers = headers
+      @payload = payload
+    end
+  end
+end
+end

data/lib/amqp-hermes/receiver.rb

@@ -0,0 +1,68 @@
+module AMQP
+module Hermes
+  class Receiver
+    include AMQP::Hermes::Connectivity
+
+    attr_reader :messages, :queue, :exchange, :routing_key
+    attr_accessor :_listening
+
+    def initialize(queue, topic="pub/sub", options={})
+      raise "You *MUST* specify a queue" if queue.nil? or queue.empty?
+      @queue = queue
+
+      if topic.is_a? Hash
+        options = topic.dup
+        topic = options.delete(:topic) || "pub/sub"
+      end
+
+      @routing_key = options.delete(:routing_key)
+      @routing_key ||= "#{queue}.*"
+
+      if @routing_key !~ Regexp.new(queue)
+        @routing_key = "#{queue}.routing_key"
+      end
+
+      @handler = options.delete(:handler) || self
+
+      options[:auto_delete] ||= true
+      @exchange = channel.topic(topic, options)
+
+      @messages = []
+      @_listening = false
+
+      self.open_connection
+      self.listen
+    end
+
+    def listen
+      Thread.new(self, @handler) do |receiver, handler|
+        receiver._listening = true
+
+        receiver.channel.queue(receiver.queue).bind(
+          receiver.exchange, :routing_key => receiver.routing_key
+        ).subscribe do |headers, payload|
+          handler.receive(AMQP::Hermes::Message.new(headers, payload))
+        end
+      end
+    end
+
+    def listening?
+      @_listening == true ? true : false
+    end
+
+    # implement the handler interface
+    def receive(message)
+      return nil if !message.kind_of?(AMQP::Hermes::Message)
+      @messages << message
+    end
+
+    def clear
+      @messages = []
+    end
+
+    def inspect
+      %Q{#<Hermes::Receiver @queue="#{@queue}" @routing_key="#{@routing_key}" @exchange="#{@exchange}" open=#{self.open?} listening=#{self.listening?}>}
+    end
+  end
+end
+end

data/lib/amqp-hermes/transmitter.rb

@@ -0,0 +1,37 @@
+module AMQP
+module Hermes
+  class Transmitter
+    include AMQP::Hermes::Connectivity
+
+    attr_reader :queue
+    def initialize(queue=nil, topic="pub/sub", options={})
+      @queue = queue
+
+      options[:auto_delete] ||= true
+      @exchange = channel.topic(topic, options)
+      @transmitting = false
+    end
+
+    def transmit(payload, options={})
+      @transmitting = true
+
+      options.merge!(
+        :routing_key => @queue
+      ) unless options.has_key?(:routing_key)
+
+      @exchange.publish( payload, options ) do
+        @transmitting = false
+      end
+    end
+
+    def done_transmitting?
+      @transmitting == true ? false : true
+    end
+
+    def close
+      AMQP::Hermes.wait_for(self, :done_transmitting?)
+      super
+    end
+  end
+end
+end

data/lib/amqp-hermes/version.rb

@@ -0,0 +1,3 @@
+module Hermes
+  VERSION = "0.0.1"
+end

data/spec/amqp-hermes/connectivity_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe AMQP::Hermes::Connectivity do
+  before :each do
+    @subject = Class.new
+    @subject.extend(AMQP::Hermes::Connectivity)
+  end
+
+  after :each do
+    @subject.close
+  end
+
+  it "should have an open connection" do
+    @subject.connection.should_not be_nil
+    @subject.should be_open
+    @subject.connection.should be_kind_of(AMQP::Session)
+  end
+
+  it "should have an open channel" do
+    @subject.channel.should_not be_nil
+    @subject.channel.should be_kind_of(AMQP::Channel)
+  end
+
+  it "should close" do
+    @subject.open_connection
+    @subject.should be_open
+
+    @subject.close
+
+    @subject.should_not be_open
+  end
+end
+

data/spec/amqp-hermes/receiver_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+class CustomHandler
+  def received?
+    @received == true ? true : false
+  end
+  def receive(message)
+    @received = true
+  end
+end
+
+describe CustomHandler do
+  it "should be a working alternate handler" do
+    handler = CustomHandler.new
+    handler.should_not be_received
+
+    handler.receive(AMQP::Hermes::Message.new("crud", "crud"))
+    handler.should be_received
+  end
+end
+
+describe AMQP::Hermes::Receiver do
+  before :each do
+    @receiver = AMQP::Hermes::Receiver.new("test.queue")
+    AMQP::Hermes.wait_for(@receiver, :listening?)
+    @receiver.clear
+  end
+
+  after :each do
+    @receiver.close
+  end
+
+  it "should include connectivity" do
+    @receiver.should be_kind_of(AMQP::Hermes::Connectivity)
+  end
+
+  it "should set a default routing key" do
+    @receiver.routing_key.should == "test.queue.*"
+  end
+
+  it "should set a default handler" do
+    @receiver.instance_variable_get(:@handler).should == @receiver
+  end
+
+  it "should open an exchange" do
+    @receiver.exchange.should_not be_nil
+    @receiver.exchange.should be_kind_of(AMQP::Exchange)
+  end
+
+  it "should be listening" do
+    @receiver.should be_listening
+  end
+
+  it "should implement a handler interface" do
+    @receiver.messages.should be_empty
+    transmitter = AMQP::Hermes::Transmitter.new("test.queue.test")
+    transmitter.transmit "crud"
+
+    AMQP::Hermes.wait_for(@receiver.messages, :any?)
+    @receiver.messages.should be_any
+  end
+
+  it "should accept an alternate handler" do
+    handler = CustomHandler.new
+
+    @receiver.close
+    @receiver = AMQP::Hermes::Receiver.new("test.queue", :handler => handler)
+
+    @receiver.instance_variable_get(:@handler).should == handler
+
+    AMQP::Hermes.wait_for(@receiver, :listening?)
+
+    transmitter = AMQP::Hermes::Transmitter.new("test.queue.test")
+    transmitter.transmit "crud"
+
+    AMQP::Hermes.wait_for(handler, :received?)
+  end
+end

data/spec/amqp-hermes/transmitter_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe AMQP::Hermes::Transmitter do
+  before :each do
+    @transmitter = AMQP::Hermes::Transmitter.new("test.queue.test")
+    @receiver   = AMQP::Hermes::Receiver.new("test.queue")
+
+    AMQP::Hermes.wait_for(@receiver, :listening?)
+    @receiver.clear
+  end
+
+  after :each do
+    @receiver.close
+    @transmitter.close
+  end
+
+  it "should include connectivity" do
+    @transmitter.should be_kind_of(AMQP::Hermes::Connectivity)
+  end
+
+  it "should hold a default queue" do
+    @transmitter.queue.should == "test.queue.test"
+  end
+
+  it "should transmitt messages on the default queue" do
+    message = Faker::Lorem.sentence
+    @transmitter.transmit message
+
+    AMQP::Hermes.wait_for(@receiver.messages, :any?)
+
+    @receiver.messages.collect(&:payload).should include(message)
+  end
+
+  it "should transmitt messages on a given queue" do
+    message = Faker::Lorem.sentence
+    @transmitter.transmit(message, :routing_key => "test.queue.given")
+
+    AMQP::Hermes.wait_for(@receiver.messages, :any?)
+
+    @receiver.messages.collect(&:payload).should include(message)
+    @receiver.messages.collect(&:headers).collect(&:routing_key).should include("test.queue.given")
+  end
+
+  it "should accept AMQP options" do
+    message = Faker::Lorem.sentence
+    @transmitter.transmit(message, :mandatory => true, :persistent => true)
+
+    AMQP::Hermes.wait_for(@receiver.messages, :any?)
+
+    @receiver.messages.collect(&:payload).should include(message)
+  end
+
+  it "should let know it's done transmitting" do
+    message = Faker::Lorem.paragraph
+    @transmitter.transmit(message, :mandatory => true, :persistent => true)
+    @transmitter.should_not be_done_transmitting
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'amqp-hermes'
+require 'faker'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification 
+name: amqp-hermes
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Hartog C. de Mik
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-03-01 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: amqp
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.9"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: faker
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1"
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "3.12"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+description: Wrapper around ruby-amqp to make pub/sub easier
+email: hartog.de.mik@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/amqp-hermes.rb
+- lib/amqp-hermes/connectivity.rb
+- lib/amqp-hermes/message.rb
+- lib/amqp-hermes/receiver.rb
+- lib/amqp-hermes/transmitter.rb
+- lib/amqp-hermes/version.rb
+- spec/amqp-hermes/connectivity_spec.rb
+- spec/amqp-hermes/receiver_spec.rb
+- spec/amqp-hermes/transmitter_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/wyngle/amqp-hermes
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -1570954477034988232
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.16
+signing_key: 
+specification_version: 3
+summary: Hermes; Messenger of the gods
+test_files: []
+