Module: ActivityStream::Actor

Defined in:
lib/activity_stream/actor.rb

Overview

Examples:

Definition

class User < ActiveRecord::Base

  include ActivityStream::Actor

  activity_stream(:friends, :actors => :friend_actors)

  def friend_actors
    friend_ids.map{|id| [User, id]}
  end

  def friend_ids
    # get friend ids
  end

end

Usage

@user.activity_stream(:friends) # => <ActivityStream::Stream>

Defined Under Namespace

Modules: ClassMethods

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object 



24
25
26
27
28
29
30
 
# File 'lib/activity_stream/actor.rb', line 24

def self.included(base)
  base.extend(ClassMethods)
  base.class_eval do
    has_many :activities, :as => :actor
    activity_stream(:default, :actors => :followed_actors)
  end
end

Instance Method Details

#activity_stream(name = :default) ⇒ Object

Creates and returns an ActivityStream::Stream for the predefined list of actors.

Parameters:

  • name (Symbol) (defaults to: :default) —

    The key of a defined activity stream



42
43
44
 
# File 'lib/activity_stream/actor.rb', line 42

def activity_stream(name = :default)
  ActivityStream::Stream.new(name, self, self.class.defined_streams[name])
end

#followed_actors ⇒ Object

Override this to change the default actors



46
47
48
 
# File 'lib/activity_stream/actor.rb', line 46

def followed_actors
  self.class.all.map{|actor| [actor.class, actor.id]}
end

#publish_activity(name, metadata = {}) ⇒ Object

Parameters:

  • name (Symbol) —

    An activity identifer defined by Activity.define



33
34
35
36
37
 
# File 'lib/activity_stream/actor.rb', line 33

def publish_activity(name, metadata = {})
  activity = ::Activity.new_with_name_and_metadata(name, metadata)
  self.activities << activity
  activity
end