stream-chat-ruby 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea550365bc302aeb9097c2f2819a0dd6c5ead1fd1064a7c12842de4670e871d4
-  data.tar.gz: b01a528a334338edfd9f05e8f3aa40e682cabd3de40e6356b162f9f0cc791e64
+  metadata.gz: cff8888b576ad92ca17c3275504e585b1490e3935e7d86595aad795dfea67a7d
+  data.tar.gz: 8aa309ce84be59f966edee13e0e8957f863f59c535bc8df9d41d90484e8b1cb5
 SHA512:
-  metadata.gz: 3f12aa7bec1853b9a91e3b9a63a6f296aca373bb8f24a719a0728959e68cbe10e4b440bc7056d730bfa36f3e2a0c5c1b4db1b566cc51159a09bad3eac4694747
-  data.tar.gz: 9982645b54641b15fd7d8deae0049d90aca66defcaba509e19be7f0c27dfd42fec8bba5221b0ca961251fc8c084c61a1793fcc689df853ae09a570b0358ac605
+  metadata.gz: 9ca7b965ba2ca2fdffcb3ff667d93a1081e5aa15f40d3aeb9a167c945f26e54d3e773e826ca583c445c0da02acb5f67f3c450d7fc3fce98fcb958acd7e9077cf
+  data.tar.gz: 98b040deb4906b952d393244fb228843e77d669481104fa0ca75512cdcaacfccd75d8733c9ade31854366ab066ff6c58a54d2ff3c89e6c590d5a8c9fdc17c888

data/.github/workflows/ci.yml

@@ -18,6 +18,7 @@ jobs:
       - env:
           STREAM_CHAT_API_KEY: ${{ secrets.STREAM_CHAT_API_KEY }}
           STREAM_CHAT_API_SECRET: ${{ secrets.STREAM_CHAT_API_SECRET }}
+          BLOCKLIST: ${{ matrix.ruby == '2.7' }}
         run: |
           gem install bundler
           bundle install --jobs 4 --retry 3

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 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

data/README.md

@@ -131,8 +131,16 @@ 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'}}, {last_created_at: -1}, offset: 5, limit: 5)
+chan.query_members({name: {'$autocomplete': 'test'}}, sort: {last_created_at: -1}, offset: 5, limit: 5)
 ```
 
 ### Messages

data/lib/stream-chat/channel.rb

@@ -25,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
 
@@ -35,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?
 
@@ -61,7 +61,7 @@ module StreamChat
       state
     end
 
-    def query_members(filter_conditions: {}, sort: nil, **options)
+    def query_members(filter_conditions = {}, sort: nil, **options)
       params = {}.merge(options).merge({
                                          id: @id,
                                          type: @channel_type,
@@ -80,10 +80,17 @@ module StreamChat
     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
@@ -93,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)
@@ -150,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

@@ -60,22 +60,22 @@ 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 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
 
@@ -85,11 +85,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)
@@ -100,7 +100,7 @@ module StreamChat
 
         payload[id] = user
       end
-      post('users', data: { 'users': payload })
+      post('users', data: { users: payload })
     end
 
     def update_user(user)
@@ -108,7 +108,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)
@@ -132,34 +132,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)
@@ -168,14 +168,14 @@ module StreamChat
 
     def query_users(filter_conditions, sort: nil, **options)
       params = options.merge({
-                               "filter_conditions": filter_conditions,
-                               "sort": get_sort_fields(sort)
+                               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)
-      data = { "state": true, "watch": false, "presence": false }
+      data = { state: true, watch: false, presence: false }
       data = data.merge(options).merge({
                                          filter_conditions: filter_conditions,
                                          sort: get_sort_fields(sort)
@@ -218,18 +218,18 @@ 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 verify_webhook(request_body, x_signature)
@@ -246,11 +246,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)
@@ -258,7 +258,7 @@ 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)
@@ -305,7 +305,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

data/lib/stream-chat/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stream-chat-ruby
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Mircea Cosbuc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-20 00:00:00.000000000 Z
+date: 2021-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday