encryption 1.1.0 → 1.1.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YTBkNmY0MjNlNGVlZjI2NzNlOGM3NDBjM2UxYzlmYTJiMDI0MTcxYQ==
+  data.tar.gz: !binary |-
+    MGY0ZjExNjA3NGI2Yzk1ZGQ0NzM5YmQyZDM4ZmUxMDNjMmQwODYzMA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    OWEyYWE2NzU0ZWQ2YmZkZmJhMmY4Yjc3ZGFlZWZiZTlhYTAxNDcwODQ5OTMx
+    Mjg1YjE5Njg2MmE2NWE0NmQ4NjExYWQ0MWQ0ZTY1ZTQ3NTM0ODZkNTZjOWVm
+    MmFmYzJhMGExOGYyMWJhMWFlODAzYzE5OWQ0ZDA3ZDExMDZkMjc=
+  data.tar.gz: !binary |-
+    ZDY1MjhkMTk1YWQ4YzQ1OTY3OTI5YTdiZmU5NTRmODE0MGVjZDQ3YWMyZTk5
+    ZjdhZjAxYzFhYThmN2I4Njc4ODliN2U3YzRmMGM5YTljYzk4Yzk3MDUyZDBi
+    NDY2ZGQ4ZmZmYzIwOGM2MGQ1MzBkOWNiNGNmMmY1N2E3YTEzOTk=

data/.travis.yml

@@ -2,6 +2,4 @@ language: ruby
 rvm:
   - 2.0.0
   - 1.9.3
-  - 1.9.2
-  - jruby-19mode
-  - rbx-19mode
+  - 1.9.2

data/README.md

@@ -43,13 +43,13 @@ encryptor.decrypt(encrypted_str) == data # true
 
   Configuration
   -------------
-  For symmetric encryption / decryption you need to set an encryption key. The rest of the settings are optional. Here is a list of all of them:
-  `Encryption.key` - Your encryption key
-  `Encryption.iv # Optional` - Encryption initialization vector. Defaults to the charecter `"\0"`
-  `Encryption.cipher # Optional` - Your encryption algorithm. Defaults to `aes-256-cbc`
+  For symmetric encryption / decryption you need to set an encryption key. The rest of the settings are optional. Here is a list of all of them:  
+  `Encryption.key` - Your encryption key  
+  `Encryption.iv # Optional` - Encryption initialization vector. Defaults to the charecter `"\0"`  _(Optional)_  
+  `Encryption.cipher # Optional` - Your encryption algorithm. Defaults to `aes-256-cbc` _(Optional)_  
   Run `openssl list-cipher-commands` in the terminal to list all installed ciphers or call `OpenSSL::Cipher.ciphers` in _Ruby_, which will return an array, containing all available algorithms.
 
-  You can optionally configure both a global instance and a custom instance with a __block__:
+  You can optionally configure both a global instance and a custom instance with a _block_:
   ```ruby
 Encryption.config do |config|
   config.key = "don't look at me!"
@@ -98,15 +98,28 @@ public_key.encrypt("H3LL0¡")
 # Note that you can use both public and private keys to encrypt and decrypt data
   ```
 
-<!---
-  Helpers
-  -------
-    String helpers
-    --------------
 
-    Array helpers
-    -------------
+Helpers
+-------
+  String helper
+  -------------
+  The gem adds the `encrypt` and `decrypt` methods to the `String` class.
+  You can use them as follows:
+  ```ruby
+# With the global Encryption instance
+"Hello".encrypt
+"Hello".encrypt!
+"h3LL0".decrypt
+"h3LL0".decrypt!
+
+# With custom settings (and custom encryptor instance)
+"Hello".encrypt({ key: 'encryption key', iv: 'initialization vector', cipher: 'encryption algorithm' })
+  ```
+
+License
+-------
+This gem is distributed under the MIT License.
 
