qsagi 0.0.3 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5abc20946ce817158e4ccbcd23c4297457dfa967
+  data.tar.gz: b454ffe9a3616b7796f6c4b83d6b7f003b8fe8da
+SHA512:
+  metadata.gz: 4c29980ce4a2bb9bfb1a069731f6568c3f09354d3da65499fee67cd08bfa487e7f8504eb7447103a0f46e3d04c958722e5d7e75f708fa9181b7b95a6fb6bbe28
+  data.tar.gz: 4d9dad24f276baec8bd09c2b2d5c9ba19cc25538b452e83f0c9a87fa80da66b56a65d2de19f43322324c0fd1ee7cd210f739661a5df51d822645d5454e8411f6

data/lib/qsagi.rb

@@ -5,4 +5,6 @@ require "qsagi/message"
 require "qsagi/default_serializer"
 require "qsagi/json_serializer"
 require "qsagi/queue"
+require "qsagi/standard_queue"
+require "qsagi/confirmed_queue"
 require "qsagi/version"

data/lib/qsagi/confirmed_queue.rb

@@ -0,0 +1,66 @@
+module Qsagi
+  class ConfirmedQueue
+    attr_reader :nacked_messages
+
+    def initialize(queue)
+      @queue = queue
+      @nacked_messages = []
+      @unconfirmed_messages = {}
+      @wait_for_confirms = false
+    end
+
+    def connect
+      @queue.connect
+      _confirm_select
+    end
+
+    def disconnect
+      @queue.disconnect
+    end
+
+    def push(message)
+      @unconfirmed_messages[_channel.next_publish_seq_no] = message
+      @queue.push(message)
+      @wait_for_confirms = true
+    end
+
+    def pop(opts={})
+      @queue.pop(opts)
+    end
+
+    def wait_for_confirms
+      _channel.wait_for_confirms if _wait_for_confirms?
+    end
+
+    def _channel
+      @queue.channel
+    end
+
+    def _confirm_messages!(attributes)
+      if attributes[:is_nack]
+        if attributes[:multiple]
+          @nacked_messages += @unconfirmed_messages.select { |k,v| k <= attributes[:delivery_tag] }.values
+          @unconfirmed_messages.delete_if { |k,v| k <= attributes[:delivery_tag] }
+        else
+          @nacked_messages << @unconfirmed_messages.delete(attributes[:delivery_tag])
+        end
+      else
+        if attributes[:multiple]
+          @unconfirmed_messages.delete_if { |k,v| k <= attributes[:delivery_tag] }
+        else
+          @unconfirmed_messages.delete(attributes[:delivery_tag])
+        end
+      end
+    end
+
+    def _confirm_select
+      _channel.confirm_select lambda { |delivery_tag, multiple, is_nack|
+        _confirm_messages!(:delivery_tag => delivery_tag, :multiple => multiple, :is_nack => is_nack)
+      }
+    end
+
+    def _wait_for_confirms?
+      @wait_for_confirms
+    end
+  end
+end

data/lib/qsagi/message.rb

@@ -2,21 +2,17 @@ module Qsagi
   class Message
     attr_reader :payload
 
-    def initialize(message, payload)
-      @message = message
+    def initialize(delivery_details, payload)
+      @delivery_details = delivery_details
       @payload = payload
     end
 
     def delivery_tag
-      _delivery_details[:delivery_tag]
+      @delivery_details.delivery_tag
     end
 
     def exchange
-      _delivery_details[:exchange]
-    end
-
-    def _delivery_details
-      @delivery_details ||= @message.fetch(:delivery_details, {})
+      @delivery_details.exchange
     end
   end
 end

data/lib/qsagi/queue.rb

@@ -1,58 +1,13 @@
 module Qsagi
   module Queue
