stream-ruby 2.11.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f26943443ea8de097cbb217a65dece67cca94aba
-  data.tar.gz: a04acc92c85377c27e9a9717200296fa7619f99d
+  metadata.gz: 0a849b72e60913e35cf4421a4fa2a0b21868e4c6
+  data.tar.gz: 2e4c8ede31bfdc3c52399314e85ec91b9bb56d0c
 SHA512:
-  metadata.gz: 50c56c98e7495420010c69d3d0c0b343c3ab831dd72f519e4222f3018f3d1fe4a6e4230f68f71f46b683401babd3ec38d60722ef28d29d0c9c3ef0e176d1f03d
-  data.tar.gz: a4d9c7ec93c0cd17f1e99e12fc5f36d347c306aca672deec071ffd3abebc219b337bc0c96f039cd6c308f5f0c45e54003ad6095f74b0ea12282473d50ed7da8d
+  metadata.gz: 0d0888b3107241fb182bc974aed6ee4ac3a3592d45af7d0c19c6704b703f31c157364398b1297302b2ebdd212694f8e96f428e98122c2ab2d5b494e2c25d901b
+  data.tar.gz: ce762dc8de16554e74476bf57b5722127c40ab665e58b27ad711f3f3e453f423ed2b81c17008f8b746558edf36052ab48cc7e5ccd88a915d3561b4b7d395f705

data/README.md

@@ -11,12 +11,11 @@ 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.8 at a minimum. We will support the following versions:
-- 2.2.8
-- 2.3.1
-- 2.3.5
-- 2.4.2
-- 2.5.1
+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
 
 See the [Travis configuration](.travis.yml) for details of how it is built and tested.
 
@@ -156,6 +155,6 @@ client.add_to_many(activity, feeds)
 
 ### Copyright and License Information
 
-Copyright (c) 2014-2017 Stream.io Inc, and individual contributors. All rights reserved.
+Copyright (c) 2014-2018 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/batch.rb

@@ -21,7 +21,8 @@ module Stream
       unless activity_copy_limit.nil?
         query_params['activity_copy_limit'] = activity_copy_limit
       end
-      make_signed_request(:post, '/follow_many/', query_params, follows)
+      signature = Stream::Signer.create_jwt_token('follower', '*', @api_secret, '*')
+      make_request(:post, '/follow_many/', signature, query_params, follows)
     end
 
     #
@@ -41,9 +42,10 @@ module Stream
     # @client.unfollow_many(unfollows)
     #
     def unfollow_many(unfollows)
-      make_signed_request(:post, '/unfollow_many/', {}, unfollows)
+      signature = Stream::Signer.create_jwt_token('follower', '*', @api_secret, '*')
+      make_request(:post, '/unfollow_many/', signature, {}, unfollows)
     end
-    
+
     #
     # Adds an activity to many feeds in one single request
     #
@@ -57,7 +59,8 @@ module Stream
         :feeds => feeds,
         :activity => activity_data
       }
-      make_signed_request(:post, '/feed/add_to_many/', {}, data)
+      signature = Stream::Signer.create_jwt_token('feed', '*', @api_secret, '*')
+      make_request(:post, '/feed/add_to_many/', signature, {}, data)
     end
   end
 end

data/lib/stream/client.rb

@@ -14,17 +14,15 @@ module Stream
     attr_reader :app_id
     attr_reader :client_options
 
-    if RUBY_VERSION.to_f >= 2.1
-      require 'stream/batch'
-      require 'stream/signedrequest'
-      require 'stream/personalization'
-      require 'stream/collections'
-      require 'stream/activities'
+    require 'stream/batch'
+    require 'stream/personalization'
+    require 'stream/collections'
+    require 'stream/activities'
+    require 'stream/reactions'
+    require 'stream/users'
 
-      include Stream::SignedRequest
-      include Stream::Batch
-      include Stream::Activities
-    end
+    include Stream::Batch
+    include Stream::Activities
 
     #
     # initializes a Stream API Client
@@ -38,6 +36,7 @@ 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
@@ -46,7 +45,7 @@ module Stream
           re = Stream::STREAM_URL_IO_RE
         end
         raise ArgumentError, 'empty api_key parameter and missing or invalid STREAM_URL env variable' unless re
-        
+
         matches = re.match(ENV['STREAM_URL'])
         api_key = matches['key']
         api_secret = matches['secret']
