multiple_man 0.5.21 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f395c0bc53fe2aab8ffde4426d0013cf9a0ee0ba
-  data.tar.gz: ce5554a9a4e526be5216796f0b34cecf7d7a1fa0
+  metadata.gz: d8c65c40b50ae40908c59ef6c0cd66d724f461ea
+  data.tar.gz: 3403383d7f31f579dcc4b450a65f5f482ea7c5cb
 SHA512:
-  metadata.gz: 163c9dad1a4ee94f7e74a442721b2be649e64af233a0105d4f885695effd21c58eb4933053f5a9abdb01a1570ad1fc33ca1318c6d709753012c363c6b2843cda
-  data.tar.gz: 87c49def2141da2c11297facc6618c93984f31aceacbcbd40ab606ce951fcdc408d6db1e472a62fc09bcb4430dd6e954b54d46ceda053e670e69f49108381d35
+  metadata.gz: b487f16fa2d71cf90898bd0024667b41c1d46fd84d53b9c650ecbc98a0d582ed2793bd68b2dab1de491473763d1fb5c82f6558f058e30a58f8daa3cc731a9e5f
+  data.tar.gz: fb7be9925bfa4d7b26747029bf0b313b236af14b2b03e71a37ca548e860d62fe21eee772601fb5922b600c29d8f4c8bd59366050c6f6001b522332bd3c81e80c

data/README.md

@@ -8,7 +8,7 @@ MultipleMan synchronizes your ActiveRecord models between Rails
 apps, using RabbitMQ to send messages between your applications.
 It's heavily inspired by Promiscuous, but differs in a few ways:
 
-- MultipleMan makes a hard assumption that you're using 
+- MultipleMan makes a hard assumption that you're using
   ActiveRecord for your models. This simplifies how models
   are sychronized, which offers a few benefits like:
 - Transactions are fully supported in MultipleMan. Records
@@ -38,9 +38,9 @@ calling MultipleMan.configure like so:
 
     MultipleMan.configure do |config|
       # A connection string to your local server. Defaults to localhost.
-      config.connection = "amqp://example.com" 
+      config.connection = "amqp://example.com"
 
-      # The topic name to push to. If you have multiple 
+      # The topic name to push to. If you have multiple
       # multiple man apps, this should be unique per application. Publishers
       # and subscribers should always use the same topic.
       config.topic_name = "multiple_man"
@@ -50,10 +50,10 @@ calling MultipleMan.configure like so:
       config.app_name = "MyApp"
 
       # Specify what should happen when MultipleMan
-      # encounters an exception. 
+      # encounters an exception.
       config.on_error do |exception|
         ErrorLogger.log(exception)
-      end 
+      end
 
       # Where you want to log errors to. Should be an instance of Logger
       # Defaults to the Rails logger (for Rails) or STDOUT otherwise.
@@ -95,16 +95,16 @@ You can use the following options when publishing:
   an ActiveRecord serializer (or anything that takes your
   record in the constructor and has an `as_json` method) to
   serialize models instead.
-- `as` - If you want the name of the model from the 
+- `as` - If you want the name of the model from the
   perspective of MultipleMan to be different than the model
-  name in Rails, specify `as` with the name you want to use. 
+  name in Rails, specify `as` with the name you want to use.
   Useful for STI.
 - `identify_by` - Specify an array of fields that MultipleMan
   should use to identify your record on the subscriber end.
-  `id` is used by default and is generally fine, unless you're working in a multi-tenant environment where ids may 
+  `id` is used by default and is generally fine, unless you're working in a multi-tenant environment where ids may
   be shared between two different models of the same class.
 - (DEPRECATED) `identifier` - Either a symbol or a proc used by MultipleMan to identify your model.
-  
+
 ### Publishing
 
 By default, MultipleMan will publish all of your models whenever you save a model (in an `after_commit` hook). If you need to manually publish models, you can do so with the `multiple_man_publish` method, which acts like a scope on your models, like so:
