search

bitcoindevkit / rust-esplora-client

Bitcoin Esplora API client library. Supports plaintext, TLS and Onion servers. Blocking or async.
MIT License
28 stars 44 forks source link

add http header support #66

Closed johncantrell97 closed 5 months ago

johncantrell97 commented 9 months ago

Technically an end-user could do this themselves because the builders support passing in pre-built ureq/reqwest clients but this makes it a bit easier for them.

Summary by CodeRabbit

LLFourn commented 9 months ago

Out of curiosity what do you need custom heeaders for?

johncantrell97 commented 9 months ago

Access to authenticated esplora servers. most public ones are heavily rate limited

notmandatory commented 8 months ago

Please rebase to pick up changes in #69 that fix CI.

johncantrell97 commented 7 months ago

rebased

notmandatory commented 7 months ago

@johncantrell97 thanks for your work on this. Our github rules also require commits be signed, can you amend/sign your commit?

notmandatory commented 6 months ago

@johncantrell97 hey can you rebase and rework this one now that #75 is merged? hopefully not a big change.

coderabbitai[bot] commented 5 months ago

Walkthrough

The update introduces the ability to handle custom HTTP headers across both asynchronous and blocking clients. This is achieved by adding a headers field to the Builder struct, allowing users to specify headers that are then applied to all requests. Additionally, the update includes error handling for invalid header names and values, and expands testing to cover the new functionality, ensuring that specified headers are correctly used in requests.

Changes

Files Change Summary
src/async.rs, src/blocking.rs Added logic to include custom HTTP headers in requests by utilizing a HeaderMap in AsyncClient and a HashMap<String, String> in BlockingClient.
src/lib.rs Introduced a headers field in the Builder struct for HTTP headers, methods to add headers, error variants for invalid headers, and expanded testing setup.

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](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: - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit-tests 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 tests 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 tests.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` 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 a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - 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/coderabbit-overrides.v2.json` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.
coveralls commented 5 months ago

Pull Request Test Coverage Report for Build 8310674431

Details

Changes Missing Coverage Covered Lines Changed/Added Lines %
src/lib.rs 43 47 91.49%
src/async.rs 2 10 20.0%
<!-- Total: 51 63 80.95% -->
Totals Coverage Status
Change from base Build 8167199538: -0.2%
Covered Lines: 959
Relevant Lines: 1134
💛 - Coveralls
notmandatory commented 5 months ago

I've rebased this on lastest master changes and updated to work with minreq for blocking module and added a simple test with http headers. In the process of rebasing I also signed the commits so github will let us merge it. Note: minreq doesn't include any header key, value validation.