amqp_helpers 0.0.1

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+#.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.ruby-gemset

@@ -0,0 +1 @@
+amqp-helpers

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 nine.ch
+
+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,36 @@
+# amqp_helpers [![Build Status](https://travis-ci.org/ninech/amqp_helpers.svg)](https://travis-ci.org/ninech/amqp_helpers)
+
+Simple utilities to achieve various AMQP tasks.
+
+## Daemon
+
+`AMQPHelpers::Daemon` allows you to build a simple message consumer.
+
+### Example
+
+``` ruby
+AMQPHelpers::Daemon.new({
+  name: 'nba-scores-daemon',
+  environment: 'production',
+  logger: PXEConfGen.logger,
+  connection_params: {
+    host: 'localhost',
+    port: 5672
+  },
+  queue_params: { durable: false },
+  exchanges: {
+   'nba.scores': {
+      params: {
+        type: :topic,
+        durable: false
+      },
+      bindings: [
+        { routing_key: 'north.#' },
+        { routing_key: 'south.#' }
+      ]
+    }
+  }
+}).start do |delivery_info, payload|
+  puts "AMQP Incoming message #{payload}"
+end
+```

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require 'bundler'
+require 'rake'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+task :default => :spec
+
+desc 'Run all specs'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/amqp_helpers.gemspec

@@ -0,0 +1,21 @@
+Gem::Specification.new do |s|
+  s.name        = 'amqp_helpers'
+  s.version     = File.read(File.expand_path('../VERSION', __FILE__)).strip
+  s.authors     = ['Nils Caspar', 'Raffael Schmid', 'Samuel Sieg']
+  s.email       = 'development@nine.ch'
+  s.homepage    = 'http://nine.ch/'
+  s.license     = 'MIT'
+  s.summary     = 'Simple helpers to achieve various AMQP tasks.'
+  s.description = s.summary
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'rspec', '~> 2.14'
+  s.add_development_dependency 'rake', '~> 10.3'
+
+  s.add_runtime_dependency 'amqp', '~> 1.3'
+  s.add_runtime_dependency 'syslogger', '~> 1.5'
+end

data/lib/amqp_helpers/daemon.rb

@@ -0,0 +1,108 @@
+require 'amqp'
+require 'logger'
+require 'socket'
+require 'syslogger'
+
+module AMQPHelpers
+  class Daemon
+
+    class Error < StandardError; end
+    class ConnectionError < Error; end
+    class ChannelError < Error; end
+
+    DEFAULT_RECONNECT_WAIT_TIME = 30
+
+    attr_accessor :name, :exchanges, :connection_params
+    attr_writer :environment, :logger, :queue_name, :queue_params, :reconnect_wait_time
+
+    def initialize(config)
+      config.each do |key, value|
+        setter = "#{key}="
+        if respond_to?(setter)
+          send(setter, value)
+        end
+      end
+    end
+
+    def start(&handler)
+      logger.info "Starting #{name} daemon..."
+      AMQP.start(connection_params) do |connection|
+        connection.on_error(&method(:handle_connection_error))
+        channel = initialize_channel(connection)
+        connection.on_tcp_connection_loss(&method(:handle_tcp_connection_loss))
+
+        queue = initialize_queue(channel)
+        queue.subscribe(&handler)
+
+        show_stopper = Proc.new do
+          logger.info "Signal INT received. #{name} is going down... I REPEAT: WE ARE GOING DOWN!"
+          connection.close { EventMachine.stop }
+        end
+        Signal.trap 'INT', show_stopper
+      end
+    end
+
+    def environment
+      @environment ||= 'development'
+    end
+
+    def queue_params
+      @queue_params ||= {}
+    end
+
+    def queue_name
+      @queue_name ||= "#{Socket.gethostname}.#{name}"
+    end
+
+    def logger
+      @logger ||= if environment == 'development'
+                    Logger.new(STDOUT)
+                  else
+                    Syslogger.new(name, Syslog::LOG_PID, Syslog::LOG_LOCAL0)
+                  end
+    end
+
+    def reconnect_wait_time
+      @reconnect_wait_time ||= DEFAULT_RECONNECT_WAIT_TIME
+    end
+
+    protected
+    def handle_connection_error(connection, connection_close)
+      logger.error "[connection.close] Reply code = #{connection_close.reply_code}, reply text = #{connection_close.reply_text}"
+      # check if graceful broker shutdown
+      if connection_close.reply_code == 320
+        logger.info "[connection.close] Setting up a periodic reconnection timer (#{reconnect_wait_time}s)..."
+        connection.periodically_reconnect(reconnect_wait_time)
+      else
+        raise ConnectionError, connection_close.reply_text
+      end
+    end
+
+    def handle_channel_error(channel, channel_close)
+      logger.error "[channel.close] Reply code = #{channel_close.reply_code}, reply text = #{channel_close.reply_text}"
+      raise ChannelError, channel_close.reply_text
+    end
+
+    def handle_tcp_connection_loss(connection, settings)
+      logger.error '[network failure] Trying to reconnect...'
+      connection.reconnect(false, 10)
+    end
+
+    def initialize_channel(connection)
+      channel = AMQP::Channel.new(connection)
+      channel.auto_recovery = true
+      channel.on_error(&method(:handle_channel_error))
+    end
+
+    def initialize_queue(channel)
+      channel.queue(queue_name, queue_params).tap do |queue|
+        exchanges.each do |exchange_name, exchange_config|
+          exchange = channel.topic(exchange_name, exchange_config[:params])
+          (exchange_config[:bindings] || []).each do |params|
+            queue.bind(exchange, params)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/amqp_helpers.rb

