active_pubsub 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 732df7c0baced02169548ca0e1b68fe64672bf98
-  data.tar.gz: dc0e9439ab43e368ebef496cb24a0686e1d6d7e1
+  metadata.gz: 1934c830b54ffd62b61a8854ba7014e7641a134d
+  data.tar.gz: cf1d897e9d8f5baf7ee7fb9e9f4ba99fd36fdb4d
 SHA512:
-  metadata.gz: 1fa9d7aabee001f5a1423d590277d0a6de796d3220f1ffa8c884699343e02689a4fc17fb2b8ef7389446fe7f244aa4566dc306fd22cde720c537b5a94dcdb2e5
-  data.tar.gz: f5068dc1ce77133ca6bbb2574d942be00a1c683c7b967da06465db2e1ecc44a1cedc4d2c78d1797c5762a9e1651ec8196e679ef3e865798c8d094657c1963fb6
+  metadata.gz: 6b764248afe7d0aae61d1709e3f6926a03ced904465c5719a5ab749e276722ef882a411cd50da0872aa44b2e11dbd831606ff84cd367eac809460a734b1d5150
+  data.tar.gz: 98ed111e12e4b56995e87ed710cbf23f4f20f0c567e137127065503456968cba2116e96b72ff7aaa2e53bf0681e3ad6588b00da35e7ef1f49eb9a79924a2bde5

data/README.md

@@ -144,6 +144,31 @@ end
 
 Its still really early in development cycle, so there may be issues running tests if you aren't running rabbit. Should probably fix that.
 
+### Configuration, Persistence, Acknowledgement and Durability
+
+Rabbit allows you to configure the hell out of it. In the spirit of convention over configuration, Ive attempted to dumb that down into shared settings, i.e., durability being applied across the board (to queues, exchanges, as well as persisting messages, set to true)
+
+**NOTE**
+
+If you change a config setting, you will likely need to remove your queues and exchanges. Rabbit does not let you override queues or exchanges or bindings at runtime with different settings. You need to destroy them manually, and easiest way to do this is via gui.
+
+** Durability **
+
+``` ruby
+::ActivePubsub.config.durable = true
+```
+
+Will make all your queues, exchanges, durable. This means they will be there when your broker is restarted. It will ALSO make the publishing of messages persisted to disk. I could split this into two settings, but once again, in the spirit of simplicity Ive elected not to for now.
+
+
+** Message Acknowledgement **
+
+``` ruby
+::ActivePubsub.config.ack = true
+```
+
+Will turn on message acknowledgement. What this means, is if there is an error in your subscriber and it fails to get to the end of your on :eventname block, it will not acknowledge that it was processed, and mark it as unacknowledged. This is a way to provide insight into failures, as well as reprocessing events, however its a poor mans solution at best. Reason being, once a subscriber attempts to process a message and fails, rabbit marks that the consumer attempted to do so, and rabbit will not let release the message back to the queue (if it did, you would suffer from potentially immediate and infinite retrys to process the message). See the following link for more details on the problem in general: http://grokbase.com/t/rabbitmq/rabbitmq-discuss/137ts15m5r/push-to-back-of-queue-on-nack
+
 ### Installation
 
 Add this line to your application's Gemfile:

data/lib/active_pubsub.rb

@@ -9,6 +9,7 @@ require "active_attr"
 require "pry"
 require "active_pubsub/config"
 require "active_pubsub/logging"
+require "active_pubsub/settings"
 
 module ActivePubsub
   class << self
@@ -26,6 +27,10 @@ module ActivePubsub
     ::ActiveSupport.run_load_hooks(:active_pubsub, self)
   end
 
+  def self.disable_publisher!
+    configuration.disable_publisher = true
+  end
+
   def self.load_subscribers
     ::Dir.glob(::Rails.root.join('app', 'subscribers', "*.rb")).each{ |file| load file }
   end
@@ -42,6 +47,10 @@ module ActivePubsub
     ::Celluloid::Actor[:rabbit_publisher]
   end
 
+  def self.publisher_disabled?
+    configuration.publisher_disabled
+  end
+
   def self.start_publisher
     ::ActivePubsub::Publisher.start unless ::ActivePubsub::Publisher.started?
   end

