conceal 0.1.0 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4a702eefd1ed82b3c014f4b89edaf6ca14e30242
+  data.tar.gz: da0bb21cc6c2c856646546971c9f41ee35179f53
+SHA512:
+  metadata.gz: ff85d8c71613582a185520487e16776c1c7a400140ee0d8a6053b3cd6355b2f86e9f99818b2a56356a82d11c4d575a601dfbc7cb8f8d944d49a8120ed816f781
+  data.tar.gz: 1d178801b039dbb3aee4bd004c820659ddf135ef6362f19a17edd3a7f7514c07da0a43d5b9171f50a5861cf3628edd7d278e9efc08c6561a3a243f464833acd9

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+## 0.2.0
+
+* Backwards incompatible changes
+  * Merged `decrypt` and `encrypt` commands into a single binary: `conceal decrypt` and `conceal encrypt`.
+
+## 0.1.0
+
+* Initial release

data/README.md

@@ -1,7 +1,6 @@
 # Conceal
 
-Simple OpenSSL-based string encryption using a shared secret. The algorithm, initialization vector, salt, crypttext, and HMAC are all encoded into a single string
-so it is easy to copy around.
+Simple OpenSSL-based string encryption using a shared secret. The algorithm, initialization vector, salt, crypttext, and HMAC are all encoded into a single string so it is easy to copy around.
 
 ## Requirements
 
@@ -11,23 +10,40 @@ so it is easy to copy around.
 
 Add this line to your application's Gemfile:
 
-    gem 'conceal'
+```ruby
+gem 'conceal'
+```
 
 And then execute:
 
