[CHAT-2598] Add shadow_ban, remove_shadow_ban, update_message_partial, pin_message & unpin_message methods (#58)

* added update_message_partial

* pin and unpin message methods

* add shadow_ban and remove_shadow_ban methods

* rubocop

* more linting

* more linting

* set rubygems_mfa_required

Author: gumuz

lib/stream-chat/client.rb

@@ -160,6 +160,16 @@ def unban_user(target_id, **options)
       delete('moderation/ban', params: params)
     end
 
+    def shadow_ban(target_id, **options)
+      payload = { target_user_id: target_id, shadow: true }.merge(options)
+      post('moderation/ban', data: payload)
+    end
+
+    def remove_shadow_ban(target_id, **options)
+      params = { target_user_id: target_id, shadow: true }.merge(options)
+      delete('moderation/ban', params: params)
+    end
+
     def mute_user(target_id, user_id)
       payload = { target_id: target_id, user_id: user_id }
       post('moderation/mute', data: payload)
@@ -175,12 +185,37 @@ def mark_all_read(user_id)
       post('channels/read', data: payload)
     end
 
+    def pin_message(message_id, user_id, expiration: nil)
+      updates = {
+        set: {
+          pinned: true,
+          pin_expires: expiration
+        }
+      }
+      update_message_partial(message_id, updates, user_id: user_id)
+    end
+
+    def unpin_message(message_id, user_id)
+      updates = {
+        set: {
+          pinned: false
+        }
+      }
+      update_message_partial(message_id, updates, user_id: user_id)
+    end
+
     def update_message(message)
       raise ArgumentError 'message must have an id' unless message.key? 'id'
 
       post("messages/#{message['id']}", data: { message: message })
     end
 
+    def update_message_partial(message_id, updates, user_id: nil, **options)
+      params = updates.merge(options)
+      params['user'] = { id: user_id } if user_id
+      put("messages/#{message_id}", data: params)
+    end
+
     def delete_message(message_id)
       delete("messages/#{message_id}")
     end

spec/client_spec.rb

@@ -120,6 +120,30 @@
     expect(response['user']['name']).to eq('Gandalf the Grey')
   end
 
+  it 'shadow bans a user' do
+    @client.shadow_ban(@random_user[:id], user_id: @random_users[0][:id])
+
+    msg_id = SecureRandom.uuid
+    response = @channel.send_message({
+                                       id: msg_id,
+                                       text: 'Hello world'
+                                     }, @random_user[:id])
+    expect(response['message']['shadowed']).to eq(false)
+    response = @client.get_message(msg_id)
+    expect(response['message']['shadowed']).to eq(true)
+
+    @client.remove_shadow_ban(@random_user[:id], user_id: @random_users[0][:id])
+
+    msg_id = SecureRandom.uuid
+    response = @channel.send_message({
+                                       id: msg_id,
+                                       text: 'Hello world'
+                                     }, @random_user[:id])
+    expect(response['message']['shadowed']).to eq(false)
+    response = @client.get_message(msg_id)
+    expect(response['message']['shadowed']).to eq(false)
+  end
+
   it 'bans a user' do
     @client.ban_user(@random_user[:id], user_id: @random_users[0][:id])
   end
@@ -171,6 +195,19 @@
     expect(@client.get_message(msg_id)[:message]).to eq(message)
   end
 
+  it 'pins and unpins a message' do
+    msg_id = SecureRandom.uuid
+    response = @channel.send_message({
+                                       'id' => msg_id,
+                                       'text' => 'Hello world'
+                                     }, @random_user[:id])
+    response = @client.pin_message(response['message']['id'], @random_user[:id])
+    expect(response['message']['pinned_by']['id']).to eq(@random_user[:id])
+
+    response = @client.unpin_message(response['message']['id'], @random_user[:id])
+    expect(response['message']['pinned_by']).to eq(nil)
+  end
+
   it 'updates a message' do
     msg_id = SecureRandom.uuid
     response = @channel.send_message({
@@ -186,6 +223,26 @@
                            })
   end
 
+  it 'updates a message partially' do
+    msg_id = SecureRandom.uuid
+    response = @channel.send_message(
+      {
+        id: msg_id,
+        text: 'Hello world'
+      }, @random_user[:id]
+    )
+    expect(response['message']['text']).to eq('Hello world')
+    response = @client.update_message_partial(msg_id,
+                                              {
+                                                set: {
+                                                  awesome: true,
+                                                  text: 'helloworld'
+                                                }
+                                              }, user_id: @random_user[:id])
+    expect(response['message']['text']).to eq('helloworld')
+    expect(response['message']['awesome']).to eq(true)
+  end
+
   it 'deletes a message' do
     msg_id = SecureRandom.uuid
     @channel.send_message({

stream-chat.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'simplecov'
+  gem.metadata['rubygems_mfa_required'] = 'true'
 end