[ECO-4932] Added a wrapper ARTRealtime.request... method

[maratal]

Added a wrapper ARTRealtime.request... method for making rest requests via internal ARTRest instance.

Closes #1959

Summary by CodeRabbit

• New Features
  • Introduced a new method for making HTTP requests, enhancing flexibility and usability for developers interacting with the API.
  • Added a user-friendly wrapper for existing request functionality, streamlining the process of handling HTTP interactions.

[coderabbitai]

Walkthrough

The changes introduce a new method in the ARTRealtime class called request:path:params:body:headers:callback:error:, which allows for more flexible HTTP request handling. This method integrates with existing functionalities while enhancing the usability of the API for developers. The existing method time: remains unchanged, ensuring backward compatibility.

Changes

Files	Change Summary
Source/ARTRealtime.m, Source/include/Ably/ARTRealtime.h	Added a new method request:path:params:body:headers:callback:error: to facilitate HTTP requests.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant ARTRealtime
    participant Internal

    Client->>ARTRealtime: request(method, path, params, body, headers, callback, error)
    ARTRealtime->>Internal: Handle request
    Internal-->>ARTRealtime: Response
    ARTRealtime-->>Client: Callback with response

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Implement RealtimeClient#request (RTC9)	✅

🐰 In the meadow, I hop with glee,
A new request method, oh what a spree!
With headers and params, our calls are so neat,
For chat and for friends, our API’s now sweet.
So let’s dance in the code, with joy we’ll sing,
For every new feature, the rabbit will fling! 🐇✨

---

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?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • 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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 55ad795 and d75d7a4.

Files selected for processing (2)

• Source/ARTRealtime.m (2 hunks)
• Source/include/Ably/ARTRealtime.h (1 hunks)

Additional comments not posted (3)

Source/include/Ably/ARTRealtime.h (1)

75-84: Method addition looks good.

The request method is well-defined and documented, providing a useful wrapper for HTTP requests.

Source/ARTRealtime.m (2)

153-161: Method implementation looks good.

The request method correctly delegates to internal components, maintaining a modular approach.

---

495-503: Method implementation looks good.

The request method in ARTRealtimeInternal appropriately uses self.rest for handling requests, ensuring consistency with the existing architecture.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d75d7a4 and 937f0df.

Files selected for processing (2)

• Source/ARTRealtime.m (2 hunks)
• Source/include/Ably/ARTRealtime.h (1 hunks)

Files skipped from review as they are similar to previous changes (2)

• Source/ARTRealtime.m
• Source/include/Ably/ARTRealtime.h