multiple_man 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27a4153d5c70fd0caf82e6a884969c3641ffc3a4
-  data.tar.gz: ea850e1b573bbd9f1a92123b728e7b5a00b1682e
+  metadata.gz: 9ca5356191de47f8a4e08e52e9a568eeebdf9048
+  data.tar.gz: 79a7e0d2c6079170cc2a81541980c603f595a366
 SHA512:
-  metadata.gz: a0644fa501b3480a09cab9ff7868286ba7199b20187e1c04cc0c9ca1fbd06e2632f842f32d42a275b1c1c43b111d0ba99832b3a44efd2d4ab9dce0351a532fd0
-  data.tar.gz: bebf010a39b98ff1461cd26c357e189e74959efe07a31ad2a8fc310772f33af011979bd97e75aa96d905c7de0a94a4de480c6d777b4969e8ccc05d0076b88bb5
+  metadata.gz: 4064bbb0ab486a17f5315302a5edbbc79e191724bc65ad74298f4b7a1edbcaac992f5f7862979eaebf8f7a5b711e3b1da5173fc6ddcd285bcf4e5cdf86bc62e1
+  data.tar.gz: 56fcab0f9ab729ff37240d419bb030aad4e8275a3626cdee62e494d506b542bb6c9276bbb014077c4a712789f0ec35d8006d4f1fc24f04ffc3bfeb8f740cf432

data/README.md

@@ -1,6 +1,19 @@
 # MultipleMan
 
