stream_rails 2.6.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c54b579f0190e13effdd0bf431cb72c10da1cb29bcf480c9fb576324d5f16968
-  data.tar.gz: fb38ca708f49735545db3d4babcb3f66544b0d1603c408ad4366cc2567d062ab
+  metadata.gz: 12af4b32dde33e9df2997ad8d9e92d7e1c912478d72db04bf949377dbe56646a
+  data.tar.gz: b6619f2ecaf1fb5b21251eec60b117386dfbc4622ffe1a71a5164506d172d809
 SHA512:
-  metadata.gz: 9e73e7b0f211f5571ae0992dbc9b90bf150d63fa35b7ffb3b15e52babdc4e4df4ed81707bf8ef1cf3b41be26da87d6377940d5f901f31160a9d71628d84267ea
-  data.tar.gz: 7699314f3e562ac9c346ff7510d4815623a62edff0f57a5e21131413f73dd9919c2fe3fc2efef8682769e5f9f31e26590cbc2227790aadc0b64746f98fde5897
+  metadata.gz: 4bd338ff891bca9426862b0996b19e6beca617662597b8b66c71995895a64a6aadb986f27c539a49e9fdf33bb5b9688f5f7393a37edd03d2eb56b2892047232b
+  data.tar.gz: 328cd1ce3ba75efefcfdf21828c2608dcd1c63428a238c9c647e21b612a567b1d23c810f8a79d08d51754cc48241076a3c0421d9ed3eb0cc0128e6d71ee338b1

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2014-2017 Stream.io Inc, and individual contributors.
+Copyright (c) 2014-2021 Stream.io Inc, and individual contributors.
 
 All rights reserved.
 

data/README.md

@@ -1,7 +1,6 @@
-Stream Rails
-============
+# Stream Rails
 
