feat(client): Add impersonate_with_headers allows optionally setting request headers

[0x676e67]

Summary by CodeRabbit

• New Features

  • Introduced a new example for impersonating a user with custom headers in HTTP requests.
  • Added a method for setting headers during the impersonation process in the client builder.

• Documentation

  • Improved formatting and clarity of the README file.
  • Updated documentation comments for better understanding of HTTP/WebSocket proxy support and TLS settings.

• Bug Fixes

  • Standardized capitalization for "HTTP" and "HTTPS" throughout the documentation.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The recent updates enhance the documentation and functionality of an asynchronous Rust HTTP/WebSocket client. Key changes include improved readability in the README, the introduction of a new method for header management in the client builder, and the addition of an example demonstrating user impersonation in HTTP requests. These modifications aim to improve usability, clarity, and flexibility without altering core functionalities.

Changes

File	Change Summary
README.md	Improved formatting, standardized capitalization, and clarified feature descriptions.
examples/impersonate_with_headers.rs	Introduced a new example demonstrating an HTTP client that impersonates a user while sending requests.
src/client/client.rs	Added impersonate_with_headers method for header management; updated use_preconfigured_tls and apply_tls_settings methods for clarity and flexibility.
src/lib.rs	Updated documentation comments for HTTP/WebSocket proxies and TLS settings for clarity.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API
    Client->>Client: Build HTTP Client with Headers
    Client->>API: Send GET request
    API-->>Client: Return response
    Client->>Client: Print response to console

Loading

🐰 In the garden, changes bloom,
New methods sprout, dispelling gloom.
Headers set with a gentle touch,
Code flows freely, oh so much!
A whiskered cheer for each new line,
In Rust we trust, our code will shine! 🌼

---

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.