-TODO: Write a gem description
+[![Code Climate](https://codeclimate.com/github/influitive/multiple_man.png)](https://codeclimate.com/github/influitive/multiple_man)
+
+[![CircleCI](https://circleci.com/gh/influitive/multiple_man.png)](https://circleci.com/gh/influitive/multiple_man)
+
+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 
+  ActiveRecord for your models. This simplifies how models
+  are sychronized, which offers a few benefits like:
+- Transactions are fully supported in MultipleMan. Records
+  which aren't committed fully to the database won't be sent
+  to your message queue.
 
 ## Installation
 
@@ -18,7 +31,65 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Configuration
+
+MultipleMan can be configured (ideally inside an initializer) by
+calling MultipleMan.configure like so:
+
+    MultipleMan.configure do |config|
+      # A connection string to your local server. Defaults to localhost.
+      config.connection = "amqp://example.com" 
+
+      # 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"
+
+      # The application name (used for subscribers) - defaults to your
+      # Rails application name if you're using rails
+      config.app_name = "MyApp"
+
+      # Where you want to log errors to. Should be an instance of Logger
+      # Defaults to the Rails logger (for Rails) or STDOUT otherwise.
+      config.logger = Logger.new(STDOUT)
+    end
+
+### Publishing models
+
+To publish a model, include the following in your model definition:
+
+    class Widget < ActiveRecord::Base
+      include MultipleMan::Publisher
+      publish fields: [:id, :name, :type], identifier: :code
+    end
+
+You can use the following options when publishing:
+
+- `fields` - An array of all the fields you want to send to the message queue. These
+  can be either ActiveRecord attributes or methods on your model.
+- `identifier` - Either a symbol or a proc used by MultipleMan to identify your model.
+  `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.
+
+### Subscribing to models
+
+You can subscribe to a model as follows (in a seperate consumer app):
+
+    class Widget < ActiveRecord::Base
+      include MultipleMan::Subscriber
+    end
+
+Currently, there's a few assumptions made of subscriber models:
+
+- They need to have all of the fields that are published.
+- They need an additional field, called `multiple_man_identifier`, that is the
+  same type as what's passed from the publisher side (just an integer if you're using
+  id)
+
+Once you've set up your subscribers, you'll need to run a background worker to manage
+the subscription process. Just run the following:
+
+    rake multiple_man:worker
 
 ## Contributing
 
@@ -27,3 +98,27 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2014 Influitive Corporation
+
+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/lib/multiple_man/attribute_extractor.rb

@@ -8,7 +8,7 @@ module MultipleMan
       
       self.record = record
       self.fields = fields 
-      self.identifier = identifier
+      self.identifier = identifier || :id
     end
 
     def data
@@ -21,13 +21,10 @@ module MultipleMan
     end
 
     def identifier_for_record
-      puts identifier.class
-      if identifier.class == Symbol
-        record.send(identifier)
-      elsif identifier.class == Proc
+      if identifier.class == Proc
         identifier.call(record)
       else
-        record.id
+        record.send(identifier)
       end
     end
 

data/lib/multiple_man/configuration.rb

@@ -5,13 +5,18 @@ module MultipleMan
       self.topic_name = "multiple_man"
       self.app_name = Rails.application.class.parent.to_s if defined?(Rails)
       self.enabled = true
+      self.channel_pool_size = 5
     end
 
     def logger
       @logger ||= defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
     end
 
-    attr_accessor :topic_name, :app_name, :connection, :enabled
+    def on_error(&block)
+      @error_handler = block
+    end
+
+    attr_accessor :topic_name, :app_name, :connection, :enabled, :channel_pool_size, :error_handler
     attr_writer :logger
   end
 

data/lib/multiple_man/connection.rb

@@ -1,4 +1,5 @@
 require 'bunny'
+require 'connection_pool'
 
 module MultipleMan
   class Connection
@@ -11,13 +12,14 @@ module MultipleMan
       end
     end
 
-    def self.open_channel
-      Thread.current[:multiple_man_channel] ||= connection.create_channel
+    def self.channel_pool
+      @channel_pool ||= ConnectionPool.new(size: 25, timeout: 5) { connection.create_channel }
     end
 
     def self.connect
-      channel = open_channel
-      yield new(channel) if block_given?
+      channel_pool.with do |channel|
+        yield new(channel) if block_given?
+      end
     end
 
     def initialize(channel)

data/lib/multiple_man/listener.rb

@@ -36,6 +36,7 @@ module MultipleMan
         subscription.send(operation, JSON.parse(payload).with_indifferent_access)
       rescue Exception => ex
         MultipleMan.logger.error "   Error - #{ex.message}"
+        MultipleMan.error(ex)
       else
         MultipleMan.logger.info "   Successfully processed!"
       end

data/lib/multiple_man/model_publisher.rb

@@ -21,9 +21,15 @@ module MultipleMan
 
     def push_record(connection, record)
       data = record_data(record)
-      routing_key = RoutingKey.new(record, operation).to_s
+      routing_key = RoutingKey.new(record_type(record), operation).to_s
       MultipleMan.logger.info("  Record Data: #{data} | Routing Key: #{routing_key}")
       connection.topic.publish(data, routing_key: routing_key)
+    rescue Exception => ex
+      MultipleMan.error(ex)
+    end
+
+    def record_type(record)
+      options[:as] || record.class.name
     end
 
     def record_data(record)

data/lib/multiple_man/routing_key.rb

@@ -8,21 +8,17 @@ module MultipleMan
     end
 
     def to_s
-      "#{topic_name}.#{klass.name}.#{operation}"
+      "#{topic_name}.#{klass}.#{operation}"
     end
 
     attr_reader :operation
-    attr_reader :klass
+    attr_accessor :klass
 
     def operation=(value)
       raise "Operation #{value} is not recognized" unless ALLOWED_OPERATIONS.include?(value)
       @operation = value
     end
 
-    def klass=(value)
-      @klass = (value.is_a?(Class) ? value : value.class)
-    end
-
   private
     def topic_name
       MultipleMan.configuration.topic_name

data/lib/multiple_man/version.rb

@@ -1,3 +1,3 @@
 module MultipleMan
-  VERSION = "0.2.6"
+  VERSION = "0.2.7"
 end

data/lib/multiple_man.rb

@@ -14,14 +14,22 @@ module MultipleMan
   require 'multiple_man/listener'
 
   def self.logger
-    MultipleMan.configuration.logger
+    configuration.logger
   end
 
   def self.disable!
-    MultipleMan.configuration.enabled = false
+    configuration.enabled = false
   end
 
   def self.enable!
-    MultipleMan.configuration.enabled = true
+    configuration.enabled = true
+  end
+
+  def self.error(ex)
+    if configuration.error_handler
+      configuration.error_handler.call(ex)
+    else
+      raise ex
+    end
   end
 end

data/multiple_man.gemspec

@@ -19,8 +19,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
-  spec.add_runtime_dependency     "bunny"
-  spec.add_runtime_dependency     "activesupport"
+  spec.add_development_dependency "rake", '~> 10.1.0'
+  spec.add_development_dependency "rspec", '~> 2.14.1'
+  spec.add_runtime_dependency     "bunny", '>= 1.0'
+  spec.add_runtime_dependency     "activesupport", '>= 3.0'
+  spec.add_runtime_dependency     "connection_pool", ">= 1.2"
 end

data/spec/connection_spec.rb

@@ -9,7 +9,7 @@ describe MultipleMan::Connection do
     it "should open a connection and a channel" do
       mock_bunny.should_receive(:start)
       Bunny.should_receive(:new).and_return(mock_bunny)
-      mock_bunny.should_receive(:create_channel).and_return(mock_channel)
+      mock_bunny.should_receive(:create_channel).exactly(25).times
 
       described_class.connect
     end

data/spec/model_publisher_spec.rb

@@ -1,15 +1,14 @@
 require 'spec_helper'
 
 describe MultipleMan::ModelPublisher do 
-  let(:channel_stub) { double(Bunny::Channel, topic: topic_stub, close: nil)}
+  let(:channel_stub) { double(Bunny::Channel, topic: topic_stub)}
   let(:topic_stub) { double(Bunny::Exchange, publish: nil) }
 
   before {
+    MultipleMan::Connection.stub(:connect).and_yield(channel_stub)
     MultipleMan.configure do |config|
       config.topic_name = "app"
     end
-
-    MultipleMan::Connection.stub(:open_channel).and_return(channel_stub)
   }
 
   class MockObject
@@ -29,15 +28,18 @@ describe MultipleMan::ModelPublisher do
   subject { described_class.new(:create, fields: [:foo]) }
 
   describe "after_commit" do
-    it "should queue the update in the correct topic" do
-      channel_stub.should_receive(:topic).with("app")
-      described_class.new(:create, fields: [:foo]).after_commit(MockObject.new)
-    end
     it "should send the jsonified version of the model to the correct routing key" do
       MultipleMan::AttributeExtractor.any_instance.should_receive(:to_json).and_return('{"id":10,"data":{"foo": "bar"}}')
       topic_stub.should_receive(:publish).with('{"id":10,"data":{"foo": "bar"}}', routing_key: "app.MockObject.create")
       described_class.new(:create, fields: [:foo]).after_commit(MockObject.new)
     end
+
+    it "should call the error handler on error" do
+      ex = Exception.new("Bad stuff happened")
+      topic_stub.stub(:publish) { raise ex }
+      MultipleMan.should_receive(:error).with(ex)
+      described_class.new(:create, fields: [:foo]).after_commit(MockObject.new)
+    end
   end
 
 end

data/spec/routing_key_spec.rb

@@ -11,7 +11,7 @@ describe MultipleMan::RoutingKey do
   end
 
   describe "to_s" do
-    subject { described_class.new(MockObject.new, operation).to_s }
+    subject { described_class.new("MockObject", operation).to_s }
 
     context "creating" do
       let(:operation) { :create }
@@ -29,7 +29,7 @@ describe MultipleMan::RoutingKey do
     end
 
     context "not specified" do
-      subject { described_class.new(MockObject.new).to_s }
+      subject { described_class.new("MockObject").to_s }
       it { should == "app.MockObject.#" }
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: multiple_man
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - Ryan Brunner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-03 00:00:00.000000000 Z
+date: 2014-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,58 +28,72 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.1.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.14.1
 - !ruby/object:Gem::Dependency
   name: bunny
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.2'
 description: MultipleMan syncs changes to ActiveRecord models via AMQP
 email:
 - ryan@influitive.com