stream-chat-ruby 2.3.0 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77a57822787deb58ec33e8b6a717e26edba13b3edbcb818abd55bc6bf86ac516
-  data.tar.gz: 917861d1fafe2b42e7d849643f9a32941ac31039ff7a3de554229d77ca60aae4
+  metadata.gz: 31e7de9bf8ce95a2bf565ac99b5a686deb0195bb3ec20f2004ec784f84d00ff0
+  data.tar.gz: '0959555927fa04219edc014cac1247cbca8942387360b2099080138ddbd22664'
 SHA512:
-  metadata.gz: 03655565e49824a54aa9c27b9621a075ede33b0b063e46aa8bb493a490a776ec8dff273992502668862df8afb0dd23c5574742f83942ad873c2f9832ba7e6d2e
-  data.tar.gz: 798df127e33162706774f4eb7a6e1e6d4d294b472db0a81c7a657049c2d4505cf089a9208c977aa2b17e9533be05c08764d378db895d05cfb10b5dd663e21af6
+  metadata.gz: 70608f85204fb4a1c9451fed4f27281579d23c5e558aea25d752735309b62409cdd15986ad6cb1550e65a5e9072fde29b1792fbf16c2dc5fc1c8b020f1f68b96
+  data.tar.gz: 4907cdf3f110e825a47c45f0759684e9bf3ae4449f74ff8546238d60f39e92c611f1f3e8b3fd855dfe2bf06846432968ee7fa56ee46f3cc946b03af63885b121

data/.github/workflows/ci.yml

@@ -6,9 +6,10 @@ jobs:
   build:
     runs-on: ubuntu-latest
     strategy:
+      max-parallel: 1
       matrix:
-        ruby: [ '2.5', '2.6', '2.7' ]
-    name: Ruby ${{ matrix.ruby }} sample
+        ruby: ['2.5', '2.6', '2.7', '3.0']
+    name: Ruby ${{ matrix.ruby }}
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-ruby@v1

data/.gitignore

@@ -48,3 +48,4 @@ Gemfile.lock
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
+.envrc

data/CHANGELOG.md

@@ -1,7 +1,38 @@
+## May 31st, 2021 - 2.9.0
+
+- Add support for app and user level token revoke
+
+## May 21st, 2021 - 2.8.0
+
+- Add query message flags support
+
+## March 17th, 2021 - 2.7.0
+
+- Add Ruby 3.x support
+- Update CI to run all tests for all versions
+
+## March 9th, 2021 - 2.6.0
+
+- Add get_rate_limits endpoint
+
+## February 3rd, 2021 - 2.5.0
+
+- Add channel partial update
+- Increase convenience in query members
+- Improve internal symbol conversions
+
+## January 20th, 2021 - 2.4.0
+
+- Add query_members to channel
+- Use post endpoint for query channels instead of get
+- Extract common code for sorting into a helper for query calls
+
 ## January 5th, 2021 - 2.3.0
+
 - Add check SQS helper
 
 ## January 4th, 2021 - 2.2.0
+
 - Add support for export channels
 - Improve readme for blocklist and export channels
 - Improve running tests for multiple versions of ruby
@@ -9,27 +40,34 @@
 - Move to GitHub Actions
 
 ## October 5th, 2020 - 2.1.0
+
 - Add support for blocklist
 
 ## October 2nd, 2020 - 2.0.0
+
 - Drop EOL Ruby versions: 2.3 && 2.4
 - Setup Rubocop and mark string literals as frozen
 
 ## August 3rd, 2020 - 1.1.3
+
 - Fixed Argument Error on delete_user
 
 ## April 23th, 2020 - 1.1.2
+
 - Fixed ArgumentError when no users was passed
 
 ## March 30th, 2020 - 1.1.1
+
 - Fixed few minor issues
 
 ## Oct 27th, 2019 - 1.1.0
+
 - Mark gems use for testing as development dependencies
 - Added `send_file`, `send_image`, `delete_file`, `delete_image`
 - Added `invite_members`
 
 ## Oct 19th, 2019 - 1.0.0
+
 - Added `channel.hide` and `channel.show`
 - Added `client.flag_message` and `client.unflag_message`
 - Added `client.flag_user` and `client.unflag_user`

data/README.md

@@ -1,20 +1,20 @@
 # stream-chat-ruby
 