data/lib/active_pubsub/config.rb

@@ -11,6 +11,9 @@ module ActivePubsub
       self[:publish_as] ||= nil
       self[:service_namespace] ||= nil
       self[:logger] ||= ::ActivePubsub::Logging.logger
+      self[:durable] ||= false
+      self[:ack] ||= false
+      self[:publisher_disabled] ||= false
     end
   end
 end

data/lib/active_pubsub/publisher.rb

@@ -1,5 +1,6 @@
 module ActivePubsub
   class Publisher
+    include ::ActivePubsub::Settings
     include ::Celluloid
 
     attr_accessor :connection
@@ -50,11 +51,20 @@ module ActivePubsub
       @exchanges ||= {}
     end
 
+    def options_for_publish(event)
+      {
+        :routing_key => event.routing_key,
+        :persistent => ::ActivePubsub.config.durable
+      }
+    end
+
     def publish_event(event)
+      return if ::ActivePubsub.publisher_disabled?
+
       ::ActiveRecord::Base.connection_pool.with_connection do
         ::ActivePubsub.logger.info("Publishing event: #{event.id} to #{event.routing_key}")
 
-        exchanges[event.exchange].publish(serialize_event(event), :routing_key => event.routing_key)
+        exchanges[event.exchange].publish(serialize_event(event), options_for_publish(event))
       end
     end
 
@@ -63,7 +73,7 @@ module ActivePubsub
     end
 
     def register_exchange(exchange_name)
-      exchanges[exchange_name] ||= channel.topic(exchange_name, :auto_delete => true)
+      exchanges[exchange_name] ||= channel.topic(exchange_name, exchange_settings)
     end
   end
 end

data/lib/active_pubsub/settings.rb

@@ -0,0 +1,40 @@
+module ActivePubsub
+  module Settings
+    extend ::ActiveSupport::Concern
+
+    def exchange_settings
+      self.class.exchange_settings
+    end
+
+    def queue_settings
+      self.class.queue_settings
+    end
+
+    def subscribe_settings
+      self.class.subscribe_settings
+    end
+
+    module ClassMethods
+      def exchange_settings
+        {
+          :durable => ::ActivePubsub.config.durable,
+          :auto_delete => !::ActivePubsub.config.durable
+        }
+      end
+
+      def queue_settings
+        {
+          :manual_ack => ::ActivePubsub.config.ack,
+          :durable => ::ActivePubsub.config.durable
+        }
+      end
+
+      def subscribe_settings
+        {
+          :manual_ack => ::ActivePubsub.config.ack,
+          :block => false
+        }
+      end
+    end
+  end
+end

data/lib/active_pubsub/subscriber.rb

@@ -2,6 +2,8 @@ require 'active_support/all'
 
 module ActivePubsub
   class Subscriber
+    include ::ActivePubsub::Settings
+
     attr_accessor :connection
 
     class_attribute :events
@@ -28,7 +30,7 @@ module ActivePubsub
     end
 
     def self.exchange
-      channel.topic(exchange_name, :auto_delete => true)
+      channel.topic(exchange_name, exchange_settings)
     end
 
     def self.inherited(klass)
@@ -43,9 +45,9 @@ module ActivePubsub
       return if started?
 
       events.each_pair do |event_name, block|
-        channel.queue(queue_for_event(event_name.to_s))
+        channel.queue(queue_for_event(event_name.to_s), queue_settings)
                .bind(exchange, :routing_key => routing_key_for_event(event_name))
-               .subscribe do |delivery_info, properties, payload|
+               .subscribe(subscribe_settings) do |delivery_info, properties, payload|
           deserialized_event = deserialize_event(payload)
           deserialized_record = deserialize_record(deserialized_event[:record])
 
@@ -53,6 +55,8 @@ module ActivePubsub
           subscriber_instance.instance_exec(deserialized_record, &block)
 
           ::ActivePubsub.logger.info "#{delivery_info[:routing_key]} #{name} consumed #{deserialized_event}"
+
+          channel.ack(delivery_info.delivery_tag) if ::ActivePubsub.config.ack
         end
       end
 

data/lib/active_pubsub/version.rb

@@ -1,3 +1,3 @@
 module ActivePubsub
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

