Feed me activities, Seymour, please!
Seymour is a library for distributing activity items to Redis-backed activity feeds in a Rails application.
In your Gemfile
Or via command line
gem install seymour
Seymour provides allows an application to distribute activities to a number of interested parties. A typical activity is a small snippet of announcing an "actor" performed some action, such as a comment activity in "Coach Bob commented 'Great game, yesterday'"
class Activity belongs_to :actor belongs_to :subject, :polymorphic => true feed_me_seymour # acts_as_activity also works here end class CommentActivity < Activity audience :team # distributes to TeamFeed by default audience :members, :feed => "DashboardFeed" # define methods for the audiences delegate :team, :to => :comment delegate :members, :to => :team def comment self.subject end end
feed_me_seymour in the activity parent class provides
Activity and its subclasses with the ability to set their
audience. Activities can have any number of audiences. Each audience must be available as an instance method on comment activities.
class TeamFeed < Seymour::Feed end class DashboardFeed < Seymour::Feed end
At some point, perhaps in a background job, we distribute the activity to our audience. Instances of seymour-enabled classes have a
distribute method, which adds the activity id to the front of Redis lists activity feeds for each audience member. Seymour expects to find the TeamFeed and DashboardFeed classes at distribution time. Other activities can distribute to the same feeds owned by the same audience members as well.
comment = Comment.create! # 'Great game, yesterday' activity = CommentActivity.create!(:actor => comment.author, :subject => comment) activity.distribute
This library is based on the feed architecture used to distribute activity items at Weplay. Weplay supports activity distribution to a variety of feeds: user dashboards, game day comment pages, global points leaders, etc. The html for each activity item is pre-rendered in a background job. To build a user's dashboard activities, the activity feed needs only to select the activities at the top of the list and output the pre-rendered html for each item, reducing the extra includes and joins needed in-process.
- generator for activity model + migration
- generator for activity feed
- support rollup
- relevance/affinity sorting