stream-chat-ruby 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97b780871d561e0047be409ecafc91d6295e0be4cb879e9be69c250a95c831ab
-  data.tar.gz: 62952ddac54e5358f43080011de4bf57fe5982225a4a710e9ae8d4edb860a010
+  metadata.gz: 9a528ef5495dbf3fc9d123e554151ee6654ef3ddf04499f89e6c093fce8f2e93
+  data.tar.gz: 5b08570a5dbfbbfdc73c356d93861f9fad95f81cf2578ef9caea24947deb9c34
 SHA512:
-  metadata.gz: 82d1582de7d93f89c77d9ce6f4513d6d84b5547203277ca83097d53853fa1033f1e1e6958e2b372837f469622205b3f45d2a183ce510e41771e9d4a3e057bc21
-  data.tar.gz: f3f95dba97aa357c06897de0c598a2083b35a9f2e38c28d91f26c893fdd90b5db77822d92eac65cc5e30f1cd4c84f039567daceb5ac91bc127b41a299ec61ddd
+  metadata.gz: 3f5e0d125c1b9a95395daea29a8694ca96d74939193f5eb035c8e1b0af840c91f457beaa4eca4dec6485fecfe2e9fd7a57f0f1c3ea34ee4f829027a77145cd59
+  data.tar.gz: 6548249f3cd5ddbb2051c84a546c94f6277571075c84c4cbcb38d359c0970ceb9d45df3158c59c2dcd160dec44508ad108371343bd6ad5c3a3b931b9a4399d6f

data/.gitignore

@@ -45,7 +45,8 @@ build-iPhoneSimulator/
 
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock # See https://github.com/rubygems/rubygems/issues/3372 for more info
+# See https://github.com/rubygems/rubygems/issues/3372 for more info
+Gemfile.lock
 .ruby-version
 # .ruby-gemset
 

data/.rubocop.yml

@@ -1,7 +1,7 @@
 AllCops:
   DisabledByDefault: false
   NewCops: enable
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.7
   Exclude:
     - sorbet/**/*.rbi
     - vendor/bundle/**/*

data/.versionrc.js