-    def ack(message)
-      @queue.ack(:delivery_tag => message.delivery_tag)
-    end
-
-    def clear
-      loop do
-        message = @queue.pop
-        break if message[:payload] == :queue_empty
-      end
-    end
-
-    def connect
-      @client = Bunny.new(:host => self.class.host, :port => self.class.port, :heartbeat => self.class.heartbeat)
-      @client.start
-      @queue = @client.queue(self.class.queue_name, :durable => true, :arguments => {"x-ha-policy" => "all"})
-      @exchange = @client.exchange(self.class._exchange)
-      @queue.bind(@exchange, :key => self.class.queue_name) unless self.class._exchange.empty?
-    end
-
-    def disconnect
-      @client.send(:close_socket) unless @client.nil?
-    end
-
-    def length
-      @queue.status[:message_count]
-    end
-
-    def pop(options = {})
-      auto_ack = options.fetch(:auto_ack, true)
-      message = @queue.pop(:ack => !auto_ack)
-
-      unless message[:payload] == :queue_empty
-        self.class._message_class.new(message, self.class._serializer.deserialize(message[:payload]))
-      end
-    end
-
-    def push(message)
-      serialized_message = self.class._serializer.serialize(message)
-      @exchange.publish(serialized_message, :key => @queue.name, :persistent => true, :mandatory => true)
-    end
-
-    def reconnect
-      disconnect
-      connect
-    end
-
     def self.included(klass)
       klass.extend ClassMethods
     end
 
     module ClassMethods
-      def connect(&block)
-        queue = new
+      def connect(opts={}, &block)
+        options = default_options.merge(opts)
+        queue = _queue(options)
 
         begin
           queue.connect
@@ -63,8 +18,36 @@ module Qsagi
         end
       end
 
-      def exchange(exchange)
+      def _queue(options)
+        standard_queue = StandardQueue.new(options)
+        if options[:queue_type] == :confirmed
+          ConfirmedQueue.new(standard_queue)
+        else
+          standard_queue
+        end
+      end
+
+      def default_options
+        {
+          :host => host,
+          :port => port,
+          :queue_type => :standard,
+          :heartbeat => heartbeat,
+          :message_class => _message_class,
+          :queue_name => queue_name,
+          :durable => true,
+          :queue_arguments => {"x-ha-policy" => "all"},
+          :persistent => true,
+          :mandatory => true,
+          :serializer => _serializer,
+          :exchange_options => _exchange_options,
+          :exchange => _exchange
+        }
+      end
+
+      def exchange(exchange, options = {})
         @exchange = exchange
+        @exchange_options = {:type => :direct}.merge(options)
       end
 
       def message_class(message_class)
@@ -79,6 +62,10 @@ module Qsagi
         @exchange || ""
       end
 
+      def _exchange_options
+        @exchange_options || {}
+      end
+
       def _message_class
         @message_class || Qsagi::Message
       end

data/lib/qsagi/standard_queue.rb

@@ -0,0 +1,70 @@
+module Qsagi
+  class StandardQueue
+    attr_reader :channel, :options
+
+    def initialize(options={})
+      @options = options
+    end
+
+    def ack(message)
+      @channel.ack(message.delivery_tag, false)
+    end
+
+    def reject(message, options={})
+      @channel.reject(message.delivery_tag, options.fetch(:requeue, true))
+    end
+
+    def clear
+      @queue.purge
+    end
+
+    def connect
+      @client = Bunny.new(
+        :host => options[:host],
+        :port => options[:port],
+        :heartbeat => options[:heartbeat],
+        :continuation_timeout => options[:continuation_timeout]
+      )
+      @client.start
+      @channel = @client.create_channel
+      @exchange = @channel.exchange(options[:exchange], options[:exchange_options])
+      @queue = @channel.queue(options[:queue_name], :durable => options[:durable], :arguments => options[:queue_arguments])
+      @queue.bind(@exchange, :routing_key => options[:queue_name]) unless options[:exchange].empty?
+    end
+
+    def disconnect
+      @client.close unless @client.nil?
+    end
+
+    def length
+      @queue.status[:message_count]
+    end
+
+    def pop(options = {})
+      auto_ack = options.fetch(:auto_ack, true)
+      delivery_info, properties, message = @queue.pop(:ack => !auto_ack)
+
+      unless message.nil?
+        _message_class.new(delivery_info, _serializer.deserialize(message))
+      end
+    end
+
+    def push(message)
+      serialized_message = options[:serializer].serialize(message)
+      @exchange.publish(serialized_message, :routing_key => @queue.name, :persistent => options[:persistent], :mandatory => options[:mandatory])
+    end
+
+    def reconnect
+      disconnect
+      connect
+    end
+
+    def _message_class
+      options[:message_class]
+    end
+
+    def _serializer
+      options[:serializer]
+    end
+  end
+end

