Add error handling for missing API key #47
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Introduce a new error, ErrMethodRequiresAPIKey, and the requiresAPIKey function to ensure that methods requiring an API key cannot proceed without one. This enhances input validation and prevents misuse of API-dependent methods.
Added a check for API key validity across multiple HIBP API methods, including `BreachedAccount`, `SubscribedDomains`, `BreachedDomain`, and `Subscription.Status`. This ensures that requests are only made with a valid API key, improving error handling and alignment with API requirements.
This change ensures the API key is included when initializing the HTTP client in tests for various API endpoints. It improves test coverage for scenarios requiring authenticated requests, enhancing consistency and reliability in validation.
This test ensures that the subscription status request fails when no API key is provided. It validates that the correct error, `ErrMethodRequiresAPIKey`, is returned in such cases.
This commit adds test cases to ensure API key requirements are enforced for specific breach API methods. The new tests validate failure scenarios for "breached account," "subscribed domains," and "breached domain" endpoints when no API key is provided. These improvements strengthen the reliability of API key handling.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #47 +/- ##
==========================================
+ Coverage 97.40% 97.50% +0.09%
==========================================
Files 6 6
Lines 463 480 +17
==========================================
+ Hits 451 468 +17
Misses 8 8
Partials 4 4 ☔ View full report in Codecov by Sentry. |
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR introduces a new error,
ErrMethodRequiresAPIKey, and therequiresAPIKeymethod to ensure that methods requiring an API key cannot proceed without one. This enhances input validation and prevents misuse of API-dependent methods.