-[![image](https://secure.travis-ci.org/GetStream/stream-rails.png?branch=master)](http://travis-ci.org/GetStream/stream-rails)
+[![build](https://github.com/GetStream/stream-rails/workflows/build/badge.svg)](https://github.com/GetStream/stream-rails/actions)
 [![Gem Version](https://badge.fury.io/rb/stream_rails.svg)](http://badge.fury.io/rb/stream_rails)
 
 [stream-rails](https://github.com/GetStream/stream-rails) is a Ruby on Rails client for [Stream](https://getstream.io/).
@@ -16,11 +15,11 @@ Note there is also a lower level [Ruby - Stream integration](https://github.com/
 
 What you can build:
 
-* Activity streams such as seen on Github
-* A twitter style newsfeed
-* A feed like instagram/ pinterest
-* Facebook style newsfeeds
-* A notification system
+- Activity streams such as seen on Github
+- A twitter style newsfeed
+- A feed like instagram/ pinterest
+- Facebook style newsfeeds
+- A notification system
 
 ### Demo
 
@@ -54,7 +53,7 @@ You can check out our example app built using this library on Github [https://gi
 
 ### Gem installation
 
-You can install ```stream_rails``` as you would any other gem:
+You can install `stream_rails` as you would any other gem:
 
 ```
 gem install stream_rails
@@ -67,17 +66,17 @@ gem 'stream_rails'
 ```
 
 This library is tested against and fully supports the following Rails versions:
-- 3.x
-- 4.0
-- 4.2
+
 - 5.0
 - 5.2
+- 6.0
+- 6.1
 
 ### Setup
 
-Login with Github on getstream.io and get your ```api_key``` and ```api_secret``` from your app configuration (Dashboard screen).
+Login with Github on getstream.io and get your `api_key` and `api_secret` from your app configuration (Dashboard screen).
 
-Then you can add the StreamRails configuration in ```config/initializers/stream_rails.rb```
+Then you can add the StreamRails configuration in `config/initializers/stream_rails.rb`
 
 ```ruby
 require 'stream_rails'
@@ -87,7 +86,7 @@ StreamRails.configure do |config|
   config.api_secret   = "YOUR API SECRET"
   config.timeout      = 30                  # Optional, defaults to 3
   config.location     = 'us-east'           # Optional, defaults to 'us-east'
-  config.api_hostname = 'stream-io-api.com' # Optional, defaults to 'stream-io-api.com' 
+  config.api_hostname = 'stream-io-api.com' # Optional, defaults to 'stream-io-api.com'
   # 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" }
@@ -152,14 +151,41 @@ class Pin < ActiveRecord::Base
 
 end
 ```
-Everytime a Pin is created it will be stored in the feed of the user that created it.  When a Pin instance is deleted, the feed will be removed as well.
+
+Everytime a Pin is created it will be stored in the feed of the user that created it. When a Pin instance is deleted, the feed will be removed as well.
 
 #### Activity fields
 
-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:
+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 these methods:
 
 **#activity_object** the object of the activity (eg. an AR model instance)
-**#activity_actor** the actor performing the activity (defaults to ```self.user```)
+
+**#activity_actor** the actor performing the activity -- this value also provides the feed name and feed ID to which the activity will be added.
+
+For example, let's say a Pin was a polymorphic class that could belong to either a user (e.g. `User` ID: 1) or a company (e.g. `Company` ID: 1). In that instance, the below code would post the pin either to the `user:1` feed or the `company:1` feed based on its owner.
+
+```ruby
+class Pin < ActiveRecord::Base
+  belongs_to :owner, :polymorphic => true
+  belongs_to :item
+
+  include StreamRails::Activity
+  as_activity
+
+  def activity_actor
+    self.owner
+  end
+
+  def activity_object
+    self.item
+  end
+
+end
+```
+
+The `activity_actor` defaults to `self.user`
+
+
 **#activity_verb** the string representation of the verb (defaults to model class name)
 
 Here's a more complete example of the Pin class:
@@ -185,8 +211,7 @@ end
 
 #### Activity extra data
 
-Often you'll want to store more data than just the basic fields. You achieve this by implementing ```#activity_extra_data``` in your model.
-
+Often you'll want to store more data than just the basic fields. You achieve this by implementing `#activity_extra_data` in your model.
 
 ```ruby
 class Pin < ActiveRecord::Base
@@ -210,7 +235,7 @@ end
 #### Activity creation
 
 If you want to control when to create an activity you should implement
-the ```#activity_should_sync?``` method in your model.
+the `#activity_should_sync?` method in your model.
 
 ```ruby
 class Pin < ActiveRecord::Base
@@ -235,7 +260,7 @@ This will create an activity only when `self.published` is true.
 
 ### Feed manager
 
-```stream_rails``` comes with a Feed Manager class that helps with all common feed operations. You can get an instance of the manager with ```StreamRails.feed_manager```.
+`stream_rails` comes with a Feed Manager class that helps with all common feed operations. You can get an instance of the manager with `StreamRails.feed_manager`.
 
 ```ruby
 feed = StreamRails.feed_manager.get_user_feed(current_user.id)
@@ -247,12 +272,15 @@ To get you started the manager has 4 feeds pre-configured. You can add more feed
 Feeds are divided into three categories.
 
 ##### User feed:
+
 The user feed stores all activities for a user. Think of it as your personal Facebook page. You can easily get this feed from the manager.
+
 ```ruby
 feed = StreamRails.feed_manager.get_user_feed(current_user.id)
 ```
 
 ##### News feeds:
+
 News feeds store activities from the people you follow.
 There is both a flat newsfeed (similar to twitter) and an aggregated newsfeed (like facebook).
 
@@ -262,15 +290,18 @@ aggregated_feed = StreamRails.feed_manager.get_news_feeds(current_user.id)[:aggr
 ```
 
 ##### Notification feed:
+
 The notification feed can be used to build notification functionality.
 
 ![Notification feed](http://feedly.readthedocs.org/en/latest/_images/fb_notification_system.png)
 
 Below we show an example of how you can read the notification feed.
+
 ```ruby
 notification_feed = StreamRails.feed_manager.get_notification_feed(current_user.id)
 
 ```
+
 By default the notification feed will be empty. You can specify which users to notify when your model gets created. In the case of a retweet you probably want to notify the user of the parent tweet.
 
 ```ruby
@@ -337,11 +368,11 @@ 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": "Item: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:
+"enrichment." An example is shown below:
 
 ```ruby
 enricher = StreamRails::Enrich.new
@@ -350,7 +381,9 @@ feed = StreamRails.feed_manager.get_news_feeds(current_user.id)[:flat]
 results = feed.get()['results']
 activities = enricher.enrich_activities(results)
 ```
-A similar method called enrich_aggregated_activities is available for aggregated feeds.
+
+A similar method called `enrich_aggregated_activities` is available for aggregated feeds.
+
 ```ruby
 enricher = StreamRails::Enrich.new
 
@@ -363,6 +396,7 @@ If you have additional metadata in your activity (by overriding `activity_extra_
 Stream Activity mixin), you can also enrich that field's data by doing the following:
 
 Step One: override the `activity_extra_data` method from our mixin:
+
 ```ruby
 class Pin < ActiveRecord::Base
   include StreamRails::Activity
@@ -403,6 +437,7 @@ pin.extra_data = {:location => "location:#{boulder.id}"}
 
 When we retrieve the activity later, the enrichment process will include our `location` model as well, giving us
 access to attributes and methods of the location model:
+
 ```ruby
 place = activity[:location].name
 # Boulder, CO
@@ -423,18 +458,17 @@ For convenience we include a basic view:
 </div>
 ```
 
-The ```render_activity``` view helper will render the activity by picking the partial ```activity/_pin``` for a pin activity, ```aggregated/_follow``` for an aggregated activity with verb follow.
-
-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
+The `render_activity` view helper will render the activity by picking the partial `activity/_pin` for a pin activity, `aggregated_activity/_follow` for an aggregated activity with verb follow.
 
+The helper will automatically send `activity` to the local scope of the partial; additional parameters can be sent as well as use different layouts, and prefix the name
 
-e.g. 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" %>
 ```
 
-e.g. prefixes the name of the template with "notification_":
+e.g. prefixes the name of the template with "notification\_":
 
 ```
 <%= render_activity activity, :prefix => "notification_" %>
@@ -482,10 +516,10 @@ From the project root directory:
 
 ### Full documentation and Low level APIs access
 
-When needed you can also use the [low level Ruby API](https://github.com/getstream/stream-ruby) directly. Documentation is available at the [Stream website](https://getstream.io/docs/?language=ruby).
+When needed you can also use the [low level Ruby API](https://github.com/getstream/stream-ruby) directly. Documentation is available at the [Stream website](https://getstream.io/activity-feeds/docs/?language=ruby).
 
 ### Copyright and License Information
 
-Copyright (c) 2014-2017 Stream.io Inc, and individual contributors. All rights reserved.
+Copyright (c) 2014-2021 Stream.io Inc, and individual contributors. All rights reserved.
 
 See the file "LICENSE" for information on the history of this software, terms & conditions for usage, and a DISCLAIMER OF ALL WARRANTIES.

data/lib/stream_rails/activity.rb

@@ -7,7 +7,7 @@ module StreamRails
       if record.is_a?(ActiveRecord::Base) || (Object.const_defined?('Sequel') && record.is_a?(Sequel::Model))
         "#{record.class.model_name}:#{record.id}"
       else
-        record.to_s unless record.nil?
+        record&.to_s
       end
     end
   end
@@ -39,7 +39,7 @@ module StreamRails
     end
 
     def activity_owner_feed
-      'user'
+      activity_actor.class.name.downcase
     end
 
     def activity_actor_id
@@ -93,9 +93,9 @@ module StreamRails
         target: activity_target_id,
         time: activity_time
       }
-      activity[:to] = activity_notify.map(&:id) unless activity_notify.nil?
-      activity.merge!(activity_extra_data) if activity_extra_data != nil
-      activity
+      arr = activity_notify
+      activity[:to] = arr.map(&:id) unless arr.nil?
+      activity.merge!(activity_extra_data || {})
     end
   end
 end

data/lib/stream_rails/enrich.rb

@@ -10,8 +10,8 @@ module StreamRails
       super
     end
 
-    def from_activity(h)
-      merge(h)
+    def from_activity(from)
+      merge(from)
     end
 
     def enriched?
@@ -31,7 +31,7 @@ module StreamRails
     attr_reader :fields
 
     def initialize(fields = nil)
-      @fields = fields || [:actor, :object, :target]
+      @fields = fields || %i[actor object target]
     end
 
     def add_fields(new_fields)
@@ -40,14 +40,16 @@ module StreamRails
 
     def model_field?(field_value)
       return false unless field_value.respond_to?('split')
-      bits = field_value.split(':')
-      return false if bits.length < 2
+
+      model, _, id = field_value.rpartition(':')
+      return false unless model.present? && id.present?
+
       begin
-        bits[0].classify.constantize
+        model.classify.constantize
       rescue NameError
-        return false
+        false
       else
-        return true
+        true
       end
     end
 
@@ -75,7 +77,8 @@ module StreamRails
       activities.each do |activity|
         activity.select { |k, _v| @fields.include? k.to_sym }.each do |_field, value|
           next unless model_field?(value)
-          model, id = value.split(':')
+
+          model, _, id = value.rpartition(':')
           model_refs[model][id] = 0
         end
       end
@@ -83,14 +86,19 @@ module StreamRails
     end
 
     def retrieve_objects(references)
-      Hash[references.map { |model, ids| [model, Hash[model.classify.constantize.where(id: ids.keys).map { |i| [i.id.to_s, i] }]] }]
+      references.map do |model, ids|
+        [model, model.classify.constantize.where(model.classify.constantize.primary_key => ids.keys).map do |i|
+          [i.id.to_s, i]
+        end.to_h]
+      end.to_h
     end
 
     def inject_objects(activities, objects)
       create_activity_results(activities).each do |activity|
         activity.select { |k, _v| @fields.include? k.to_sym }.each do |field, value|
           next unless model_field?(value)
-          model, id = value.split(':')
+
+          model, _, id = value.rpartition(':')
           activity[field] = objects[model][id] || value
           activity.track_not_enriched_field(field, value) if objects[model][id].nil?
         end
@@ -100,7 +108,7 @@ module StreamRails
     private
 
     def create_activity_results(activities)
-      return activities.map { |a| ActivityResult.new.from_activity(a) }
+      activities.map { |a| ActivityResult.new.from_activity(a) }
     end
   end
 end

data/lib/stream_rails/feed_manager.rb

@@ -15,7 +15,7 @@ module StreamRails
     end
 
     def get_news_feeds(user_id)
-      Hash[@news_feeds.map { |feed_name, feed_slug| [feed_name, get_feed(feed_slug, user_id)] }]
+      @news_feeds.transform_values { |feed_slug| get_feed(feed_slug, user_id) }
     end
 
     def get_notification_feed(user_id)
@@ -28,6 +28,7 @@ module StreamRails
 
     def follow_user(user_id, target_id)
       return unless StreamRails.enabled?
+
       target_feed = get_user_feed(target_id)
       @news_feeds.each do |_, feed|
         news_feed = get_feed(feed, user_id)
@@ -37,6 +38,7 @@ module StreamRails
 
     def unfollow_user(user_id, target_id)
       return unless StreamRails.enabled?
+
       target_feed = get_user_feed(target_id)
       @news_feeds.each do |_, feed|
         news_feed = get_feed(feed, user_id)
@@ -50,6 +52,7 @@ module StreamRails
 
     def created_activity(instance)
       return unless StreamRails.enabled? && instance.activity_should_sync?
+
       activity = instance.create_activity
       feed = get_owner_feed(instance)
       feed.add_activity(activity)
@@ -57,6 +60,7 @@ module StreamRails
 
     def destroyed_activity(instance)
       return unless StreamRails.enabled?
+
       feed = get_owner_feed(instance)
       feed.remove(instance.activity_foreign_id, true)
     end

data/lib/stream_rails/logger.rb

@@ -4,5 +4,5 @@ module StreamRails
   class << self
     attr_accessor :logger
   end
-  self.logger = Logger.new(STDOUT)
+  self.logger = Logger.new($stdout)
 end

data/lib/stream_rails/renderable.rb

@@ -20,17 +20,17 @@ module StreamRails
           context.render params
         else
           StreamRails.logger.warn "trying to display a non enriched activity #{activity.inspect} #{activity.failed_to_enrich}"
-          return ''
+          ''
         end
       end
 
       def render_aggregated(activity, context, params)
-        if !activity['activities'].map { |a| !a.enriched? }.all?
-          context.render params
-        else
+        if activity['activities'].map { |a| !a.enriched? }.all?
           first_activity = activity['activities'][0]
           StreamRails.logger.warn "trying to display a non enriched activity #{first_activity.inspect} #{first_activity.failed_to_enrich}"
-          return ''
+          ''
+        else
+          context.render params
         end
       end
 
@@ -42,7 +42,7 @@ module StreamRails
 
       def partial_path(activity, aggregated, prefix = '', path = nil, root = nil)
         root ||= (aggregated ? 'aggregated_activity' : 'activity')
-        path ||= "#{activity['verb']}".downcase
+        path ||= (activity['verb']).to_s.downcase
         path = "#{prefix}_#{path}" if prefix
         select_path path, root
       end
@@ -50,8 +50,8 @@ module StreamRails
       def prepare_locals(activity, params)
         locals = params.delete(:locals) || {}
         locals.merge\
-          activity:     activity,
-          parameters:   params
+          activity: activity,
+          parameters: params
       end
 
       private

data/lib/stream_rails/sync_policies.rb

@@ -28,8 +28,8 @@ module StreamRails
 
     module SyncDestroy
       def self.included(base)
-        if base.respond_to? :after_commit
-          base.after_commit :remove_from_feed, on: :destroy
+        if base.respond_to? :before_destroy
+          base.before_destroy :remove_from_feed
         elsif Object.const_defined?('Sequel') && base < Sequel::Model
           base.instance_eval do
             define_method(:before_destroy) do |*args|

data/lib/stream_rails/version.rb

@@ -1,3 +1,3 @@
 module StreamRails
-  VERSION = '2.6.2'.freeze
+  VERSION = '3.0.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stream_rails
 version: !ruby/object:Gem::Version
-  version: 2.6.2
+  version: 3.0.0
 platform: ruby
 authors:
 - Tommaso Barbugli
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-15 00:00:00.000000000 Z
+date: 2021-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -18,62 +18,56 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
-  name: railties
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
-  name: stream-ruby
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.6.1
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.6'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.6.1
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: stream-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 4.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 4.0.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -89,61 +83,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: sequel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: '4.49'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: '4.49'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 0.16.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: 0.16.1
 - !ruby/object:Gem::Dependency
-  name: sequel
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.29'
+        version: 1.3.13
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.29'
+        version: 1.3.13
 description: 
 email: support@getstream.io
 executables: []
@@ -177,15 +171,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 2.5.5
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A gem that provides a client interface for getstream.io