A gem to manage activity streams (consciousness optional).
Add this line to your application's Gemfile:
gem 'joyce'
And then execute:
$ bundle
Or install it yourself as:
$ gem install joyce
To generate the migration file in Rails, run:
$ rails generate joyce
This will generate a file in your db/migrate/ folder. You will need to run rake db:migrate afterwards.
Just add acts_as_joyce in your models to enable activity streaming for them. E.g.:
class Person < Activerecord::Base
acts_as_joyce
end
This will add to the model methods such as activity_stream.
The basic concepts in Joyce are the activity and the stream.
An activity is a trace of an action that happened in an application. It can usually be mapped to a simple sentence, such as John logged in or Jane added a comment to a post. The verb identifies the activity, the subject identifies the actor and the other entities in the sentence represent other people or objects contributing to the activity.
A stream is a list of activities, usually presented in reverse chronological order. An activity can belong to multiple streams. In fact, by default, an activity belongs to the streams of all the entities involved in it: the activity user#1 added comment#2 to post#3 belongs to the stream for user#1, the one for comment#2 and the one for post#3. It also belongs to the generic User, Comment, and Post streams.
An additional concept is the subscription. To make streams more manageable, it is possible to subscribe to multiple streams, in order to get a composite stream containing all the activities for them.
Basic usage:
Joyce.publish_activity(:actor => actor, :verb => verb, :obj => object)
The parameter names conform to the JSON Activity Streams 1.0 specification (:obj is used instead of :object, which is a reserved word).
The publish_activity method accepts a hash of parameters, among which :actor and :verb are the only mandatory ones.
By default, the activity will be added to the stream for each model instance passed with the call (i.e. actor, object, targets). E.g.:
person = Person.new
activity = Joyce.publish_activity(:actor => person, :verb => "did")
person.activity_stream # will return [activity]
Once a model has been enabled by specifying acts_as_joyce, it will have an activity stream.
You can get all the activities for a specific model instance. E.g.:
person.activity_stream
Or you can get all the activities for all instances of a model. E.g.:
Person.activity_stream
Targets are another kind of entity that can be attached to an activity, to map all relationships that do not fit in the actor/verb/object model.
E.g. an activity such as Jane added a comment to a post can be coded as such:
Joyce.publish_activity(:actor => jane, :verb => Added, :obj => comment, :target => post)
The get_targets method can be used to retrieve targets for an activity. E.g., given the activity defined earlier:
activity.get_targets(:target) # => will return [post]
Note that :target is the default target name, so the line above is equivalent to:
activity.get_targets # => will return [post]
Targets act very much like a bucket of generic items: it is possible to add as many targets as you like to an activity. Notice that Joyce will consider as targets all the publish_activity parameters that are not already reserved terms (e.g. :actor, :verb and such).
E.g. an activity such as Jane added a comment to a post in a group can be coded as such:
Joyce.publish_activity(:actor => jane, :verb => Added, :obj => comment, :post => post, :group => group)
The targets can then be retrieved with:
activity.get_targets(:post) # => will return [post]
activity.get_targets(:group) # => will return [group]
It is possible to specify an array as a target value (although it will need to be named).
E.g. an activity such as Jane added a post to groups A and B can be coded as such:
Joyce.publish_activity(:actor => jane, :verb => Added, :obj => post, :groups => [groupA, groupB])
The targets can then be retrieved with:
activity.get_targets(:groups) # => will return [groupA, groupB]
Once a model has been enabled by specifying acts_as_joyce, it will be able to subscribe to streams (or, more interestingly, stream owners).
E.g. supposing john and jane are instances of joyce-enabled models, it will be possible to do:
john.subscribe_to(jane)
The following code will then return all activities from the subscribed streams:
john.subscribed_activity_stream
Note that the return value for the activity_stream method and for the subscribed_activity_stream method has the same format (an array of Activity instances). The difference is in which activities are returned.
In the example above, subscribed_activity_stream will return jane's activities, while activity_stream will return john's activities.
Execute:
$ rspec
Documentation can be generated using YARD, or browsed online on rubydoc.info.
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Added some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request