data/spec/active_pubsub/config_spec.rb

@@ -15,6 +15,10 @@ describe ::ActivePubsub::Config do
     its(:address) { should eq ENV["RABBITMQ_URL"] }
     its(:publish_as) { should eq nil }
     its(:service_namespace) { should eq nil }
+    its(:ack) { should be false }
+    its(:durable) { should be false }
+    its(:logger) { should be_instance_of(::Logger) }
+    its(:publisher_disabled) { should eq false }
   end
 
 end

data/spec/active_pubsub/publisher_spec.rb

@@ -46,6 +46,32 @@ describe ::ActivePubsub::Publisher do
     its(:exchanges) { should include(exchange_key) }
   end
 
+  describe "#options_for_publish" do
+    let(:expected) {
+      {
+        :routing_key => fake_event.routing_key,
+        :persistent => false
+      }
+    }
+
+    it { subject.options_for_publish(fake_event).should eq expected }
+
+    context "durable is true" do
+      before do
+        ::ActivePubsub::Config.any_instance.stub(:durable).and_return(true)
+      end
+
+      let(:expected) do
+        {
+          :routing_key => fake_event.routing_key,
+          :persistent => true
+        }
+      end
+
+      it { subject.options_for_publish(fake_event).should eq expected }
+    end
+  end
+
   describe "#publish_event" do
     it "should receive publish event with instance of event when publishable record is saved" do
       subject.should_receive(:publish_event).with(instance_of(::ActivePubsub::Event))

data/spec/active_pubsub/settings_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe ::ActivePubsub::Settings do
+  subject {
+    class FakeSettingsIncluder
+      include ::ActivePubsub::Settings
+    end
+  }
+
+  its(:exchange_settings) {
+    options = { :durable => false, :auto_delete => true }
+    should eq options
+  }
+
+  its(:queue_settings) {
+    options = { :manual_ack => false, :durable => false }
+    should eq options
+  }
+
+  its(:subscribe_settings) {
+    options = { :manual_ack => false, :block => false }
+    should eq options
+  }
+
+  context "acknowledgement is true" do
+    before do
+      ::ActivePubsub::Config.any_instance.stub(:ack).and_return(true)
+    end
+
+    its(:queue_settings) {
+      options = { :manual_ack => true, :durable => false }
+      should eq options
+    }
+
+    its(:subscribe_settings) {
+      options = { :manual_ack => true, :block => false }
+      should eq options
+    }
+  end
+
+  context "durability is true" do
+    its(:exchange_settings) {
+      options = { :durable => false, :auto_delete => true }
+      should eq options
+    }
+
+    its(:queue_settings) {
+      options = { :manual_ack => false, :durable => false }
+      should eq options
+    }
+
+    its(:subscribe_settings) {
+      options = { :manual_ack => false, :block => false }
+      should eq options
+    }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_pubsub
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Jason Ayre
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-27 00:00:00.000000000 Z
+date: 2014-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_attr
@@ -319,6 +319,7 @@ files:
 - lib/active_pubsub/publishable.rb
 - lib/active_pubsub/publisher.rb
 - lib/active_pubsub/railtie.rb
+- lib/active_pubsub/settings.rb
 - lib/active_pubsub/subscribe_to_changes.rb
 - lib/active_pubsub/subscriber.rb
 - lib/active_pubsub/version.rb
@@ -327,6 +328,7 @@ files:
 - spec/active_pubsub/publish_with_serializer_spec.rb
 - spec/active_pubsub/publishable_spec.rb
 - spec/active_pubsub/publisher_spec.rb
+- spec/active_pubsub/settings_spec.rb
 - spec/active_pubsub/subscribe_to_changes_spec.rb
 - spec/active_pubsub/subscriber_spec.rb
 - spec/spec_helper.rb
@@ -369,6 +371,7 @@ test_files:
 - spec/active_pubsub/publish_with_serializer_spec.rb
 - spec/active_pubsub/publishable_spec.rb
 - spec/active_pubsub/publisher_spec.rb
+- spec/active_pubsub/settings_spec.rb
 - spec/active_pubsub/subscribe_to_changes_spec.rb
 - spec/active_pubsub/subscriber_spec.rb
 - spec/spec_helper.rb