Tests Coverage Status User Docs API Docs

KCV

KCV is a glue gem for making it easy to use Keycard, Checkpoint, and Vizier together in your application.

Each of the above libraries is designed to be independent of each other, but follow relatively simple interfaces that work together. For example, Checkpoint grants permissions to agents and has an AgentResolver extension mechanisms and Keycard can inspect a request for the attributes needed to create agents, but neither should depend on the other. This is where KCV comes in, providing an AgentResolver implementation that depends on Keycard's interface. Then, this can be used directly or extended within your application.

Installation

Add this line to your application's Gemfile:

gem 'kcv'

And then execute:

$ bundle

Compatibility

KCV is intended to be compatible with all community-supported Ruby branches (i.e., minor versions), currently:

  • 2.6
  • 2.7
  • 3.0
  • 3.1

We prefer the newest syntax and linting rules that preserve compatibility with the oldest branch in normal maintenance. When the security maintenance for a branch expires, Keycard's compatibility should be considered unsupported.

See also, Ruby's branch maintenance policy.

License

Checkpoint is licensed under the BSD-3-Clause license. See LICENSE.md.