parsel 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 80d50c158df4722786b31e9f644699453e4f8dfb
-  data.tar.gz: 12e6dac5ec2e15b3a8970235fc806d1e996c9a5a
+SHA256:
+  metadata.gz: ab6c3def75bb0d360e2e50ba25ad94625801dcb7fdbb9ad5040e8030d0a58ee5
+  data.tar.gz: aa17d8b8c3ea92c7357c23a6637cacaaa977c5295c9f36a79fbf1deb7742098d
 SHA512:
-  metadata.gz: 6c6cf7a7cc8bb1e1373fe45d6a0473c16b31492d319363210b7206585feead5ec9db5cb163401e4ef6cc203a525e03e0b92be5e921beceaf2190f53166162237
-  data.tar.gz: b0df1372c7a6682191f1ad4fea0c779720b86b571228fd07d97af3c626b7b3cc61139ef64c3a980baf4ab17f575af687b291f52b57f79241c2f834ac5a2ffdb8
+  metadata.gz: 50fa30534889c969e533319572a1dcdc3cacbe9e7acf9fba92965e65b4be09350963e135ff29e3a4ff16be4b581db38b88de05fbe71162f205bec796229a76eb
+  data.tar.gz: 47cd6019ff5155c646ac1e669d145815c7e997cd48bccf8d718516190f1a8ab611b1a5542ba680d6145830866f590903bd23dea00e538019120bb325a5a2b026

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+cache: bundler
+sudo: false
+rvm:
+  - 'ruby-head'
+  - '2.3.0'
+  - '2.2'
+  - '2.1'
+notifications:
+  email: false

data/Gemfile

@@ -1,2 +1,2 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 gemspec

data/README.md

@@ -1,5 +1,10 @@
 # parsel
 
