Implements Custom Headers and Better Timeout for REST Interfaces

[davidvonthenen]

Fixes issue: https://github.com/deepgram/deepgram-dotnet-sdk/issues/234

This implements:

• custom headers for each REST call
• setting timeouts per REST call instead of having a global "high water mark" implementation
• Fixes all unit tests to verify this works
• Updates examples and those examples work as intented
• Updates formatting of Unit Tests to be more uniform

Summary by CodeRabbit

• New Features
  • Introduced new HTTP operation methods with enhanced flexibility and error handling in the REST client.
  • Added headers parameter to various client methods for custom request headers.
  • New NoopSchema classes across different models for future extensibility.
• Bug Fixes
  • Fixed cancellation token consistency in the Live client.
• Refactor
  • Refactored URL construction and parameter handling across various clients for improved readability and maintainability.
  • Renamed RequestContentUtil to HttpRequestUtil for clarity.
• Tests
  • Enhanced unit tests with better exception handling, refined input parameters, and clearer assertions.
  • Improved test comments for better understanding of test setup and expectations.
• Documentation
  • Updated comments and documentation for clearer guidance on placeholders and expected inputs.
• Chores
  • Updated project configurations and target frameworks for examples.
• Style
  • Adjusted comments from //Arrange to // Input and Output in test descriptions for enhanced clarity.

[coderabbitai[bot]]

Walkthrough

This comprehensive update focuses on refining and enhancing the Deepgram .NET SDK across various client tests, utility classes, and client implementations. It includes method signature updates, improved exception handling, refined test setups, and the introduction of new functionalities such as custom headers and cancellation token support. Additionally, it addresses HTTP client configuration, timeout settings, and the organization of constants and schemas within the SDK, aiming to improve flexibility, readability, and maintainability.

Changes

File Paths	Change Summaries
Deepgram.Tests/UnitTests/ClientTests/...	Adjusted test methods for exception handling, method signatures, mock setups, and added clarity in comments.
Deepgram/Abstractions/..., Deepgram/Clients/...	Introduced new methods with additional parameters for headers and cancellation tokens, updated method calls, and refined URI construction.
Deepgram/Models/...	Added NoopSchema.cs files across various namespaces as placeholders or base schemas.
Deepgram/Utilities/QueryParameterUtil.cs, Deepgram/Abstractions/Utilities.cs	Refactored methods for URL formatting and renamed classes for clarity.
Deepgram/Deepgram.csproj, examples/...	Updated project configurations and target frameworks.
Deepgram/Factory/HttpClientFactory.cs	Enhanced HTTP client configuration with infinite timeout and protocol check.

Related issues

• deepgram/deepgram-dotnet-sdk#234: The changes in this PR, especially around method signature updates for thread safety and custom headers, directly address the objectives related to further HTTP/REST refactoring for thread safety and custom HTTP params.
• deepgram/deepgram-dotnet-sdk#127: The introduction of new methods and parameters could potentially allow for the setting of HTTP timeouts as requested, although it's not explicitly mentioned, the groundwork for such functionality seems to be laid here.
• deepgram/deepgram-dotnet-sdk#181: While the PR summary does not explicitly mention exposing the metadata field, the extensive updates and refactoring could facilitate such a feature in future updates.
• deepgram/deepgram-dotnet-sdk#229: The refactoring and improvements in test setups and the introduction of new utility methods could help address the concern of repeated setup of HttpClientWrapper and mocking HTTP calls.

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.

[davidvonthenen]

Updated PR based on code rabbit feedback.