streama 0.2.0 → 0.3.0

data/README.rdoc

@@ -2,6 +2,8 @@
 
 Streama is a simple Ruby activity stream gem for use with the Mongoid ODM framework.
 
+**UPDATE: Streama now conforms to the activitystrea.ms specification. Version 0.3.0 breaks compatibility with previous versions.**
+
 == Install
 
   $ gem install streama
@@ -12,16 +14,28 @@ Streama is a simple Ruby activity stream gem for use with the Mongoid ODM framew
 
 Create an Activity model and define the activities and the fields you would like to cache within the activity.
 
-class Activity
-  include Streama::Activity
+An activity consists of an actor, a verb, an object, and a target. 
+
+  class Activity
+    include Streama::Activity
   
-  activity :enquiry do
-    actor :user, :cache => [:full_name]
-    target :enquiry, :cache => [:subject]
-    referrer :listing, :cache => [:title]
-  end
+    activity :new_enquiry do
+      actor :user, :cache => [:full_name]
+      object :enquiry, :cache => [:subject, :comment]
+      target :listing, :cache => [:title]
+    end
   
-end
+  end
+
+The activity verb is implied from the activity name, in the above example the verb is :new_enquiry
+
+The object may be the entity performing the activity, or the entity on which the activity was performed.
+e.g John(actor) shared a video(object)
+
+The target is the object that the verb is enacted on.
+e.g. Geraldine(actor) posted a photo(object) to her album(target)
+
+This is based on the Activity Streams 1.0 specification (http://activitystrea.ms)
 
 === Setup Actors
 
@@ -31,8 +45,10 @@ Include the Actor module in a class and override the default followers method.
     include Mongoid::Document
     include Streama::Actor
 
+		field :full_name, :type => String
+
     def followers
-      ...
+    	User.excludes(:id => self.id).all
     end
   end
 
@@ -46,14 +62,14 @@ Create the indexes for the Activities collection. You can do so by calling the c
 
 In your controller or background worker:
 
-  current_user.publish_activity(:enquiry, :target => @enquiry, :referrer => @listing)
+  current_user.publish_activity(:new_enquiry, :object => @enquiry, :target => @listing)
   
-This will publish the activity to the objects returned by the "followers" method in the Actor.
+This will publish the activity to the mongoid objects returned by the #followers method in the Actor.
 
 To send your activity to different receievers, pass in an additional :receivers parameter.
 
-  current_user.publish_activity(:enquiry, :target => @enquiry, :referrer => @listing, :receivers => :friends) # calls friends method
-  current_user.publish_activity(:enquiry, :target => @enquiry, :referrer => @listing, :receivers => current_user.find(:all, :conditions => {:group_id => mygroup}))
+  current_user.publish_activity(:new_enquiry, :object => @enquiry, :target => @listing, :receivers => :friends) # calls friends method
+  current_user.publish_activity(:new_enquiry, :object => @enquiry, :target => @listing, :receivers => current_user.find(:all, :conditions => {:group_id => mygroup}))
 
 == Retrieving Activity
 
@@ -63,9 +79,9 @@ To retrieve all activity for an actor
   
 To retrieve and filter to a particular activity type
 
-  current_user.activity_stream(:type => :activity_type)
+  current_user.activity_stream(:type => :activity_verb)
 
-If you need to return the instance of an :actor, :target or :referrer from an activity call the Activity#load_instance method
+If you need to return the instance of an :actor, :object or :target from an activity call the Activity#load_instance method
 
   activity.load_instance(:actor)
   
@@ -75,7 +91,7 @@ You can also refresh the cached activity data by calling the Activity#refresh_da
   
 == Compatibility
 
-Streama is developed against Ruby 1.9.2 and Mongoid 2.0.0.rc7
+Streama is developed against Ruby 1.9.2 and Mongoid 2
 
 == TODO
 

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/lib/streama/activity.rb

@@ -7,19 +7,19 @@ module Streama
       include Mongoid::Document
       include Mongoid::Timestamps
     
-      field :name,        :type => Symbol
+      field :verb,        :type => Symbol
       field :actor,       :type => Hash
+      field :object,      :type => Hash
       field :target,      :type => Hash
-      field :referrer,    :type => Hash
       field :receivers,   :type => Array
           
       index :name
       index [['actor._id', Mongo::ASCENDING], ['actor._type', Mongo::ASCENDING]]
+      index [['object._id', Mongo::ASCENDING], ['object._type', Mongo::ASCENDING]]
       index [['target._id', Mongo::ASCENDING], ['target._type', Mongo::ASCENDING]]
-      index [['referrer._id', Mongo::ASCENDING], ['referrer._type', Mongo::ASCENDING]]
       index [['receivers.id', Mongo::ASCENDING], ['receivers.type', Mongo::ASCENDING]]
           
-      validates_presence_of :actor, :name
+      validates_presence_of :actor, :verb
       before_save :assign_data
       
     end
@@ -33,8 +33,8 @@ module Streama
       # @example Define a new activity
       #   activity(:enquiry) do
       #     actor :user, :cache => [:full_name]
-      #     target :enquiry, :cache => [:subject]
-      #     referrer :listing, :cache => [:title]
+      #     object :enquiry, :cache => [:subject]
+      #     target :listing, :cache => [:title]
       #   end
       #
       # @return [Definition] Returns the registered definition
@@ -46,18 +46,18 @@ module Streama
 
       # Publishes an activity using an activity name and data
       #
-      # @param [ String ] name The name of the activity
+      # @param [ String ] verb The verb of the activity
       # @param [ Hash ] data The data to initialize the activity with.
       #
       # @return [Streama::Activity] An Activity instance with data
-      def publish(name, data)
+      def publish(verb, data)
         receivers = data.delete(:receivers)
-        new({:name => name}.merge(data)).publish(:receivers => receivers)
+        new({:verb => verb}.merge(data)).publish(:receivers => receivers)
       end
       
       def stream_for(actor, options={})
         query = {:receivers => {'$elemMatch' => {:id => actor.id, :type => actor.class.to_s}}}
-        query.merge!({:name => options[:type]}) if options[:type]
+        query.merge!({:verb => options[:type]}) if options[:type]
         self.where(query).without(:receivers).desc(:created_at)
       end
       
@@ -77,11 +77,11 @@ module Streama
         self
       end
       
-      # Returns an instance of an actor, target or referrer
+      # Returns an instance of an actor, object or target
       #
-      # @param [ Symbol ] type The data type (actor, target, referrer) to return an instance for.
+      # @param [ Symbol ] type The data type (actor, object, target) to return an instance for.
       #
-      # @return [Object] object An object instance
+      # @return [Mongoid::Document] document A mongoid document instance
       def load_instance(type)
         (data = self.send(type)).is_a?(Hash) ? data['type'].to_s.camelcase.constantize.find(data['id']) : data
       end
@@ -95,7 +95,7 @@ module Streama
         
       def assign_data
       
-        [:actor, :target, :referrer].each do |type|
+        [:actor, :object, :target].each do |type|
           next unless object = load_instance(type)
 
           class_sym = object.class.name.underscore.to_sym
@@ -115,7 +115,7 @@ module Streama
       end
     
       def definition
-        @definition ||= Streama::Definition.find(name)
+        @definition ||= Streama::Definition.find(verb)
       end
       
     end

data/lib/streama/actor.rb

@@ -21,8 +21,8 @@ module Streama
       #
       # @param [ Hash ] options The options to publish with.
       #
-      # @example publish an activity with a target and referrer
-      #   current_user.publish_activity(:enquiry, :target => @enquiry, :referrer => @listing)
+      # @example publish an activity with a object and target
+      #   current_user.publish_activity(:enquiry, :object => @enquiry, :target => @listing)
       #
       def publish_activity(name, options={})
         options[:receivers] = self.send(options[:receivers]) if options[:receivers].is_a?(Symbol)
@@ -34,7 +34,7 @@ module Streama
       end
     
       def followers
-        self.class.all
+        raise Streama::NoFollowersDefined
       end
       
       def activity_class

data/lib/streama/definition.rb

@@ -2,14 +2,14 @@ module Streama
   
   class Definition
     
-    attr_reader :name, :actor, :target, :referrer, :receivers
+    attr_reader :name, :actor, :object, :target, :receivers
     
     # @param dsl [Streama::DefinitionDSL] A DSL object
     def initialize(definition)
       @name = definition[:name]
       @actor = definition[:actor] || {}
+      @object = definition[:object] || {}
       @target = definition[:target] || {}
-      @referrer = definition[:referrer] || {}
     end
     
     #

data/lib/streama/definition_dsl.rb

@@ -8,8 +8,8 @@ module Streama
       @attributes = {
         :name => name.to_sym,
         :actor => {}, 
-        :target => {}, 
-        :referrer => {}
+        :object => {}, 
+        :target => {}
       }
     end
     
@@ -22,7 +22,7 @@ module Streama
         end
       end
     end
-    data_methods :actor, :target, :referrer
+    data_methods :actor, :object, :target
 
   end
   

data/lib/streama/errors.rb

@@ -7,7 +7,7 @@ module Streama
   end
   
   # This error is raised when an object isn't defined
-  # as an actor, target or referrer
+  # as an actor, object or target
   #
   # Example:
   #
@@ -38,4 +38,7 @@ module Streama
   class ActivityNotSaved < StreamaError
   end
   
+  class NoFollowersDefined < StreamaError
+  end
+  
 end

data/spec/lib/activity_spec.rb

@@ -10,9 +10,9 @@ describe "Activity" do
     it "registers and return a valid definition" do
       @definition = Activity.activity(:new_enquiry) do
         actor :user, :cache => [:full_name]
-        target :enquiry, :cache => [:comment]
-        target :listing, :cache => [:title, :full_address]
-        referrer :listing, :cache => [:title]
+        object :enquiry, :cache => [:comment]
+        object :listing, :cache => [:title, :full_address]
+        target :listing, :cache => [:title]
       end
       
       @definition.is_a?(Streama::Definition).should be true
@@ -20,23 +20,19 @@ describe "Activity" do
   end
   
   describe '#publish' do
-
-    before :each do
-      @actor = user
-      @activity = Activity.publish(:new_enquiry, {:actor => @actor, :target => enquiry, :referrer => listing})
-    end
     
     it "overrides the recievers if option passed" do
       send_to = []
       2.times { |n| send_to << User.create(:full_name => "Custom Receiver #{n}") }
       5.times { |n| User.create(:full_name => "Receiver #{n}") }
-
-      # @activity.receivers << send_to
-      # @activity.receivers.size.should == 2
+      @activity = Activity.publish(:new_enquiry, {:actor => user, :object => enquiry, :target => listing, :receivers => send_to})
+      @activity.receivers.size.should == 2
     end
     
     context "when republishing"
       before :each do
+        @actor = user
+        @activity = Activity.publish(:new_enquiry, {:actor => @actor, :object => enquiry, :target => listing})
         @activity.publish
       end
       
@@ -45,14 +41,12 @@ describe "Activity" do
         @actor.save
         @activity.publish
         @activity.actor['full_name'].should eq "testing"
-
       end
   end
   
-  
   describe '.publish' do
     it "creates a new activity" do
-      activity = Activity.publish(:new_enquiry, {:actor => user, :target => enquiry, :referrer => listing})
+      activity = Activity.publish(:new_enquiry, {:actor => user, :object => enquiry, :target => listing})
       activity.should be_an_instance_of Activity
     end
   end
@@ -61,7 +55,7 @@ describe "Activity" do
     
     before :each do
       @user = user
-      @activity = Activity.publish(:new_enquiry, {:actor => @user, :target => enquiry, :referrer => listing})
+      @activity = Activity.publish(:new_enquiry, {:actor => @user, :object => enquiry, :target => listing})
     end
     
     it "reloads instances and updates activities stored data" do
@@ -79,7 +73,7 @@ describe "Activity" do
   describe '#load_instance' do
     
     before :each do
-      @activity = Activity.publish(:new_enquiry, {:actor => user, :target => enquiry, :referrer => listing})
+      @activity = Activity.publish(:new_enquiry, {:actor => user, :object => enquiry, :target => listing})
       @activity = Activity.last
     end
     
@@ -87,12 +81,12 @@ describe "Activity" do
       @activity.load_instance(:actor).should be_instance_of User
     end
     
-    it "loads a target instance" do
-      @activity.load_instance(:target).should be_instance_of Enquiry
+    it "loads an object instance" do
+      @activity.load_instance(:object).should be_instance_of Enquiry
     end
     
-    it "loads a referrer instance" do
-      @activity.load_instance(:referrer).should be_instance_of Listing
+    it "loads a target instance" do
+      @activity.load_instance(:target).should be_instance_of Listing
     end
     
   end

data/spec/lib/actor_spec.rb

@@ -9,8 +9,8 @@ describe "Actor" do
   before :all do
     Activity.activity :new_comment do
       actor :user, :cache => [:full_name]
+      object :listing, :cache => [:title]
       target :listing, :cache => [:title]
-      referrer :listing, :cache => [:title]
     end
   end
   
@@ -21,12 +21,12 @@ describe "Actor" do
     end
     
     it "pushes activity to receivers" do
-      activity = user.publish_activity(:new_enquiry, :target => enquiry, :referrer => listing)
+      activity = user.publish_activity(:new_enquiry, :object => enquiry, :target => listing)
       activity.receivers.size == 6
     end
     
     it "pushes to a defined stream" do
-      activity = user.publish_activity(:new_enquiry, :target => enquiry, :referrer => listing, :receivers => :friends)
+      activity = user.publish_activity(:new_enquiry, :object => enquiry, :target => listing, :receivers => :friends)
       activity.receivers.size == 6
     end
     
@@ -36,8 +36,8 @@ describe "Actor" do
     
     before :each do
       5.times { |n| User.create(:full_name => "Receiver #{n}") }
-      user.publish_activity(:new_enquiry, :target => enquiry, :referrer => listing)
-      user.publish_activity(:new_comment, :target => listing)
+      user.publish_activity(:new_enquiry, :object => enquiry, :target => listing)
+      user.publish_activity(:new_comment, :object => listing)
     end
     
     it "retrieves the stream for an actor" do

data/spec/lib/definition_dsl_spec.rb

@@ -21,16 +21,16 @@ describe "Definition" do
     dsl.attributes[:actor].should eq :user => { :cache=>[:id, :full_name] }, :company => { :cache=>[:id, :name] }
   end
   
-  it "adds a target to the definition" do
+  it "adds an object to the definition" do
     dsl = definition_dsl
-    dsl.target(:listing, :cache => [:id, :title])
-    dsl.attributes[:target].should eq :listing => { :cache=>[:id, :title] }
+    dsl.object(:listing, :cache => [:id, :title])
+    dsl.attributes[:object].should eq :listing => { :cache=>[:id, :title] }
   end
 
-  it "adds a referrer to the definition" do
+  it "adds a target to the definition" do
     dsl = definition_dsl
-    dsl.referrer(:company, :cache => [:id, :name])
-    dsl.attributes[:referrer].should eq :company => { :cache=>[:id, :name] }
+    dsl.target(:company, :cache => [:id, :name])
+    dsl.attributes[:target].should eq :company => { :cache=>[:id, :name] }
   end
   
 end

data/spec/lib/definition_spec.rb

@@ -5,8 +5,8 @@ describe "Definition" do
   let(:definition_dsl) do
     dsl = Streama::DefinitionDSL.new(:new_enquiry)
     dsl.actor(:user, :cache => [:id, :full_name])
-    dsl.target(:enquiry, :cache => [:id, :full_name])
-    dsl.referrer(:listing, :cache => [:id, :name, :full_address])
+    dsl.object(:enquiry, :cache => [:id, :full_name])
+    dsl.target(:listing, :cache => [:id, :name, :full_address])
     dsl
   end
   
@@ -19,12 +19,12 @@ describe "Definition" do
     it "assigns @actor" do
       @definition.actor.has_key?(:user).should be true
     end
-    it "assigns @target" do
-      @definition.target.has_key?(:enquiry).should be true
+    it "assigns @object" do
+      @definition.object.has_key?(:enquiry).should be true
     end
     
-    it "assigns @referrer" do
-      @definition.referrer.has_key?(:listing).should be true
+    it "assigns @target" do
+      @definition.target.has_key?(:listing).should be true
     end
     
   end

data/spec/support/models/activity.rb

@@ -3,8 +3,8 @@ class Activity
   
   activity :enquiry do
     actor :user, :cache => [:full_name]
-    target :enquiry, :cache => [:subject]
-    referrer :listing, :cache => [:title]
+    object :enquiry, :cache => [:subject]
+    target :listing, :cache => [:title]
   end
   
 end

data/spec/support/models/user.rb

@@ -8,5 +8,8 @@ class User
     self.class.all
   end
   
+  def followers
+    User.all
+  end
   
 end

data/streama.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{streama}
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Christos Pappas"]
-  s.date = %q{2011-05-31}
+  s.date = %q{2011-06-23}
   s.description = %q{Streama is a simple activity stream gem for use with the Mongoid ODM framework.}
   s.email = %q{christos.pappas@gmail.com}
   s.extra_rdoc_files = [

metadata

@@ -2,7 +2,7 @@
 name: streama
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Christos Pappas
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-31 00:00:00 +10:00
+date: 2011-06-23 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -127,7 +127,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -386201865970004577
+      hash: -1352868759098387394
       segments: 
       - 0
       version: "0"