refactor: remove direct dependency on redis-rb

[matteoredz]

Summary by CodeRabbit

Release Notes

• Documentation

  • Updated README with clearer Redis gem references
  • Added comprehensive documentation for RedisStore class and methods
  • Improved clarity of usage instructions and method behaviors

• Dependencies

  • Removed explicit runtime dependency on Redis gem

• Improvements

  • Enhanced error handling for Redis store loading
  • Implemented conditional module loading for better compatibility

[coderabbitai]

Warning

Rate limit exceeded

@matteoredz has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 6 minutes and 26 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 607c2fe and a4c2d41.

📒 Files selected for processing (8)

• Gemfile (1 hunks)
• README.md (1 hunks)
• idempotency_key.gemspec (0 hunks)
• lib/rack/idempotency_key.rb (1 hunks)
• lib/rack/idempotency_key/redis_store.rb (2 hunks)
• spec/rack/idempotency_key/memory_store_spec.rb (0 hunks)
• spec/rack/idempotency_key/redis_store_spec.rb (0 hunks)
• spec/support/shared_examples/describe_store_get_and_set_methods.rb (1 hunks)

Walkthrough

This pull request focuses on improving the documentation and error handling for the Redis store functionality in the Rack Idempotency Key middleware. The changes include updating the README with more precise Redis gem references, removing a runtime dependency on the Redis gem, implementing conditional loading of the Redis store module, and adding comprehensive documentation comments to the Redis store implementation. The modifications aim to enhance clarity and flexibility in how the Redis store can be used and loaded.

Changes

File	Change Summary
README.md	- Updated "redis gem" to "redis-rb gem" - Modified Redis instantiation from Redis.current to Redis.new
idempotency_key.gemspec	- Removed runtime dependency on "redis" gem with version constraint
lib/rack/idempotency_key.rb	- Added conditional loading mechanism for redis_store module - Implemented begin-rescue block with warning messages if Redis store cannot be loaded
lib/rack/idempotency_key/redis_store.rb	- Added extensive documentation comments for RedisStore class - Documented initialize, get, set, and unset methods with parameter details, return values, and usage examples

Possibly related PRs

• refactor: remove configurable routes #12: Documentation updates for RedisStore implementation and Redis instantiation
• feat: properly handle concurrent requests from Memory and Redis stores #15: Modifications to error handling in IdempotencyKey class
• feat: add request hashing #16: Redis store method signature and error handling improvements

Poem

🐰 A Redis tale of code so bright,
Conditional loading, a developer's delight!
Docs sparkle like gems so clear,
Flexibility dancing without fear,
Idempotency keys now shine with might! 🔑✨

---

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
• Mastodon
• Reddit
• LinkedIn

🪧 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 <commit_id>, please review it.
  • Generate unit testing code 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 testing code 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• 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/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.