Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/torokmark/encrubto

Ruby encryption library
https://github.com/torokmark/encrubto

Last synced: 30 days ago
JSON representation

Ruby encryption library

Awesome Lists containing this project

README

        

# Encrubto

[![Build Status](https://travis-ci.org/torokmark/encrubto.svg?branch=master)](https://travis-ci.org/torokmark/encrubto)
[![Coverage Status](https://coveralls.io/repos/github/torokmark/encrubto/badge.svg?branch=master)](https://coveralls.io/github/torokmark/encrubto?branch=master)

Encrubto is intended to provide encryption and decryption algorithms.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'encrubto'
```

And then execute:

$ bundle

Or install it yourself as:

$ gem install encrubto

## Usage

```ruby
require 'encrubto'

encrypted_str = Encrubto::Rot13.encrypt('apple')
decrypted_str = Encrubto::Rot13.decrypt(encrypted_str)

puts "#{ encrypted_str } == #{ decrypted_str }"
```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/torokmark/encrubto. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the Encrubto project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/torokmark/encrubto/blob/master/CODE_OF_CONDUCT.md).