bustle 0.1.0 → 0.1.1

data/README.md

@@ -12,9 +12,11 @@ The advantages of Bustle are:
 - It is lightweight and simple to use
 - It is largely self-contained and separated from you core app logic
 - It works nicely with ActiveRecord out of box
-- It can be extended to use with other databases
+- It is ORM-agnostic therefore can be extended to use with other databases
 - It has full unit test coverage
 
+Bustle is built for simplicity and extensibility. If you are after high performance pub/sub then this gem is not for you.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -45,7 +47,8 @@ class CreateBustleTables < ActiveRecord::Migration
     create_table :bustle_activities do |t|
       t.string  :resource_class
       t.integer :resource_id
-      t.string  :action
+      t.string  :action,       :default => ''
+      t.text    :data,         :default => ''
       t.integer :publisher_id, :null => false
       t.timestamps
     end
@@ -153,16 +156,28 @@ Bustle::Subscriptions.get(bustle_publisher, bustle_subscriber).destroy
 #### Publish an Activity
 
 ```ruby
-Bustle::Activities.add bustle_publisher, action, activity
+Bustle::Activities.add bustle_publisher, {
+  :resource => some_resource,
+  :action   => some_string,
+  :data     => some_text
+}
 # or
-Bustle::Publisher.publish action, activity
+Bustle::Publisher.publish({
+  :resource => some_resource,
+  :action   => some_string,
+  :data     => some_text
+})
 
 # example
 post    = Post.find(1)
 comment = post.comments.add(:content => "I'm a comment")
 Bustle::Publishers.add post
 publisher = Bustle::Publishers.get post
-publisher.publish 'new', comment
+publisher.publish({
+  :resource => comment,
+  :action   => 'new,
+  :data     => 'a new comment has been posted'
+})
 ```
 
 #### Activities

data/lib/bustle/activities.rb

@@ -6,11 +6,17 @@ module Bustle
     include Concern::ByPublisher
 
     class << self
-      def add(publisher, action, activity_resource)
+      def add(publisher, data = {})
+        if resource = data.delete(:resource)
+          data[:resource_class] = resource.class.name
+          data[:resource_id]    = resource.id
+        end
+
         Activity.to_adapter.create!(
-          :resource_class => activity_resource.class.name,
-          :resource_id    => activity_resource.id,
-          :action         => action,
+          :resource_class => data[:resource_class],
+          :resource_id    => data[:resource_id],
+          :action         => data[:action],
+          :data           => data[:data],
           :publisher_id   => publisher.id
         )
       end

data/lib/bustle/models/publisher.rb

@@ -1,7 +1,7 @@
 module Bustle
   class Publisher < "#{Bustle.storage}::Publisher".constantize
-    def publish(action, activity_resource)
-      Activities.add self, action, activity_resource
+    def publish(data = {})
+      Activities.add(self, data)
     end
 
     def activities(conditions = {})

data/lib/bustle/version.rb

@@ -1,3 +1,3 @@
 module Bustle
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/specs/bustle/activities_spec.rb

@@ -10,20 +10,25 @@ module Bustle
     let(:subscriber2) { Subscribers.add user }
 
     it "creates an activity" do
-      Activities.add publisher, 'show', comment
+      Activities.add publisher, {
+        :action   => 'show',
+        :resource => comment,
+        :data     => 'hello world'
+      }
 
       activity = Activity.to_adapter.get(1)
       activity.resource_class.should  == 'Bustle::Dummy::Comment'
       activity.resource_id.should == 101
       activity.action.should == 'show'
+      activity.data.should == 'hello world'
       activity.publisher_id.should == publisher.id
     end
 
     context "multiple activities" do
       before do
-        2.times { Activities.add publisher, 'show', comment }
-        1.times { Activities.add publisher, 'reply', comment }
-        2.times { Activities.add publisher2, 'reply', comment }
+        2.times { Activities.add publisher, { :action => 'show' } }
+        1.times { Activities.add publisher, { :action => 'reply' } }
+        2.times { Activities.add publisher2, { :action => 'reply' } }
       end
 
       it "finds all activities" do

data/specs/bustle/models/publisher_spec.rb

@@ -10,7 +10,10 @@ module Bustle
 
     it "is able to publish an activity" do
       publisher = Publishers.add post
-      publisher.publish 'reply', comment
+      publisher.publish({
+        :resource => comment,
+        :action   => 'reply'
+      })
       Activity.to_adapter.get(1).action.should == 'reply'
     end
   end

data/specs/support/active_record_tables.rb

@@ -19,7 +19,8 @@ ActiveRecord::Migration.suppress_messages do
     create_table :bustle_activities, :force => true do |t|
       t.string  :resource_class
       t.integer :resource_id
-      t.string  :action
+      t.string  :action, :default => ''
+      t.text    :data,   :default => ''
       t.integer :publisher_id
       t.timestamps
     end

data/specs/support/shared_examples/has_activities.rb

@@ -8,7 +8,7 @@ shared_examples 'has_activities' do
     end
 
     it "has activities" do
-      2.times { publisher.publish 'show', comment }
+      2.times { publisher.publish }
 
       publisher.activities.count.should == 2
       subscriber.activities.count.should == 2

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bustle
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -234,7 +234,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1631565603439208655
+      hash: -534014299533993721
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -243,7 +243,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1631565603439208655
+      hash: -534014299533993721
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24