@@ -77,12 +76,31 @@ module Stream
     # @return [Stream::Feed]
     #
     def feed(feed_slug, user_id)
-      token = @signer.sign(feed_slug, user_id)
-      Stream::Feed.new(self, feed_slug, user_id, token)
+      Stream::Feed.new(self, feed_slug, user_id)
     end
 
+    # Creates a user token
+    #
+    # @deprecated Use Client#create_user_token instead
+    #
+    # @param [string] user_id the user_if of this token (e.g. User42)
+    # @param [hash] extra_data additional token data
+    #
+    # @return [string]
+    #
     def create_user_session_token(user_id, extra_data = {})
-      return Stream::Signer.create_user_session_token(user_id, extra_data, api_secret)
+      create_user_token(user_id, extra_data)
+    end
+
+    # Creates a user token
+    #
+    # @param [string] user_id the user_if of this token (e.g. User42)
+    # @param [hash] extra_data additional token data
+    #
+    # @return [string]
+    #
+    def create_user_token(user_id, extra_data = {})
+      return Stream::Signer.create_user_token(user_id, extra_data, api_secret)
     end
 
     def personalization
@@ -93,6 +111,14 @@ module Stream
       CollectionsClient.new(api_key, api_secret, app_id, client_options)
     end
 
+    def reactions
+      ReactionsClient.new(api_key, api_secret, app_id, client_options)
+    end
+
+    def users
+      UsersClient.new(api_key, api_secret, app_id, client_options)
+    end
+
     def update_activity(activity)
       update_activities([activity])
     end

data/lib/stream/collections.rb

@@ -1,5 +1,33 @@
 module Stream
   class CollectionsClient < Client