data/lib/qsagi/version.rb

@@ -1,3 +1,3 @@
 module Qsagi
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/qsagi.gemspec

@@ -17,6 +17,6 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency "bunny", "~> 0.8.0"
+  gem.add_dependency "bunny", "~> 1.1.0"
   gem.add_dependency "json", "~> 1.7.0"
 end

data/spec/qsagi/confirmed_queue_spec.rb

@@ -0,0 +1,33 @@
+require "spec_helper"
+
+describe Qsagi::ConfirmedQueue do
+  describe "_confirm_messages!" do
+    it "adds a single nacked message to nacked_messages" do
+      queue = Qsagi::ConfirmedQueue.new(nil)
+      queue.instance_variable_set(:@unconfirmed_messages, {2 => "message"})
+      queue._confirm_messages!(:delivery_tag => 2, :multiple => false, :is_nack => true)
+      queue.nacked_messages.should == ["message"]
+    end
+
+    it "adds multiple nacked messages to nacked_messages" do
+      queue = Qsagi::ConfirmedQueue.new(nil)
+      queue.instance_variable_set(:@unconfirmed_messages, {2 => "message", 3 => "other_message"})
+      queue._confirm_messages!(:delivery_tag => 3, :multiple => true, :is_nack => true)
+      queue.nacked_messages.should == ["message", "other_message"]
+    end
+
+    it "removes a single acked message from unconfirmed_messages" do
+      queue = Qsagi::ConfirmedQueue.new(nil)
+      queue.instance_variable_set(:@unconfirmed_messages, {2 => "message", 3 => "other_message"})
+      queue._confirm_messages!(:delivery_tag => 2, :multiple => false, :is_nack => false)
+      queue.instance_variable_get(:@unconfirmed_messages).should == {3 => "other_message"}
+    end
+
+    it "removes multiple acked messages from unconfirmed_messages" do
+      queue = Qsagi::ConfirmedQueue.new(nil)
+      queue.instance_variable_set(:@unconfirmed_messages, {2 => "message", 3 => "other_message", 4 => "this_dude"})
+      queue._confirm_messages!(:delivery_tag => 3, :multiple => true, :is_nack => false)
+      queue.instance_variable_get(:@unconfirmed_messages).should == {4 => "this_dude"}
+    end
+  end
+end

data/spec/qsagi/message_spec.rb

@@ -3,39 +3,21 @@ require "spec_helper"
 describe Qsagi::Message do
   describe "delivery_tag" do
     it "returns the delivery_tag" do
-      data = {
-        :delivery_details => {:delivery_tag => "tag"},
-        :payload => "raw_payload"
-      }
-      Qsagi::Message.new(data, :parsed_payload).delivery_tag.should == "tag"
-    end
-
-    it "gracefully handles no delivery details" do
-      Qsagi::Message.new({}, :parsed_payload).delivery_tag.should be_nil
+      delivery_details = OpenStruct.new(:delivery_tag => "tag")
+      Qsagi::Message.new(delivery_details, :parsed_payload).delivery_tag.should == "tag"
     end
   end
 
   describe "exchange" do
     it "returns the exchange" do
-      data = {
-        :delivery_details => {:exchange => "the_exchange"},
-        :payload => "raw_payload"
-      }
-      Qsagi::Message.new(data, :parsed_payload).exchange.should == "the_exchange"
-    end
-
-    it "gracefully handles no delivery details" do
-      Qsagi::Message.new({}, :parsed_payload).exchange.should be_nil
+      delivery_details = OpenStruct.new(:exchange => "the_exchange")
+      Qsagi::Message.new(delivery_details, :parsed_payload).exchange.should == "the_exchange"
     end
   end
 
   describe "payload" do
     it "returns the parsed payload" do
