stream_rails 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82fcbb047a9fc18b2f808bf7a0c9d24edc6fef5b
-  data.tar.gz: 8741b89406b037ea2b6be3769e5663395661d185
+  metadata.gz: 0d3432a8955f14a1c5bc68728636624f4e32feb7
+  data.tar.gz: 07c4acdc2ece3b24277052b51547a07095f335fa
 SHA512:
-  metadata.gz: 675e198519664358583be4d42e5265a0b7d74c4b3e212ec1296e9d34bad68e7e2277a97fe51902d24a33031f9aa6965d9ed25b39f4e93c5e11c1a42c99e0b55b
-  data.tar.gz: 7b21994454b8f1c62e17f7a642738c9c725ef717f29776c97c5fbee17373b210ae94c9718d3b33f10bea0b6ddf30662ec87c06f516c40d634004a49551edb65f
+  metadata.gz: a03aafb8e658cc99d5808dc1ca1d56e2012ae647eefd26bd126b4b63a6ca74f3d026ea253bb56027a888e89e54192c74a4ddd4227c3981ce8e00999baa8a998f
+  data.tar.gz: 791fd74c07194ecbf7fdff17419531b1b71cdadc841a6e3df751c84bf34d2c0568c3b9ae7a8e6bac6d9b47b8ad3af60e7fe81ea1ce94e05c0e677f1e8ca68701

data/README.md

@@ -6,7 +6,7 @@ Stream Rails
 
 This package helps you create activity streams & newsfeeds with Ruby on Rails and [GetStream.io](https://getstream.io).
 
-###Activity Streams & Newsfeeds
+### Activity Streams & Newsfeeds
 
 ![](https://dvqg2dogggmn6.cloudfront.net/images/mood-home.png)
 
@@ -52,11 +52,15 @@ You can check out our example app built using this library on Github [https://gi
 
 You can install ```stream_rails``` as you would any other gem:
 
-```gem install stream_rails```
+```
+gem install stream_rails
+```
 
 or in your Gemfile:
 
-```gem 'stream_rails'```
+```
+gem 'stream_rails'
+```
 
 
 ### Setup
@@ -76,6 +80,9 @@ StreamRails.configure do |config|
   # If you use custom feed names, e.g.: timeline_flat, timeline_aggregated,
   # use this, otherwise omit:
   config.news_feeds = { flat: "timeline_flat", aggregated: "timeline_aggregated" }
+  # Point to the notifications feed group providing the name, omit if you don't
+  # have a notifications feed
+  config.notification_feed = "notification"
 end
 ```
 
@@ -265,7 +272,7 @@ class Pin < ActiveRecord::Base
 
   def activity_notify
     if self.is_retweet
-      [feed_manager.get_notification_feed(self.parent.user_id)]
+      [StreamRails.feed_manager.get_notification_feed(self.parent.user_id)]
     end
   end
 
@@ -290,7 +297,7 @@ class Follow < ActiveRecord::Base
   as_activity
 
   def activity_notify
-    [feed_manager.get_notification_feed(self.target_id)]
+    [StreamRails.feed_manager.get_notification_feed(self.target_id)]
   end
 
   def activity_object
@@ -301,12 +308,17 @@ end
 ```
 
 ####Follow a feed
-This is how you create the newsfeeds you need to notify the system about follow relationships. The manager comes with APIs to let a user's news feed follow another user's feed. This code lets the current user's flat and aggregated feeds follow the target_user's personal feed.
+
+In order to populate newsfeeds, you need to notify the system about follow relationships.
+
+The current user's flat and aggregated feeds will follow the `target_user`'s user feed, with the following code:
 
 ```
 StreamRails.feed_manager.follow_user(user_id, target_id)
 ```
 
+![](http://i.imgur.com/bLywmPj.png)
+
 ### Showing the newsfeed
 
 ####Activity enrichment
@@ -347,25 +359,30 @@ The ```render_activity``` view helper will render the activity by picking the pa
 The helper will automatically send ```activity``` to the local scope of the partial; additional parameters can be send as well as use different layouts, and prefix the name
 
 
-eg. renders the activity partial using the ```small_activity``` layout.
+e.g. renders the activity partial using the ```small_activity``` layout:
 
 ```
 <%= render_activity activity, :layout => "small_activity" %>
 ```
 
-
-eg. prefixes the name of the template with "notification_"
+e.g. prefixes the name of the template with "notification_":
 
 ```
 <%= render_activity activity, :prefix => "notification_" %>
 ```
 
-eg. adds the extra_var to the partial scope
+e.g. adds the extra_var to the partial scope:
 
 ```
 <%= render_activity activity, :locals => {:extra_var => 42} %>
 ```
 
+e.g. renders the activity partial using the `notifications` partial root, which will render the partial with the path `notifications/#{ACTIVITY_VERB}`
+
+```
+<%= render_activity activity, :partial_root => "notifications" %>
+```
+
 ####Pagination
 
 For simple pagination you can use the [stream-ruby API](https://github.com/getstream/stream-ruby),

data/lib/stream_rails/activity.rb

@@ -47,7 +47,11 @@ module StreamRails
     end
 
     def activity_object
-      fail NotImplementedError, 'Activity models must define `#activity_object`'
+      fail NotImplementedError, "Activity models must define `#activity_object` - missing on `#{self.class}`"
+    end
+
+    def activity_target
+      nil
     end
 
     def activity_verb
@@ -62,6 +66,10 @@ module StreamRails
       StreamRails.create_reference(self)
     end
 
+    def activity_target_id
+      StreamRails.create_reference(activity_target) if activity_target
+    end
+
     def activity_notify
     end
 
@@ -83,6 +91,7 @@ module StreamRails
         verb: activity_verb,
         object: activity_object_id,
         foreign_id: activity_foreign_id,
+        target: activity_target_id,
         time: activity_time
       }
       activity[:to] = activity_notify.map(&:id) unless activity_notify.nil?

data/lib/stream_rails/enrich.rb

@@ -29,7 +29,7 @@ module StreamRails
 
   class Enrich
     def initialize(fields = nil)
-      @fields = fields || [:actor, :object]
+      @fields = fields || [:actor, :object, :target]
     end
 
     def model_field?(field_value)

data/lib/stream_rails/version.rb

@@ -1,3 +1,3 @@
 module StreamRails
-  VERSION = '2.4.0'
+  VERSION = '2.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stream_rails
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Tommaso Barbugli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-23 00:00:00.000000000 Z
+date: 2016-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.5
+        version: '2.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.5
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -151,7 +151,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.29'
 description: 
-email: tbarbugli@gmail.com
+email: tommaso@getstream.io
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -171,7 +171,7 @@ files:
 - lib/stream_rails/sync_policies.rb
 - lib/stream_rails/utils/view_helpers.rb
 - lib/stream_rails/version.rb
-homepage: http://github.com/tbarbugli/stream-ruby
+homepage: http://github.com/GetStream/stream-rails
 licenses:
 - Apache-2.0
 metadata: {}
@@ -191,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.7
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A gem that provides a client interface for getstream.io