+    def add(collection_name, collection_data, id: nil, user_id: nil)
+      data = {
+        id: id,
+        user_id: user_id,
+        data: collection_data,
+      }
+      uri = "/collections/#{collection_name}/"
+      make_collection_request(:post, {}, data, :endpoint => uri)
+    end
+
+    def get(collection_name, id)
+      uri = "collections/#{collection_name}/#{id}/"
+      make_collection_request(:get, {}, {}, :endpoint => uri)
+    end
+
+    def update(collection_name, id, data: nil)
+      data = {
+        data: data
+      }
+      uri = "collections/#{collection_name}/#{id}/"
+      make_collection_request(:put, {}, data, :endpoint => uri)
+    end
+
+    def delete(collection_name, id)
+      uri = "collections/#{collection_name}/#{id}/"
+      make_collection_request(:delete, {}, {}, :endpoint => uri)
+    end
+
     def upsert(collection, objects = [])
       data = {
         data: {
@@ -9,14 +37,14 @@ module Stream
       make_collection_request(:post, {}, data)
     end
 
-    def get(collection, ids = [])
+    def select(collection, ids = [])
       params = {
         foreign_ids: ids.map { |id| "#{collection}:#{id}" }.join(',')
       }
       make_collection_request(:get, params, {})
     end
 
-    def delete(collection, ids = [])
+    def delete_many(collection, ids = [])
       params = {
         collection_name: collection,
         ids: ids.join(',')
@@ -25,17 +53,16 @@ module Stream
     end
 
     def create_reference(collection, id)
-      "SO:#{collection}:#{id}"
-    end
-
-    def create_user_reference(id)
-      create_reference('user', id)
+      _id = id
+      if id.respond_to?(:keys) and !id["id"].nil?
+        _id = id["id"]
+      end
+      "SO:#{collection}:#{_id}"
     end
 
     private
 
-    def make_collection_request(method, params, data)
-      endpoint = '/meta/'
+    def make_collection_request(method, params, data, endpoint: '/collections/')
       auth_token = Stream::Signer.create_jwt_token('collections', '*', @api_secret, '*', '*')
       make_request(method, endpoint, auth_token, params, data)
     end

data/lib/stream/feed.rb

@@ -6,9 +6,8 @@ module Stream
     attr_reader :id
     attr_reader :slug
     attr_reader :user_id
-    attr_reader :token
 
-    def initialize(client, feed_slug, user_id, token)
+    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
@@ -23,7 +22,6 @@ module Stream
       @slug = feed_slug
       @feed_name = "#{feed_slug}#{user_id}"
       @feed_url = "#{feed_slug}/#{user_id}"
-      @token = token
     end
 
     def readonly_token
@@ -39,30 +37,37 @@ module Stream
     end
 
     def get(params = {})
-      uri = "/feed/#{@feed_url}/"
+      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
-      auth_token = create_jwt_token('feed', 'read')
+      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
+      end
+      [:enrich, :reactions].each { |k| params.delete(k) }
 
+      auth_token = create_jwt_token('feed', 'read')
       @client.make_request(:get, uri, auth_token, params)
     end
 
-    def sign_to_field(to)
-      to.map do |feed_id|
-        feed_slug, user_id = feed_id.split(':')
-        feed = @client.feed(feed_slug, user_id)
-        "#{feed.id} #{feed.token}"
-      end
-    end
-
     def add_activity(activity_data)
       uri = "/feed/#{@feed_url}/"
       data = activity_data.clone
-      data[:to] &&= sign_to_field(data[:to])
       auth_token = create_jwt_token('feed', 'write')
 
       @client.make_request(:post, uri, auth_token, {}, data)
@@ -70,9 +75,6 @@ module Stream
 
     def add_activities(activities)
       uri = "/feed/#{@feed_url}/"
-      activities.each do |activity|
-        activity[:to] &&= sign_to_field(activity[:to])
-      end
       data = {:activities => activities}
       auth_token = create_jwt_token('feed', 'write')
 
@@ -102,6 +104,27 @@ module Stream
       @client.make_request(:post, '/activities/', auth_token, {}, 'activities' => activities)
     end
 
+    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
+      }
+
+      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
+      auth_token = create_jwt_token('feed_targets', 'write')
+
+      @client.make_request(:post, uri, auth_token, {}, data)
+    end
+
     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
@@ -109,7 +132,6 @@ module Stream
 
       follow_data = {
           target: "#{target_feed_slug}:#{target_user_id}",
-          target_token: @client.feed(target_feed_slug, target_user_id).token,
           activity_copy_limit: activity_copy_limit
       }
       auth_token = create_jwt_token('follower', 'write')

data/lib/stream/reactions.rb

@@ -0,0 +1,84 @@
+module Stream
+  class ReactionsClient < Client
+    def add(kind, activity_id, user_id, data: nil, target_feeds: nil)
+      data = {
+        kind: kind,
+        activity_id: activity_id,
+        user_id: user_id,
+        data: data,
+        target_feeds: target_feeds
+      }
+      make_reaction_request(:post, {}, data)
+    end
+
+    def get(reaction_id)
+      uri = "/reaction/#{reaction_id}/"
+      make_reaction_request(:get, {}, {}, :endpoint => uri)
+    end
+
+    def update(reaction_id, data: nil, target_feeds: nil)
+      data = {
+        data: data,
+        target_feeds: target_feeds
+      }
+      uri = "/reaction/#{reaction_id}/"
+      make_reaction_request(:put, {}, data, :endpoint => uri)
+    end
+
+    def delete(reaction_id)
+      uri = "/reaction/#{reaction_id}/"
+      make_reaction_request(:delete, {}, data, :endpoint => uri)
+    end
+
+    def add_child(kind, parent_id, user_id, data: nil, target_feeds: nil)
+      data = {
+        kind: kind,
+        parent: parent_id,
+        user_id: user_id,
+        data: data,
+        target_feeds: target_feeds
+      }
+      make_reaction_request(:post, {}, data)
+    end
+
+    def filter(params = {})
+      lookup_field = ""
+      lookup_value = ""
+      kind = params.fetch(:kind, "")
+      if params[:reaction_id]
+        lookup_field = "reaction_id"
+        lookup_value = params[:reaction_id]
+      elsif params[:activity_id]
+        lookup_field = "activity_id"
+        lookup_value = params[:activity_id]
+      elsif params[:user_id]
+        lookup_field = "user_id"
+        lookup_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)
+    end
+
+    def create_reference(id)
+      _id = id
+      if id.respond_to?(:keys) and !id["id"].nil?
+        _id = id["id"]
+      end
+      "SR:#{_id}"
+    end
+
+    private
+
+    def make_reaction_request(method, params, data, endpoint: '/reaction/')
+      auth_token = Stream::Signer.create_jwt_token('reactions', '*', @api_secret, '*', '*')
+      make_request(method, endpoint, auth_token, params, data)
+    end
+  end
+end

data/lib/stream/signer.rb

@@ -7,24 +7,9 @@ module Stream
 
     def initialize(key)
       @key = key.to_s
-      @sha1 = OpenSSL::Digest.new('sha1')
     end
 
-    def urlsafe_encodeb64(value)
-      value.tr('+', '-').tr('/', '_').gsub(/^=+/, '').gsub(/=+$/, '')
-    end
-
-    def sign_message(message)
-      key = Digest::SHA1.digest @key.to_s
-      token = Base64.strict_encode64(OpenSSL::HMAC.digest(@sha1, key, message))
-      urlsafe_encodeb64(token)
-    end
-
-    def sign(feed_slug, user_id)
-      sign_message("#{feed_slug}#{user_id}")
-    end
-
-    def self.create_user_session_token(user_id, payload = {}, api_secret)
+    def self.create_user_token(user_id, payload = {}, api_secret)
       payload['user_id'] = user_id
       return JWT.encode(payload, api_secret, 'HS256')
     end

data/lib/stream/users.rb

@@ -0,0 +1,47 @@
+module Stream
+  class UsersClient < Client
+    def add(user_id, data: nil, get_or_create: false)
+      data = {
+        id: user_id,
+        data: data
+      }
+      params = {
+        get_or_create: get_or_create
+      }
+      make_user_request(:post, params, data)
+    end
+
+    def get(user_id)
+      uri = "/user/#{user_id}/"
+      make_user_request(:get, {}, {}, :endpoint => uri)
+    end
+
+    def update(user_id, data: nil)
+      data = {
+        data: data
+      }
+      uri = "/user/#{user_id}/"
+      make_user_request(:put, {}, data, :endpoint => uri)
+    end
+
+    def delete(user_id)
+      uri = "/user/#{user_id}/"
+      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}"
+    end
+
+    private
+
+    def make_user_request(method, params, data, endpoint: '/user/')
+      auth_token = Stream::Signer.create_jwt_token('users', '*', @api_secret, '*', '*')
+      make_request(method, endpoint, auth_token, params, data)
+    end
+  end
+end