@@ -13,4 +13,14 @@ const versionFileUpdater = {
 
 module.exports = {
     bumpFiles: [{ filename: './lib/stream-chat/version.rb', updater: versionFileUpdater }],
+    types: [
+        {"type": "feat", "section": "Features"},
+        {"type": "fix", "section": "Bug Fixes"},
+        {"type": "chore", "section": "Other", "hidden": false},
+        {"type": "docs", "section": "Other", "hidden": false},
+        {"type": "style", "section": "Other", "hidden": false},
+        {"type": "refactor", "section": "Other", "hidden": false},
+        {"type": "perf", "section": "Other", "hidden": false},
+        {"type": "test", "section": "Other", "hidden": false}
+    ]
 }

data/CHANGELOG.md

@@ -2,6 +2,27 @@
 
 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.
 
+## [3.2.0](https://github.com/GetStream/stream-chat-ruby/compare/v3.1.0...v3.2.0) (2022-11-17)
+
+
+### Features
+
+* **send_message:** add options argument ([#107](https://github.com/GetStream/stream-chat-ruby/issues/107)) ([8e5bf89](https://github.com/GetStream/stream-chat-ruby/commit/8e5bf8977f899d3e5a259efd38d7bcf3962cd999))
+
+
+### Bug Fixes
+
+* do not ship lock ([#118](https://github.com/GetStream/stream-chat-ruby/issues/118)) ([4cd4f25](https://github.com/GetStream/stream-chat-ruby/commit/4cd4f251a575ec8b010543d0277914463028cf2b))
+* relax dependency versions ([#116](https://github.com/GetStream/stream-chat-ruby/issues/116)) ([2b87af6](https://github.com/GetStream/stream-chat-ruby/commit/2b87af624856c403ffaf8c9b69982832f169df70))
+
+
+### Other
+
+* add ignored sections into changelog ([#120](https://github.com/GetStream/stream-chat-ruby/issues/120)) ([191ea82](https://github.com/GetStream/stream-chat-ruby/commit/191ea825c4ad68473568da6c801819d6a8fec827))
+* **deps-dev:** bump rack from 2.2.3 to 2.2.4 ([#110](https://github.com/GetStream/stream-chat-ruby/issues/110)) ([2ab646b](https://github.com/GetStream/stream-chat-ruby/commit/2ab646b4f6cdcb016203075a94a77437739b69d0))
+* drop old rubies ([#122](https://github.com/GetStream/stream-chat-ruby/issues/122)) ([77ddb1f](https://github.com/GetStream/stream-chat-ruby/commit/77ddb1f4917611a6579c177dd617358bdbde6bbc))
+* move pr template into github ([#119](https://github.com/GetStream/stream-chat-ruby/issues/119)) ([99cd178](https://github.com/GetStream/stream-chat-ruby/commit/99cd178571cfdf6b6828ef60f4eca57890f14e18))
+
 ## [3.1.0](https://github.com/GetStream/stream-chat-ruby/compare/v3.0.0...v3.1.0) (2022-08-26)
 
 

data/Gemfile

@@ -5,16 +5,16 @@ source 'https://rubygems.org'
 gemspec
 
 group :dev do
-  gem 'method_source', '= 1.0.0'
-  gem 'pry', '= 0.14.1'
-  gem 'pry-doc', '= 1.3.0'
-  gem 'rubocop', '= 1.28.2', require: false
-  gem 'rubocop-ast', '= 1.17.0', require: false
-  gem 'sorbet', '= 0.5.10346'
+  gem 'method_source', '~> 1.0'
+  gem 'pry', '~> 0.14'
+  gem 'pry-doc', '~> 1.3'
+  gem 'rubocop', '~> 1.38', require: false
+  gem 'rubocop-ast', '~> 1.23', require: false
+  gem 'sorbet', '~> 0.5.10539'
 end
 
 group :test do
-  gem 'rack', '= 2.2.3'
-  gem 'simplecov', '= 0.21.2'
-  gem 'simplecov-console', '= 0.9.1'
+  gem 'rack', '~> 2.2.4'
+  gem 'simplecov', '~> 0.21.2'
+  gem 'simplecov-console', '~> 0.9.1'
 end

data/README.md

@@ -30,7 +30,7 @@ For the client-side integrations (web and mobile) have a look at the JavaScript,
 
 [`stream-chat-ruby`](https://rubygems.org/gems/stream-chat-ruby) supports:
 
-- Ruby (2.5, 2.6, 2.7, 3.0, 3.1)
+- Ruby (2.7, 3.0, 3.1)
 
 ```bash
 $ gem install stream-chat-ruby
@@ -41,7 +41,7 @@ $ gem install stream-chat-ruby
 ```ruby
 require 'stream-chat'
 
-client = StreamChat::Client.new(api_key='STREAM_KEY', api_secret='STREAM_SECRET')
+client = StreamChat::Client.new('STREAM_KEY', 'STREAM_SECRET')
 ```
 
 > 💡 Note: since v2.21.0 we implemented [Sorbet](https://sorbet.org/) type checker. As of v2.x.x we only use it for static type checks and you won't notice any difference, but from v3.0.0 **we will enable runtime checks** 🚨 🚨 🚨.
@@ -49,7 +49,7 @@ client = StreamChat::Client.new(api_key='STREAM_KEY', api_secret='STREAM_SECRET'
 > What this means, is that you'll receive an error during runtime if you pass an invalid type to our methods. To prepare for that, just make sure whatever you pass in, matches the method signature (`sig { ... }`).
 
 > **Update (2022-May-24)**: we have relased [v3.0.0](https://github.com/GetStream/stream-chat-ruby/releases/tag/v3.0.0) with enabled runtime checks.
- 
+
 ---
 
 > Additionally, in a future major version, we would like to enforce symbol hash keys during runtime to conform to Ruby best practises. It's a good idea to prepare your application for that.
@@ -127,7 +127,7 @@ chan.unban_user('bob-1')
 ```ruby
 m1 = chan.send_message({:text => 'Hi Jane!'}, 'bob-1')
 
-deleted_message = client.delete_message(r1['id'])
+deleted_message = client.delete_message(m1['message']['id'])
 
 ```
 

data/lib/stream-chat/channel.rb

@@ -46,9 +46,9 @@ module StreamChat
     end
 
     # Sends a message to this channel.
-    sig { params(message: StringKeyHash, user_id: String).returns(StreamChat::StreamResponse) }
-    def send_message(message, user_id)
-      payload = { message: add_user_id(message, user_id) }
+    sig { params(message: StringKeyHash, user_id: String, options: T.untyped).returns(StreamChat::StreamResponse) }
+    def send_message(message, user_id, **options)
+      payload = options.merge({ message: add_user_id(message, user_id) })
       @client.post("#{url}/message", data: payload)
     end
 

data/lib/stream-chat/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module StreamChat
-  VERSION = '3.1.0'
+  VERSION = '3.2.0'
 end

data/stream-chat.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |gem|
   gem.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|sorbet|spec|\.github|scripts|assets)/}) }
   end
-  gem.required_ruby_version = '>=2.5.0'
+  gem.required_ruby_version = '>=2.7.0'
   gem.metadata = {
     'rubygems_mfa_required' => 'false',
     'homepage_uri' => 'https://getstream.io/chat/docs/',
@@ -26,14 +26,14 @@ Gem::Specification.new do |gem|
     'source_code_uri' => 'https://github.com/GetStream/stream-chat-ruby'
   }
 
-  gem.add_dependency 'faraday', '= 1.10.0'
-  gem.add_dependency 'faraday-multipart', '= 1.0.3'
-  gem.add_dependency 'faraday-net_http_persistent', '= 1.2.0'
-  gem.add_dependency 'jwt', '= 2.3.0'
-  gem.add_dependency 'net-http-persistent', '= 4.0.1'
-  gem.add_dependency 'sorbet-runtime', '= 0.5.10354'
-  gem.add_development_dependency 'rake', '= 13.0.6'
-  gem.add_development_dependency 'rspec', '= 3.11.0'
-  gem.add_development_dependency 'simplecov', '= 0.21.2'
-  gem.add_development_dependency 'simplecov-console', '= 0.9.1'
+  gem.add_dependency 'faraday', '~> 1.10.0'
+  gem.add_dependency 'faraday-multipart', '~> 1.0.3'
+  gem.add_dependency 'faraday-net_http_persistent', '~> 1.2'
+  gem.add_dependency 'jwt', '~> 2.3'
+  gem.add_dependency 'net-http-persistent', '~> 4.0'
+  gem.add_dependency 'sorbet-runtime', '~> 0.5.10539'
+  gem.add_development_dependency 'rake', '~> 13.0'
+  gem.add_development_dependency 'rspec', '~> 3.12'
+  gem.add_development_dependency 'simplecov', '~> 0.21.2'
+  gem.add_development_dependency 'simplecov-console', '~> 0.9.1'
 end

metadata

@@ -1,153 +1,153 @@
 --- !ruby/object:Gem::Specification
 name: stream-chat-ruby
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - getstream.io
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-26 00:00:00.000000000 Z
+date: 2022-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.10.0
 - !ruby/object:Gem::Dependency
   name: faraday-multipart
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.3
 - !ruby/object:Gem::Dependency
   name: faraday-net_http_persistent
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: jwt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: net-http-persistent
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.1
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.1
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.10354
+        version: 0.5.10539
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.10354
+        version: 0.5.10539
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.6
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.6
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.11.0
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.11.0
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.21.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.21.2
 - !ruby/object:Gem::Dependency
   name: simplecov-console
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.1
 description: Ruby client for Stream Chat.
@@ -162,7 +162,6 @@ files:
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - PULL_REQUEST_TEMPLATE.md
 - README.md
@@ -194,7 +193,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/Gemfile.lock

@@ -1,130 +0,0 @@
-PATH
-  remote: .
-  specs:
-    stream-chat-ruby (3.1.0)
-      faraday (= 1.10.0)
-      faraday-multipart (= 1.0.3)
-      faraday-net_http_persistent (= 1.2.0)
-      jwt (= 2.3.0)
-      net-http-persistent (= 4.0.1)
-      sorbet-runtime (= 0.5.10354)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ansi (1.5.0)
-    ast (2.4.2)
-    coderay (1.1.3)
-    connection_pool (2.2.5)
-    diff-lcs (1.5.0)
-    docile (1.4.0)
-    faraday (1.10.0)
-      faraday-em_http (~> 1.0)
-      faraday-em_synchrony (~> 1.0)
-      faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0)
-      faraday-multipart (~> 1.0)
-      faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.0)
-      faraday-patron (~> 1.0)
-      faraday-rack (~> 1.0)
-      faraday-retry (~> 1.0)
-      ruby2_keywords (>= 0.0.4)
-    faraday-em_http (1.0.0)
-    faraday-em_synchrony (1.0.0)
-    faraday-excon (1.1.0)
-    faraday-httpclient (1.0.1)
-    faraday-multipart (1.0.3)
-      multipart-post (>= 1.2, < 3)
-    faraday-net_http (1.0.1)
-    faraday-net_http_persistent (1.2.0)
-    faraday-patron (1.0.0)
-    faraday-rack (1.0.0)
-    faraday-retry (1.0.3)
-    jwt (2.3.0)
-    method_source (1.0.0)
-    multipart-post (2.2.3)
-    net-http-persistent (4.0.1)
-      connection_pool (~> 2.2)
-    parallel (1.22.1)
-    parser (3.1.2.1)
-      ast (~> 2.4.1)
-    pry (0.14.1)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    pry-doc (1.3.0)
-      pry (~> 0.11)
-      yard (~> 0.9.11)
-    rack (2.2.3)
-    rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.5.0)
-    rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.28.2)
-      parallel (~> 1.10)
-      parser (>= 3.1.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.17.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.17.0)
-      parser (>= 3.1.1.0)
-    ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.5)
-    simplecov (0.21.2)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-      simplecov_json_formatter (~> 0.1)
-    simplecov-console (0.9.1)
-      ansi
-      simplecov
-      terminal-table
-    simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.4)
-    sorbet (0.5.10346)
-      sorbet-static (= 0.5.10346)
-    sorbet-runtime (0.5.10354)
-    sorbet-static (0.5.10346-universal-darwin-21)
-    sorbet-static (0.5.10346-x86_64-linux)
-    terminal-table (3.0.2)
-      unicode-display_width (>= 1.1.1, < 3)
-    unicode-display_width (2.2.0)
-    webrick (1.7.0)
-    yard (0.9.28)
-      webrick (~> 1.7.0)
-
-PLATFORMS
-  x86_64-darwin-21
-  x86_64-linux
-
-DEPENDENCIES
-  method_source (= 1.0.0)
-  pry (= 0.14.1)
-  pry-doc (= 1.3.0)
-  rack (= 2.2.3)
-  rake (= 13.0.6)
-  rspec (= 3.11.0)
-  rubocop (= 1.28.2)
-  rubocop-ast (= 1.17.0)
-  simplecov (= 0.21.2)
-  simplecov-console (= 0.9.1)
-  sorbet (= 0.5.10346)
-  stream-chat-ruby!
-
-BUNDLED WITH
-   2.3.20