stream_rails 2.6.6 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32133621350213716900e311c9d4b9b5321f4b9de8c5743826baf986437f5f86
-  data.tar.gz: c3150a813bb1633373ccd4e10cef820d251095fc6f2885568b36d63cc4e0dd62
+  metadata.gz: 12af4b32dde33e9df2997ad8d9e92d7e1c912478d72db04bf949377dbe56646a
+  data.tar.gz: b6619f2ecaf1fb5b21251eec60b117386dfbc4622ffe1a71a5164506d172d809
 SHA512:
-  metadata.gz: 0bde40e704677f17be82ad11c7a0c7e7db9749692e5a3e8b3f91b8416c1304d4d154ce4d9caf39f03b72eb4fe871cb4a0fdbf08f8f97bfba3138610ea6b4233e
-  data.tar.gz: 8445326c9e9fd66e3fda414b4430bbadf28ef340e3b1b98dfcf8d39c2f882844cc880c4907f04055810043acf921ef7308471a34743d63b20426573d63a5c327
+  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,6 +1,6 @@
 # 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/).
@@ -67,10 +67,10 @@ gem 'stream_rails'
 
 This library is tested against and fully supports the following Rails versions:
 
-- 4.0
-- 4.2
 - 5.0
 - 5.2
+- 6.0
+- 6.1
 
 ### Setup
 
@@ -156,10 +156,36 @@ Everytime a Pin is created it will be stored in the feed of the user that create
 
 #### 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:
@@ -346,7 +372,7 @@ When you read data from feeds, a pin activity will look like this:
 ```
 
 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
@@ -356,7 +382,7 @@ 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
@@ -434,7 +460,7 @@ For convenience we include a basic view:
 
 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 send as well as use different layouts, and prefix the name
+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:
 
@@ -490,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

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)
@@ -47,9 +47,9 @@ module StreamRails
       begin
         model.classify.constantize
       rescue NameError
-        return false
+        false
       else
-        return true
+        true
       end
     end
 
@@ -77,6 +77,7 @@ 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.rpartition(':')
           model_refs[model][id] = 0
         end
@@ -85,13 +86,18 @@ module StreamRails
     end
 
     def retrieve_objects(references)
-      Hash[references.map { |model, ids| [model, Hash[model.classify.constantize.where(model.classify.constantize.primary_key => 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.rpartition(':')
           activity[field] = objects[model][id] || value
           activity.track_not_enriched_field(field, value) if objects[model][id].nil?
@@ -102,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/version.rb

@@ -1,3 +1,3 @@
 module StreamRails
-  VERSION = '2.6.6'.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.6
+  version: 3.0.0
 platform: ruby
 authors:
 - Tommaso Barbugli
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-18 00:00:00.000000000 Z
+date: 2021-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -18,56 +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: '3.1'
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.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
@@ -83,33 +83,33 @@ 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: 1.3.13
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.13
+        version: '3.10'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: sequel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '4.49'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '4.49'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -125,19 +125,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.16.1
 - !ruby/object:Gem::Dependency
-  name: sequel
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.49'
+        version: 1.3.13
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.49'
+        version: 1.3.13
 description: 
 email: support@getstream.io
 executables: []
@@ -171,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.8
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A gem that provides a client interface for getstream.io