-    Hash helpers
-    ------------
--->
+  Author
+  ------
+  Itay Grudev - ![Itay Grudev](http://safemail.justlikeed.net/e/a5307c0c2dd405f756cab9f4c76cd63a.png)

data/encryption.gemspec

@@ -2,10 +2,10 @@ require 'date'
 
 Gem::Specification.new do |s|
   s.name        = 'encryption'
-  s.version     = '1.1.0'
+  s.version     = '1.1.2'
   s.date        = Date.today.to_s
   s.summary     = 'A simple wrapper for the OpenSSL Cipher library'
-  s.description = 'Encryption provides a simple interface for symmetric / asymmetric encryption and decryption with the OpenSSL Cipher library'
+  s.description = 'Encryption provides a simple interface for symmetric / asymmetric encryption with the OpenSSL Cipher library'
   s.authors     = ['Itay Grudev']
   s.email       = ['itay.grudev@gmail.com']
   s.homepage    = 'https://github.com/Itehnological/encryption'

data/lib/encryption.rb

@@ -2,6 +2,8 @@ require_relative 'configuration.rb'
 require_relative 'modules.rb'
 require_relative 'helpers.rb'
 
+String.send(:include, Encryption::String)
+
 module Encryption
 
   @@instance = nil # An instance to Encryption::Symmetric

data/lib/helpers.rb

@@ -0,0 +1 @@
+require_relative 'helpers/string.rb'

data/lib/helpers/string.rb

@@ -0,0 +1,35 @@
+module Encryption
+  module String
+
+    def encrypt(options = {})
+      encryptor(options).encrypt self
+    end
+
+    def decrypt(options = {})
+      encryptor(options).decrypt self
+    end
+
+    def encrypt!(options = {})
+      replace encrypt(options)
+    end
+
+    def decrypt!(options = {})
+      replace decrypt(options)
+    end
+
+    private
+
+    def encryptor(options)
+      return Encryption if options.empty?
+
+      encrypt = Encryption::Symmetric.new
+
+      options.each do |key, value|
+        encrypt.send(key.to_s + '=', value)
+      end
+
+      encrypt
+    end
+
+  end
+end

data/spec/encryption/symmetric_global_spec.rb

@@ -19,8 +19,8 @@ describe Encryption do
     Encryption.cipher.should == cipher
   end
 
-  OpenSSL::Cipher.ciphers.each do |cipher|
-    next if ! cipher[-3, 3].nil? and ['gcm', 'fb1'].include? cipher[-3, 3].downcase
+  %x(openssl list-cipher-commands).split.each do |cipher|
+    next if ['base64', 'zlib'].include? cipher
     
     describe 'with cipher ' + cipher do
       before(:each) do

data/spec/encryption/symmetric_instance_spec.rb

@@ -21,8 +21,9 @@ describe Encryption::Symmetric do
     encryptor.cipher.should == cipher
   end
 
-  OpenSSL::Cipher.ciphers.each do |cipher|
-    next if ! cipher[-3, 3].nil? and ['gcm', 'fb1'].include? cipher[-3, 3].downcase
+  %x(openssl list-cipher-commands).split.each do |cipher|
+    next if ['base64', 'zlib'].include? cipher
+    
     describe 'with cipher ' + cipher do
 
       before(:each) do

data/spec/helpers/string_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe String do
+
+  it { should respond_to :encrypt }
+  it { should respond_to :decrypt }
+  it { should respond_to :encrypt! }
+  it { should respond_to :decrypt! }
+
+  describe "with global Encryption instance" do
+    before(:each) do
+      @string = String.random
+      Encryption.key = String.random
+    end
+
+    it 'should generate encryption different then the original string' do
+      @string.encrypt.should_not == @string
+    end
+
+    it 'should decrypt, encrypted values and match the original string' do
+      @string.encrypt.decrypt.should == @string
+    end
+  end
+
+  describe "with custom options" do
+    before(:each) do
+      @string = String.random
+      @options = {
+        :key => String.random,
+        :iv => String.random
+      }
+    end
+
+    it 'should generate encryption different then the original string' do
+      @string.encrypt(@options).should_not == @string
+    end
+
+    it 'should decrypt, encrypted values and match the original string' do
+      @string.encrypt(@options).decrypt(@options).should == @string
+    end
+  end
+
+end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: encryption
 version: !ruby/object:Gem::Version
-  version: 1.1.0
-  prerelease: 
+  version: 1.1.2
 platform: ruby
 authors:
 - Itay Grudev
@@ -12,7 +11,7 @@ cert_chain: []
 date: 2013-03-30 00:00:00.000000000 Z
 dependencies: []
 description: Encryption provides a simple interface for symmetric / asymmetric encryption
-  and decryption with the OpenSSL Cipher library
+  with the OpenSSL Cipher library
 email:
 - itay.grudev@gmail.com
 executables: []
@@ -32,6 +31,7 @@ files:
 - lib/configuration/symmetric.rb
 - lib/encryption.rb
 - lib/helpers.rb
+- lib/helpers/string.rb
 - lib/modules.rb
 - lib/modules/asymmetric.rb
 - lib/modules/asymmetric/keypair.rb
@@ -48,30 +48,30 @@ files:
 - spec/encryption/asymmetric/public_key_spec.rb
 - spec/encryption/symmetric_global_spec.rb
 - spec/encryption/symmetric_instance_spec.rb
+- spec/helpers/string_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/Itehnological/encryption
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A simple wrapper for the OpenSSL Cipher library
 test_files: []