data/lib/stream/version.rb

@@ -1,3 +1,3 @@
 module Stream
-  VERSION = '2.11.0'.freeze
+  VERSION = '3.0.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stream-ruby
 version: !ruby/object:Gem::Version
-  version: 2.11.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Tommaso Barbugli
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-30 00:00:00.000000000 Z
+date: 2018-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -32,20 +32,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: http_signatures
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: jwt
   requirement: !ruby/object:Gem::Requirement
@@ -128,9 +114,10 @@ files:
 - lib/stream/exceptions.rb
 - lib/stream/feed.rb
 - lib/stream/personalization.rb
-- lib/stream/signedrequest.rb
+- lib/stream/reactions.rb
 - lib/stream/signer.rb
 - lib/stream/url.rb
+- lib/stream/users.rb
 - lib/stream/version.rb
 homepage: http://github.com/GetStream/stream-ruby
 licenses:

data/lib/stream/signedrequest.rb

@@ -1,43 +0,0 @@
-require 'http_signatures'
-require 'net/http'
-require 'time'
-
-module Stream
-  module SignedRequest
-    module ClassMethods
-      def supports_signed_requests;
-      end
-    end
-
-    def self.included(klass)
-      klass.extend ClassMethods
-    end
-
-    def make_signed_request(method, relative_url, params = {}, data = {})
-      query_params = make_query_params(params)
-      context = HttpSignatures::Context.new(
-          keys: {@api_key => @api_secret},
-          algorithm: 'hmac-sha256',
-          headers: %w(date)
-      )
-      method_map = {
-          :get => Net::HTTP::Get,
-          :delete => Net::HTTP::Delete,
-          :put => Net::HTTP::Put,
-          :post => Net::HTTP::Post
-      }
-      request_date = Time.now.rfc822
-      message = method_map[method].new(
-          "#{get_http_client.base_path}#{relative_url}?#{URI.encode_www_form(query_params)}",
-          'date' => request_date
-      )
-      context.signer.sign(message)
-      headers = {
-          Authorization: message['Signature'],
-          Date: request_date,
-          'X-Api-Key' => api_key
-      }
-      get_http_client.make_http_request(method, relative_url, query_params, data, headers)
-    end
-  end
-end