stream-chat-ruby 2.18.0 → 2.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af3ba47a48c7b729201b5db3401986f5d45007030b4caa86053399f5faf12aba
-  data.tar.gz: ba8243a507b81682a5f283f09e5075dd21a9c345c9043c8bf118ea423db1a1da
+  metadata.gz: 5789a9c18bf5d3508b754a0a3931b647d441dd48057fe0ff4209092d31a985c1
+  data.tar.gz: 86f540d7f3dc23e481314757efa3f6bac1746218f8e7686448da197c373a6b7b
 SHA512:
-  metadata.gz: b004af8b95616a958803f632a434ae0ac1a6cd7504725faeceb76a2b27e75cdee45541ad876f598dc465ff02edee5662f4521437a9a74c5db3ef84c08dee6845
-  data.tar.gz: ca7d458fe80c3417f4058e7c876ea4984818e3c0b072f4bedd962f96a5b556d7835a36748f5da9e1ed968fe52e8711ca2c4011b463eec4108590d9b384ecb047
+  metadata.gz: c4984f7402280cd7484a7687a6a940ef6c7662bcda3684da6e05d3e9cef8271f677221e11df4c0e865a4a3910dcdb5423a9adac479648f30d0eb1341effbb515
+  data.tar.gz: 0d89825ed4fae41d47a4daeb80d0192aad1c8e2d381d89384eed4076820fd7ce6538e278fd905a04e657e9f719910166f6b10dc6e1ae33fcc59d5988b3907ffe

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [2.19.0](https://github.com/GetStream/stream-chat-ruby/compare/v2.18.0...v2.19.0) (2022-02-02)
+
+
+### Features
+
+* ability to provide custom http client ([#75](https://github.com/GetStream/stream-chat-ruby/issues/75)) ([bfff20d](https://github.com/GetStream/stream-chat-ruby/commit/bfff20d06232c49a1a8d0eee255a718bfffbb351))
+* add connection pooling and idle timeout ([#74](https://github.com/GetStream/stream-chat-ruby/issues/74)) ([7891005](https://github.com/GetStream/stream-chat-ruby/commit/78910053b3a15b1efa3183a71299068e63b128e3))
+* env var handling enhancement ([#76](https://github.com/GetStream/stream-chat-ruby/issues/76)) ([0cdc38a](https://github.com/GetStream/stream-chat-ruby/commit/0cdc38abd671bfaa8cefa7f403b9e2ac8b642272))
+> 🚨 Note: if you used `STREAM_CHAT_URL` env var, you'll need to provide it manually in the `**options` as `base_url`. See the initializer of `Client` class for more information.
+
 ## [2.18.0](https://github.com/GetStream/stream-chat-ruby/compare/v2.17.2...v2.18.0) (2022-01-26)
 
 

data/lib/stream-chat/client.rb

@@ -4,6 +4,7 @@
 require 'open-uri'
 require 'faraday'
 require 'faraday/multipart'
+require 'faraday/net_http_persistent'
 require 'jwt'
 require 'time'
 require 'stream-chat/channel'
@@ -18,7 +19,8 @@ module StreamChat
   HARD_DELETE = 'hard'
 
   class Client
-    BASE_URL = 'https://chat.stream-io-api.com'
+    DEFAULT_BASE_URL = 'https://chat.stream-io-api.com'
+    DEFAULT_TIMEOUT = 6.0
 
     attr_reader :api_key
     attr_reader :api_secret
@@ -29,27 +31,50 @@ module StreamChat
     #
     # @param [string] api_key your application api_key
     # @param [string] api_secret your application secret
-    # @param [string]
-    # @param [hash] options extra options
+    # @param [float] timeout the timeout for the http requests
+    # @param [hash] options extra options such as base_url
     #
     # @example initialized the client with a timeout setting
     #   StreamChat::Client.new('my_key', 'my_secret', 3.0)
     #
-    def initialize(api_key = '', api_secret = '', timeout = 6.0, **options)
-      @api_key = api_key || ENV['STREAM_KEY']
-      @api_secret = api_secret || ENV['STREAM_SECRET']
-      @timeout = timeout || ENV['STREAM_CHAT_TIMEOUT']
+    def initialize(api_key, api_secret, timeout = nil, **options)
+      raise ArgumentError, 'api_key and api_secret are required' if api_key.to_s.empty? || api_secret.to_s.empty?
+
+      @api_key = api_key
+      @api_secret = api_secret
+      @timeout = timeout || DEFAULT_TIMEOUT
       @options = options
       @auth_token = JWT.encode({ server: true }, @api_secret, 'HS256')
-      @base_url = options[:base_url] || ENV['STREAM_CHAT_URL'] || BASE_URL
+      @base_url = options[:base_url] || DEFAULT_BASE_URL
       @conn = Faraday.new(url: @base_url) do |faraday|
         faraday.options[:open_timeout] = @timeout
         faraday.options[:timeout] = @timeout
         faraday.request :multipart
-        faraday.adapter :net_http
+        faraday.adapter :net_http_persistent, pool_size: 5 do |http|
+          # AWS load balancer idle timeout is 60 secs, so let's make it 59
+          http.idle_timeout = 59
+        end
       end
     end
 
+    # initializes a Stream Chat API Client from STREAM_KEY and STREAM_SECRET
+    # environmental variables. STREAM_CHAT_TIMEOUT and STREAM_CHAT_URL
+    # variables are optional.
+    # @param [hash] options extra options
+    def self.from_env(**options)
+      Client.new(ENV['STREAM_KEY'],
+                 ENV['STREAM_SECRET'],
+                 ENV['STREAM_CHAT_TIMEOUT'],
+                 **{ base_url: ENV['STREAM_CHAT_URL'] }.merge(options))
+    end
+
+    # Sets the underlying Faraday http client.
+    #
+    # @param [client] an instance of Faraday::Connection
+    def set_http_client(client)
+      @conn = client
+    end
+
     def create_token(user_id, exp = nil, iat = nil)
       payload = { user_id: user_id }
       payload['exp'] = exp unless exp.nil?
@@ -522,10 +547,9 @@ module StreamChat
       headers = get_default_headers
       headers['Authorization'] = @auth_token
       headers['stream-auth-type'] = 'jwt'
-      url = [@base_url, relative_url].join('/')
       params = {} if params.nil?
       params = (get_default_params.merge(params).sort_by { |k, _v| k.to_s }).to_h
-      url = "#{url}?#{URI.encode_www_form(params)}"
+      url = "#{relative_url}?#{URI.encode_www_form(params)}"
 
       body = data.to_json if %w[patch post put].include? method.to_s
 

data/lib/stream-chat/version.rb

@@ -3,5 +3,5 @@
 # lib/version.rb
 
 module StreamChat
-  VERSION = '2.18.0'
+  VERSION = '2.19.0'
 end

data/stream-chat.gemspec

@@ -28,7 +28,9 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency 'faraday'
   gem.add_dependency 'faraday-multipart'
+  gem.add_dependency 'faraday-net_http_persistent'
   gem.add_dependency 'jwt'
+  gem.add_dependency 'net-http-persistent'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'simplecov'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stream-chat-ruby
 version: !ruby/object:Gem::Version
-  version: 2.18.0
+  version: 2.19.0
 platform: ruby
 authors:
 - getstream.io
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-26 00:00:00.000000000 Z
+date: 2022-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday-net_http_persistent
+  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
@@ -52,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-http-persistent
+  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: rake
   requirement: !ruby/object:Gem::Requirement