Feat/add ttl to response

[mnbf9rca]

resolves #43

Summary by Sourcery

This pull request introduces a TTL (time-to-live) feature for API responses by calculating expiration times from the 'cache-control' header. It also updates the Pydantic models to include a 'content_expires' property and updates the README to document these changes.

• New Features:
  • Added TTL (time-to-live) calculation for API responses based on the 'cache-control' header.
• Enhancements:
  • Updated Pydantic models to include a 'content_expires' property for tracking TTL.
• Documentation:
  • Updated README to document the new 'content_expires' property in response objects and its usage.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request adds a Time-To-Live (TTL) feature to the response objects in the pydantic_tfl_api. The TTL is calculated based on the 's-maxage' directive in the 'cache-control' header of the HTTP response. The changes involve updating the client to parse this header and calculate the expiry time, and modifying the models to include a 'content_expires' field.

File-Level Changes

Files	Changes
pydantic_tfl_api/models/line.py pydantic_tfl_api/models/disruption.py pydantic_tfl_api/models/mode.py pydantic_tfl_api/models/prediction.py pydantic_tfl_api/models/route_sequence.py pydantic_tfl_api/models/stop_points_response.py	Added content_expires field to multiple models to store the calculated expiry time.

---

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: 9 issues found
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

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.}