-      data = {
-        :delivery_details => {:delivery_tag => "tag"},
-        :payload => "raw_payload"
-      }
-      Qsagi::Message.new(data, :parsed_payload).payload.should == :parsed_payload
+      Qsagi::Message.new(:deliver_details, :parsed_payload).payload.should == :parsed_payload
     end
   end
 end

data/spec/qsagi/queue_spec.rb

@@ -12,7 +12,7 @@ describe Qsagi::Queue do
   describe "self.exchange" do
     it "configures the exchange" do
       queue_on_exchange1 = Class.new(ExampleQueue) do
-        exchange "exchange1"
+        exchange "exchange1", :type => :direct
       end
       queue_on_exchange2 = Class.new(ExampleQueue) do
         exchange "exchange2"
@@ -54,6 +54,30 @@ describe Qsagi::Queue do
     end
   end
 
+  describe "reject" do
+    it "rejects the message and places it back on the queue" do
+      ExampleQueue.connect do |queue|
+        queue.push("message")
+        message = queue.pop(:auto_ack => false)
+        queue.reject(message, :requeue => true)
+      end
+      ExampleQueue.connect do |queue|
+        queue.length.should == 1
+      end
+    end
+
+    it "rejects and discards the message" do
+      ExampleQueue.connect do |queue|
+        queue.push("message")
+        message = queue.pop(:auto_ack => false)
+        queue.reject(message, :requeue => false)
+      end
+      ExampleQueue.connect do |queue|
+        queue.length.should == 0
+      end
+    end
+  end
+
   describe "pop" do
     it "automatically acks if :auto_ack is not passed in" do
       ExampleQueue.connect do |queue|
@@ -84,4 +108,14 @@ describe Qsagi::Queue do
       end
     end
   end
+
+  describe "queue_type confirmed" do
+    it "should use a ConfirmedQueue" do
+      ExampleQueue.connect(:queue_type => :confirmed) do |queue|
+        queue.push("message")
+        queue.wait_for_confirms
+        queue.nacked_messages.size.should == 0
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 require "qsagi"
+require "ostruct"
 
 class ExampleQueue
   include Qsagi::Queue
@@ -22,10 +23,8 @@ end
 
 RSpec.configure do |c|
   c.before(:each) do
-    client = Bunny.new(:host => ExampleQueue.host, :port => ExampleQueue.port)
-    client.start
-    queue = client.queue(ExampleQueue.queue_name, :durable => true, :arguments => {"x-ha-policy" => "all"})
-    queue.delete rescue nil
-    client.send(:close_socket)
+    ExampleQueue.connect do |queue|
+      queue.clear
+    end
   end
 end

metadata

@@ -1,36 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: qsagi
 version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors:
 - Braintree
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-29 00:00:00.000000000 Z
+date: 2014-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -56,41 +51,44 @@ files:
 - README.md
 - Rakefile
 - lib/qsagi.rb
+- lib/qsagi/confirmed_queue.rb
 - lib/qsagi/default_serializer.rb
 - lib/qsagi/json_serializer.rb
 - lib/qsagi/message.rb
 - lib/qsagi/queue.rb
+- lib/qsagi/standard_queue.rb
 - lib/qsagi/version.rb
 - qsagi.gemspec
+- spec/qsagi/confirmed_queue_spec.rb
 - spec/qsagi/json_serializer_spec.rb
 - spec/qsagi/message_spec.rb
 - spec/qsagi/queue_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/braintree/qsagi
 licenses: []
+metadata: {}
 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
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A friendly way to talk to RabbitMQ
 test_files:
+- spec/qsagi/confirmed_queue_spec.rb
 - spec/qsagi/json_serializer_spec.rb
 - spec/qsagi/message_spec.rb
 - spec/qsagi/queue_spec.rb