stream-ruby 2.5.10 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3b58bcc7cb83f9424b45eb1e268e476d7f05717
-  data.tar.gz: a3d1ebe35bb26a98b51704acb074e3500d1d4863
+  metadata.gz: 499ca2934dbfc39668a3d3095aa6a1f616138d9d
+  data.tar.gz: 61ec2335f9983b4f111a873a6db1ea816324e28b
 SHA512:
-  metadata.gz: 93974c1a54ed500e6503632142f350c9381cbc77655566ce459b2f5f8acf63401b570135b78434a6b6945ffce3c601abfe6b85328c2dd5f366e6524e78d147fe
-  data.tar.gz: 114e765ba286365dea5aa1ef3611c85c7775904909bd64c3db5b5a98ced47650f6e89d142ebdd45261896583def6aa5eff31f9e1882bf522d7aae274d36377a9
+  metadata.gz: 7436d395e632dc67481c8e1f49d6011cac64ea4a7ef506b43cd022fa5170774c57ae52ba7635c254c2cbf28ea146d16c689577233fc518f3ee72f1c6e310da5c
+  data.tar.gz: 238c2e10cd26f1248cd2fe88d2b58668e440e08986d9a83c080aa44f7cb7378ddbceaa59576f862e5d68a875982a22e4c54dcaeb959389c2ac22dd484b7dadce

data/README.md

@@ -16,6 +16,7 @@ This API Client project requires Ruby 2.2.8 at a minimum. We will support the fo
 - 2.3.1
 - 2.3.5
 - 2.4.2
+- 2.5.1
 
 See the [Travis configuration](.travis.yml) for details of how it is built and tested.
 

data/lib/stream/client.rb

@@ -2,6 +2,7 @@ require 'faraday'
 require 'stream/errors'
 require 'stream/feed'
 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
@@ -16,6 +17,8 @@ module Stream
     if RUBY_VERSION.to_f >= 2.1
       require 'stream/batch'
       require 'stream/signedrequest'
+      require 'stream/personalization'
+      require 'stream/collections'
 
       include Stream::SignedRequest
       include Stream::Batch
@@ -33,15 +36,16 @@ 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 ENV['STREAM_URL'] =~ Stream::STREAM_URL_COM_RE && (api_key.nil? || api_key.empty?)
-        matches = Stream::STREAM_URL_COM_RE.match(ENV['STREAM_URL'])
-        api_key = matches['key']
-        api_secret = matches['secret']
-        app_id = matches['app_id']
-        opts[:location] = matches['location']
-        opts[:api_hostname] = matches['api_hostname']
-      elsif ENV['STREAM_URL'] =~ Stream::STREAM_URL_IO_RE && (api_key.nil? || api_key.empty?)
-        matches = Stream::STREAM_URL_IO_RE.match(ENV['STREAM_URL'])
+      if api_key.nil? || api_key.empty?
+        env_url = ENV['STREAM_URL']
+        if env_url =~ Stream::STREAM_URL_COM_RE
+          re = Stream::STREAM_URL_COM_RE
+        elsif env_url =~ Stream::STREAM_URL_IO_RE
+          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']
         app_id = matches['app_id']
@@ -49,21 +53,17 @@ module Stream
         opts[:api_hostname] = matches['api_hostname']
       end
 
-      if api_key.nil? || api_key.empty?
-        raise ArgumentError, 'empty api_key parameter and missing or invalid STREAM_URL env variable'
-      end
-
       @api_key = api_key
       @api_secret = api_secret
       @app_id = app_id
       @signer = Stream::Signer.new(api_secret)
 
       @client_options = {
-          api_version: opts.fetch(:api_version, 'v1.0'),
-          location: opts.fetch(:location, nil),
-          default_timeout: opts.fetch(:default_timeout, 3),
-          api_key: @api_key,
-          api_hostname: opts.fetch(:api_hostname, 'stream-io-api.com')
+        api_version: opts.fetch(:api_version, 'v1.0'),
+        location: opts.fetch(:location, nil),
+        default_timeout: opts.fetch(:default_timeout, 3),
+        api_key: @api_key,
+        api_hostname: opts.fetch(:api_hostname, 'stream-io-api.com')
       }
     end
 
@@ -79,6 +79,14 @@ module Stream
       Stream::Feed.new(self, feed_slug, user_id, token)
     end
 