@@ -120,7 +120,7 @@ Widget.where(published: true).multiple_man_publish
 Widget.first.multiple_man_publish
 ```
 
-If you're publishing multiple models, it's best to use the 
+If you're publishing multiple models, it's best to use the
 version of multiple_man_publish that operates on a collection. By calling the individual version, a channel is opened and closed for each model, which can impact the thoroughput of MultipleMan.
 
 ### Subscribing to models
@@ -143,6 +143,22 @@ By default, MultipleMan will attempt to identify which model on the subscriber m
 
 If your publisher specifies an `identifier` option, you *must* include a column on the subscriber side called `multiple_man_identifier`. MultipleMan will attempt to locate models on the subscriber side by this column.
 
+## Listening for model changes
+
+If you want to do something other than populate a model on MultipleMan messages,
+you can listen for messages and process them however you'd like:
+
+```
+def ListenerClass
+  include MultipleMan::Listener
+  listen_to 'ModelName'
+
+  def create(payload)
+    # do something when a model is created
+  end
+end
+``
+
 ## Listening for subscriptions
 
 Once you've set up your subscribers, you'll need to run a background worker to manage
@@ -152,9 +168,9 @@ the subscription process. Just run the following:
 
 ## Seeding
 
-One common problem when using MultipleMan on an existing project is that there's already a lot of data that you want to process using your listeners. MultipleMan provides a mechanism called "seeding" to accomplish this. 
+One common problem when using MultipleMan on an existing project is that there's already a lot of data that you want to process using your listeners. MultipleMan provides a mechanism called "seeding" to accomplish this.
 
-1. On the subscriber side, start listening for seed requests with the following rake task: 
+1. On the subscriber side, start listening for seed requests with the following rake task:
 
 ```
 rake multiple_man:seed
@@ -166,7 +182,7 @@ rake multiple_man:seed
 MyModel.multiple_man_publish(:seed)
 ```
 
-3. Stop the seeder rake task when all of your messages have been processed. You can check your RabbitMQ server 
+3. Stop the seeder rake task when all of your messages have been processed. You can check your RabbitMQ server
 
 ## Contributing
 
