stream_rails 2.0 → 2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 016dba86836c2294b0a5577de9174c1b875505c4
-  data.tar.gz: 33db2c3a74a97944e7c4dab79d44d6894d30ac3c
+  metadata.gz: 6e747d58bdea6d8fb3730c4c989473f80742aa27
+  data.tar.gz: 7de3ea1b730b2ab6776357285fee6e828ab870f7
 SHA512:
-  metadata.gz: d16e76cfdec6cc77c2392e3311204b80b28bc6f634a43adf48104ce3563e27d53560bbd62546d53e57570c11238509f6a2064533b0cc40dc8ea59dae9c66a5f2
-  data.tar.gz: caed45788f3ab7001043badac5bf66b2a5e69daad42756f808746430bb6490fe3046474aa39a7ba762a1e03aa92391ac47050fda96108996287809bc93579b18
+  metadata.gz: 90acf4f1f8b17e3c8310f55b24bec008340b71772f8b831c8b8d740affc2503c826c6fc40d4f2c528d218591fe0344913c036f1666253c830d35a112e0bd5e88
+  data.tar.gz: aad3af59da1f2b7c27c9f19ae47dc7c66a80cd1072d8a8ae0c7f3d6a1210d2ca4dcd206ae762e3db2fe11395b225393795d522e9ad8db3842ceef8dea8c63fbf

data/README.md

@@ -74,26 +74,24 @@ class Pin < ActiveRecord::Base
 
   include StreamRails::Activity
   as_activity
+
+  def activity_object
+    self.item
+  end
+
 end
 ```
 Everytime a Pin is created it will be stored in the feed of the user that created it, and when a Pin instance is deleted than it will get removed as well.
 
 ####Activity fields
 
-Models are stored in feeds as activities. An activity is composed of at least the following data fields: **actor**, **verb**, **object**, **time**. You can also add more custom data if needed.
-
-**object** is a reference to the model instance itself
-**actor** is a reference to the user attribute of the instance
-**verb** is a string representation of the class name
+ActiveRecord models are stored in your feeds as activities; Activities are objects that tell the story of a person performing an action on or with an object, in its simplest form, an activity consists of an actor, a verb, and an object. In order for this to happen your models need to implement this methods:
 
-In order to work out-of-the-box, the Activity class makes makes few assumptions:
+**#activity_object** the object of the activity (eg. an AR model instance)
+**#activity_actor** the actor performing the activity (defaults to ```self.user```)
+**#activity_verb** the string representation of the verb (defaults to model class name)
 
-1. the Model class belongs to a user
-2. the model table has timestamp columns (created_at is required)
-
-You can change this behaviour by overriding ```#activity_actor```.
-
-Below shows an example how to change your class if the model belongs to an author instead of to a user.
+Here's a more complete example of the Pin class:
 
 ```ruby
 class Pin < ActiveRecord::Base
@@ -107,6 +105,10 @@ class Pin < ActiveRecord::Base
     self.author
   end
 
+  def activity_object
+    self.item
+  end
+
 end
 ```
 
@@ -127,6 +129,10 @@ class Pin < ActiveRecord::Base
     {'is_retweet' => self.is_retweet}
   end
 
+  def activity_object
+    self.item
+  end
+
 end
 ```
 
@@ -184,6 +190,10 @@ class Pin < ActiveRecord::Base
     end
   end
 
+  def activity_object
+    self.item
+  end
+
 end
 ```
 
@@ -204,6 +214,10 @@ class Follow < ActiveRecord::Base
     [feed_manager.get_notification_feed(self.target_id)]
   end
 
+  def activity_object
+    self.target
+  end
+
 end
 ```
 
@@ -221,7 +235,7 @@ StreamRails.feed_manager.follow_user(user_id, target_id)
 When you read data from feeds, a pin activity will look like this:
 
 ```json
-{"actor": "User:1", "verb": "like", "object": "Pin:42"}
+{"actor": "User:1", "verb": "like", "object": "Item:42"}
 ```
 
 This is far from ready for usage in your template. We call the process of loading the references from the database enrichment. An example is shown below:

data/lib/stream_rails/activity.rb

@@ -52,12 +52,16 @@ module StreamRails
       StreamRails.create_reference(self.activity_actor)
     end
 
+    def activity_object
+      raise NotImplementedError, "Activity models must define `#activity_object`"
+    end
+
     def activity_verb
       self.class.model_name.to_s
     end
 
     def activity_object_id
-      StreamRails.create_reference(self)
+      StreamRails.create_reference(self.activity_object)
     end
 
     def activity_foreign_id

data/lib/stream_rails/version.rb

@@ -1,3 +1,3 @@
 module StreamRails
-  VERSION = '2.0'
+  VERSION = '2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stream_rails
 version: !ruby/object:Gem::Version
-  version: '2.0'
+  version: '2.1'
 platform: ruby
 authors:
 - Tommaso Barbugli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-10 00:00:00.000000000 Z
+date: 2014-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack