Protocol::Redis

Protocol::Redis

Implements the RESP2 and RESP3 Redis protocols.

Development Status

Usage

Please browse the source code index or refer to the guides below.

Getting Started

This guide explains how to use the Protocol::Redis gem to implement the RESP2 and RESP3 Redis protocols for low level client and server implementations.

Releases

Please browse the releases for more details.

v0.12.0

  • Introduce Pubsub#spublish method for shard channels.

v0.11.0

  • Introduce cluster methods, including Strings, Streams, Scripting and Pubsub.

v0.10.0

  • Add agent context.
  • 100% documentation and test coverage + minor bug fixes.

v0.9.0

  • Add support for client info command.

v0.8.1

  • Fix HSCAN method implementation.

v0.8.0

  • Add missing hscan method.
  • Add mapped_hmget and mapped_hmset methods to match redis-rb gem interface.
  • Add cluster methods to client.
  • Make hashes methods compatible with redis-rb.

v0.7.0

  • Add scripting methods to client and fix script interface.
  • Include sets and streams in the protocol methods.
  • Add support for essential exists? method.
  • Prefer bake-gem for release management.

v0.6.1

  • Add support for multi-argument auth.

v0.6.0

  • Add relevant pubsub method group.

v0.5.1

  • Add tests for info command, streams, and string methods.
  • Use correct CRLF constant in server methods.
  • Modernize gem configuration.

Contributing

We welcome contributions to this project.

  1. Fork it.
  2. Create your feature branch (git checkout -b my-new-feature).
  3. Commit your changes (git commit -am 'Add some feature').
  4. Push to the branch (git push origin my-new-feature).
  5. Create new Pull Request.

Developer Certificate of Origin

In order to protect users of this project, we require all contributors to comply with the Developer Certificate of Origin. This ensures that all contributions are properly licensed and attributed.

Community Guidelines

This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.