stream-ruby 3.0.1 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1234ef10092da5e7ceade3115fc2036afee959883ab2ac22c96480106157f5b
-  data.tar.gz: 6f5c5f1a2b91385f4497a9695a1cf018d216a5b737835aecfaddaada0c31dce8
+  metadata.gz: 9aef0477b7b269f76432beea87cab0b7d41e5887ffdb69100abd1096421028c5
+  data.tar.gz: a0974c2b7e0d8967656f7433ea04b7ece51cfb72253aede20793710e6cb318f8
 SHA512:
-  metadata.gz: 53793fe9fd892a88959ab38b62b1096d6f71b521e5ea7087a85354685dbaa857bb4f643863edb8281e7a187b0388810c7a2f972277de6fb4c63123339c06d46c
-  data.tar.gz: 964cc5bad77573acb2a2c4e1856a910fdf5f2ed6ff12f565b1b7c864cecf64b15c1f00ef8c935a983906abadbe6d709867c1638bdf6ebd8341c253bded1495b3
+  metadata.gz: 9838aedac28f96372299682572fc3de5a4c8e946ebe1d60dc5851c5cafe26a2ea9d3c44aca46f8e851d2337021e49da77442306db67cca95c30002b06b9267ad
+  data.tar.gz: 76c77e37c537150587dfff557b6b3870276f1ce87054119a5653960b7dc07c6cce9d9bf2e250af937d6fbb0fa674316fbd62127c61facff850b6bb6758391feb

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-ruby
-===========
+# stream-ruby
 