+    def personalization
+      PersonalizationClient.new(api_key, api_secret, app_id, client_options)
+    end
+
+    def collections
+      CollectionsClient.new(api_key, api_secret, app_id, client_options)
+    end
+
     def update_activity(activity)
       update_activities([activity])
     end
@@ -93,7 +101,7 @@ module Stream
     end
 
     def get_http_client
-      @http_client ||= StreamHTTPClient.new(@client_options)
+      @http_client ||= StreamHTTPClient.new(url_generator)
     end
 
     def make_query_params(params)
@@ -106,6 +114,12 @@ module Stream
 
       get_http_client.make_http_request(method, relative_url, make_query_params(params), data, headers)
     end
+
+    private
+
+    def url_generator
+      APIURLGenerator.new(@client_options)
+    end
   end
 
   class StreamHTTPClient
@@ -115,59 +129,34 @@ module Stream
     attr_reader :options
     attr_reader :base_path
 
-    def initialize(client_params)
-      @options = client_params
-      location_name = 'api'
-      unless client_params[:location].nil?
-        location_name = "#{client_params[:location]}-api"
-      end
-
-      protocol = 'https'
-      port = ':443'
-      if @options[:location] == 'qa' || @options[:location] == 'localhost'
-        protocol = 'http'
-        port = ':80'
-        if @options[:location] == 'localhost'
-          port = ':8000'
-        end
-      end
-
-      api_hostname = 'stream-io-api.com'
-      if @options[:api_hostname]
-        api_hostname = @options[:api_hostname]
-      end
-
-      @base_path = "/api/#{@options[:api_version]}"
-      base_url = "#{protocol}://#{location_name}.#{api_hostname}#{port}#{@base_path}"
-
-      @conn = Faraday.new(:url => base_url) do |faraday|
-        # faraday.request :url_encoded
+    def initialize(url_generator)
+      @options = url_generator.options
+      @conn = Faraday.new(url: url_generator.url) do |faraday|
         faraday.use RaiseHttpException
         faraday.options[:open_timeout] = @options[:default_timeout]
         faraday.options[:timeout] = @options[:default_timeout]
-
-        # do this last
         faraday.adapter Faraday.default_adapter
       end
-      @conn.path_prefix = @base_path
+      @base_path = url_generator.base_path
+      @conn.path_prefix = base_path
     end
 
     def make_http_request(method, relative_url, params = nil, data = nil, headers = nil)
       headers['Content-Type'] = 'application/json'
       headers['X-Stream-Client'] = "stream-ruby-client-#{Stream::VERSION}"
-      params['api_key'] = @options[:api_key]
-      relative_url = "#{@base_path}#{relative_url}?#{URI.encode_www_form(params)}"
-      body = data.to_json if %w(post put).include? method.to_s
+      base_url = [base_path, relative_url].join('/').gsub(%r{/+}, '/')
+      url = "#{base_url}?#{URI.encode_www_form(params)}"
+      body = data.to_json if %w[post put].include? method.to_s
       response = @conn.run_request(
-          method,
-          relative_url,
-          body,
-          headers
+        method,
+        url,
+        body,
+        headers
       )
 
       case response[:status].to_i
-        when 200..203
-          return ::JSON.parse(response[:body])
+      when 200..203
+        return ::JSON.parse(response[:body])
       end
     end
   end

data/lib/stream/collections.rb

@@ -0,0 +1,35 @@
+module Stream
+  class CollectionsClient < Client
+    def upsert(collection, objects = [])
+      data = {
+        data: {
+          collection => objects
+        }
+      }
+      make_collection_request(:post, {}, data)
+    end
+
+    def get(collection, ids = [])
+      params = {
+        foreign_ids: ids.map { |id| "#{collection}:#{id}" }.join(',')
+      }
+      make_collection_request(:get, params, {})
+    end
+
+    def delete(collection, ids = [])
+      params = {
+        collection_name: collection,
+        ids: ids.join(',')
+      }
+      make_collection_request(:delete, params, {})
+    end
+
+    private
+
+    def make_collection_request(method, params, data)
+      endpoint = '/meta/'
+      auth_token = Stream::Signer.create_jwt_token('collections', '*', @api_secret, '*', '*')
+      make_request(method, endpoint, auth_token, params, data)
+    end
+  end
+end

data/lib/stream/feed.rb

@@ -101,13 +101,6 @@ module Stream
       @client.make_request(:post, '/activities/', auth_token, {}, 'activities' => activities)
     end
 
