just-encrypt 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d098863785faeea95dd4205e6cf623a8f543137716bfc007868ef19703a356d8
-  data.tar.gz: 4610a38974c0b379ce10978c26e49e2b51fb4ed5e155987dd0c0d196fa5979e9
+  metadata.gz: 2e35289244a30a59b4ee4445b1ceed17839c827b8a0f4b009ae0d6cb93222840
+  data.tar.gz: 0b67ccb69907ab655e67e5e48f34ba7ef187e190fad09e34eaac72596426a809
 SHA512:
-  metadata.gz: e3ec12b4be15f5bb2d128ff4cbf32e5d967b70b75f3e9b3c51149bc56697112c0d903676fbabdeb6a81075d46506eee4e336d7f37d0599ba1095ec166b52df50
-  data.tar.gz: eba123531b8270d4658cc86056d458ec329d5510ac5946b573e4fe7e68c679b4ba09528db3bb8e0100e93540233315f43bf86940966496a61bf5429f8cdd9308
+  metadata.gz: 33e0231c4b4c68a19769ac32e880a45d5d16b4ff7402a4233d779b85536838e45bbc86311c5e620a64506fbc0c2a3edd01db15161aff1993e50eb47d0ad26615
+  data.tar.gz: a61e0d8473a5a4baa693ecb68eff928a96c1b30b2672fe240b8f727aa771e493a46463af3c26c28059ebf8e29d5635fd1b7bf8b5db4b61b6a8ae69903ec464ab

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Jeremías Gutiérrez.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# Just Encrypt
+
+The simplest gem to encrypt and decrypt data, you only need to set a secret password to your credentials.
+
+# Getting started
+JustEncrypt works with Rails 5.2 onwards. Add the following line to your Gemfile:
+```ruby
+gem 'just-encrypt'
+```  
+Then run `bundle install`
+
+Next, you need to add a secret key into your credentials file, the key must be 32 bytes. You can generate one easily with OpenSSL:
+```console
+$ openssl rand -hex 32
+```
+
+Then edit your credentials:
+```console
+$ EDITOR=vim rails credentials:edit
+```
+
+And add the secret key generated with the next structure:
+
+```console
+just_encrypt:
+  secret: YOUR_SECRET_KEY
+```
+  
+## Encrypt data
+
+For encrypt data just do:
+
+```ruby 
+require 'just-encrypt'
+
+JustEncrypt.encrypt('STRING_TO_ENCRYPT')
+```
+
+## Decrypt data
+
+```ruby 
+require 'just-encrypt'
+
+JustEncrypt.decrypt('STRING_TO_DECRYPT')
+```
+
+## Contributing
+
+1. Fork it
+2. Commit changes
+3. Submit a Pull Request
+4.  :heart:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: just-encrypt
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Jeremías G.
@@ -16,9 +16,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- MIT-LICENSE
+- README.md
 - lib/just-encrypt.rb
 homepage: https://github.com/jimmy-owoa/just-encrypt
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -28,7 +31,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="