Remove ApiToken and pass api_key as a string

[mnbf9rca]

Summary by Sourcery

This pull request refactors the API token handling by removing the ApiToken class and passing the API key directly as a string. It includes updates to the documentation and tests to reflect this change.

• Enhancements:
  • Refactored the API token handling by removing the ApiToken class and passing the API key directly as a string.
• Documentation:
  • Updated README.md to reflect the new method of passing the API key directly as a string.
• Tests:
  • Modified tests to accommodate the change from using ApiToken to passing the API key directly as a string.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request removes the ApiToken class and refactors the codebase to pass the api_key as a string. Significant changes include updating the Client and RestClient classes, modifying tests, and updating documentation and examples to reflect this change.

File-Level Changes

Files	Changes
tests/test_basic_tests.py tests/test_client.py	Updated tests to use a string for api_key instead of ApiToken.
pydantic_tfl_api/rest_client.py pydantic_tfl_api/client.py pydantic_tfl_api/__init__.py	Refactored client and rest client to use a string for api_key instead of ApiToken.
README.md example.py	Updated documentation and examples to use a string for api_key instead of ApiToken.

---

Tips

• Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
• Continue your discussion with Sourcery by replying directly to review comments.
• You can change your review settings at any time by accessing your dashboard:
  • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
  • Change the review language;
• You can always contact us if you have any questions or feedback.

[sourcery-ai]

Hey @mnbf9rca - I've reviewed your changes and they look great!

Here's what I looked at during the review

• 🟡 General issues: 3 issues found
• 🟢 Security: all looks good
• 🟡 Testing: 2 issues found
• 🟢 Complexity: all looks good
• 🟡 Documentation: 1 issue found

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.}

[sourcery-ai]

suggestion: Update docstring to reflect new parameter name.

The docstring should be updated to reflect the new parameter name 'api_token' instead of 'api_token' to avoid confusion.

[sourcery-ai]

suggestion (testing): Add test for invalid API key in parameterized test

Consider adding an additional parameterized test case for an invalid API key to ensure that the client handles invalid keys correctly.

Suggested change

	( "valid_key", RestClient, {"test_model"}),
	("valid_key", RestClient, {"test_model"}),
	("invalid_key", RestClient, {"test_model"}),

[sourcery-ai]

suggestion (documentation): Consider adding a note explaining the change from ApiToken to a direct token string.

To avoid confusion for users familiar with the previous method, consider adding a note or comment explaining the change from ApiToken(app_id, app_key) to token = "your_secret_token".

Suggested change

	token = "your_secret_token"
	# Note: Changed from ApiToken(app_id, app_key) to a direct token string for simplicity
	token = "your_secret_token"

[sourcery-ai]

suggestion (code-quality): Merge dictionary updates via the union operator (dict-assign-update-to-union)

Suggested change

	request_headers.update(self.app_key)
	request_headers |= self.app_key