-[![Build Status](https://travis-ci.org/GetStream/stream-ruby.svg?branch=master)](https://travis-ci.org/GetStream/stream-ruby) [![Gem Version](https://badge.fury.io/rb/stream-ruby.svg)](http://badge.fury.io/rb/stream-ruby)
+[![build](https://github.com/GetStream/stream-ruby/workflows/build/badge.svg)](https://github.com/GetStream/stream-ruby/actions) [![Gem Version](https://badge.fury.io/rb/stream-ruby.svg)](http://badge.fury.io/rb/stream-ruby)
 
 [stream-ruby](https://github.com/GetStream/stream-ruby) is the official Ruby client for [Stream](https://getstream.io/), a web service for building scalable newsfeeds and activity streams.
 
@@ -11,18 +10,14 @@ You can sign up for a Stream account at https://getstream.io/get_started.
 
 #### Ruby version requirements and support
 
-This API Client project requires Ruby 2.2.10 at a minimum. We will support the following versions:
-- 2.2.10
-- 2.3.8
-- 2.4.5
-- 2.5.3
+This API Client project requires Ruby 2.5.x at a minimum.
 
 See the [Travis configuration](.travis.yml) for details of how it is built and tested.
 
 ### Installation
 
 ```bash
-gem install "stream-ruby"
+gem install 'stream-ruby'
 ```
 
 ### Full documentation
@@ -34,30 +29,43 @@ Documentation for this Ruby client are available at the [Stream website](https:/
 ```ruby
 # Instantiate a new client to connect to us east API endpoint
 require 'stream'
-client = Stream::Client.new('YOUR_API_KEY', 'API_KEY_SECRET', 'APP_ID', :location => 'us-east')
+client = Stream::Client.new('YOUR_API_KEY', 'API_KEY_SECRET', 'APP_ID', location: 'us-east')
+
 # Find your API keys here https://getstream.io/dashboard/
 
 # Instantiate a feed object
 user_feed_1 = client.feed('user', '1')
 
 # Get activities from 5 to 10 (slow pagination)
-result = user_feed_1.get(:limit=>5, :offset=>5)
+result = user_feed_1.get(limit: 5, offset: 5)
 # (Recommended & faster) Filter on an id less than the given UUID
-result = user_feed_1.get(:limit=>5, :id_lt=>'e561de8f-00f1-11e4-b400-0cc47a024be0')
+result =
+  user_feed_1.get(limit: 5, id_lt: 'e561de8f-00f1-11e4-b400-0cc47a024be0')
 
 # Create a new activity
-activity_data = {:actor => 1, :verb => 'tweet', :object => 1, :foreign_id => 'tweet:1'}
+activity_data = { actor: 1, verb: 'tweet', object: 1, foreign_id: 'tweet:1' }
 activity_response = user_feed_1.add_activity(activity_data)
 # Create a bit more complex activity
-activity_data = {:actor => 1, :verb => 'tweet', :object => 1, :foreign_id => 'tweet:1',
-	:course => {:name => 'Golden Gate park', :distance => 10},
-	:participants => ['Thierry', 'Tommaso'],
-	:started_at => DateTime.now()
+activity_data = {
+  actor: 1,
+  verb: 'tweet',
+  object: 1,
+  foreign_id: 'tweet:1',
+  course: { name: 'Golden Gate park', distance: 10 },
+  participants: %w[Thierry Tommaso],
+  started_at: DateTime.now
 }
 activity_response = user_feed_1.add_activity(activity_data)
 
 # Update an existing activity (requires both :foreign_id and :time fields)
-activity_data = {:actor => 1, :verb => 'tweet', :object => 1, :foreign_id => 'tweet:1', :popularity => 100, :time => '2016-05-13T16:12:30'}
+activity_data = {
+  actor: 1,
+  verb: 'tweet',
+  object: 1,
+  foreign_id: 'tweet:1',
+  popularity: 100,
+  time: '2016-05-13T16:12:30'
+}
 client.update_activity(activity_data)
 
 # Update activities
@@ -67,7 +75,7 @@ client.update_activities([activity_data])
 user_feed_1.remove_activity('e561de8f-00f1-11e4-b400-0cc47a024be0')
 
 # Remove activities by their foreign_id
-user_feed_1.remove_activity('tweet:1', foreign_id=true)
+user_feed_1.remove_activity('tweet:1', foreign_id: true)
 
 # Follow another feed
 user_feed_1.follow('flat', '42')
@@ -77,60 +85,45 @@ user_feed_1.unfollow('flat', '42')
 
 # Batch adding activities
 activities = [
-    [:actor => '1', :verb => 'tweet', :object => '1'],
-    [:actor => '2', :verb => 'like', :object => '3']
+  [actor: '1', verb: 'tweet', object: '1'],
+  [actor: '2', verb: 'like', object: '3']
 ]
 user_feed_1.add_activities(activities)
 
 # Batch following many feeds (requires ruby 2.1 or later)
 follows = [
-  {:source => 'flat:1', :target => 'user:1'},
-  {:source => 'flat:1', :target => 'user:2'},
-  {:source => 'flat:1', :target => 'user:3'},
+  { source: 'flat:1', target: 'user:1' },
+  { source: 'flat:1', target: 'user:2' },
+  { source: 'flat:1', target: 'user:3' }
 ]
 client.follow_many(follows)
 
 # Add an activity and push it to other feeds too using the `to` field
-data = [
-    :actor_id => '1',
-    :verb => 'like',
-    :object_id => '3',
-    :to => %w(user:44 user:45)
-]
+data = [actor_id: '1', verb: 'like', object_id: '3', to: %w[user:44 user:45]]
 user_feed_1.add_activity(data)
 
-
 # Updating parts of an activity
 set = {
-  'product.price': 19.99,
-  'shares': {
-    'facebook': '...',
-    'twitter': '...'
-  },
+  'product.price': 19.99, 'shares': { 'facebook': '...', 'twitter': '...' }
 }
-unset = [
-    'daily_likes',
-    'popularity'
-]
+unset = %w[daily_likes popularity]
 # ...by ID
 client.activity_partial_update(
-  id: '54a60c1e-4ee3-494b-a1e3-50c06acb5ed4',
-  set: set,
-  unset: unset,
+  id: '54a60c1e-4ee3-494b-a1e3-50c06acb5ed4', set: set, unset: unset
 )
 # ...or by combination of foreign ID and time
 client.activity_partial_update(
   foreign_id: 'product:123',
   time: '2016-11-10T13:20:00.000000',
   set: set,
-  unset: unset,
+  unset: unset
 )
 
 # Generating tokens for client side usage
 token = user_feed_1.readonly_token
 
 # Javascript client side feed initialization
-user1 = client.feed('user', '1', '{{ token }}');
+user1 = client.feed('user', '1', '{{ token }}')
 
 # Retrieve first 10 followers of a feed
 user_feed_1.followers(0, 10)
@@ -145,16 +138,21 @@ user_feed_1.following(10)
 user_feed_1.following(10, 10)
 
 # Check if user_feed_1 follows specific feeds
-user_feed_1.following(0, 2, filter=['user:42', 'user:43'])
+user_feed_1.following(0, 2, filter = %w[user:42 user:43])
 
 # Add one activity to many feeds in one request
-feeds = %w(flat:1 flat:2 flat:3 flat:4)
-activity = {:actor => "User:2", :verb => "pin", :object => "Place:42", :target => "Board:1"}
+feeds = %w[flat:1 flat:2 flat:3 flat:4]
+activity = {
+  actor: 'User:2', verb: 'pin', object: 'Place:42', target: 'Board:1'
+}
 client.add_to_many(activity, feeds)
+
+# Retrive open graph information
+client.og('https://google.com')
 ```
 
 ### Copyright and License Information
 
-Copyright (c) 2014-2018 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/activities.rb

@@ -1,6 +1,5 @@
 module Stream
   module Activities
-
     #
     # Get activities directly, via ID or Foreign ID + timestamp
     #
@@ -8,34 +7,33 @@ module Stream
     #
     # @return the found activities, if any.
     #
-    # @example
-    #
+    # @example Retrieve by activity IDs
+    #   @client.get_activities(
+    #     ids: [
+    #       '4b39fda2-d6e2-42c9-9abf-5301ef071b12',
+    #       '89b910d3-1ef5-44f8-914e-e7735d79e817'
+    #     ]
+    #   )
     #
-    # @client.get_activities(
-    #   ids: [
-    #     '4b39fda2-d6e2-42c9-9abf-5301ef071b12',
-    #     '89b910d3-1ef5-44f8-914e-e7735d79e817'
-    #   ]
-    # )
-    #
-    # @client.get_activities(
-    #   foreign_id_times: [
-    #     { foreign_id: 'post:1000', time: '2016-11-10T13:20:00.000000' },
-    #     { foreign_id: 'like:2000', time: '2018-01-07T09:15:59.123456' }
-    #   ]
-    # )
+    # @example Retrieve by Foreign IDs + timestamps
+    #   @client.get_activities(
+    #     foreign_id_times: [
+    #       { foreign_id: 'post:1000', time: '2016-11-10T13:20:00.000000' },
+    #       { foreign_id: 'like:2000', time: '2018-01-07T09:15:59.123456' }
+    #     ]
+    #   )
     #
     def get_activities(params = {})
       if params[:foreign_id_times]
         foreign_ids = []
         timestamps = []
-        params[:foreign_id_times].each{|e|
+        params[:foreign_id_times].each do |e|
           foreign_ids << e[:foreign_id]
           timestamps << e[:time]
-        }
+        end
         params = {
           foreign_ids: foreign_ids,
-          timestamps: timestamps,
+          timestamps: timestamps
         }
       end
       signature = Stream::Signer.create_jwt_token('activities', '*', @api_secret, '*')
@@ -43,42 +41,108 @@ module Stream
     end
 
     #
-    # Partial update activity, via foreign ID or Foreign ID + timestamp
+    # Partial update activity, via activity ID or Foreign ID + timestamp
     #
     # @param [Hash<:id, :foreign_id, :time, :set, :unset>] data the request params (id and foreign_id+timestamp mutually exclusive)
     #
     # @return the updated activity.
     #
-    # @example
-    #
-    # @client.activity_partial_update(
-    #   id: "4b39fda2-d6e2-42c9-9abf-5301ef071b12",
-    #   set: {
-    #    "product.price.eur": 12.99,
-    #    "colors": {
-    #      "blue": "#0000ff",
-    #      "green": "#00ff00",
-    #    }
-    #   },
-    #   unset: [ "popularity", "size.xl" ]
-    # )
-    #
-    # @client.activity_partial_update(
-    #   foreign_id: 'product:123',
-    #   time: '2016-11-10T13:20:00.000000',
-    #   set: {
-    #    "product.price.eur": 12.99,
-    #    "colors": {
-    #      "blue": "#0000ff",
-    #      "green": "#00ff00",
-    #    }
-    #   },
-    #   unset: [ "popularity", "size.xl" ]
-    # )
+    # @example Identify using activity ID
+    #   @client.activity_partial_update(
+    #     id: "4b39fda2-d6e2-42c9-9abf-5301ef071b12",
+    #     set: {
+    #       "product.price.eur": 12.99,
+    #       "colors": {
+    #         "blue": "#0000ff",
+    #         "green": "#00ff00",
+    #       }
+    #     },
+    #     unset: [ "popularity", "size.xl" ]
+    #   )
+    #
+    # @example Identify using Foreign ID + timestamp
+    #   @client.activity_partial_update(
+    #     foreign_id: 'product:123',
+    #     time: '2016-11-10T13:20:00.000000',
+    #     set: {
+    #      "product.price.eur": 12.99,
+    #      "colors": {
+    #        "blue": "#0000ff",
+    #        "green": "#00ff00",
+    #      }
+    #     },
+    #     unset: [ "popularity", "size.xl" ]
+    #   )
+    #
     def activity_partial_update(data = {})
       signature = Stream::Signer.create_jwt_token('activities', '*', @api_secret, '*')
       make_request(:post, '/activity/', signature, {}, data)
     end
 
+    #
+    # Batch partial activity update
+    #
+    # @param [Array< Hash<:id, :foreign_id, :time, :set, :unset> >] changes the list of changes to be applied
+    #
+    # @return the updated activities
+    #
+    # @example Identify using activity IDs
+    #   @client.batch_activity_partial_update([
+    #     {
+    #       id: "4b39fda2-d6e2-42c9-9abf-5301ef071b12",
+    #       set: {
+    #         "product.price.eur": 12.99,
+    #         "colors": {
+    #           "blue": "#0000ff",
+    #           "green": "#00ff00",
+    #         }
+    #       },
+    #       unset: [ "popularity", "size.x2" ]
+    #     },
+    #     {
+    #       id: "8d2dcad8-1e34-11e9-8b10-9cb6d0925edd",
+    #       set: {
+    #         "product.price.eur": 17.99,
+    #         "colors": {
+    #           "red": "#ff0000",
+    #           "green": "#00ff00",
+    #         }
+    #       },
+    #       unset: [ "rating" ]
+    #     }
+    #   ])
+    #
+    # @example Identify using Foreign IDs + timestamps
+    #   @client.batch_activity_partial_update([
+    #     {
+    #       foreign_id: "product:123",
+    #       time: '2016-11-10T13:20:00.000000',
+    #       set: {
+    #         "product.price.eur": 22.99,
+    #         "colors": {
+    #           "blue": "#0000ff",
+    #           "green": "#00ff00",
+    #         }
+    #       },
+    #       unset: [ "popularity", "size.x2" ]
+    #     },
+    #     {
+    #       foreign_id: "product:1234",
+    #       time: '2017-11-10T13:20:00.000000',
+    #       set: {
+    #         "product.price.eur": 37.99,
+    #         "colors": {
+    #           "black": "#000000",
+    #           "white": "#ffffff",
+    #         }
+    #       },
+    #       unset: [ "rating" ]
+    #     }
+    #   ])
+    #
+    def batch_activity_partial_update(changes = [])
+      signature = Stream::Signer.create_jwt_token('activities', '*', @api_secret, '*')
+      make_request(:post, '/activity/', signature, {}, { changes: changes })
+    end
   end
 end

data/lib/stream/batch.rb

@@ -8,19 +8,15 @@ module Stream
     # @return [nil]
     #
     # @example
-    #
-    #
-    # follows = [
-    #   {:source => 'flat:1', :target => 'user:1'},
-    #   {:source => 'flat:1', :target => 'user:3'}
-    # ]
-    # @client.follow_many(follows)
+    #   follows = [
+    #     {:source => 'flat:1', :target => 'user:1'},
+    #     {:source => 'flat:1', :target => 'user:3'}
+    #   ]
+    #   @client.follow_many(follows)
     #
     def follow_many(follows, activity_copy_limit = nil)
       query_params = {}
-      unless activity_copy_limit.nil?
-        query_params['activity_copy_limit'] = activity_copy_limit
-      end
+      query_params['activity_copy_limit'] = activity_copy_limit unless activity_copy_limit.nil?
       signature = Stream::Signer.create_jwt_token('follower', '*', @api_secret, '*')
       make_request(:post, '/follow_many/', signature, query_params, follows)
     end
@@ -33,13 +29,11 @@ module Stream
     # return [nil]
     #
     # @example
-    #
-    #
-    # unfollows = [
-    #   {source: 'user:1', target: 'timeline:1'},
-    #   {source: 'user:2', target: 'timeline:2', keep_history: false}
-    # ]
-    # @client.unfollow_many(unfollows)
+    #   unfollows = [
+    #     {source: 'user:1', target: 'timeline:1'},
+    #     {source: 'user:2', target: 'timeline:2', keep_history: false}
+    #   ]
+    #   @client.unfollow_many(unfollows)
     #
     def unfollow_many(unfollows)
       signature = Stream::Signer.create_jwt_token('follower', '*', @api_secret, '*')
@@ -56,8 +50,8 @@ module Stream
     #
     def add_to_many(activity_data, feeds)
       data = {
-        :feeds => feeds,
-        :activity => activity_data
+        feeds: feeds,
+        activity: activity_data
       }
       signature = Stream::Signer.create_jwt_token('feed', '*', @api_secret, '*')
       make_request(:post, '/feed/add_to_many/', signature, {}, data)

data/lib/stream/client.rb

@@ -5,8 +5,8 @@ require 'stream/signer'
 require 'stream/url'
 
 module Stream
-  STREAM_URL_COM_RE = %r{https\:\/\/(?<key>\w+)\:(?<secret>\w+)@((api\.)|((?<location>[-\w]+)\.))?(?<api_hostname>stream-io-api\.com)\/[\w=-\?%&]+app_id=(?<app_id>\d+)}i
-  STREAM_URL_IO_RE = %r{https\:\/\/(?<key>\w+)\:(?<secret>\w+)@((api\.)|((?<location>[-\w]+)\.))?(?<api_hostname>getstream\.io)\/[\w=-\?%&]+app_id=(?<app_id>\d+)}i
+  STREAM_URL_COM_RE = %r{https://(?<key>\w+):(?<secret>\w+)@((api\.)|((?<location>[-\w]+)\.))?(?<api_hostname>stream-io-api\.com)/[\w=-?%&]+app_id=(?<app_id>\d+)}i.freeze
+  STREAM_URL_IO_RE = %r{https://(?<key>\w+):(?<secret>\w+)@((api\.)|((?<location>[-\w]+)\.))?(?<api_hostname>getstream\.io)/[\w=-?%&]+app_id=(?<app_id>\d+)}i.freeze
 
   class Client
     attr_reader :api_key
@@ -36,7 +36,6 @@ module Stream
     #   Stream::Client.new('my_key', 'my_secret', 'my_app_id', :location => 'us-east')
     #
     def initialize(api_key = '', api_secret = '', app_id = nil, opts = {})
-
       if api_key.nil? || api_key.empty?
         env_url = ENV['STREAM_URL']
         if env_url =~ Stream::STREAM_URL_COM_RE
@@ -100,7 +99,7 @@ module Stream
     # @return [string]
     #
     def create_user_token(user_id, extra_data = {})
-      return Stream::Signer.create_user_token(user_id, extra_data, api_secret)
+      Stream::Signer.create_user_token(user_id, extra_data, api_secret)
     end
 
     def personalization
@@ -128,22 +127,26 @@ module Stream
       make_request(:post, '/activities/', auth_token, {}, 'activities' => activities)
     end
 
+    def og(uri)
+      auth_token = Stream::Signer.create_jwt_token('*', '*', @api_secret, '*')
+      make_request(:get, '/og', auth_token, { url: uri })
+    end
+
     def get_default_params
-      {:api_key => @api_key}
+      { api_key: @api_key }
     end
 
     def get_http_client
-      @http_client ||= StreamHTTPClient.new(url_generator)
+      @get_http_client ||= StreamHTTPClient.new(url_generator)
     end
 
     def make_query_params(params)
-      Hash[get_default_params.merge(params).sort_by {|k, v| k.to_s}]
+      get_default_params.merge(params).sort_by { |k, _v| k.to_s }.to_h
     end
 
     def make_request(method, relative_url, signature, params = {}, data = {}, headers = {})
       headers['Authorization'] = signature
       headers['stream-auth-type'] = 'jwt'
-
       get_http_client.make_http_request(method, relative_url, make_query_params(params), data, headers)
     end
 
@@ -188,7 +191,7 @@ module Stream
 
       case response[:status].to_i
       when 200..203
-        return ::JSON.parse(response[:body])
+        ::JSON.parse(response[:body])
       end
     end
   end
@@ -197,16 +200,16 @@ module Stream
     def call(env)
       @app.call(env).on_complete do |response|
         case response[:status].to_i
-          when 200..203
-            return response
-          when 401
-            raise StreamApiResponseException, error_message(response, 'Bad feed')
-          when 403
-            raise StreamApiResponseException, error_message(response, 'Bad auth/headers')
-          when 404
-            raise StreamApiResponseException, error_message(response, 'url not found')
-          when 204...600
-            raise StreamApiResponseException, error_message(response, _build_error_message(response.body))
+        when 200..203
+          return response
+        when 401
+          raise StreamApiResponseException, error_message(response, 'Bad feed')
+        when 403
+          raise StreamApiResponseException, error_message(response, 'Bad auth/headers')
+        when 404
+          raise StreamApiResponseException, error_message(response, 'url not found')
+        when 204...600
+          raise StreamApiResponseException, error_message(response, _build_error_message(response.body))
         end
       end
     end
@@ -230,7 +233,7 @@ module Stream
     end
 
     def error_message(response, body = nil)
-      "#{response[:method].to_s.upcase} #{response[:url]}: #{[response[:status].to_s + ':', body].compact.join(' ')}"
+      "#{response[:method].to_s.upcase} #{response[:url]}: #{["#{response[:status]}:", body].compact.join(' ')}"
     end
   end
 end

data/lib/stream/collections.rb

@@ -4,15 +4,15 @@ module Stream
       data = {
         id: id,
         user_id: user_id,
-        data: collection_data,
+        data: collection_data
       }
       uri = "/collections/#{collection_name}/"
-      make_collection_request(:post, {}, data, :endpoint => uri)
+      make_collection_request(:post, {}, data, endpoint: uri)
     end
 
     def get(collection_name, id)
       uri = "collections/#{collection_name}/#{id}/"
-      make_collection_request(:get, {}, {}, :endpoint => uri)
+      make_collection_request(:get, {}, {}, endpoint: uri)
     end
 
     def update(collection_name, id, data: nil)
@@ -20,12 +20,12 @@ module Stream
         data: data
       }
       uri = "collections/#{collection_name}/#{id}/"
-      make_collection_request(:put, {}, data, :endpoint => uri)
+      make_collection_request(:put, {}, data, endpoint: uri)
     end
 
     def delete(collection_name, id)
       uri = "collections/#{collection_name}/#{id}/"
-      make_collection_request(:delete, {}, {}, :endpoint => uri)
+      make_collection_request(:delete, {}, {}, endpoint: uri)
     end
 
     def upsert(collection, objects = [])
@@ -53,11 +53,9 @@ module Stream
     end
 
     def create_reference(collection, id)
-      _id = id
-      if id.respond_to?(:keys) and !id["id"].nil?
-        _id = id["id"]
-      end
-      "SO:#{collection}:#{_id}"
+      k = id
+      k = id['id'] if id.respond_to?(:keys) && !id['id'].nil?
+      "SO:#{collection}:#{k}"
     end
 
     private

data/lib/stream/errors.rb

@@ -1,5 +1,7 @@
 module Stream
   class Error < StandardError; end
+
   class StreamApiResponseException < Error; end
+
   class StreamInputData < Error; end
 end

data/lib/stream/feed.rb

@@ -8,13 +8,9 @@ module Stream
     attr_reader :user_id
 
     def initialize(client, feed_slug, user_id)
-      unless valid_feed_slug feed_slug
-        raise StreamInputData, 'feed_slug can only contain alphanumeric characters plus underscores'
-      end
+      raise StreamInputData, 'feed_slug can only contain alphanumeric characters plus underscores' unless valid_feed_slug feed_slug
 
-      unless valid_user_id user_id
-        raise StreamInputData, 'user_id can only contain alphanumeric characters plus underscores and dashes'
-      end
+      raise StreamInputData, 'user_id can only contain alphanumeric characters plus underscores and dashes' unless valid_user_id user_id
 
       @id = "#{feed_slug}:#{user_id}"
       @client = client
@@ -37,29 +33,19 @@ module Stream
     end
 
     def get(params = {})
-      if params[:enrich] or params[:reactions]
-        uri = "/enrich/feed/#{@feed_url}/"
-      else
-        uri = "/feed/#{@feed_url}/"
-      end
-      if params[:mark_read] && params[:mark_read].is_a?(Array)
-        params[:mark_read] = params[:mark_read].join(',')
-      end
-      if params[:mark_seen] && params[:mark_seen].is_a?(Array)
-        params[:mark_seen] = params[:mark_seen].join(',')
-      end
+      uri = if params[:enrich] || params[:reactions]
+              "/enrich/feed/#{@feed_url}/"
+            else
+              "/feed/#{@feed_url}/"
+            end
+      params[:mark_read] = params[:mark_read].join(',') if params[:mark_read]&.is_a?(Array)
+      params[:mark_seen] = params[:mark_seen].join(',') if params[:mark_seen]&.is_a?(Array)
       if params[:reactions].respond_to?(:keys)
-        if params[:reactions][:own]
-          params[:withOwnReactions] = true
-        end
-        if params[:reactions][:recent]
-          params[:withRecentReactions] = true
-        end
-        if params[:reactions][:counts]
-          params[:withReactionCounts] = true
-        end
+        params[:withOwnReactions] = true if params[:reactions][:own]
+        params[:withRecentReactions] = true if params[:reactions][:recent]
+        params[:withReactionCounts] = true if params[:reactions][:counts]
       end
-      [:enrich, :reactions].each { |k| params.delete(k) }
+      %i[enrich reactions].each { |k| params.delete(k) }
 
       auth_token = create_jwt_token('feed', 'read')
       @client.make_request(:get, uri, auth_token, params)
@@ -75,20 +61,20 @@ module Stream
 
     def add_activities(activities)
       uri = "/feed/#{@feed_url}/"
-      data = {:activities => activities}
+      data = { activities: activities }
       auth_token = create_jwt_token('feed', 'write')
 
       @client.make_request(:post, uri, auth_token, {}, data)
     end
 
-    def remove(activity_id, foreign_id = false)
-      remove_activity(activity_id, foreign_id)
+    def remove(activity_id, foreign_id: false)
+      remove_activity(activity_id, foreign_id: foreign_id)
     end
 
-    def remove_activity(activity_id, foreign_id = false)
+    def remove_activity(activity_id, foreign_id: false)
       uri = "/feed/#{@feed_url}/#{activity_id}/"
       params = {}
-      params = {foreign_id: 1} if foreign_id
+      params = { foreign_id: 1 } if foreign_id
       auth_token = create_jwt_token('feed', 'delete')
 
       @client.make_request(:delete, uri, auth_token, params)
@@ -107,19 +93,13 @@ module Stream
     def update_activity_to_targets(foreign_id, time, new_targets: nil, added_targets: nil, removed_targets: nil)
       uri = "/feed_targets/#{@feed_url}/activity_to_targets/"
       data = {
-        'foreign_id': foreign_id,
-        'time': time
+        foreign_id: foreign_id,
+        time: time
       }
 
-      if !new_targets.nil?
-        data['new_targets'] = new_targets
-      end
-      if !added_targets.nil?
-        data['added_targets'] = added_targets
-      end
-      if !removed_targets.nil?
-        data['removed_targets'] = removed_targets
-      end
+      data['new_targets'] = new_targets unless new_targets.nil?
+      data['added_targets'] = added_targets unless added_targets.nil?
+      data['removed_targets'] = removed_targets unless removed_targets.nil?
       auth_token = create_jwt_token('feed_targets', 'write')
 
       @client.make_request(:post, uri, auth_token, {}, data)
@@ -127,12 +107,12 @@ module Stream
 
     def follow(target_feed_slug, target_user_id, activity_copy_limit = 300)
       uri = "/feed/#{@feed_url}/follows/"
-      activity_copy_limit = 0 if activity_copy_limit < 0
+      activity_copy_limit = 0 if activity_copy_limit.negative?
       activity_copy_limit = 1000 if activity_copy_limit > 1000
 
       follow_data = {
-          target: "#{target_feed_slug}:#{target_user_id}",
-          activity_copy_limit: activity_copy_limit
+        target: "#{target_feed_slug}:#{target_user_id}",
+        activity_copy_limit: activity_copy_limit
       }
       auth_token = create_jwt_token('follower', 'write')
 
@@ -142,8 +122,8 @@ module Stream
     def followers(offset = 0, limit = 25)
       uri = "/feed/#{@feed_url}/followers/"
       params = {
-          offset: offset,
-          limit: limit
+        offset: offset,
+        limit: limit
       }
       auth_token = create_jwt_token('follower', 'read')
 
@@ -153,16 +133,16 @@ module Stream
     def following(offset = 0, limit = 25, filter = [])
       uri = "/feed/#{@feed_url}/follows/"
       params = {
-          offset: offset,
-          limit: limit,
-          filter: filter.join(',')
+        offset: offset,
+        limit: limit,
+        filter: filter.join(',')
       }
       auth_token = create_jwt_token('follower', 'read')
 
       @client.make_request(:get, uri, auth_token, params)
     end
 
-    def unfollow(target_feed_slug, target_user_id, keep_history = false)
+    def unfollow(target_feed_slug, target_user_id, keep_history: false)
       uri = "/feed/#{@feed_url}/follows/#{target_feed_slug}:#{target_user_id}/"
       auth_token = create_jwt_token('follower', 'delete')
       params = {}

data/lib/stream/reactions.rb

@@ -13,7 +13,7 @@ module Stream
 
     def get(reaction_id)
       uri = "/reaction/#{reaction_id}/"
-      make_reaction_request(:get, {}, {}, :endpoint => uri)
+      make_reaction_request(:get, {}, {}, endpoint: uri)
     end
 
     def update(reaction_id, data: nil, target_feeds: nil)
@@ -22,12 +22,12 @@ module Stream
         target_feeds: target_feeds
       }
       uri = "/reaction/#{reaction_id}/"
-      make_reaction_request(:put, {}, data, :endpoint => uri)
+      make_reaction_request(:put, {}, data, endpoint: uri)
     end
 
     def delete(reaction_id)
       uri = "/reaction/#{reaction_id}/"
-      make_reaction_request(:delete, {}, {}, :endpoint => uri)
+      make_reaction_request(:delete, {}, {}, endpoint: uri)
     end
 
     def add_child(kind, parent_id, user_id, data: nil, target_feeds: nil)
@@ -42,36 +42,32 @@ module Stream
     end
 
     def filter(params = {})
-      lookup_field = ""
-      lookup_value = ""
-      kind = params.fetch(:kind, "")
+      field = ''
+      value = ''
+      kind = params.fetch(:kind, '')
       if params[:reaction_id]
-        lookup_field = "reaction_id"
-        lookup_value = params[:reaction_id]
+        field = 'reaction_id'
+        value = params[:reaction_id]
       elsif params[:activity_id]
-        lookup_field = "activity_id"
-        lookup_value = params[:activity_id]
+        field = 'activity_id'
+        value = params[:activity_id]
       elsif params[:user_id]
-        lookup_field = "user_id"
-        lookup_value = params[:user_id]
+        field = 'user_id'
+        value = params[:user_id]
       end
-      unless lookup_field.empty?
-        params.delete(lookup_field.to_sym)
-      end
-      if kind.nil? || kind.empty?
-        uri = "/reaction/#{lookup_field}/#{lookup_value}/"
-      else
-        uri = "/reaction/#{lookup_field}/#{lookup_value}/#{kind}/"
-      end
-      make_reaction_request(:get, params, {}, :endpoint => uri)
+      params.delete(field.to_sym) unless field.empty?
+      uri = if kind.nil? || kind.empty?
+              "/reaction/#{field}/#{value}/"
+            else
+              "/reaction/#{field}/#{value}/#{kind}/"
+            end
+      make_reaction_request(:get, params, {}, endpoint: uri)
     end
 
     def create_reference(id)
-      _id = id
-      if id.respond_to?(:keys) and !id["id"].nil?
-        _id = id["id"]
-      end
-      "SR:#{_id}"
+      k = id
+      k = id['id'] if id.respond_to?(:keys) && !id['id'].nil?
+      "SR:#{k}"
     end
 
     private

data/lib/stream/signer.rb

@@ -11,13 +11,13 @@ module Stream
 
     def self.create_user_token(user_id, payload = {}, api_secret)
       payload['user_id'] = user_id
-      return JWT.encode(payload, api_secret, 'HS256')
+      JWT.encode(payload, api_secret, 'HS256')
     end
 
     def self.create_jwt_token(resource, action, api_secret, feed_id = nil, user_id = nil)
       payload = {
-          resource: resource,
-          action: action
+        resource: resource,
+        action: action
       }
       payload['feed_id'] = feed_id if feed_id
       payload['user_id'] = user_id if user_id

data/lib/stream/url.rb

@@ -7,10 +7,11 @@ module Stream
 
   class APIURLGenerator < URLGenerator
     def initialize(options)
+      super()
       @options = options
       location = make_location(options[:location])
-      location ||= "api"
-      api_version = options[:api_version] ? options[:api_version] : 'v1.0'
+      location ||= 'api'
+      api_version = options[:api_version] || 'v1.0'
       if ENV['STREAM_URL']
         uri = URI.parse(ENV['STREAM_URL'])
         scheme = uri.scheme
@@ -48,6 +49,7 @@ module Stream
 
   class PersonalizationURLGenerator < URLGenerator
     def initialize(options)
+      super()
       @options = options
       host = 'personalization.stream-io-api.com'
       @base_path = '/personalization/v1.0'

data/lib/stream/users.rb

@@ -13,7 +13,7 @@ module Stream
 
     def get(user_id)
       uri = "/user/#{user_id}/"
-      make_user_request(:get, {}, {}, :endpoint => uri)
+      make_user_request(:get, {}, {}, endpoint: uri)
     end
 
     def update(user_id, data: nil)
@@ -21,20 +21,18 @@ module Stream
         data: data
       }
       uri = "/user/#{user_id}/"
-      make_user_request(:put, {}, data, :endpoint => uri)
+      make_user_request(:put, {}, data, endpoint: uri)
     end
 
     def delete(user_id)
       uri = "/user/#{user_id}/"
-      make_user_request(:delete, {}, {}, :endpoint => uri)
+      make_user_request(:delete, {}, {}, endpoint: uri)
     end
 
     def create_reference(id)
-      _id = id
-      if id.respond_to?(:keys) and !id["id"].nil?
-        _id = id["id"]
-      end
-      "SU:#{_id}"
+      k = id
+      k = id['id'] if id.respond_to?(:keys) && !id['id'].nil?
+      "SU:#{k}"
     end
 
     private

data/lib/stream/version.rb

@@ -1,3 +1,3 @@
 module Stream
-  VERSION = '3.0.1'.freeze
+  VERSION = '4.1.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stream-ruby
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 4.1.0
 platform: ruby
 authors:
 - Tommaso Barbugli
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-19 00:00:00.000000000 Z
+date: 2021-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -18,82 +18,70 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: jwt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.0
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.0
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0'
 description: Ruby client for getstream.io service
 email: support@getstream.io
 executables: []
@@ -131,15 +119,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 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