traffiq 1.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ebf36730922b2f8e415d1a0220a6edf1b4c1a21b
+  data.tar.gz: b77ef9b9902681c190418c85238cc104526b2827
+SHA512:
+  metadata.gz: 749a2c2dcefe36499ce673dc57153cdfa492e2ff2feb786f42474ddbb6bd4c9f7a7af7a9c7b4c2d27483eecb3d55a490b74a894738adc4b4c4e5e4115909e6be
+  data.tar.gz: 76c41db2eaab5872b91097bd68b3f8858037ceea1bd2f5830bcc271bdccc055007482597f98fc84363d506a74ce8a4d9d5bf7bbfade6e3786130d518dd5e9d15

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+## Version 1.3.0 (July 10)
+
+* Allow publishers to bind queues on publish even if no consumers are up (9016226).
+
+## Version 1.1.0 to 1.2.0 (Mar 18)
+
+* Allow clients to specify a block to be called when an uncaught exception happens
+in a consumer.
+
+## Version 1.0.1 to 1.1.0 (Feb 4)
+
+* Adding AMQP test helpers (d707a1e).
+
+## Version 1.0.0 to 1.0.1 (Jan 27)
+
+* Update bunny dependency to allow bunny version 1.6.x (40f7f71).

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in traffiq.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Ride Group Inc and contributors.
+
+MIT License
+
+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,108 @@
+# Traffiq
+
+[![Circle CI](https://circleci.com/gh/ride/traffiq.svg?style=svg)](https://circleci.com/gh/ride/traffiq)
+
+`Traffiq` helps you with your queues so you don't have to.
+
+![Boston Traffic](http://statescoop.com/wp-content/uploads/2014/04/boston-traffic.jpg)
+
+## Usage
+
+For now only AMQP is supported with *topic* exchanges.
+
+```ruby
+  # consumer.rb
+  amqp = Traffiq::AMQP.new("user:password@rabbit-server.com")
+  amqp.define_exchange('events', durable: true)
+  amqp.subscribe('routing_key', options) do |delivery_info, metadata, payload| 
+    puts delivery_info, metadata, payload
+  end
+
+  # producer.rb
+  amqp = Traffiq::AMQP.new(queue_url)
+  amqp.define_exchange('events', durable: true)
+  amqp.publish('routing_key', payload)
+  amqp.close
+```
+
+By default, the exchanges created will be `durable`. Please note that the
+producer and the consumer need to agree on the exchange options.
+
+Queues will be created with `durable: true, auto_delete: false`.
+
+More documentation can be found in the code as inline comments.
+
+### Publishing Messages
+
+Be aware that, by design, `topic` exchanges will drop any message sent to a
+queue that has never been binded to. So you will need to make sure your
+consumers start before the producer (and bind to a specific queue) before you
+send messages to them.
+
+You can force the publisher to bind to a queue with the `bind_to_queue`
+option on the `#publish` method. This will create a queue with the same name of
+the routing key, so be careful with that. You don't want to have many durable
+queues created by temporary proccesses.
+
+```ruby
+amqp = Traffiq::AMQP.new("server")
+amqp.publish('routing_key', payload)
+amqp.queues['routing_key'] # => nil
+
+amqp.publish('routing_key', payload, bind_to_queue: true)
+amqp.queues['routing_key'] # => Bunny::Queue
+```
+
+## Test Helpers
+
+`traffiq` comes with some test helpers for RabbitMQ integration tests. Notice
+that when using these helpers you *must* have a RabbitMQ server running.
+
+To use them, you can do the following:
+
+```ruby
+# test_helper.rb
+
+require 'traffiq/test_helpers'
+include Traffiq::TestHelpers
+
+queue, amqp = setup_amqp_queue(server_url, exchange_name, routing_key)
+
+amqp.publish(routing_key, { tony: 'montana' }.to_json)
+
+last_amqp_queue_message(queue) # => { 'tony' => 'montana' }
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'traffiq'
+```
+
+And then execute:
+
+    $ bundle
+
+## Running Tests
+
+Traffiq requires RabbitMQ to be running for tests. So after you start your
+rabbit server, you can test with Rake:
+
+```
+bundle exec rake test
+```
+
+You can pass the Rabbit URL via the `QUEUE_URL` environment variable. If you are
+running Rabbit with the default configuration you don't need this. Same goes for
+Boxen, Traffiq will detect if you have Boxen installed and use the Boxen default
+port (55672).
+
+## Contributing
+
+1. Fork it ( https://github.com/ride/traffiq/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs = [ "test" ]
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+  # TODO: AMQP has a lot of warnings. Fix them and turn this on.
+  # t.warning = true
+end
+
+task :default => [ :test ]

data/circle.yml

@@ -0,0 +1,11 @@
+machine:
+  environment:
+    QUEUE_URL: amqp://guest:guest@127.0.0.1:5672
+  ruby:
+    version: 2.2.2
+  services:
+    - rabbitmq-server
+
+test:
+  override:
+    - bundle exec rake test

data/lib/traffiq.rb

@@ -0,0 +1,7 @@
+require "traffiq/errors"
+require "traffiq/amqp"
+require "traffiq/version"
+
+require 'multi_json'
+
+module Traffiq ; end

data/lib/traffiq/amqp.rb

@@ -0,0 +1,111 @@
+require 'bunny'
+
+module Traffiq
+  class AMQP
+    attr_reader :exchange
+
+    def initialize(queue_url)
+      @conn = Bunny.new(queue_url)
+      @conn.start
+
+      @channel = @conn.create_channel
+    end
+
+    # Checks if the connection to the Rabbit server is opened.
+    def connected?
+      @conn.connected? && @channel.open?
+    end
+
+    # Returns the exchanges that the channel has, except the default exchange.
+    def exchanges
+      @channel.exchanges
+    end
+
+    # Returns the queues that are binded on this connection.
+    def queues
+      @channel.queues
+    end
+
+    # Sets up the block to run when an error happens.
+    #
+    # @param [Block] block The block to run on uncaught exceptions.
+    def on_uncaught_exception(&block)
+      @channel.on_uncaught_exception(&block)
+    end
+
+    # Defines a *topic* exchange.
+    #
+    # This defines a durable topic exchange by default.
+    #
+    # @param [String] name The name of the exchange.
+    # @param [Hash] options The options to define the exchange with.
+    #
+    # For options, look at Bunny's exchange options.
+    #     http://rubybunny.info/articles/exchanges.html
+    def define_exchange(name, options = {})
+      options = {
+        durable: true,
+      }.merge(options)
+      @exchange = @channel.topic(name, options)
+    end
+
+    # Binds a queue to the exchange and sets it's routing_key to `name`.
+    #
+    # @param [String] name The name of the queue and routing key to use.
+    # @param [Hash] options Queue options.
+    #
+    # For options look at Bunny's Queue options.
+    #     http://rubybunny.info/articles/queues.html
+    def bind_queue(name, options = {})
+      raise Traffiq::NoExchangeError.new if @exchange.nil?
+
+      options = {
+        durable: true,
+        auto_delete: false,
+      }.merge(options)
+
+      @channel.queue(name, options)
+              .bind(@exchange, routing_key: name)
+    end
+
+    # Subscribes to a specific routing_key. Executes the block when there's a
+    # message routed there.
+    #
+    # A queue will be binded with the `routing_key` name.
+    #
+    # @param [String]  routing_key Routing key to subscribe to.
+    # @param [Hash] options Subscribe options for the queue.
+    # @param [Block] &block the block you want to execute when a message arrive.
+    #
+    # For options look at Bunny's Queue#subscribe options.
+    #     http://rubybunny.info/articles/queues.html
+    def subscribe(routing_key, options = {}, &block)
+      q = bind_queue(routing_key)
+      options = options.merge(manual_ack: true)
+
+      q.subscribe(options) do |delivery_info, metadata, payload|
+        block.call(delivery_info, metadata, payload)
+        @channel.ack(delivery_info.delivery_tag)
+      end
+    end
+
+    # Publishes a message to a specific routing key.
+    #
+    # @param [String] routing_key The routing key where you want to send the message to.
+    # @param [Hash] payload What you want the message to have. It'll be converted to JSON.
+    # @param [Hash] options Publish options
+    #
+    # @option opts [Boolean] :bind_to_queue If you want to bind a queue just in case there are no subscribers.
+    def publish(routing_key, payload = {}, options = {})
+      raise Traffiq::NoExchangeError.new if @exchange.nil?
+      bind_queue(routing_key) if options[:bind_to_queue]
+      @exchange.publish(MultiJson.dump(payload), routing_key: routing_key, persistent: true)
+    end
+
+    # Closes connection to the Rabbit server.
+    def close
+      @channel.close
+      @conn.close
+    end
+  end
+end

data/lib/traffiq/errors.rb

@@ -0,0 +1,19 @@
+module Traffiq
+  class Error < StandardError
+    def initialize(msg = nil)
+      super(msg || default_message)
+    end
+
+    private
+    def default_message
+      "Traffiq error"
+    end
+  end
+
+  class NoExchangeError < Error
+    private
+    def default_message
+      "Must define exchange"
+    end
+  end
+end

data/lib/traffiq/test_helpers.rb

@@ -0,0 +1,19 @@
+module Traffiq
+  module TestHelpers
+    def setup_amqp_queue(url, exchange_name, routing_key)
+      amqp = Traffiq::AMQP.new(url)
+      amqp.define_exchange(exchange_name)
+      queue = amqp.bind_queue(routing_key)
+      queue.purge
+      return queue, amqp
+    end
+
+    def last_amqp_queue_message(queue)
+      _, _, payload = queue.pop
+      if payload
+        payload = JSON.parse(payload)
+      end
+      payload
+    end
+  end
+end

data/lib/traffiq/version.rb

@@ -0,0 +1,3 @@
+module Traffiq
+  VERSION = "1.3.0"
+end

data/test/lib/traffiq/amqp_test.rb

@@ -0,0 +1,137 @@
+require 'test_helper'
+
+module Traffiq
+  class AMQPTest < Minitest::Spec
+    let(:queue_url) { ENV['QUEUE_URL'] || ENV['BOXEN_RABBITMQ_URL'] || "amqp://guest:guest@localhost:5672" }
+    let(:amqp) { ::Traffiq::AMQP.new(queue_url) }
+    let(:payload) {{ payload: :goes_here }}
+    let(:routing_key) { 'routing_key' }
+    let(:json_payload) { '{"payload":"goes_here"}' }
+
+    after do
+      amqp.close
+    end
+
+    describe '#initialize' do
+      it "connects to a queue and creates a channel" do
+        amqp = ::Traffiq::AMQP.new(queue_url)
+        assert amqp.connected?
+      end
+    end
+
+    describe '#define_exchange' do
+      let(:exchange_name) { 'new_exchange' }
+      let(:exchange) { amqp.exchanges[exchange_name] }
+
+      before do
+        amqp.define_exchange(exchange_name)
+      end
+
+      it "defines a topic exchange with the exchange name" do
+        assert_equal 1, amqp.exchanges.size
+        refute_nil exchange
+        assert_equal :topic, exchange.type
+      end
+
+      it "defines a durable and non auto-delete exchange" do
+        assert exchange.durable?
+        refute exchange.auto_delete?
+      end
+    end
+
+    describe "#bind_queue" do
+      context "without an exchange" do
+        it "raises an error" do
+          assert_raises ::Traffiq::NoExchangeError do
+            amqp.bind_queue(routing_key)
+          end
+        end
+      end
+
+      context "with an exchange" do
+        before do
+          amqp.define_exchange('traffiq_test')
+        end
+
+        it "creates a queue" do
+          queue = amqp.bind_queue(routing_key)
+          refute_nil queue
+
+          assert_equal 1, amqp.queues.length
+          assert_equal queue, amqp.queues[routing_key]
+        end
+      end
+    end
+
+    describe "#publish" do
+      context "without an exchange" do
+        it "raises an error" do
+          assert_raises ::Traffiq::NoExchangeError do
+            amqp.publish(routing_key, payload)
+          end
+        end
+      end
+
+      context "with an exchange" do
+        before do
+          amqp.define_exchange('traffiq_test')
+        end
+
+        it "pushes a message with a specific routing key and as JSON" do
+          amqp.exchange.expects(:publish).
+            with(json_payload, routing_key: 'test_routing_key', persistent: true).
+            once
+          amqp.publish('test_routing_key', payload)
+        end
+
+        it "doesn't bind to a queue by default" do
+          amqp.publish('test_routing_key', payload)
+          assert_empty amqp.queues
+        end
+
+        it "binds to a queue if you want it to" do
+          amqp.publish('test_routing_key', payload, bind_to_queue: true)
+          refute_empty amqp.queues
+          refute_nil amqp.queues['test_routing_key']
+        end
+      end
+    end
+
+    describe "#subscribe" do
+      let(:noop) {  lambda{ |_,_,_| }}
+      context "without an exchange" do
+        it "raises an error" do
+          assert_raises ::Traffiq::NoExchangeError do
+            amqp.subscribe(routing_key, &noop)
+          end
+        end
+      end
+
+      context "with an exchange" do
+        before do
+          amqp.define_exchange('traffiq_test')
+        end
+
+        it "binds to a routing key" do
+          amqp.subscribe(routing_key, &noop)
+          assert_equal 1, amqp.queues.length
+
+          queue = amqp.queues[routing_key]
+          refute_nil queue
+          assert_equal routing_key, queue.name
+        end
+
+        it "executes the block with the payload when something is published" do
+          amqp.subscribe(routing_key) do |delivery_info, metadata, q_payload|
+            refute_nil delivery_info
+            refute_nil metadata
+            refute_nil q_payload
+            assert_equal json_payload, q_payload
+          end
+
+          amqp.publish('test_routing_key', payload)
+        end
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require File.expand_path('../../lib/traffiq', __FILE__)
+require 'minitest/autorun'
+require 'mocha/mini_test'
+
+def context(name, &block)
+  describe(name, &block)
+end

data/traffiq.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'traffiq/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "traffiq"
+  spec.version       = Traffiq::VERSION
+  spec.authors       = ["Ride"]
+  spec.email         = ["nicolas@ride.com"]
+  spec.summary       = %q{Simple queue helpers for Ride.}
+  spec.description   = %q{Simple queue helpers for Ride.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'multi_json', '~> 1.11'
+  spec.add_dependency 'bunny', '>= 1.5.1', '< 2.0'
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.7"
+  spec.add_development_dependency "mocha", "~> 1.1"
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: traffiq
+version: !ruby/object:Gem::Version
+  version: 1.3.0
+platform: ruby
+authors:
+- Ride
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: bunny
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.7'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: Simple queue helpers for Ride.
+email:
+- nicolas@ride.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- circle.yml
+- lib/traffiq.rb
+- lib/traffiq/amqp.rb
+- lib/traffiq/errors.rb
+- lib/traffiq/test_helpers.rb
+- lib/traffiq/version.rb
+- test/lib/traffiq/amqp_test.rb
+- test/test_helper.rb
+- traffiq.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Simple queue helpers for Ride.
+test_files:
+- test/lib/traffiq/amqp_test.rb
+- test/test_helper.rb