-    $ bundle
+```
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install conceal
+```
+$ gem install conceal
+```
 
 ## Usage
 
+This gem provides both a ruby library and some command-line utilities.
+
+### Library
+
 ```ruby
 encrypted = Conceal.encrypt('some plaintext', key: 'your shared secret', algorithm: 'aes-256-cbc')
 decrypted = Conceal.decrypt(encrypted, key: 'your shared secret')
 ```
 
+### Command-line
+
+```
+$ ruby -rsecurerandom -e 'print SecureRandom.urlsafe_base64(32)' | conceal encrypt key.file | pbcopy
+$ pbpaste | conceal decrypt key.file | pbcopy
+```
+
 ## Authors
 
 * Ben Scott (<gamepoet@gmail.com>)

data/bin/conceal

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'conceal/cli'
+Conceal::CLI.start(ARGV)

data/conceal.gemspec

@@ -20,6 +20,8 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 1.9.3'
 
+  spec.add_dependency 'thor', '~> 0.18'
+
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake',    '>= 0.8.7'
   spec.add_development_dependency 'rspec',   '~> 3.0'

data/lib/conceal/cli.rb

@@ -0,0 +1,54 @@
+require 'thor'
+
+module Conceal
+  class CLI < Thor
+    map %w(d de dec) => :decrypt
+    map %w(e en enc) => :encrypt
+    map %w(-v --version) => :version
+
+    option :newline, aliases: '-n', type: :boolean, desc: 'print a trailing newline character'
+    desc 'decrypt [OPTIONS] KEY_FILE', 'decrypt stdin using the given key file'
+    def decrypt(key_file)
+      require 'conceal'
+
+      # load the key
+      raise Thor::Error, 'ERROR: key file is not readable or does not exist' unless File.readable?(key_file)
+      key = IO.read(key_file)
+
+      # decrypt from stdin
+      encrypted_data = $stdin.read
+      plaintext = Conceal.decrypt(encrypted_data, key: key)
+
+      $stdout.write(plaintext)
+      $stdout.write("\n") if options[:newline]
+    end
+
+    option :newline, aliases: '-n', type: :boolean, desc: 'print a trailing newline character'
+    desc 'encrypt [OPTIONS] KEY_FILE', 'encrypt stdin using the given key file'
+    def encrypt(key_file)
+      require 'conceal'
+
+      # load the key
+      raise Thor::Error, 'ERROR: key file is not readable or does not exist' unless File.readable?(key_file)
+      key = IO.read(key_file)
+
+      # encrypt from stdin
+      plaintext = $stdin.read
+      encrypted_data = Conceal.encrypt(plaintext, key: key)
+
+      $stdout.write(encrypted_data)
+      $stdout.write("\n") if options[:newline]
+    end
+
+    desc 'version', 'display the version and exit'
+    def version
+      require 'conceal/version'
+      puts VERSION
+    end
+
+  protected
+    def self.exit_on_failure?
+      true
+    end
+  end
+end

data/lib/conceal/version.rb

@@ -1,3 +1,3 @@
 module Conceal
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,115 +1,119 @@
 --- !ruby/object:Gem::Specification
 name: conceal
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Ben Scott
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-26 00:00:00.000000000 Z
+date: 2014-09-05 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.7
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 description: Encrypts and decrypts strings using OpenSSL.
 email:
 - gamepoet@gmail.com
 executables:
-- decrypt
-- encrypt
+- conceal
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
-- bin/decrypt
-- bin/encrypt
+- bin/conceal
 - conceal.gemspec
 - lib/conceal.rb
+- lib/conceal/cli.rb
 - lib/conceal/version.rb
 - spec/conceal_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/gamepoet/conceal
 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: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 3065879142632505148
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23.2
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Simple OpenSSL-based string encryption.
 test_files:
 - spec/conceal_spec.rb
 - spec/spec_helper.rb
+has_rdoc: 

data/bin/decrypt

@@ -1,42 +0,0 @@
-#!/usr/bin/env ruby
-require 'conceal'
-require 'optparse'
-
-class Options < Struct.new(:trailing_newline)
-end
-
-def main
-  opts = Options.new
-  opts.trailing_newline = true
-
-  OptionParser.new do |o|
-    o.banner = 'Usage: decrypt KEY_FILE'
-    o.on('-h', '--help', 'show this message') do
-      puts o
-      exit(0)
-    end
-    o.on('-n', "don't print the trailing newline") do
-      opts.trailing_newline = false
-    end
-    o.on('-v', '--version', 'print the version') do
-      puts Conceal::VERSION
-    end
-  end.parse!(ARGV)
-
-  # read the key file
-  if ARGV.empty?
-    $stderr.puts "Missing KEY_FILE argument"
-    exit(1)
-  end
-  key_file = ARGV.shift
-  key = IO.read(key_file)
-
-  # decrypt from stdin
-  encrypted_data = $stdin.read
-  plaintext = Conceal.decrypt(encrypted_data, key: key)
-
-  $stdout.write(plaintext)
-  $stdout.write("\n") if opts.trailing_newline
-end
-
-main

data/bin/encrypt

@@ -1,42 +0,0 @@
-#!/usr/bin/env ruby
-require 'conceal'
-require 'optparse'
-
-class Options < Struct.new(:trailing_newline)
-end
-
-def main
-  opts = Options.new
-  opts.trailing_newline = true
-
-  OptionParser.new do |o|
-    o.banner = 'Usage: encrypt KEY_FILE'
-    o.on('-h', '--help', 'show this message') do
-      puts o
-      exit(0)
-    end
-    o.on('-n', "don't print the trailing newline") do
-      opts.trailing_newline = false
-    end
-    o.on('-v', '--version', 'print the version') do
-      puts Conceal::VERSION
-    end
-  end.parse!(ARGV)
-
-  # read the key file
-  if ARGV.empty?
-    $stderr.puts "Missing KEY_FILE argument"
-    exit(1)
-  end
-  key_file = ARGV.shift
-  key = IO.read(key_file)
-
-  # encrypt from stdin
-  plaintext = $stdin.read
-  encrypted_data = Conceal.encrypt(plaintext, key: key)
-
-  $stdout.write(encrypted_data)
-  $stdout.write("\n") if opts.trailing_newline
-end
-
-main