stream-chat-ruby 3.2.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a528ef5495dbf3fc9d123e554151ee6654ef3ddf04499f89e6c093fce8f2e93
-  data.tar.gz: 5b08570a5dbfbbfdc73c356d93861f9fad95f81cf2578ef9caea24947deb9c34
+  metadata.gz: c3120569255394b3306b2748c2883707f7c98bff14353f6b0dd8ff7b9bfdcc1d
+  data.tar.gz: 9a715e02897a4ab371a78f8fb31e9669023dd84ae01bd7d5c67a77fa698ccfeb
 SHA512:
-  metadata.gz: 3f5e0d125c1b9a95395daea29a8694ca96d74939193f5eb035c8e1b0af840c91f457beaa4eca4dec6485fecfe2e9fd7a57f0f1c3ea34ee4f829027a77145cd59
-  data.tar.gz: 6548249f3cd5ddbb2051c84a546c94f6277571075c84c4cbcb38d359c0970ceb9d45df3158c59c2dcd160dec44508ad108371343bd6ad5c3a3b931b9a4399d6f
+  metadata.gz: 10ff4a6917a0081a33eb92a55d05142f9b97dab0e297a171f4f52122bcd907fcd9a5999673b7b61cedf7fbcf861ee467bb226cf6b0cbe3bc626a3fc35d651f52
+  data.tar.gz: e2dd165c34ec9a570b8e5b8b9e4f36e1922c37909680b104441e9c7816602e96d06cf0376e1507b94d34dd5c10a82daebb4f2837e5e7a5f5a9f31321559d4d86

data/CHANGELOG.md

@@ -2,6 +2,25 @@
 
 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)
+
+
+### Features
+
+* add campaign support ([#124](https://github.com/GetStream/stream-chat-ruby/issues/124)) ([d7a935f](https://github.com/GetStream/stream-chat-ruby/commit/d7a935f7b4459399b82db1d51a541388caeb5e68))
+
 ## [3.2.0](https://github.com/GetStream/stream-chat-ruby/compare/v3.1.0...v3.2.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/README.md

@@ -57,7 +57,7 @@ client = StreamChat::Client.new('STREAM_KEY', 'STREAM_SECRET')
 > # Wrong:
 > user = { "user" => { "id" => "bob-1"}}
 > # Correct:
-> user = { :user => { :id => "bob-1" }}
+> user = { user: { id: "bob-1" }}
 > ```
 
 ### Generate a token for client-side usage:
@@ -70,14 +70,14 @@ client.create_token('bob-1')
 
 ```ruby
 client.upsert_user({
-    :id => 'bob-1',
-    :role => 'admin',
-    :name => 'Robert Tables'
+    id: 'bob-1',
+    role: 'admin',
+    name: 'Robert Tables'
 })
 
 # Batch update is also supported
-jane = {:id => 'jane-1'}
-june = {:id => 'june-1'}
+jane = {id: 'jane-1'}
+june = {id: 'june-1'}
 client.upsert_users([jane, june])
 ```
 
@@ -85,10 +85,10 @@ client.upsert_users([jane, june])
 
 ```ruby
 client.create_channel_type({
-    :name => 'livechat',
-    :automod => 'disabled',
-    :commands => ['ban'],
-    :mutes => true
+    name: 'livechat',
+    automod: 'disabled',
+    commands: ['ban'],
+    mutes: true
 })
 
 channel_types = client.list_channel_types()
@@ -109,7 +109,7 @@ chan.add_members(['bob-1', 'jane-77'])
 
 ### Reactions
 ```ruby
-chan.send_reaction(m1['id'], {:type => 'like'}, 'bob-1')
+chan.send_reaction(m1['id'], {type: 'like'}, 'bob-1')
 ```
 
 ### Moderation
@@ -125,7 +125,7 @@ chan.unban_user('bob-1')
 ### Messages
 
 ```ruby
-m1 = chan.send_message({:text => 'Hi Jane!'}, 'bob-1')
+m1 = chan.send_message({text: 'Hi Jane!'}, 'bob-1')
 
 deleted_message = client.delete_message(m1['message']['id'])
 
@@ -158,13 +158,39 @@ client.delete_blocklist('my_blocker')
 
 ```ruby
 # Register an export
-response = client.export_channels({:type => 'messaging', :id => 'jane'})
+response = client.export_channels({type: 'messaging', id: 'jane'})
 
 # Check completion
 status_response = client.get_export_channel_status(response['task_id'])
 # status_response['status'] == 'pending', 'completed'
 ```
 
+### Campaigns
+
+```ruby
+# Create a user or channel segment
+client.create_segment({ name: 'test', type: 'user', filter: { uniq: 'a flag on users' } })
+
+# Create a campaign that uses the segment
+client.create_campaign({
+    name: 'test',
+    text: 'Hi',
+    sender_id: campaign_sender,
+    segment_id: segment_id,
+    channel_type: 'messaging'
+})
+
+# Schedule the campaign
+client.schedule_campaign(campaign_id, Time.now.to_i)
+
+# Query the campaign to check the status
+response = client.query_campaigns(filter_conditions: { id: campaign_id })
+response['campaigns'][0]['status'] == 'completed'
+
+# Read sent information
+client.query_recipients(filter_conditions: { campaign_id: campaign_id })
+```
+
 ### Rate limits
 
 ```ruby

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) }
@@ -869,16 +875,10 @@ module StreamChat
       post('campaigns', data: { campaign: campaign })
     end
 