+[![Code Climate](https://codeclimate.com/github/fnando/parsel-rb.png)](https://codeclimate.com/github/fnando/parsel-rb)
+[![Build Status](https://travis-ci.org/fnando/parsel-rb.svg)](https://travis-ci.org/fnando/parsel-rb)
+[![Gem](https://img.shields.io/gem/v/parsel.svg)](https://rubygems.org/gems/parsel)
+[![Gem](https://img.shields.io/gem/dt/parsel.svg)](https://rubygems.org/gems/parsel)
+
 Encrypt and decrypt data with a given key.
 
 This library was created to allow an easy data
@@ -14,21 +19,21 @@ Check it out the Node.js counter-part: <http://github.com/fnando/parsel-js>.
 ## Usage
 
 ```ruby
-require 'parsel'
+require "parsel"
 
-secret_key = 'mysupersecretkeythatnobodyknowsabout'
-encrypted = Parsel.encrypt(secret_key, 'hello from ruby!')
+secret_key = "mysupersecretkeythatnobodyknowsabout"
+encrypted = Parsel.encrypt(secret_key, "hello from ruby!")
 decrypted = Parsel.decrypt(secret_key, encrypted)
 ```
 
 You can also use Marshal for encrypting/decrypting objects. Notice that this isn't supported by Node.js.
 
 ```ruby
-require 'parsel'
+require "parsel"
 
 data = {user_id: 1234}
 
-secret_key = 'mysupersecretkeythatnobodyknowsabout'
+secret_key = "mysupersecretkeythatnobodyknowsabout"
 encrypted = Parsel::Marshal.encrypt(secret_key, data)
 
 decrypted = Parsel::Marshal.decrypt(secret_key, encrypted)
@@ -38,11 +43,11 @@ decrypted = Parsel::Marshal.decrypt(secret_key, encrypted)
 Alternatively you can use `JSON` as your serializer.
 
 ```ruby
-require 'parsel'
+require "parsel"
 
 data = {user_id: 1234}
 
-secret_key = 'mysupersecretkeythatnobodyknowsabout'
+secret_key = "mysupersecretkeythatnobodyknowsabout"
 encrypted = Parsel::JSON.encrypt(secret_key, data)
 
 decrypted = Parsel::JSON.decrypt(secret_key, encrypted)
@@ -51,6 +56,8 @@ decrypted = Parsel::JSON.decrypt(secret_key, encrypted)
 
 ### Custom Cipher IV
 
+![Make sure you use a 16-chars long if you're going to exchange data with parsel-js.](http://messages.hellobits.com/warning.svg?message=Make%20sure%20you%20use%20a%2016-chars%20long%20if%20you're%20going%20to%20exchange%20data%20with%20parsel-js.)
+
 By default, this library uses a built-in IV. You may want to change that.
 
 You can globally change the IV like the following:
@@ -66,6 +73,8 @@ Parsel.encrypt(secret_key, iv, data)
 Parsel.decrypt(secret_key, iv, data)
 ```
 
+**NOTE:** If you're going to use <http://github.com/fnando/parsel-js> to exchange data, you have to use a 16-chars long IV. Node.js will fail with different lengths.
+
 ## Maintainer
 
 - Nando Vieira (<http://nandovieira.com.br>)

data/Rakefile

@@ -1,5 +1,10 @@
-require "bundler"
-Bundler::GemHelper.install_tasks
+require "bundler/gem_tasks"
+require "rake/testtask"
 
-require "rspec/core/rake_task"
-RSpec::Core::RakeTask.new
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.warning = false
+end
+
+task default: :test

data/lib/parsel.rb

@@ -1,13 +1,22 @@
-require 'openssl'
-require 'base64'
-require 'json'
-require 'parsel/marshal'
-require 'parsel/json'
-require 'parsel/version'
+require "securerandom"
+require "openssl"
+require "base64"
+require "json"
+require "parsel/marshal"
+require "parsel/json"
+require "parsel/version"
 
 module Parsel
-  DEFAULT_IV = 'f89209ffcdd1a225'.freeze
-  CIPHER = 'AES-256-CBC'.freeze
+  DEFAULT_IV = "f89209ffcdd1a225".freeze
+  CIPHER = "AES-256-CBC".freeze
+
+  def self.print_deprecation_message
+    warn <<~TEXT
+      `parsel` is no longer supported. Use at your own risk.
+      Called from #{caller[1]}
+
+    TEXT
+  end
 
   def self.default_iv=(iv)
     @default_iv = iv
@@ -20,10 +29,12 @@ module Parsel
   self.default_iv = DEFAULT_IV
 
   def self.encrypt(*args)
+    Parsel.print_deprecation_message
     encode cipher(:encrypt, *expand_args(args))
   end
 
   def self.decrypt(*args)
+    Parsel.print_deprecation_message
     key, iv, data = expand_args(args)
     cipher(:decrypt, key, iv, decode(data))
   rescue Exception
@@ -45,15 +56,17 @@ module Parsel
   def self.cipher(mode, key, iv, data)
     cipher = OpenSSL::Cipher.new(CIPHER).public_send(mode)
     cipher.key = Digest::SHA256.digest(key)
-    cipher.iv = iv
+    cipher.iv = iv[0...cipher.iv_len]
     cipher.update(data) + cipher.final
   end
 
   def self.encode(data)
-    Base64.encode64(data).gsub(/\n/, '')
+    Base64.encode64(data).gsub(/\n/, "")
   end
 
   def self.decode(data)
     Base64.decode64(data)
   end
 end
+
+Parsel.print_deprecation_message

data/lib/parsel/json.rb

@@ -1,11 +1,13 @@
 module Parsel
   module JSON
     def self.encrypt(*args)
+      Parsel.print_deprecation_message
       key, iv, data = Parsel.expand_args(args)
       Parsel.encrypt(key, iv, ::JSON.dump(data))
     end
 
     def self.decrypt(*args)
+      Parsel.print_deprecation_message
       key, iv, data = Parsel.expand_args(args)
       ::JSON.load Parsel.decrypt(key, iv, data)
     rescue Exception

data/lib/parsel/marshal.rb

@@ -1,11 +1,13 @@
 module Parsel
   module Marshal
     def self.encrypt(*args)
+      Parsel.print_deprecation_message
       key, iv, data = Parsel.expand_args(args)
       Parsel.encrypt(key, iv, ::Marshal.dump(data))
     end
 
     def self.decrypt(*args)
+      Parsel.print_deprecation_message
       key, iv, data = Parsel.expand_args(args)
       ::Marshal.load Parsel.decrypt(key, iv, data)
     rescue Exception

data/lib/parsel/version.rb

@@ -1,7 +1,7 @@
 module Parsel
   module Version
-    MAJOR = 0
-    MINOR = 3
+    MAJOR = 1
+    MINOR = 0
     PATCH = 0
     STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
   end

data/parsel.gemspec

@@ -1,21 +1,22 @@
-# -*- encoding: utf-8 -*-
-require './lib/parsel/version'
+require "./lib/parsel/version"
 
 Gem::Specification.new do |s|
-  s.name        = 'parsel'
+  s.name        = "parsel"
   s.version     = Parsel::Version::STRING
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ['Nando Vieira']
-  s.email       = ['fnando.vieira@gmail.com']
-  s.homepage    = 'http://rubygems.org/gems/parsel'
-  s.summary     = 'Encrypt and decrypt data with a given key.'
+  s.authors     = ["Nando Vieira"]
+  s.email       = ["fnando.vieira@gmail.com"]
+  s.homepage    = "http://rubygems.org/gems/parsel"
+  s.summary     = "Encrypt and decrypt data with a given key."
   s.description = s.summary
+  s.post_install_message = "`parsel` is no longer supported. Use at your own risk."
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.executables   = `git ls-files -- bin/*`.split("\n").map {|f| File.basename(f) }
   s.require_paths = ['lib']
 
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'rspec'
+  s.add_development_dependency "rake"
+  s.add_development_dependency "minitest-utils"
+  s.add_development_dependency "pry-meta"
 end

data/test/parsel/json_test.rb

@@ -0,0 +1,18 @@
+require "test_helper"
+
+class JsonTest < Minitest::Test
+  let(:key) { "my secret key" }
+
+  test "encrypts data" do
+    refute_equal JSON.dump(["hello"]), Parsel::JSON.encrypt(key, ["hello"])
+  end
+
+  test "decrypts data" do
+    encrypted = Parsel::JSON.encrypt(key, ["hello"])
+    assert_equal ["hello"], Parsel::JSON.decrypt(key, encrypted)
+  end
+
+  test "returns false when decryption fails" do
+    refute Parsel::JSON.decrypt("abc", "123")
+  end
+end

data/test/parsel/marshal_test.rb

@@ -0,0 +1,18 @@
+require "test_helper"
+
+class MarshalTest < Minitest::Test
+  let(:key) { "my secret key" }
+
+  test "encrypts data" do
+    refute_equal Marshal.dump("hello"), Parsel::Marshal.encrypt(key, "hello")
+  end
+
+  test "decrypts data" do
+    encrypted = Parsel::Marshal.encrypt(key, "hello")
+    assert_equal "hello", Parsel::Marshal.decrypt(key, encrypted)
+  end
+
+  test "returns false when decryption fails" do
+    refute Parsel::Marshal.decrypt("abc", "123")
+  end
+end

data/test/parsel/parsel_test.rb

@@ -0,0 +1,40 @@
+require "test_helper"
+
+class ParselTest < Minitest::Test
+  let(:key) { "my secret key" }
+
+  test "encrypts data" do
+    refute_equal "hello", Parsel.encrypt(key, "hello")
+  end
+
+  test "decrypts data" do
+    encrypted = Parsel.encrypt(key, "hello")
+    assert_equal "hello", Parsel.decrypt(key, encrypted)
+  end
+
+  test "returns false when decryption fails" do
+    refute Parsel.decrypt("abc", "123")
+  end
+
+  test "uses custom iv" do
+    iv = SecureRandom.hex(100)
+    encrypted = Parsel.encrypt(key, iv, "hello")
+
+    assert_equal "hello", Parsel.decrypt(key, iv, encrypted)
+  end
+
+  test "return false when decryption for custom iv fails" do
+    iv = SecureRandom.hex(100)
+    encrypted = Parsel.encrypt(key, iv, "hello")
+
+    refute Parsel.decrypt(key, encrypted)
+  end
+
+  test "changes global iv" do
+    iv = SecureRandom.hex(100)
+    Parsel.default_iv = iv
+    encrypted = Parsel.encrypt(key, "hello")
+
+    assert_equal "hello", Parsel.decrypt(key, iv, encrypted)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+require "bundler/setup"
+require "parsel"
+require "minitest/utils"
+require "minitest/autorun"
+
+module Minitest
+  class Test
+    setup do
+      Parsel.default_iv = Parsel::DEFAULT_IV
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parsel
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Nando Vieira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-14 00:00:00.000000000 Z
+date: 2020-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -25,7 +25,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: minitest-utils
+  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-meta
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -46,7 +60,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".rspec"
+- ".travis.yml"
 - Gemfile
 - README.md
 - Rakefile
@@ -55,14 +69,14 @@ files:
 - lib/parsel/marshal.rb
 - lib/parsel/version.rb
 - parsel.gemspec
-- spec/parsel/json_spec.rb
-- spec/parsel/marshal_spec.rb
-- spec/parsel_spec.rb
-- spec/spec_helper.rb
+- test/parsel/json_test.rb
+- test/parsel/marshal_test.rb
+- test/parsel/parsel_test.rb
+- test/test_helper.rb
 homepage: http://rubygems.org/gems/parsel
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message: "`parsel` is no longer supported. Use at your own risk."
 rdoc_options: []
 require_paths:
 - lib
@@ -77,13 +91,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Encrypt and decrypt data with a given key.
 test_files:
-- spec/parsel/json_spec.rb
-- spec/parsel/marshal_spec.rb
-- spec/parsel_spec.rb
-- spec/spec_helper.rb
+- test/parsel/json_test.rb
+- test/parsel/marshal_test.rb
+- test/parsel/parsel_test.rb
+- test/test_helper.rb

data/.rspec

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

data/spec/parsel/json_spec.rb

@@ -1,18 +0,0 @@
-require 'spec_helper'
-
-describe Parsel::JSON do
-  let(:key) { 'my secret key' }
-
-  it 'encrypts data' do
-    expect(Parsel::JSON.encrypt(key, ['hello'])).not_to eq(JSON.dump(['hello']))
-  end
-
-  it 'decrypts data' do
-    encrypted = Parsel::JSON.encrypt(key, ['hello'])
-    expect(Parsel::JSON.decrypt(key, encrypted)).to eq(['hello'])
-  end
-
-  it 'returns false when decryption fails' do
-    expect(Parsel::JSON.decrypt('abc', '123')).to be_falsy
-  end
-end

data/spec/parsel/marshal_spec.rb

@@ -1,18 +0,0 @@
-require 'spec_helper'
-
-describe Parsel::Marshal do
-  let(:key) { 'my secret key' }
-
-  it 'encrypts data' do
-    expect(Parsel::Marshal.encrypt(key, 'hello')).not_to eq(Marshal.dump('hello'))
-  end
-
-  it 'decrypts data' do
-    encrypted = Parsel::Marshal.encrypt(key, 'hello')
-    expect(Parsel::Marshal.decrypt(key, encrypted)).to eq('hello')
-  end
-
-  it 'returns false when decryption fails' do
-    expect(Parsel::Marshal.decrypt('abc', '123')).to be_falsy
-  end
-end

data/spec/parsel_spec.rb

@@ -1,40 +0,0 @@
-require 'spec_helper'
-
-describe Parsel do
-  let(:key) { 'my secret key' }
-
-  it 'encrypts data' do
-    expect(Parsel.encrypt(key, 'hello')).not_to eq('hello')
-  end
-
-  it 'decrypts data' do
-    encrypted = Parsel.encrypt(key, 'hello')
-    expect(Parsel.decrypt(key, encrypted)).to eq('hello')
-  end
-
-  it 'returns false when decryption fails' do
-    expect(Parsel.decrypt('abc', '123')).to be_falsy
-  end
-
-  it 'uses custom iv' do
-    iv = SecureRandom.hex(100)
-    encrypted = Parsel.encrypt(key, iv, 'hello')
-
-    expect(Parsel.decrypt(key, iv, encrypted)).to eq('hello')
-  end
-
-  it 'return false when decryption for custom iv fails' do
-    iv = SecureRandom.hex(100)
-    encrypted = Parsel.encrypt(key, iv, 'hello')
-
-    expect(Parsel.decrypt(key, encrypted)).to be_falsy
-  end
-
-  it 'changes global iv' do
-    iv = SecureRandom.hex(100)
-    Parsel.default_iv = iv
-    encrypted = Parsel.encrypt(key, 'hello')
-
-    expect(Parsel.decrypt(key, iv, encrypted)).to eq('hello')
-  end
-end

data/spec/spec_helper.rb

@@ -1,8 +0,0 @@
-require 'bundler/setup'
-require 'parsel'
-
-RSpec.configure do |config|
-  config.before do
-    Parsel.default_iv = Parsel::DEFAULT_IV
-  end
-end