cryptology 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6d8652577b9efbf08654071baa5eeaf5b7bab7d
-  data.tar.gz: 3b55e70aae9c511960b58c723e723ed55ebf217c
+  metadata.gz: 87ffdef922d38150c58aace752ca1656791678a5
+  data.tar.gz: 6e74ff79379bb8d0242f1465a2072ccbab1666eb
 SHA512:
-  metadata.gz: 7d2fa0167bb97234782fde940d707a30c3eb4bd9bd56bc1ba54ff34ab7bdd8155be35525e803f15b9be567665ab024be5b7f57eade759260a1395aa1d9b0a3f9
-  data.tar.gz: 76c7f040b484a1a051c739211dc0a4737ae68066d3bbef5fd4a229040d7a31c349799cce50b2e1efb17116d1636f97b1740bd9f0bcf9e567c203a54a9e522c5e
+  metadata.gz: 8845e0fbfa4e0b69e36a7e18a4c896737f72731f8c703c108e1772503d987a8d16a82fd6665cb604b6e8743a319c8598b6674e746b5b68c94f4ad542b536817b
+  data.tar.gz: f031d742a21a2c42c871bb8b7aa284effc30f5053925d753c3f3fb3f8f629365195370714802dbc8e7bd40b1190fef3a9450d71636122f0ca4ea44ff72a182f2

data/.travis.yml

@@ -1,7 +1,6 @@
 language: ruby
 
 rvm:
-  - 2.0.0
   - 2.1.7
   - 2.2.3
 

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 1.1.0 (2015-12-08)
+
+- Improvement: Switch to keyword arguments
+- Ruby Versioning: Drop support for Ruby 2.0
+
 ## 1.0.1 (2015-12-08)
 
 - Bug Fix: Allow iv to be nil

data/README.md

@@ -1,9 +1,9 @@
 # Cryptology
 
