stream-chat-ruby 3.15.0 → 3.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cbaf42294dbe5ae2578a02f9b2a18e60dda4dd92906607b472537c201bd025f
-  data.tar.gz: 66f27459befeb6529b367fa469aaf506f7d4a2919edea05823e994835b2b0588
+  metadata.gz: 1931489e635ef2e2a3f052c55bd01063d013571745721e37e6dfdee96d86ce84
+  data.tar.gz: 020ebe362659ec374a3d45db80815cffa696f00dfca0ff1b57d329496d5762ed
 SHA512:
-  metadata.gz: 346d166b21cdf6165993718d05a063cdbdc3f393b844fe72c5830923eb36f9db4e48838bd1181cde7418275ce22819f59245dd0677d84ce48147b2198cb2d829
-  data.tar.gz: 30b643a68dd9de1c3fa4f3056712e58083bb1c5913c75f51a550050a03b8bdc7643ea27751c2051679f1611a981653ed88657926caec8ce2dbf9de20ff18960c
+  metadata.gz: 03ea03f3fe7831cd3f2424d937a75b27e98077e03aea57fd029105af3c5be15fc4c46bb7895a19960d8ba25c4dd9e5fef020ec670e5e4417d8b3a3c5889f147a
+  data.tar.gz: 1e7c7a0b52920e7b3cd6a36b20503f46d0f02cedca6cf34cfb6ab25f443bfbc42f621cafd8ad45381796fc4f3106f78d1f7dc61a08e41a6cf78a1612eea53ca7

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 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.17.0](https://github.com/GetStream/stream-chat-ruby/compare/v3.16.0...v3.17.0) (2025-06-25)
+
+## [3.16.0](https://github.com/GetStream/stream-chat-ruby/compare/v3.15.0...v3.16.0) (2025-06-18)
+
 ## [3.15.0](https://github.com/GetStream/stream-chat-ruby/compare/v3.14.0...v3.15.0) (2025-06-06)
 
 ## [3.14.0](https://github.com/GetStream/stream-chat-ruby/compare/v3.13.0...v3.14.0) (2025-04-07)
@@ -350,4 +354,4 @@ before continuing with v3.0.0 of this library.
 - Added `client.search`
 - Added `client.update_users_partial`
 - Added `client.update_user_partial`
-- Added `client.reactivate_user`
+- Added `client.reactivate_user`

data/CONTRIBUTING.md

@@ -1,4 +1,3 @@
-
 # :recycle: Contributing
 
 We welcome code changes that improve this library or fix a problem, please make sure to follow all best practices and add tests if applicable before submitting a Pull Request on Github. We are very happy to merge your code in the official repository. Make sure to sign our [Contributor License Agreement (CLA)](https://docs.google.com/forms/d/e/1FAIpQLScFKsKkAJI7mhCr7K9rEIOpqIDThrWxuvxnwUq2XkHyG154vQ/viewform) first. See our license file for more details.
@@ -63,6 +62,34 @@ Recommended settings:
 }
 ```
 
+For Docker-based development, you can use:
+
+```shell
+$ make lint_with_docker      # Run linters in Docker
+$ make lint-fix_with_docker  # Fix linting issues in Docker
+$ make test_with_docker      # Run tests in Docker
+$ make check_with_docker     # Run both linters and tests in Docker
+$ make sorbet_with_docker    # Run Sorbet type checker in Docker
+```
+
+You can customize the Ruby version used in Docker by setting the RUBY_VERSION variable:
+
+```shell
+$ RUBY_VERSION=3.1 make test_with_docker
+```
+
+By default, the API client connects to the production Stream Chat API. You can override this by setting the STREAM_CHAT_URL environment variable:
+
+```shell
+$ STREAM_CHAT_URL=http://localhost:3030 make test
+```
+
+When running tests in Docker, the `test_with_docker` command automatically sets up networking to allow the Docker container to access services running on your host machine via `host.docker.internal`. This is particularly useful for connecting to a local Stream Chat server:
+
+```shell
+$ STREAM_CHAT_URL=http://host.docker.internal:3030 make test_with_docker
+```
+
 ### Commit message convention
 
 This repository follows a commit message convention in order to automatically generate the [CHANGELOG](./CHANGELOG.md). Make sure you follow the rules of [conventional commits](https://www.conventionalcommits.org/) when opening a pull request.

data/Makefile

@@ -0,0 +1,50 @@
+STREAM_KEY ?= NOT_EXIST
+STREAM_SECRET ?= NOT_EXIST
+RUBY_VERSION ?= 3.0
+STREAM_CHAT_URL ?= https://chat.stream-io-api.com
+
+# These targets are not files
+.PHONY: help check test lint lint-fix test_with_docker lint_with_docker lint-fix_with_docker
+
+help: ## Display this help message
+	@echo "Please use \`make <target>\` where <target> is one of"
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; \
+	{printf "\033[36m%-40s\033[0m %s\n", $$1, $$2}'
+
+lint: ## Run linters
+	bundle exec rubocop
+
+lint-fix: ## Fix linting issues
+	bundle exec rubocop -a
+
+test: ## Run tests
+	STREAM_KEY=$(STREAM_KEY) STREAM_SECRET=$(STREAM_SECRET) bundle exec rspec
+
+check: lint test ## Run linters + tests
+
+console: ## Start a console with the gem loaded
+	bundle exec rake console
+
+lint_with_docker: ## Run linters in Docker (set RUBY_VERSION to change Ruby version)
+	docker run -t -i -w /code -v $(PWD):/code ruby:$(RUBY_VERSION) sh -c "gem install bundler && bundle install && bundle exec rubocop"
+
+lint-fix_with_docker: ## Fix linting issues in Docker (set RUBY_VERSION to change Ruby version)
+	docker run -t -i -w /code -v $(PWD):/code ruby:$(RUBY_VERSION) sh -c "gem install bundler && bundle install && bundle exec rubocop -a"
+
+test_with_docker: ## Run tests in Docker (set RUBY_VERSION to change Ruby version)
+	docker run -t -i -w /code -v $(PWD):/code --add-host=host.docker.internal:host-gateway -e STREAM_KEY=$(STREAM_KEY) -e STREAM_SECRET=$(STREAM_SECRET) -e "STREAM_CHAT_URL=http://host.docker.internal:3030" ruby:$(RUBY_VERSION) sh -c "gem install bundler && bundle install && bundle exec rspec"
+
+check_with_docker: lint_with_docker test_with_docker ## Run linters + tests in Docker (set RUBY_VERSION to change Ruby version)
+
+sorbet: ## Run Sorbet type checker
+	bundle exec srb tc
+
+sorbet_with_docker: ## Run Sorbet type checker in Docker (set RUBY_VERSION to change Ruby version)
+	docker run -t -i -w /code -v $(PWD):/code ruby:$(RUBY_VERSION) sh -c "gem install bundler && bundle install && bundle exec srb tc"
+
+coverage: ## Generate test coverage report
+	COVERAGE=true bundle exec rspec
+	@echo "Coverage report available at ./coverage/index.html"
+
+reviewdog: ## Run reviewdog for CI
+	bundle exec rubocop --format json | reviewdog -f=rubocop -name=rubocop -reporter=github-pr-review 

data/README.md

@@ -132,6 +132,29 @@ deleted_message = client.delete_message(m1['message']['id'])
 
 ```
 
+### Reminders
+
+```ruby
+# Create a reminder for a message
+reminder = client.create_reminder(m1['message']['id'], 'bob-1', DateTime.now + 1)
+
+# Create a reminder without a notification time (just mark for later)
+reminder = client.create_reminder(m1['message']['id'], 'bob-1')
+
+# Update a reminder
+updated_reminder = client.update_reminder(m1['message']['id'], 'bob-1', DateTime.now + 2)
+
+# Delete a reminder
+client.delete_reminder(m1['message']['id'], 'bob-1')
+
+# Query reminders for a user
+reminders = client.query_reminders('bob-1')
+
+# Query reminders with filters
+filter = { 'channel_cid' => 'messaging:bob-and-jane' }
+reminders = client.query_reminders('bob-1', filter)
+```
+
 ### Devices
 
 ```ruby

data/lib/stream-chat/client.rb

@@ -7,6 +7,7 @@ require 'faraday/multipart'
 require 'faraday/net_http_persistent'
 require 'jwt'
 require 'time'
+require 'date'
 require 'sorbet-runtime'
 require 'stream-chat/channel'
 require 'stream-chat/errors'
@@ -418,6 +419,13 @@ module StreamChat
       delete("messages/#{message_id}", params: options)
     end
 
+    # Un-deletes a message.
+    sig { params(message_id: String, undeleted_by: String, options: T.untyped).returns(StreamChat::StreamResponse) }
+    def undelete_message(message_id, undeleted_by, **options)
+      payload = { undeleted_by: undeleted_by }.merge(options)
+      post("messages/#{message_id}/undelete", data: payload)
+    end
+
     # Queries banned users.
     #
     # Banned users can be retrieved in different ways:
@@ -688,7 +696,7 @@ module StreamChat
     # Revoke tokens for an application issued since the given date.
     sig { params(before: T.any(DateTime, String)).returns(StreamChat::StreamResponse) }
     def revoke_tokens(before)
-      before = T.cast(before, DateTime).rfc3339 if before.instance_of?(DateTime)
+      before = before.rfc3339 if before.instance_of?(DateTime)
       update_app_settings({ 'revoke_tokens_issued_before' => before })
     end
 
@@ -701,7 +709,7 @@ module StreamChat
     # Revoke tokens for users issued since.
     sig { params(user_ids: T::Array[String], before: T.any(DateTime, String)).returns(StreamChat::StreamResponse) }
     def revoke_users_token(user_ids, before)
-      before = T.cast(before, DateTime).rfc3339 if before.instance_of?(DateTime)
+      before = before.rfc3339 if before.instance_of?(DateTime)
 
       updates = []
       user_ids.map do |user_id|
@@ -939,6 +947,55 @@ module StreamChat
       post('threads', data: params)
     end
 
+    # Creates a reminder for a message.
+    # @param message_id [String] The ID of the message to create a reminder for
+    # @param user_id [String] The ID of the user creating the reminder
+    # @param remind_at [DateTime, nil] When to remind the user (optional)
+    # @return [StreamChat::StreamResponse] API response
+    sig { params(message_id: String, user_id: String, remind_at: T.nilable(DateTime)).returns(StreamChat::StreamResponse) }
+    def create_reminder(message_id, user_id, remind_at = nil)
+      data = { user_id: user_id }
+      data[:remind_at] = remind_at.rfc3339 if remind_at.instance_of?(DateTime)
+      post("messages/#{message_id}/reminders", data: data)
+    end
+
+    # Updates a reminder for a message.
+    # @param message_id [String] The ID of the message with the reminder
+    # @param user_id [String] The ID of the user who owns the reminder
+    # @param remind_at [DateTime, nil] When to remind the user (optional)
+    # @return [StreamChat::StreamResponse] API response
+    sig { params(message_id: String, user_id: String, remind_at: T.nilable(DateTime)).returns(StreamChat::StreamResponse) }
+    def update_reminder(message_id, user_id, remind_at = nil)
+      data = { user_id: user_id }
+      data[:remind_at] = remind_at.rfc3339 if remind_at
+      patch("messages/#{message_id}/reminders", data: data)
+    end
+
+    # Deletes a reminder for a message.
+    # @param message_id [String] The ID of the message with the reminder
+    # @param user_id [String] The ID of the user who owns the reminder
+    # @return [StreamChat::StreamResponse] API response
+    sig { params(message_id: String, user_id: String).returns(StreamChat::StreamResponse) }
+    def delete_reminder(message_id, user_id)
+      delete("messages/#{message_id}/reminders", params: { user_id: user_id })
+    end
+
+    # Queries reminders based on filter conditions.
+    # @param user_id [String] The ID of the user whose reminders to query
+    # @param filter_conditions [Hash] Conditions to filter reminders
+    # @param sort [Array<Hash>, nil] Sort parameters (default: [{ field: 'remind_at', direction: 1 }])
+    # @param options [Hash] Additional query options like limit, offset
+    # @return [StreamChat::StreamResponse] API response with reminders
+    sig { params(user_id: String, filter_conditions: T::Hash[T.untyped, T.untyped], sort: T.nilable(T::Array[T::Hash[T.untyped, T.untyped]]), options: T.untyped).returns(StreamChat::StreamResponse) }
+    def query_reminders(user_id, filter_conditions = {}, sort: nil, **options)
+      params = options.merge({
+                               filter_conditions: filter_conditions,
+                               sort: sort || [{ field: 'remind_at', direction: 1 }],
+                               user_id: user_id
+                             })
+      post('reminders/query', data: params)
+    end
+
     private
 
     sig { returns(T::Hash[String, String]) }

data/lib/stream-chat/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stream-chat-ruby
 version: !ruby/object:Gem::Version
-  version: 3.15.0
+  version: 3.17.0
 platform: ruby
 authors:
 - getstream.io
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-06 00:00:00.000000000 Z
+date: 2025-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -107,6 +107,7 @@ files:
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE
+- Makefile
 - PULL_REQUEST_TEMPLATE.md
 - README.md
 - Rakefile