- [![build](https://github.com/GetStream/stream-chat-ruby/workflows/build/badge.svg)](https://github.com/GetStream/stream-chat-ruby/actions) [![Gem Version](https://badge.fury.io/rb/stream-chat-ruby.svg)](http://badge.fury.io/rb/stream-chat-ruby)
+[![build](https://github.com/GetStream/stream-chat-ruby/workflows/build/badge.svg)](https://github.com/GetStream/stream-chat-ruby/actions) [![Gem Version](https://badge.fury.io/rb/stream-chat-ruby.svg)](http://badge.fury.io/rb/stream-chat-ruby)
 
 stream-chat-ruby is the official Ruby client for [Stream chat](https://getstream.io/chat/) a service for building chat applications.
 
 You can sign up for a Stream account at https://getstream.io/chat/get_started/.
 
 You can use this library to access chat API endpoints server-side. For the
-client-side integrations (web and mobile) have a look at the Javascript, iOS and
+client-side integrations (web and mobile) have a look at the JavaScript, iOS and
 Android SDK libraries (https://getstream.io/chat/).
 
 ### Installation
 
 stream-chat-ruby supports:
 
-- Ruby (2.7, 2.6, 2.5)
+- Ruby (3.0, 2.7, 2.6, 2.5)
 
 #### Install
 
@@ -28,9 +28,8 @@ gem install stream-chat-ruby
 
 ### Supported features
 
-- Chat channels
+- Chat channel type, channels and members
 - Messages
-- Chat channel types
 - User management
 - Moderation API
 - Push configuration
@@ -131,6 +130,17 @@ chan.unban_user('bob-1')
 
 # Query channel state
 chan.query({'messages' => { 'limit' => 10, 'id_lte' => m1['id']}})
+
+# Update metadata (overwrite)
+chan.update({'motd' => 'one apple a day....'})
+
+# Update partial
+# 1. key-value pairs to set
+# 2. keys to unset (remove)
+chan.update_partial({color: 'blue', age: 30}, ['motd'])
+
+# Query channel members
+chan.query_members({name: {'$autocomplete': 'test'}}, sort: {last_created_at: -1}, offset: 5, limit: 5)
 ```
 
 ### Messages
@@ -155,6 +165,7 @@ client.remove_device(jane_phone['id'], jane_phone['user_id'])
 ```
 
 ### Blocklists
+
 ```ruby
 # Create a blocklist
 client.create_blocklist('my_blocker', %w[fudge cream sugar])
@@ -170,6 +181,7 @@ client.delete_blocklist('my_blocker')
 ```
 
 ### Export Channels
+
 ```ruby
 # Register an export
 response = client.export_channels({type: 'messaging', id: 'jane'})
@@ -179,6 +191,19 @@ status_response = client.get_export_channel_status(response['task_id'])
 # status_response['status'] == 'pending', 'completed'
 ```
 
+### Rate limits
+
+```ruby
+# Get all rate limits
+limits = client.get_rate_limits
+
+# Get rate limits for specific platform(s)
+limits = client.get_rate_limits(server_side: true)
+
+# Get rate limits for specific platforms and endpoints
+limits = client.get_rate_limits(android: true, ios: true, endpoints: ['QueryChannels', 'SendMessage'])
+```
+
 ### Example Rails application
 
 See [an example rails application using the Ruby SDK](https://github.com/GetStream/rails-chat-example).

data/lib/stream-chat/channel.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
 require 'stream-chat/errors'
+require 'stream-chat/util'
 
 module StreamChat
   class Channel # rubocop:todo Metrics/ClassLength # rubocop:todo Style/Documentation
     attr_reader :id
     attr_reader :channel_type
     attr_reader :custom_data
+    attr_reader :members
 
     def initialize(client, channel_type, channel_id = nil, custom_data = nil)
       @channel_type = channel_type
@@ -23,7 +25,7 @@ module StreamChat
     end
 
     def send_message(message, user_id)
-      payload = { "message": add_user_id(message, user_id) }
+      payload = { message: add_user_id(message, user_id) }
       @client.post("#{url}/message", data: payload)
     end
 
@@ -33,24 +35,24 @@ module StreamChat
     end
 
     def send_reaction(message_id, reaction, user_id)
-      payload = { "reaction": add_user_id(reaction, user_id) }
+      payload = { reaction: add_user_id(reaction, user_id) }
       @client.post("messages/#{message_id}/reaction", data: payload)
     end
 
     def delete_reaction(message_id, reaction_type, user_id)
       @client.delete(
         "messages/#{message_id}/reaction/#{reaction_type}",
-        params: { "user_id": user_id }
+        params: { user_id: user_id }
       )
     end
 
     def create(user_id)
-      @custom_data['created_by'] = { "id": user_id }
+      @custom_data['created_by'] = { id: user_id }
       query(watch: false, state: false, presence: false)
     end
 
     def query(**options)
-      payload = { "state": true, "data": @custom_data }.merge(options)
+      payload = { state: true, data: @custom_data }.merge(options)
       url = "channels/#{@channel_type}"
       url = "#{url}/#{@id}" unless @id.nil?
 
@@ -59,11 +61,36 @@ module StreamChat
       state
     end
 
+    def query_members(filter_conditions = {}, sort: nil, **options)
+      params = {}.merge(options).merge({
+                                         id: @id,
+                                         type: @channel_type,
+                                         filter_conditions: filter_conditions,
+                                         sort: get_sort_fields(sort)
+                                       })
+
+      if @id == '' && @members.length.positive?
+        params['members'] = []
+        @members&.each do |m|
+          params['members'] << m['user'].nil? ? m['user_id'] : m['user']['id']
+        end
+      end
+
+      @client.get('members', params: { payload: params.to_json })
+    end
+
     def update(channel_data, update_message = nil)
-      payload = { "data": channel_data, "message": update_message }
+      payload = { data: channel_data, message: update_message }
       @client.post(url, data: payload)
     end
 
+    def update_partial(set = nil, unset = nil)
+      raise StreamChannelException 'set or unset is needed' if set.nil? && unset.nil?
+
+      payload = { set: set, unset: unset }
+      @client.patch(url, data: payload)
+    end
+
     def delete
       @client.delete(url)
     end
@@ -73,23 +100,23 @@ module StreamChat
     end
 
     def add_members(user_ids)
-      @client.post(url, data: { "add_members": user_ids })
+      @client.post(url, data: { add_members: user_ids })
     end
 
     def invite_members(user_ids)
-      @client.post(url, data: { "invites": user_ids })
+      @client.post(url, data: { invites: user_ids })
     end
 
     def add_moderators(user_ids)
-      @client.post(url, data: { "add_moderators": user_ids })
+      @client.post(url, data: { add_moderators: user_ids })
     end
 
     def remove_members(user_ids)
-      @client.post(url, data: { "remove_members": user_ids })
+      @client.post(url, data: { remove_members: user_ids })
     end
 
     def demote_moderators(user_ids)
-      @client.post(url, data: { "demote_moderators": user_ids })
+      @client.post(url, data: { demote_moderators: user_ids })
     end
 
     def mark_read(user_id, **options)
@@ -130,17 +157,17 @@ module StreamChat
     end
 
     def delete_file(url)
-      @client.delete("#{self.url}/file", params: { "url": url })
+      @client.delete("#{self.url}/file", params: { url: url })
     end
 
     def delete_image(url)
-      @client.delete("#{self.url}/image", params: { "url": url })
+      @client.delete("#{self.url}/image", params: { url: url })
     end
 
     private
 
     def add_user_id(payload, user_id)
-      payload.merge({ "user": { "id": user_id } })
+      payload.merge({ user: { id: user_id } })
     end
   end
 end

data/lib/stream-chat/client.rb

@@ -4,9 +4,11 @@
 require 'open-uri'
 require 'faraday'
 require 'jwt'
+require 'time'
 require 'stream-chat/channel'
 require 'stream-chat/errors'
 require 'stream-chat/version'
+require 'stream-chat/util'
 
 module StreamChat
   DEFAULT_BLOCKLIST = 'profanity_en_2020_v1'
@@ -44,9 +46,10 @@ module StreamChat
       end
     end
 
-    def create_token(user_id, exp = nil)
+    def create_token(user_id, exp = nil, iat = nil)
       payload = { user_id: user_id }
       payload['exp'] = exp unless exp.nil?
+      payload['iat'] = iat unless iat.nil?
       JWT.encode(payload, @api_secret, 'HS256')
     end
 
@@ -59,22 +62,29 @@ module StreamChat
     end
 
     def flag_message(id, **options)
-      payload = { 'target_message_id': id }.merge(options)
+      payload = { target_message_id: id }.merge(options)
       post('moderation/flag', data: payload)
     end
 
     def unflag_message(id, **options)
-      payload = { 'target_message_id': id }.merge(options)
+      payload = { target_message_id: id }.merge(options)
       post('moderation/unflag', data: payload)
     end
 
+    def query_message_flags(filter_conditions, **options)
+      params = options.merge({
+                               filter_conditions: filter_conditions
+                             })
+      get('moderation/flags/message', params: { payload: params.to_json })
+    end
+
     def flag_user(id, **options)
-      payload = { 'target_user_id': id }.merge(options)
+      payload = { target_user_id: id }.merge(options)
       post('moderation/flag', data: payload)
     end
 
     def unflag_user(id, **options)
-      payload = { 'target_user_id': id }.merge(options)
+      payload = { target_user_id: id }.merge(options)
       post('moderation/unflag', data: payload)
     end
 
@@ -84,11 +94,11 @@ module StreamChat
 
     def search(filter_conditions, query, **options)
       params = options.merge({
-                               "filter_conditions": filter_conditions,
-                               "query": query
+                               filter_conditions: filter_conditions,
+                               query: query
                              })
 
-      get('search', params: { "payload": params.to_json })
+      get('search', params: { payload: params.to_json })
     end
 
     def update_users(users)
@@ -99,7 +109,7 @@ module StreamChat
 
         payload[id] = user
       end
-      post('users', data: { 'users': payload })
+      post('users', data: { users: payload })
     end
 
     def update_user(user)
@@ -107,7 +117,7 @@ module StreamChat
     end
 
     def update_users_partial(updates)
-      patch('users', data: { 'users': updates })
+      patch('users', data: { users: updates })
     end
 
     def update_user_partial(update)
@@ -131,34 +141,34 @@ module StreamChat
     end
 
     def ban_user(target_id, **options)
-      payload = { 'target_user_id': target_id }.merge(options)
+      payload = { target_user_id: target_id }.merge(options)
       post('moderation/ban', data: payload)
     end
 
     def unban_user(target_id, **options)
-      params = { 'target_user_id': target_id }.merge(options)
+      params = { target_user_id: target_id }.merge(options)
       delete('moderation/ban', params: params)
     end
 
     def mute_user(target_id, user_id)
-      payload = { 'target_id': target_id, 'user_id': user_id }
+      payload = { target_id: target_id, user_id: user_id }
       post('moderation/mute', data: payload)
     end
 
     def unmute_user(target_id, user_id)
-      payload = { 'target_id': target_id, 'user_id': user_id }
+      payload = { target_id: target_id, user_id: user_id }
       post('moderation/unmute', data: payload)
     end
 
     def mark_all_read(user_id)
-      payload = { 'user': { 'id': user_id } }
+      payload = { user: { id: user_id } }
       post('channels/read', data: payload)
     end
 
     def update_message(message)
       raise ArgumentError 'message must have an id' unless message.key? 'id'
 
-      post("messages/#{message['id']}", data: { 'message': message })
+      post("messages/#{message['id']}", data: { message: message })
     end
 
     def delete_message(message_id)
@@ -166,28 +176,20 @@ module StreamChat
     end
 
     def query_users(filter_conditions, sort: nil, **options)
-      sort_fields = []
-      sort&.each do |k, v|
-        sort_fields << { "field": k, "direction": v }
-      end
       params = options.merge({
-                               "filter_conditions": filter_conditions,
-                               "sort": sort_fields
+                               filter_conditions: filter_conditions,
+                               sort: get_sort_fields(sort)
                              })
-      get('users', params: { "payload": params.to_json })
+      get('users', params: { payload: params.to_json })
     end
 
     def query_channels(filter_conditions, sort: nil, **options)
-      params = { "state": true, "watch": false, "presence": false }
-      sort_fields = []
-      sort&.each do |k, v|
-        sort_fields << { "field": k, "direction": v }
-      end
-      params = params.merge(options).merge({
-                                             "filter_conditions": filter_conditions,
-                                             "sort": sort_fields
-                                           })
-      get('channels', params: { "payload": params.to_json })
+      data = { state: true, watch: false, presence: false }
+      data = data.merge(options).merge({
+                                         filter_conditions: filter_conditions,
+                                         sort: get_sort_fields(sort)
+                                       })
+      post('channels', data: data)
     end
 
     def create_channel_type(data)
@@ -225,18 +227,29 @@ module StreamChat
 
     def add_device(device_id, push_provider, user_id)
       post('devices', data: {
-             "id": device_id,
-             "push_provider": push_provider,
-             "user_id": user_id
+             id: device_id,
+             push_provider: push_provider,
+             user_id: user_id
            })
     end
 
     def delete_device(device_id, user_id)
-      delete('devices', params: { "id": device_id, "user_id": user_id })
+      delete('devices', params: { id: device_id, user_id: user_id })
     end
 
     def get_devices(user_id)
-      get('devices', params: { "user_id": user_id })
+      get('devices', params: { user_id: user_id })
+    end
+
+    def get_rate_limits(server_side: false, android: false, ios: false, web: false, endpoints: [])
+      params = {}
+      params['server_side'] = server_side if server_side
+      params['android'] = android if android
+      params['ios'] = ios if ios
+      params['web'] = web if web
+      params['endpoints'] = endpoints.join(',') unless endpoints.empty?
+
+      get('rate_limits', params: params)
     end
 
     def verify_webhook(request_body, x_signature)
@@ -253,11 +266,11 @@ module StreamChat
     end
 
     def create_blocklist(name, words)
-      post('blocklists', data: { "name": name, "words": words })
+      post('blocklists', data: { name: name, words: words })
     end
 
     def update_blocklist(name, words)
-      put("blocklists/#{name}", data: { "words": words })
+      put("blocklists/#{name}", data: { words: words })
     end
 
     def delete_blocklist(name)
@@ -265,13 +278,37 @@ module StreamChat
     end
 
     def export_channels(*channels)
-      post('export_channels', data: { "channels": channels })
+      post('export_channels', data: { channels: channels })
     end
 
     def get_export_channel_status(task_id)
       get("export_channels/#{task_id}")
     end
 
+    def revoke_tokens(before)
+      before = before.rfc3339 if before.instance_of?(DateTime)
+      update_app_settings({ 'revoke_tokens_issued_before' => before })
+    end
+
+    def revoke_user_token(user_id, before)
+      revoke_users_token([user_id], before)
+    end
+
+    def revoke_users_token(user_ids, before)
+      before = before.rfc3339 if before.instance_of?(DateTime)
+
+      updates = []
+      user_ids.each do |user_id|
+        updates.push({
+                       'id' => user_id,
+                       'set' => {
+                         'revoke_tokens_issued_before' => before
+                       }
+                     })
+      end
+      update_users_partial(updates)
+    end
+
     def put(relative_url, params: nil, data: nil)
       make_http_request(:put, relative_url, params: params, data: data)
     end
@@ -312,7 +349,7 @@ module StreamChat
     end
 
     def check_sqs(sqs_key = nil, sqs_secret = nil, sqs_url = nil)
-      post('check_sqs', data: { "sqs_key": sqs_key, "sqs_secret": sqs_secret, "sqs_url": sqs_url })
+      post('check_sqs', data: { sqs_key: sqs_key, sqs_secret: sqs_secret, sqs_url: sqs_url })
     end
 
     private
@@ -349,7 +386,7 @@ module StreamChat
       headers['stream-auth-type'] = 'jwt'
       url = [@base_url, relative_url].join('/')
       params = params.nil? ? {} : params
-      params = Hash[get_default_params.merge(params).sort_by { |k, _v| k.to_s }]
+      params = (get_default_params.merge(params).sort_by { |k, _v| k.to_s }).to_h
       url = "#{url}?#{URI.encode_www_form(params)}"
 
       body = data.to_json if %w[patch post put].include? method.to_s

data/lib/stream-chat/util.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# lib/util.rb
+
+def get_sort_fields(sort)
+  sort_fields = []
+  sort&.each do |k, v|
+    sort_fields << { field: k, direction: v }
+  end
+  sort_fields
+end

data/lib/stream-chat/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stream-chat-ruby
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.9.0
 platform: ruby
 authors:
 - Mircea Cosbuc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-05 00:00:00.000000000 Z
+date: 2021-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -99,6 +99,7 @@ files:
 - lib/stream-chat/channel.rb
 - lib/stream-chat/client.rb
 - lib/stream-chat/errors.rb
+- lib/stream-chat/util.rb
 - lib/stream-chat/version.rb
 - stream-chat.gemspec
 homepage: http://github.com/GetStream/stream-chat-ruby