-    # Gets a campaign.
-    sig { params(campaign_id: String).returns(StreamChat::StreamResponse) }
-    def get_campaign(campaign_id)
-      get("campaigns/#{campaign_id}")
-    end
-
-    # Lists all campaigns. Options dictionary can contain 'offset' and 'limit' keys for pagination.
-    sig { params(options: StringKeyHash).returns(StreamChat::StreamResponse) }
-    def list_campaigns(options)
-      get('campaigns', params: options)
+    # Queries campaigns similar to query_channels or query_users.
+    sig { params(params: T.untyped).returns(StreamChat::StreamResponse) }
+    def query_campaigns(**params)
+      get('campaigns', params: { payload: params.to_json })
     end
 
     # Updates a campaign.
@@ -894,9 +894,9 @@ module StreamChat
     end
 
     # Schedules a campaign.
-    sig { params(campaign_id: String, send_at: Integer).returns(StreamChat::StreamResponse) }
-    def schedule_campaign(campaign_id, send_at)
-      patch("campaigns/#{campaign_id}/schedule", data: { send_at: send_at })
+    sig { params(campaign_id: String, scheduled_for: Integer).returns(StreamChat::StreamResponse) }
+    def schedule_campaign(campaign_id, scheduled_for)
+      patch("campaigns/#{campaign_id}/schedule", data: { scheduled_for: scheduled_for })
     end
 
     # Stops a campaign.
@@ -923,16 +923,10 @@ module StreamChat
       post('segments', data: { segment: segment })
     end
 
-    # Gets a campaign segment.
-    sig { params(segment_id: String).returns(StreamChat::StreamResponse) }
-    def get_segment(segment_id)
-      get("segments/#{segment_id}")
-    end
-
-    # Lists all campaign segments. Options dictionary can contain 'offset' and 'limit' keys for pagination.
-    sig { params(options: StringKeyHash).returns(StreamChat::StreamResponse) }
-    def list_segments(options)
-      get('segments', params: options)
+    # Queries campaign segments.
+    sig { params(params: T.untyped).returns(StreamChat::StreamResponse) }
+    def query_segments(**params)
+      get('segments', params: { payload: params.to_json })
     end
 
     # Updates a campaign segment.
@@ -947,6 +941,12 @@ module StreamChat
       delete("segments/#{segment_id}")
     end
 
+    # Queries campaign recipients.
+    sig { params(params: T.untyped).returns(StreamChat::StreamResponse) }
+    def query_recipients(**params)
+      get('recipients', params: { payload: params.to_json })
+    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.2.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.2.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.