OAuth Signature

Build Status Gem Version Depfu Maintainability Test Coverage

OAuth is a ruby gem to help encrypt OAuth client secrets so that they can be safely stored in desktop applications. This gem is a work in progress and is a smaller part of a larger planned suite of software to assist in OAuth related desktop application problems.

Documentation

You should find the documentation for your version of oauth_signature on Rubygems

See GETTING_STARTED for information on how to generate and read encrypted certificates.

Installation

Add this line to your application's Gemfile:

gem 'oauth_signature'

And then execute:

bundle

Or install it yourself as:

gem install oauth_signature

Using OAuthSignature with Rails

you can begin using OAuthSignature with rails by running:

bundle exec rails generate oauth_signature:install

you will then be prompted with further steps on configuring and completing the installation of OAuthSignature with your Rails application. Also be sure to checkout GETTING_STARTED for more detailed information on how to use OAuthSignature with Rails.

Supported Versions

  • ruby 2.5.0+
  • rails 5.2.0+

Development

After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the OAuth Signature project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.