[ECO-4962] feat: add `ChatApi` implementation

Walkthrough

The changes introduce a new ChatApi class designed for interacting with a chat service, featuring methods for retrieving messages, sending messages, and checking occupancy. Additionally, the project enhances its dependency management by incorporating Gson for JSON processing, along with new testing libraries. A new interface for managing paginated results has also been established, improving the overall structure and functionality of the codebase.

Changes

File	Change Summary
`chat-android/build.gradle.kts`	Changed `ably.android` dependency from `implementation` to `api` and added `gson`, `mockk`, and `coroutine.test` dependencies.
`chat-android/src/main/java/com/ably/chat/ChatApi.kt`	Introduced `ChatApi` class with methods for message retrieval, sending, and occupancy.
`chat-android/src/main/java/com/ably/chat/PaginatedResult.kt`	Added `PaginatedResult` interface and extension function for handling paginated results.
`chat-android/src/test/java/com/ably/chat/ChatApiTest.kt`	Introduced unit tests for `ChatApi` methods.
`gradle/libs.versions.toml`	Introduced Gson, MockK, and Coroutine library dependency versions for JSON handling and testing.
`detekt.yml`	Added `excludes` property to ignore test directories in complexity checks.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ChatApi
    participant RealtimeClient
    participant Server

    User->>ChatApi: getMessages(roomId, params)
    ChatApi->>RealtimeClient: fetchMessages(roomId, params)
    RealtimeClient->>Server: HTTP GET /messages
    Server-->>RealtimeClient: return messages
    RealtimeClient-->>ChatApi: messages
    ChatApi-->>User: return messages

sequenceDiagram
    participant User
    participant ChatApi
    participant RealtimeClient
    participant Server

    User->>ChatApi: sendMessage(roomId, params)
    ChatApi->>RealtimeClient: sendMessage(roomId, params)
    RealtimeClient->>Server: HTTP POST /messages
    Server-->>RealtimeClient: return response
    RealtimeClient-->>ChatApi: response
    ChatApi-->>User: return response

Assessment against linked issues

Objective	Addressed	Explanation
Implement `ChatApi` (ECO-4962)	✅

🐰 In the meadow, I hop with glee,
New ChatApi brings joy to me!
Messages sent and received with grace,
With Gson's help, we quicken the pace.
Test cases added, all snug and tight,
Hooray for the code, it feels just right! 🌼

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

ably-labs / ably-chat-kotlin