-    def delete
-      uri = "/feed/#{@feed_url}/"
-      auth_token = create_jwt_token('feed', 'delete')
-
-      @client.make_request(:delete, uri, auth_token)
-    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

data/lib/stream/personalization.rb

@@ -0,0 +1,29 @@
+require 'stream/url'
+
+module Stream
+  class PersonalizationClient < Client
+    def url_generator
+      PersonalizationURLGenerator.new(@client_options)
+    end
+
+    def get(resource, params = {})
+      make_personalization_request(:get, resource, params, {})
+    end
+
+    def post(resource, params = {}, data = {})
+      make_personalization_request(:post, resource, params, data: data)
+    end
+
+    def delete(resource, params = {})
+      make_personalization_request(:delete, resource, params, {})
+    end
+
+    private
+
+    def make_personalization_request(method, resource, params, data)
+      endpoint = "/#{resource}/"
+      auth_token = Stream::Signer.create_jwt_token('personalization', '*', @api_secret, '*', '*')
+      make_request(method, endpoint, auth_token, params, data)
+    end
+  end
+end

data/lib/stream/signedrequest.rb

@@ -18,7 +18,7 @@ module Stream
       context = HttpSignatures::Context.new(
           keys: {@api_key => @api_secret},
           algorithm: 'hmac-sha256',
-          headers: %w((request-target) Date)
+          headers: %w(date)
       )
       method_map = {
           :get => Net::HTTP::Get,
@@ -29,7 +29,7 @@ module Stream
       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
+          'date' => request_date
       )
       context.signer.sign(message)
       headers = {

data/lib/stream/url.rb

@@ -0,0 +1,57 @@
+module Stream
+  class URLGenerator
+    attr_reader :options
+    attr_reader :base_path
+    attr_reader :url
+  end
+
+  class APIURLGenerator < URLGenerator
+    def initialize(options)
+      @options = options
+      location = make_location(options[:location])
+      location ||= "api"
+      api_version = options[:api_version] ? options[:api_version] : 'v1.0'
+      if ENV['STREAM_URL']
+        uri = URI.parse(ENV['STREAM_URL'])
+        scheme = uri.scheme
+        host = uri.host
+        port = uri.port
+      else
+        scheme = 'https'
+        host = options[:api_hostname]
+        port = 443
+      end
+      unless ENV['STREAM_URL'] =~ /localhost/
+        host_parts = host.split('.')
+        host = host_parts.slice(1..-1).join('.') if host_parts.length == 3
+        host = "#{location}.#{host}" if location
+      end
+      @base_path = "/api/#{api_version}"
+      @url = "#{scheme}://#{host}:#{port}#{@base_path}"
+    end
+
+    private
+
+    def make_location(loc)
+      case loc
+      when 'us-east'
+        'us-east-api'
+      when 'eu-west'
+        'eu-west-api'
+      when 'singapore'
+        'singapore-api'
+      else
+        loc
+      end
+    end
+  end
+
+  class PersonalizationURLGenerator < URLGenerator
+    def initialize(options)
+      @options = options
+      host = 'personalization.stream-io-api.com'
+      @base_path = '/personalization/v1.0'
+      @url = "https://#{host}#{@base_path}"
+    end
+  end
+end

data/lib/stream/version.rb

@@ -1,3 +1,3 @@
 module Stream
-  VERSION = '2.5.10'.freeze
+  VERSION = '2.6.0'.freeze
 end

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: stream-ruby
 version: !ruby/object:Gem::Version
-  version: 2.5.10
+  version: 2.6.0
 platform: ruby
 authors:
 - Tommaso Barbugli
 - Ian Douglas
+- Federico Ruggi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-01 00:00:00.000000000 Z
+date: 2018-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -115,11 +116,14 @@ files:
 - lib/stream/base.rb
 - lib/stream/batch.rb
 - lib/stream/client.rb
+- lib/stream/collections.rb
 - lib/stream/errors.rb
 - lib/stream/exceptions.rb
 - lib/stream/feed.rb
+- lib/stream/personalization.rb
 - lib/stream/signedrequest.rb
 - lib/stream/signer.rb
+- lib/stream/url.rb
 - lib/stream/version.rb
 homepage: http://github.com/GetStream/stream-ruby
 licenses:
@@ -141,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: A gem that provides a client interface for getstream.io