@@ -202,4 +218,3 @@ THE SOFTWARE.
 
 
 [![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/influitive/multiple_man/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
-

data/lib/multiple_man/connection.rb

@@ -8,7 +8,7 @@ module MultipleMan
     def self.connect
       channel = connection.create_channel
       yield new(channel) if block_given?
-    rescue Bunny::ConnectionClosedError, Bunny::NetworkErrorWrapper
+    rescue Bunny::Exception
       reset!
       retry
     ensure

data/lib/multiple_man/listeners/listener.rb

@@ -7,7 +7,6 @@ module MultipleMan::Listeners
     class << self
       def start
         MultipleMan.logger.debug "Starting listeners."
-        MultipleMan.logger.debug MultipleMan::Subscribers::Registry.subscriptions.to_json
 
         MultipleMan::Subscribers::Registry.subscriptions.each do |subscription|
           new(subscription).listen
@@ -33,7 +32,7 @@ module MultipleMan::Listeners
     attr_accessor :subscription, :connection
 
     def listen
-      
+
       MultipleMan.logger.info "Listening for #{subscription.klass} with routing key #{routing_key}."
       queue.bind(connection.topic, routing_key: routing_key).subscribe(ack: true) do |delivery_info, meta_data, payload|
         process_message(delivery_info, payload)

data/lib/multiple_man/mixins/listener.rb

@@ -0,0 +1,43 @@
+module MultipleMan
+  module Listener
+    def Listener.included(base)
+      base.extend(ClassMethods)
+    end
+
+    def routing_key
+      MultipleMan::RoutingKey.new(klass, operation).to_s
+    end
+
+    attr_accessor :klass
+    attr_accessor :operation
+
+    def create
+      # noop
+    end
+
+    def update
+      # noop
+    end
+
+    def destroy
+      # noop
+    end
+
+    def seed
+      # noop
+    end
+
+    def queue_name
+      "#{MultipleMan.configuration.topic_name}.#{MultipleMan.configuration.app_name}.#{klass}"
+    end
+
+    module ClassMethods
+      def listen_to(model, operation: '#')
+        listener = self.new
+        listener.klass = model
+        listener.operation = operation
+        Subscribers::Registry.register(listener)
+      end
+    end
+  end
+end

data/lib/multiple_man/mixins/subscriber.rb

@@ -10,4 +10,4 @@ module MultipleMan
       end
     end
   end
-end
+end

data/lib/multiple_man/model_populator.rb

@@ -9,12 +9,13 @@ module MultipleMan
     def populate(payload)
       data = payload[:id].merge(payload[:data])
       fields_for(data).each do |field|
-        populate_field(field, data[field])
+        source, dest = field.is_a?(Array) ? field : [field, field]
+        populate_field(dest, data[source])
       end
       record
     end
 
-  private 
+  private
     attr_accessor :record, :fields
 
     # Raise an exception if explicit fields were provided.
@@ -23,7 +24,7 @@ module MultipleMan
     end
 
     def populate_field(field, value)
-      # Attempt to populate source id if id is specified
+      # Attempts to populate source id if id is specified
       if field.to_s == 'id' && record.respond_to?('source_id')
         field = 'source_id'
       end
@@ -40,4 +41,4 @@ module MultipleMan
       fields || data.keys
     end
   end
-end
+end

data/lib/multiple_man/model_publisher.rb

@@ -11,10 +11,16 @@ module MultipleMan
       return unless MultipleMan.configuration.enabled
 
       Connection.connect do |connection|
-        all_records(records) do |record|
-          push_record(connection, record, operation)
+        ActiveSupport::Notifications.instrument('multiple_man.publish_messages') do
+          all_records(records) do |record|
+            ActiveSupport::Notifications.instrument('multiple_man.publish_message') do
+              push_record(connection, record, operation)
+            end
+          end
         end
       end
+    rescue Exception => ex
+      MultipleMan.error(ex)
     end
 
   private
@@ -28,8 +34,6 @@ module MultipleMan
       MultipleMan.logger.debug("  Record Data: #{data} | Routing Key: #{routing_key}")
 
       connection.topic.publish(data.payload, routing_key: routing_key)
-    rescue Exception => ex
-      MultipleMan.error(ex)
     end
 
     def all_records(records, &block)

data/lib/multiple_man/subscribers/base.rb

@@ -28,7 +28,7 @@ module MultipleMan::Subscribers
     end
 
     def queue_name
-      "#{MultipleMan.configuration.topic_name}.#{MultipleMan.configuration.app_name}.#{klass.name}"
+      "#{MultipleMan.configuration.topic_name}.#{MultipleMan.configuration.app_name}.#{klass}"
     end
 
   private

data/lib/multiple_man/subscribers/model_subscriber.rb

@@ -2,7 +2,8 @@ module MultipleMan::Subscribers
   class ModelSubscriber < Base
 
     def initialize(klass, options)
-      super(klass)
+      self.model_class = klass
+      super(options[:to] || klass.name)
       self.options = options
     end
 
@@ -26,7 +27,7 @@ module MultipleMan::Subscribers
   private
 
     def find_model(id)
-      klass.where(find_conditions(id)).first || klass.new
+      model_class.where(find_conditions(id)).first || model_class.new
     end
 
     def find_conditions(id)
@@ -43,6 +44,7 @@ module MultipleMan::Subscribers
     end
 
     attr_writer :klass
+    attr_accessor :model_class
 
   end
 end

data/lib/multiple_man/subscribers/registry.rb

@@ -9,4 +9,4 @@ module MultipleMan::Subscribers
       end
     end
   end
-end
+end

data/lib/multiple_man/tasks/worker.rake

@@ -14,8 +14,9 @@ namespace :multiple_man do
 
     listener.start
 
-    while(true)
-      sleep 10
-    end
+    Signal.trap("INT") { puts "received INT"; exit }
+    Signal.trap("QUIT") { puts "received QUIT"; exit }
+
+    sleep
   end
 end

data/lib/multiple_man/version.rb

@@ -1,3 +1,3 @@
 module MultipleMan
-  VERSION = "0.5.21"
+  VERSION = "0.6.0"
 end

data/lib/multiple_man.rb

@@ -6,6 +6,7 @@ module MultipleMan
 
   require 'multiple_man/mixins/publisher'
   require 'multiple_man/mixins/subscriber'
+  require 'multiple_man/mixins/listener'
   require 'multiple_man/subscribers/base'
   require 'multiple_man/subscribers/model_subscriber'
   require 'multiple_man/subscribers/registry'

data/spec/model_populator_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe MultipleMan::ModelPopulator do 
+describe MultipleMan::ModelPopulator do
   class MockModel
     attr_accessor :a, :b, :multiple_man_identifier
   end
@@ -27,6 +27,13 @@ describe MultipleMan::ModelPopulator do
         end
       end
     end
+
+    context "with fields as a hash" do
+      let(:fields) { { b: :a } }
+
+      its(:b) { should == nil }
+      its(:a) { should == 2 }
+    end
     context "record has source id" do
       let(:model) { Class.new do
         attr_accessor :source_id, :id
@@ -57,4 +64,4 @@ describe MultipleMan::ModelPopulator do
       end
     end
   end
-end
+end

data/spec/subscriber_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe MultipleMan::Subscriber do 
+describe MultipleMan::Subscriber do
   class MockClass
     include MultipleMan::Subscriber
   end
@@ -9,6 +9,6 @@ describe MultipleMan::Subscriber do
     it "should register itself" do
       MultipleMan::Subscribers::Registry.should_receive(:register).with(instance_of(MultipleMan::Subscribers::ModelSubscriber))
       MockClass.subscribe fields: [:foo, :bar]
-    end 
+    end
   end
-end
+end

data/spec/subscribers/base_spec.rb

@@ -5,13 +5,17 @@ describe MultipleMan::Subscribers::Base do
   end
 
   specify "routing_key should be the model name and a wildcard" do
-    described_class.new(MockClass).routing_key.should == "app.MockClass.#"
+    described_class.new(MockClass).routing_key.should =~ /\.MockClass\.\#$/
   end
 
   specify "queue name should be the app name + class" do
     MultipleMan.configure do |config|
       config.app_name = "test"
     end
-    described_class.new(MockClass).queue_name.should == "app.test.MockClass"
+    described_class.new(MockClass).queue_name.should =~ /\.test\.MockClass$/
+  end
+
+  specify "it should be alright to use a string for a class name" do
+    described_class.new("MockClass").routing_key.should =~ /\.MockClass\.\#$/
   end
 end

data/spec/subscribers/model_subscriber_spec.rb

@@ -5,6 +5,13 @@ describe MultipleMan::Subscribers::ModelSubscriber do
 
   end
 
+  describe "initialize" do
+    it "should listen to the object passed in for to" do
+      subscriber = described_class.new(MockClass, to: 'PublishedClass')
+      expect(subscriber.klass).to eq("PublishedClass")
+    end
+  end
+
   describe "create" do
     it "should create a new model" do
       mock_object = MockClass.new
@@ -40,4 +47,4 @@ describe MultipleMan::Subscribers::ModelSubscriber do
       described_class.new(MockClass, {}).destroy({id: 1})
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: multiple_man
 version: !ruby/object:Gem::Version
-  version: 0.5.21
+  version: 0.6.0
 platform: ruby
 authors:
 - Ryan Brunner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-18 00:00:00.000000000 Z
+date: 2015-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -171,6 +171,7 @@ files:
 - lib/multiple_man/identity.rb
 - lib/multiple_man/listeners/listener.rb
 - lib/multiple_man/listeners/seeder_listener.rb
+- lib/multiple_man/mixins/listener.rb
 - lib/multiple_man/mixins/publisher.rb
 - lib/multiple_man/mixins/subscriber.rb
 - lib/multiple_man/model_populator.rb