stream-chat-ruby 3.3.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73e40b4cf714cd04476c91ac638895cab0327dc618fb54031a83aaadc8b3279a
-  data.tar.gz: b5c98b143f98798cb2cd9db4e5a3c2c8c4cc7aaf9e35aa55a392c371d06fc970
+  metadata.gz: c3120569255394b3306b2748c2883707f7c98bff14353f6b0dd8ff7b9bfdcc1d
+  data.tar.gz: 9a715e02897a4ab371a78f8fb31e9669023dd84ae01bd7d5c67a77fa698ccfeb
 SHA512:
-  metadata.gz: 74e06fd1205667b6c0a6f2d745f197aac2639ca5d932dee52bea8f2a4e371d9fc7d4ed8c2663010b47a1b1af0d7dd644f3bdf16b26f0048ed2fad6d8a5c18859
-  data.tar.gz: a91d9ec87dfb82fb7a393212a08641bd4b8164ccd38ef0259fbcb27d4824dc3a4b0330b973b6d46315ab77cf17c357dd48961cf37ac3ccf1748310e3fb6bfb8f
+  metadata.gz: 10ff4a6917a0081a33eb92a55d05142f9b97dab0e297a171f4f52122bcd907fcd9a5999673b7b61cedf7fbcf861ee467bb226cf6b0cbe3bc626a3fc35d651f52
+  data.tar.gz: e2dd165c34ec9a570b8e5b8b9e4f36e1922c37909680b104441e9c7816602e96d06cf0376e1507b94d34dd5c10a82daebb4f2837e5e7a5f5a9f31321559d4d86

data/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 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.4.0](https://github.com/GetStream/stream-chat-ruby/compare/v3.3.0...v3.4.0) (2023-07-19)
+
+
+### Features
+
+* commit message endpoint ([#129](https://github.com/GetStream/stream-chat-ruby/issues/129)) ([09eabb3](https://github.com/GetStream/stream-chat-ruby/commit/09eabb33f4bcfa6f8881dc545060bc5bdd51374e))
+
+
+### Bug Fixes
+
+* sorbet type for mark_read function signature ([#130](https://github.com/GetStream/stream-chat-ruby/issues/130)) ([7ea0f51](https://github.com/GetStream/stream-chat-ruby/commit/7ea0f517592c1819e223a65eedb53caa85a92817))
+
 ## [3.3.0](https://github.com/GetStream/stream-chat-ruby/compare/v3.2.0...v3.3.0) (2022-11-17)
 
 

data/CONTRIBUTING.md

@@ -14,7 +14,23 @@ $ bundle install --path vendor/bundle
 ### Run tests
 
 ```shell
-$ STREAM_KEY=my_api_key STREAM_SECRET=my_api_secret bundle exec rake spec
+$ STREAM_KEY=my_api_key STREAM_SECRET=my_api_secret bundle exec rspec spec
+```
+
+### Run specific test
+
+Add :focus tag on target test:
+
+```rb
+it 'can mark messages as read', :focus do
+    # test something
+end
+```
+
+And then run as following:
+
+```shell
+$ STREAM_KEY=myapi_key STREAM_SECRET=my_secret STREAM_CHAT_URL=http://127.0.0.1:3030 bundle exec rspec spec --tag focus
 ```
 
 ### Linters and type check

data/Gemfile

@@ -8,13 +8,15 @@ group :dev do
   gem 'method_source', '~> 1.0'
   gem 'pry', '~> 0.14'
   gem 'pry-doc', '~> 1.3'
+  gem 'rake', '~> 13.0'
+  gem 'rspec', '~> 3.12'
   gem 'rubocop', '~> 1.38', require: false
   gem 'rubocop-ast', '~> 1.23', require: false
+  gem 'simplecov', '~> 0.21.2'
+  gem 'simplecov-console', '~> 0.9.1'
   gem 'sorbet', '~> 0.5.10539'
 end
 
 group :test do
   gem 'rack', '~> 2.2.4'
-  gem 'simplecov', '~> 0.21.2'
-  gem 'simplecov-console', '~> 0.9.1'
 end

data/SECURITY.md

@@ -0,0 +1,16 @@
+# Reporting a Vulnerability
+At Stream we are committed to the security of our Software. We appreciate your efforts in disclosing vulnerabilities responsibly and we will make every effort to acknowledge your contributions.
+
+Report security vulnerabilities at the following email address:
+```
+[security@getstream.io](mailto:security@getstream.io)
+```
+Alternatively it is also possible to open a new issue in the affected repository, tagging it with the `security` tag.
+
+A team member will acknowledge the vulnerability and will follow-up with more detailed information. A representative of the security team will be in touch if more information is needed.
+
+# Information to include in a report
+While we appreciate any information that you are willing to provide, please make sure to include the following:
+* Which repository is affected
+* Which branch, if relevant
+* Be as descriptive as possible, the team will replicate the vulnerability before working on a fix.

data/lib/stream-chat/channel.rb

@@ -219,7 +219,7 @@ module StreamChat
     end
 
     # Sends the mark read event for this user, only works if the `read_events` setting is enabled.
-    sig { params(user_id: String, options: StringKeyHash).returns(StreamChat::StreamResponse) }
+    sig { params(user_id: String, options: T.untyped).returns(StreamChat::StreamResponse) }
     def mark_read(user_id, **options)
       payload = add_user_id(options, user_id)
       @client.post("#{url}/read", data: payload)

data/lib/stream-chat/client.rb

@@ -361,6 +361,12 @@ module StreamChat
       update_message_partial(message_id, updates, user_id: user_id)
     end
 
+    #  commits a message.
+    sig { params(message_id: String).returns(StreamChat::StreamResponse) }
+    def commit_message(message_id)
+      post("messages/#{message_id}/commit")
+    end
+
     # Updates a message. Fully overwrites a message.
     # For partial update, use `update_message_partial` method.
     sig { params(message: StringKeyHash).returns(StreamChat::StreamResponse) }

data/lib/stream-chat/version.rb

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

data/stream-chat.gemspec

@@ -32,8 +32,4 @@ Gem::Specification.new do |gem|
   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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stream-chat-ruby
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.0
 platform: ruby
 authors:
 - getstream.io
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-17 00:00:00.000000000 Z
+date: 2023-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -94,62 +94,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.5.10539
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        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.
 email: support@getstream.io
 executables: []
@@ -166,6 +110,7 @@ files:
 - PULL_REQUEST_TEMPLATE.md
 - README.md
 - Rakefile
+- SECURITY.md
 - lib/stream-chat.rb
 - lib/stream-chat/channel.rb
 - lib/stream-chat/client.rb
@@ -200,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: The low level client for serverside calls for Stream Chat.