= Rails::Keyserver
image:https://img.shields.io/gem/v/rails-keyserver.svg[ Gem Version, link="https://rubygems.org/gems/rails-keyserver"] image:https://img.shields.io/travis/riboseinc/rails-keyserver/master.svg[ Build Status, link="https://travis-ci.org/riboseinc/rails-keyserver/branches"] image:https://img.shields.io/codecov/c/github/riboseinc/rails-keyserver.svg[ Test Coverage, link="https://codecov.io/gh/riboseinc/rails-keyserver"] image:https://img.shields.io/codeclimate/maintainability/riboseinc/rails-keyserver.svg[ "Code Climate", link="https://codeclimate.com/github/riboseinc/rails-keyserver"]
A generic Rails engine for serving most kinds of keys.
== Installation
Add this line to your application’s Gemfile:
And then execute:
Or install it yourself as:
== Routes
The following is a sample of what we would like to achieve in terms of API endpoints:
[ { public: '===== BEGIN PGP BLOCK ==========.....', key_id: 0x346cb447 key_type: rsa expires: '2055/12/12 11:23:45Z+08:00' key_size: 4096/4096 fingerprint: 72e5 f8ae da12 7b85 fadb 25a5 83a3 ef8c 346c b447 userid: apple product security activation_date: '2055/12/12 11:23:45Z+08:00', } ]
[ { public: '===== BEGIN PGP BLOCK ==========.....', key_id: 0x346cb446 key_type: rsa expires: '2055/12/12 11:23:45Z+08:00' key_size: 4096/4096 fingerprint: 72e5 f8ae da12 7b85 fadb 25a5 83a3 ef8c 346c b447 userid: apple product security activation_date: '2055/12/12 11:23:45Z+08:00', } ]
200: { id: 'slfsjdfdklsj', public: '===== BEGIN PGP BLOCK ==========.....', key_id: 0x346cb446 key_type: rsa expires: '2055/12/12 11:23:45Z+08:00' key_size: 4096/4096 fingerprint: 72e5 f8ae da12 7b85 fadb 25a5 83a3 ef8c 346c b447 userid: apple product security created_at: '2055/12/12 11:23:45Z+08:00', }
422: { errors: { format: 'invalid' } }
== Usage
=== Override controllers and rendering methods
==== Keys Controller
#render_index
** @composed
is the collection to render#render_show_json(key)
#render_show_ext(key)
==== Default settings for mounted routes
== Contributing
First, thank you for contributing! We love pull requests from everyone. By participating in this project, you hereby grant https://www.ribose.com[Ribose Inc.] the right to grant or transfer an unlimited number of non exclusive licenses or sub-licenses to third parties, under the copyright covering the contribution to use the contribution by all means.
Here are a few technical guidelines to follow:
== Credits
This gem is developed, maintained and funded by https://www.ribose.com[Ribose Inc.]
== License
The gem is available as open source under the terms of the http://opensource.org/licenses/MIT[MIT License].