easy_encryption 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7462e6d0b95b2deceeae6234766c5d179a77e6a1
+  data.tar.gz: 206ab0d885387883b14d533d40f6aae503a493ee
+SHA512:
+  metadata.gz: 1899ad93eb959af929f8360ab17a2d2d41ae3ef8dddf6193a710570441f44444f8d85b129281cc47be9f93b4e868ae292a1e8d4a3c30c733c06e724776e3f671
+  data.tar.gz: 31d4560e6f980befd5d49fe9b096b95564706726a5794b3801a95b9dbabe1d2fc619b4ddb3d4b2b3a349ab981bc56b7eba78497570fb19f1d3ca92f73278b237

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.swp
+*.un~
+.DS_STORE

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in easy_encryption.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Adam Ervans
+
+MIT License
+
+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,69 @@
+# EasyEncryption
+
+Easy Encryption provides a simple means for encrypting and decrypting strings. Uses the Gibberish gem (https://github.com/mdp/gibberish) under the hood to do the actual encryption work.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'easy_encryption'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install easy_encryption
+
+Finally, call setup on EasyEncryption passing your cipher key:
+```ruby
+EasyEncryption.setup 'secret'
+```
+
+In a Rails app you will need to set the default cipher key inside of your app's ::Application.configure block:
+```ruby
+config.after_initialize do
+  EasyEncryption.setup 'secret'
+end
+```
+
+To enable the gem for your Rails tests, set the default cipher key inside of `test_helper.rb` as in the first example.
+
+## Usage
+
+EasyEncryption provides two additional methods that can be called on any string.
+
+`encrypt` will encrypt a string:
+```ruby
+encrypted_data = 'foo'.encrypt
+```
+
+`decrypt` will decrypt an encrypted string:
+```ruby
+decrypted_data = encrypted_data.decrypt
+```
+
+For special cases where a different cipher key needs to be used, it can be passed directly:
+```ruby
+encrypted_data = 'foo'.encrypt 'secret'
+decrypted_data = 'encrypted data'.decrypt 'secret'
+```
+
+Alternatively:
+```ruby
+string = 'foo'
+string.cipher_key = 'secret'
+encrypted_data = string.encrypt
+
+encrypted_data.cipher_key = 'secret'
+decrypted_data = encrypted_data.decrypt
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/easy_encryption.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'easy_encryption/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "easy_encryption"
+  spec.version       = EasyEncryption::VERSION
+  spec.authors       = ["Adam Ervans"]
+  spec.email         = ["aervans@gmail.com"]
+  spec.description   = %q{Check the github page for a detailed description}
+  spec.summary       = %q{Adds easy to use encrypt and decrypt methods to strings.}
+  spec.homepage      = "https://github.com/arthrex/easy-encryption"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_dependency "gibberish"
+end

data/lib/easy_encryption.rb

@@ -0,0 +1,43 @@
+require "easy_encryption/version"
+require "easy_encryption/instance_methods"
+require "easy_encryption/class_methods"
+require "gibberish"
+
+module EasyEncryption
+
+  # sets up EasyEncryption
+  def self.setup(cipher_key)
+    @cipher_key = cipher_key
+    String.send :include, InstanceMethods
+    String.send :extend, ClassMethods
+    true
+  end
+
+  # getter for the default cipher key
+  def self.cipher_key
+    @cipher_key
+  end
+
+  # setter to change the default cipher key
+  def self.cipher_key=(cipher_key)
+    @cipher_key = cipher_key
+  end
+
+  # lambda for creating Gibberish ciphers
+  CREATE_CIPHER = lambda do |cipher_key|
+
+    if cipher_key == @last_cipher_key
+      # no cipher has been created or cipher_key is the same
+      @cipher = Gibberish::AES.new cipher_key
+    else
+      # cipher_key was changed
+      @cipher = Gibberish::AES.new cipher_key
+    end
+    
+    # remember the cipher key to determine if a new cipher
+    # needs to be created on the next call
+    @last_cipher_key = cipher_key
+    # return the cipher
+    @cipher
+  end
+end

data/lib/easy_encryption/class_methods.rb

@@ -0,0 +1,11 @@
+module EasyEncryption
+
+  module ClassMethods
+
+    # returns a Gibberish cipher
+    def cipher
+      # create/use a cipher in the context of the String singleton
+      instance_exec EasyEncryption.cipher_key, &EasyEncryption::CREATE_CIPHER
+    end
+  end
+end

data/lib/easy_encryption/instance_methods.rb

@@ -0,0 +1,36 @@
+module EasyEncryption
+
+  module InstanceMethods
+
+    # encrypts a string. ex: "string".encrypt
+    def encrypt(cipher_key=nil)
+      @cipher_key = cipher_key if cipher_key
+      cipher.encrypt self
+    end
+
+    # decrypts a string. ex: "string".decrypt
+    def decrypt(cipher_key=nil)
+      @cipher_key = cipher_key if cipher_key
+      cipher.decrypt self
+    end
+
+    # setter to change the cipher key on an instance of String
+    def cipher_key=(cipher_key)
+      @cipher_key = cipher_key
+    end
+
+  private
+
+    # returns a Gibberish cipher
+    def cipher
+
+      if @cipher_key
+        # create/use a cipher in the context of a String instance
+        instance_exec @cipher_key, &EasyEncryption::CREATE_CIPHER
+      else
+        # use the singleton class's cipher
+        self.class.cipher
+      end
+    end
+  end
+end

data/lib/easy_encryption/string_encryptor.rb

@@ -0,0 +1,5 @@
+module EasyEncryption
+
+  module StringEncryption
+  end
+end

data/lib/easy_encryption/version.rb

@@ -0,0 +1,3 @@
+module EasyEncryption
+  VERSION = "0.0.1"
+end

data/spec/easy_encryption_spec.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe EasyEncryption do
+  
+  before(:all) do 
+    EasyEncryption.setup 'default_password'
+  end
+
+  let(:default_password) { EasyEncryption.cipher_key }
+
+  describe '.create_cipher' do
+    after { remove_instance_variable :@cipher }
+
+    it 'should create a cipher in the context of the caller' do 
+      instance_exec default_password, &EasyEncryption::CREATE_CIPHER
+      @cipher.should be_an_instance_of(Gibberish::AES)
+    end
+  end
+
+  describe '.cipher_key=' do
+
+    it 'should set the cipher key' do 
+      expect(EasyEncryption.cipher_key=('password')).to eql('password')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'easy_encryption'
+require 'pry'

data/spec/string_spec.rb

@@ -0,0 +1,74 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe String do
+
+  before(:all) do 
+    EasyEncryption.setup 'default_password'
+  end
+
+  let(:default_password) { EasyEncryption.cipher_key }
+  let(:password) { 'password' }
+  let(:text) { 'foo' }
+  let(:console_text) { `echo "foo"` }
+
+  describe '#encrypt' do
+
+    context 'with cipher key set on String' do
+
+      it 'encrypts a string' do
+        encrypted = text.encrypt 
+        decrypted = `echo "#{encrypted}" | openssl enc -d -aes-256-cbc -a -k "#{default_password}"`
+        decrypted.should eql(text)
+      end
+    end
+
+    context 'with cipher key set on a String instance' do
+
+      it 'encrypts a string' do
+        text.cipher_key = password
+        encrypted = text.encrypt
+        decrypted = `echo "#{encrypted}" | openssl enc -d -aes-256-cbc -a -k "#{password}"`
+        decrypted.should eql(text)
+      end
+    end
+    
+    context 'with cipher key passed to a String instance' do
+
+      it 'encrypts a string' do
+        encrypted = text.encrypt password
+        decrypted = `echo "#{encrypted}" | openssl enc -d -aes-256-cbc -a -k "#{password}"`
+        decrypted.should eql(text)
+      end
+    end
+  end
+
+  describe '#decrypt' do
+
+    context 'with cipher key set on String' do
+
+      it 'decrypts a string' do 
+        encrypted = `echo "foo" | openssl enc -aes-256-cbc -a -k "#{default_password}"`
+        decrypted = encrypted.decrypt.chomp
+        decrypted.should eql('foo')
+      end
+    end
+
+    context 'with cipher key set on a String instance' do
+
+      it 'decrypts a string' do
+        encrypted = `echo "foo" | openssl enc -aes-256-cbc -a -k "#{password}"`
+        encrypted.cipher_key = password
+        encrypted.decrypt.should eql(console_text)
+      end
+    end
+
+    context 'with cipher key passed to a String instance' do
+
+      it 'decrypts a string' do
+        encrypted = `echo "foo" | openssl enc -aes-256-cbc -a -k "#{password}"`
+        encrypted.decrypt(password).should eql(console_text)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: easy_encryption
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Adam Ervans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gibberish
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Check the github page for a detailed description
+email:
+- aervans@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- easy_encryption.gemspec
+- lib/easy_encryption.rb
+- lib/easy_encryption/class_methods.rb
+- lib/easy_encryption/instance_methods.rb
+- lib/easy_encryption/string_encryptor.rb
+- lib/easy_encryption/version.rb
+- spec/easy_encryption_spec.rb
+- spec/spec_helper.rb
+- spec/string_spec.rb
+homepage: https://github.com/arthrex/easy-encryption
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: Adds easy to use encrypt and decrypt methods to strings.
+test_files:
+- spec/easy_encryption_spec.rb
+- spec/spec_helper.rb
+- spec/string_spec.rb