active_pubsub 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec487cd15cef4ce67b58a62ea1b9dc71202d0e40
-  data.tar.gz: 641188b0b8799312a4ae42d2318ca5eb4ca36005
+  metadata.gz: f6d67467176a0be6bf12783385e9ccb215a61b9d
+  data.tar.gz: dbef4a7b649425c4d1326f982970366f1ec297ec
 SHA512:
-  metadata.gz: eb26c9710230741ebb90fc04a2ee271492186d52d381eef9ea99e8beb28cdbc0b3ef51ccc796e94ea64911065ee9c549a1532af4aa41754c4fa05c56b6ecb621
-  data.tar.gz: aa4cbb39249701500481b0df49177ce08dfb264a7c49f290888c1c427642705a1ab49a526e3a8f446e8cbb51a905754f9ad00a1aa785152aa8e23815f46193f2
+  metadata.gz: 0217c66e7d33a9acbb750c1c66617819431baf28033a5c2b373449172172ad2ceb88fe91b198a939b951e25454e9cf928079cf1b7f6d4dfc6351dcaeb966b658
+  data.tar.gz: d64f92f24b55f9cb09336b96b00fc98d681ac54b7c859b6a945b2632df33fc1bb3499c581b01d03533b334d709df3d656c083c9cfaa46eee62751a2065876d6d

data/README.md

@@ -1,8 +1,104 @@
 # ActivePubsub
 
-TODO: Write a gem description
+Service oriented observers for active record, via RabbitMQ and Bunny gem. Publish/Observe changes made to ActiveRecord models asynchronously, from different applications/services.
 
-## Installation
+Best examples can be found here:
+https://github.com/jasonayre/active_pubsub_examples
+
+## Publisher Example
+``` ruby
+class Post < ::ActiveRecord::Base
+  include ::ActivePubsub::Publishable
+
+  # This is the namespace for the local service
+  # The following Will set up a cms.post rabbit exchange
+  publish_as "cms"
+end
+```
+
+## Subscriber example
+``` ruby
+# this is an example of a service that wants to do something when posts are created,
+# updated, or destroyed, in the publishing service
+
+class PostSubscriber < ::ActivePubsub::Subscriber
+  observes "cms"
+  as "aggregator"
+
+  on :created do |record|
+    puts record.inspect
+  end
+
+  on :destroyed do |record|
+    puts record.inspect
+  end
+
+  on :updated do |record|
+    puts record.inspect
+  end
+end
+```
+
+## Publishing events
+
+Just include ::ActivePubsub::Publishable module into an active record class whose events you want to publish.
+
+``` ruby
+class Post < ::ActiveRecord::Base
+  include ::ActivePubsub::Publishable
+end
+```
+
+Also, you need to declare a namespace to publish under, either in the main configuration or in the model
+
+``` ruby
+class Post < ::ActiveRecord::Base
+  include ::ActivePubsub::Publishable
+  publish_as "cms"
+end
+```
+
+Or in initializer
+
+``` ruby
+::ActivePubsub.configure do |config|
+  config.publish_as = "cms"
+end
+```
+
+**IMPORTANT:** If you don't do one of the above the publisher will not be started.
+
+The publisher simply runs in a new thread alongside your main application, connects to rabbit, and publishes the events.
+
+## Subscribing to Events
+
+Subscriber runs in a separate process from your application itself. You can start the subscriber with:
+
+## Starting the subscriber
+
+```
+bundle exec subscriber start
+```
+
+## Benchmarks/Performance
+
+No full benchmarks, but here are the results Ive seen so far via rabbit. MacbookPro, 2.6 i7 w 16gb ram. Running one publisher app and one subscriber, via examples at https://github.com/jasonayre/active_pubsub_examples
+
+### Celluloid version > 0.16
+
+I removed the gem lock to be compatibile with the most recent version of sidekiq which uses celluloid (0.15.2) or something, however I noticed a significant speed boost with > 0.16 version of celluloid.
+
+Range of published messages/second: 250-500
+Range processed (subscriber) messages/second: 250-500
+
+### Celluloid version 15.2
+
+Average published messages/second: 100-150
+Average processed (subscriber) messages/second: 100-150
+
+The throughput seems to be limited by the publisher mostly, from the very limited benchmarks thus far.
+
+### Installation
 
 Add this line to your application's Gemfile:
 