@@ -0,0 +1,2 @@
+module AMQPHelpers
+end

data/spec/daemon_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+require 'amqp_helpers/daemon'
+
+describe AMQPHelpers::Daemon do
+  describe '#start' do
+    subject { described_class.new }
+
+    it 'starts the AMQP loop with the given config' do
+      AMQP.should_receive(:start).with instance_of(Hash)
+      subject.start
+    end
+
+    let(:config) {
+      {
+        name: 'lala',
+        queue_name: 'example-queue',
+        queue_params: { durable: false },
+        logger: Logger.new('/dev/null'),
+        connection_params: { host: 'localhost', port: 1337 },
+        exchanges: {
+          'test-topic' => {
+            params: { type: :topic, durable: false },
+            bindings: [ { routing_key: 'lala.#' } ]
+          }
+        }
+      }
+    }
+    let(:block) { @block }
+    let(:connection) { double(AMQP) }
+    let(:exchange) { Object.new }
+    let(:queue) { double(AMQP::Queue) }
+
+    subject { described_class.new(config) }
+
+    before(:each) do
+      AMQP.stub(:start) do |&block|
+        @block = block
+      end
+      subject.start { |a, b| nil }
+    end
+
+    before(:each) do
+      EM.stub(:reactor_running?).and_return(true)
+      connection.stub(:auto_recovering?).and_return(true)
+      connection.stub(:open?).and_return(true)
+      connection.stub(:channel_max).and_return(0)
+      connection.stub(:on_connection)
+      connection.stub(:on_error)
+      connection.stub(:on_tcp_connection_loss)
+      connection.stub(:next_channel_id).and_return(0)
+      AMQP::Channel.any_instance.stub(:topic).and_return(exchange)
+      AMQP::Channel.any_instance.stub(:queue).and_return(queue)
+      queue.stub(:bind)
+      queue.stub(:subscribe)
+    end
+
+    it 'creates a non-durable queue' do
+      AMQP::Channel.any_instance.should_receive(:queue).with('example-queue', durable: false).and_return(queue)
+      block.call(connection)
+    end
+
+    it 'creates the topic' do
+      AMQP::Channel.any_instance.should_receive(:topic).with('test-topic', type: :topic, durable: false).and_return(exchange)
+      block.call(connection)
+    end
+
+    it 'binds the queue to the exchange' do
+      queue.should_receive(:bind).with(exchange, routing_key: 'lala.#')
+      block.call(connection)
+    end
+
+    it 'subscribes' do
+      queue.should_receive(:subscribe)
+      block.call(connection)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: amqp_helpers
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Nils Caspar
+- Raffael Schmid
+- Samuel Sieg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: amqp
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: syslogger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: Simple helpers to achieve various AMQP tasks.
+email: development@nine.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- amqp_helpers.gemspec
+- lib/amqp_helpers.rb
+- lib/amqp_helpers/daemon.rb
+- spec/daemon_spec.rb
+- spec/spec_helper.rb
+homepage: http://nine.ch/
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      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.23
+signing_key: 
+specification_version: 3
+summary: Simple helpers to achieve various AMQP tasks.
+test_files:
+- spec/daemon_spec.rb
+- spec/spec_helper.rb