-[![Gem Version](https://badge.fury.io/rb/cryptology.svg)](http://badge.fury.io/rb/cryptology)
+[![Gem Version](https://badge.fury.io/rb/cryptology.svg)](https://badge.fury.io/rb/cryptology)
 [![Build Status](https://travis-ci.org/rubysamurai/cryptology.svg?branch=master)](https://travis-ci.org/rubysamurai/cryptology)
 
-`Cryptology` is a wrapper for encryption and decryption in Ruby. Supports all algorithms, that are available in installed version of OpenSSL. By default `AES-256-CBC` is used.
+`Cryptology` is a wrapper for encryption and decryption in Ruby. Supports all cipher algorithms, that are available in installed version of OpenSSL. By default `AES-256-CBC` is used.
 
 ## Installation
 
@@ -13,9 +13,9 @@ Add this line to your application's Gemfile:
 gem 'cryptology'
 ```
 
-Save `Gemfile` and execute `bundle` command to install the gem.
+Save `Gemfile` and execute `$ bundle` command to install the gem.
 
-Or to install it yourself run this command: 
+Or to install it yourself run this command:
 
 ```
 $ gem install cryptology
@@ -25,18 +25,18 @@ $ gem install cryptology
 
 ```ruby
 # Encrypting
-Cryptology.encrypt(data, key, algorithm, iv)
+Cryptology.encrypt(data: data, key: key, cipher: cipher, iv: iv)
 
 # Decrypting
-Cryptology.decrypt(data, key, algorithm, iv)
+Cryptology.decrypt(data: data, key: key, cipher: cipher, iv: iv)
 ```
 
-Argument  | Required? | Default       | Comment
-----------|-----------|---------------|-------------
-data      | **Yes**   | n/a           | Data to encrypt or decrypt
-key       | **Yes**   | n/a           | Secure key for encryption and decryption
-algorithm | *No*      | `AES-256-CBC` | Cipher algorithm
-iv        | *No*      | `nil`         | Initialization vector for CBC, CFB, CTR, OFB modes
+Argument | Required? | Default       | Comment
+---------|-----------|---------------|-------------
+data     | **Yes**   | n/a           | Data to encrypt or decrypt
+key      | **Yes**   | n/a           | Secure key for encryption and decryption
+cipher   | *No*      | `AES-256-CBC` | Cipher algorithm
+iv       | *No*      | `nil`         | Initialization vector for CBC, CFB, CTR, OFB modes
 
 Example:
 
@@ -45,16 +45,16 @@ Example:
 data = 'Very, very confidential data'
 # Secure key for encryption (required)
 key = 'veryLongAndSecurePassword_6154309'
-# Use Blowfish algorithm in CBC mode (optional)
-algorithm  = 'BF-CBC'
+# Use Blowfish cipher in CBC mode (optional)
+cipher = 'BF-CBC'
 # Initialization vector for BF-CBC (optional)
-iv = OpenSSL::Cipher::Cipher.new(algorithm).random_iv
+iv = OpenSSL::Cipher::Cipher.new(cipher).random_iv
 
 # Encrypt our data
-encrypted = Cryptology.encrypt(data, key, algorithm, iv)
+encrypted = Cryptology.encrypt(data: data, key: key, cipher: cipher, iv: iv)
 
 # Decrypt our data
-plain = Cryptology.decrypt(encrypted, key, algorithm, iv)
+plain = Cryptology.decrypt(data: encrypted, key: key, cipher: cipher, iv: iv)
 
 ```
 

data/cryptology.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.0.0'
+  spec.required_ruby_version = '>= 2.1.0'
 
   spec.add_development_dependency 'rake',  '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.3'

data/lib/cryptology.rb

@@ -3,33 +3,33 @@ require 'openssl'
 require 'base64'
 
 module Cryptology
-  def self.encrypt(data, key, algorithm = 'AES-256-CBC', iv = nil)
-    encrypted = encrypt_data(data.to_s, digest(key), algorithm, iv)
+  def self.encrypt(data:, key:, cipher: 'AES-256-CBC', iv: nil)
+    encrypted = encrypt_data(data.to_s, digest(key), cipher, iv)
     ::Base64.encode64(encrypted)
   end
 
-  def self.decrypt(data, key, algorithm = 'AES-256-CBC', iv = nil)
+  def self.decrypt(data:, key:, cipher: 'AES-256-CBC', iv: nil)
     base64_decoded = ::Base64.decode64(data.to_s)
-    decrypt_data(base64_decoded, digest(key), algorithm, iv)
+    decrypt_data(base64_decoded, digest(key), cipher, iv)
       .force_encoding('UTF-8').encode
   end
 
   private
 
-    def self.encrypt_data(data, key, algorithm, iv)
-      cipher = ::OpenSSL::Cipher::Cipher.new(algorithm)
+    def self.encrypt_data(data, key, cipher, iv)
+      cipher = ::OpenSSL::Cipher::Cipher.new(cipher)
       cipher.encrypt
       cipher.key = key
-      cipher.iv = iv unless iv.nil?
+      cipher.iv  = iv unless iv.nil?
       cipher.update(data) + cipher.final
     end
 
-    def self.decrypt_data(encrypted_data, key, algorithm, iv)
-      decipher = ::OpenSSL::Cipher::Cipher.new(algorithm)
+    def self.decrypt_data(data, key, cipher, iv)
+      decipher = ::OpenSSL::Cipher::Cipher.new(cipher)
       decipher.decrypt
       decipher.key = key
-      decipher.iv = iv unless iv.nil?
-      decipher.update(encrypted_data) + decipher.final
+      decipher.iv  = iv unless iv.nil?
+      decipher.update(data) + decipher.final
     end
 
     def self.digest(key)

data/lib/cryptology/version.rb

@@ -1,3 +1,3 @@
 module Cryptology
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cryptology
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Dmitriy Tarasov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-07 00:00:00.000000000 Z
+date: 2015-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -71,7 +71,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="