feat: enhance get_message method to support options and add tests for deleted messages

Author: nijeesh-stream

lib/stream-chat/client.rb

@@ -177,9 +177,9 @@ def review_flag_report(report_id, review_result, user_id, **details)
     end
 
     # Returns a message.
-    sig { params(id: String).returns(StreamChat::StreamResponse) }
-    def get_message(id)
-      get("messages/#{id}")
+    sig { params(id: String, options: T.untyped).returns(StreamChat::StreamResponse) }
+    def get_message(id, **options)
+      get("messages/#{id}", params: options)
     end
 
     # Searches for messages.

spec/client_spec.rb

@@ -266,14 +266,36 @@ def loop_times(times)
     @client.mark_all_read(@random_user[:id])
   end
 
-  it 'gets message by id' do
-    msg_id = SecureRandom.uuid
-    message = @channel.send_message({
-                                      'id' => msg_id,
-                                      'text' => 'Hello world'
-                                    }, @random_user[:id])[:message]
+  describe '#get_message' do
+    # runs before all tests in this describe block once
+    before(:all) do
+      @msg_id = SecureRandom.uuid
+      @channel.send_message({
+                              'id' => @msg_id,
+                              'text' => 'This is not deleted'
+                            }, @random_user[:id])
+      @deleted_msg_id = SecureRandom.uuid
+      @channel.send_message({
+                            'id' => @deleted_msg_id,
+                            'text' => 'This is deleted'
+                          }, @random_user[:id])
+      @client.delete_message(@deleted_msg_id)
+    end
 
-    expect(@client.get_message(msg_id)[:message]).to eq(message)
+    it 'gets message by id' do
+      message = @client.get_message(@msg_id)[:message]
+      expect(message.id).to eq(@msg_id)
+    end
+
+    it 'gets deleted message when show_deleted_message is true' do
+      message = @client.get_message(@deleted_msg_id, show_deleted_message: true)[:message]
+      expect(message.id).to eq(@deleted_msg_id)
+    end
+
+    it 'also it gets non-deleted message when show_deleted_message is true' do
+      message = @client.get_message(@msg_id, show_deleted_message: true)[:message]
+      expect(message.id).to eq(@msg_id)
+    end
   end
 
   it 'pins and unpins a message' do