@@ -16,9 +112,7 @@ Or install it yourself as:
 
     $ gem install active_pubsub
 
-## Usage
 
-TODO: Write usage instructions here
 
 ## Contributing
 

data/active_pubsub.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "active_attr"
-  spec.add_dependency "celluloid-io"
+  spec.add_dependency "celluloid", "~> 0.15.2"
   spec.add_dependency "json"
   spec.add_dependency "bunny"
 

data/bin/subscriber

@@ -5,18 +5,22 @@ require 'active_pubsub'
 require './config/environment.rb'
 
 class Subscriber < ::Thor
-  desc "start", "Start Rabbit Subscriber"
+  desc "start", "Start ActivePubsub Subscriber"
   def start
-    puts "Starting Rabbit Subscriber SERVER"
+    puts "Starting ActivePubsub Subscriber"
 
     ::ActivePubsub.load_subscribers
 
     ::ActivePubsub.start_subscribers
-    
+
     puts "Subscribers Started"
   end
 end
 
+#todo: write event loop that handles shutdown gracefully
+#however, it seems that Bunny knows when to wake subscribers up
+#so sleeping seems to be enough for now
+
 ::Subscriber.start
 
 sleep

data/lib/active_pubsub.rb

@@ -56,5 +56,4 @@ require "active_pubsub/event"
 require "active_pubsub/publisher"
 require "active_pubsub/publishable"
 require "active_pubsub/subscriber"
-
 require 'active_pubsub/railtie' if defined?(Rails)

data/lib/active_pubsub/publisher.rb

@@ -1,5 +1,3 @@
-'celluloid/io'
-
 module ActivePubsub
   class Publisher
     include ::Celluloid
@@ -54,8 +52,6 @@ module ActivePubsub
 
     def publish_event(event)
       ::ActiveRecord::Base.connection_pool.with_connection do
-        puts event.inspect
-
         exchanges[event.exchange].publish(serialize_event(event), :routing_key => event.routing_key)
       end
     end

data/lib/active_pubsub/railtie.rb

@@ -4,14 +4,13 @@ module ActivePubsub
   class Railtie < ::Rails::Railtie
     # we only need publisher started if service has a publishable model
     ::ActiveSupport.on_load(:active_record) do
-      puts "Active Record LOADED"
-
       if(::ActivePubsub::Publisher.publishable_model_count > 0) && !::ActivePubsub::Publisher.started?
+        puts "Starting Publisher"
         ::ActivePubsub::Publisher.start
       end
     end
 
-    #todo: make redis configurable
+    #todo: make this do something or remove it
     def self.load_config_yml
       config_file = ::YAML.load_file(config_yml_filepath)
       return unless config_file.is_a?(Hash)

data/lib/active_pubsub/subscriber.rb

@@ -34,20 +34,21 @@ module ActivePubsub
         channel.queue(queue_for_event(event_name.to_s))
                .bind(exchange, :routing_key => routing_key_for_event(event_name))
                .subscribe do |delivery_info, properties, payload|
-          event = deserialize_event(payload)
-          resource = deserialize_record(event[:record])
+          deserialized_event = deserialize_event(payload)
+          deserialized_record = deserialize_record(deserialized_event[:record])
 
-          block.call(resource)
+          subscriber_instance = new(deserialized_record)
+          subscriber_instance.instance_exec(deserialized_record, &block)
         end
       end
     end
 
     def self.deserialize_event(event)
-      @current_event = Marshal.load(event)
+      @current_event = ::Marshal.load(event)
     end
 
     def self.deserialize_record(record)
-      @current_record = Marshal.load(record)
+      @current_record = ::Marshal.load(record)
     end
 
     def self.observes(target_exchange)
@@ -72,5 +73,13 @@ module ActivePubsub
 
       puts message
     end
+
+    ### Instance Methods ###
+    attr_accessor :record
+
+    def initialize(record)
+      @record = record
+    end
+
   end
 end

data/lib/active_pubsub/version.rb

@@ -1,3 +1,3 @@
 module ActivePubsub
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_pubsub
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Jason Ayre
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-12 00:00:00.000000000 Z
+date: 2014-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_attr
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: celluloid-io
+  name: celluloid
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.15.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.15.2
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement