[CHA-768] feat: enhance get_message method to support options and add tests for deleted messages

[nijeesh-stream]

Submit a pull request

CLA

• I have signed the Stream CLA (required).
• The code changes follow best practices
• Code changes are tested

Description of the pull request

This PR adds support for the show_deleted_message option in the get_message API. This feature allows retrieving deleted messages when explicitly requested.

Changes Made

1. Added support for the show_deleted_message option in the get_message method
2. Added comprehensive test cases to verify the functionality:
   • Basic message retrieval
   • Retrieving deleted messages with show_deleted_message: true
   • Retrieving non-deleted messages with show_deleted_message: true

Test Cases

The following test cases have been added to verify the functionality:

 it 'gets message by id' do
      response = @client.get_message(@msg_id)
      message = response['message']
      expect(message['id']).to eq(@msg_id)
    end

    it 'gets deleted message when show_deleted_message is true' do
      response = @client.get_message(@deleted_msg_id, show_deleted_message: true)
      message = response['message']
      expect(message['id']).to eq(@deleted_msg_id)
    end

    it 'also it gets non-deleted message when show_deleted_message is true' do
      response = @client.get_message(@msg_id, show_deleted_message: true)
      message = response['message']
      expect(message['id']).to eq(@msg_id)
    end

Implementation Details

The get_message method now accepts an optional show_deleted_message parameter that is passed through to the API. This allows users to:

1. Retrieve deleted messages when needed
2. Maintain backward compatibility with existing code
3. Have explicit control over whether deleted messages should be included in the response

Testing

All tests have been run and passed successfully. The test suite includes:

• Unit tests for the new functionality
• Integration tests to verify API behavior
• Edge cases for both deleted and non-deleted messages

Documentation

The changes maintain the existing documentation style and include:

• Method signature updates
• Parameter descriptions
• Usage examples in the test cases

Breaking Changes

None. This is a backward-compatible enhancement that adds new functionality without modifying existing behavior.