cript 0.0.1 → 0.0.2

data/.travis.yml

@@ -3,5 +3,5 @@ rvm:
   - 1.9.3
   - 2.0.0
   - jruby-19mode
-  - rbx-19mode
+  - rbx-2.1.1
 script: bundle exec rspec spec

data/README.md

@@ -66,6 +66,9 @@ c2 = Cript::Simple.new({
 encrypted = c.encrypt("More secret stuff!")
 ```
 
+You can use Cript::Simple from bash with the `cript` executable.
+Type `cript --help` after gem installation for usage.
+
 ### Cript::Hidr
 
 The Hidr class allows you to obscure strings in other strings by facilitating a two-way conversion
@@ -83,6 +86,9 @@ After running this code, result will contain "zzzazazazzzzazzazzzazzzazaaaazaa".
 It comes with a few commonly used mappings already setup: ascii, unicode, orly.
 Call the class method of the same name to get these hidrs.
 
+You can use Cript::Hidr from bash with the `hidr` executable.
+Type `hidr --help` after gem installation for usage.
+
 ## Contributing
 
 1. Fork it

data/bin/cript

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+require 'cript/cript_command'
+Cript::CriptCommand.new(ARGV).run!

data/bin/hidr

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+require 'cript/hidr_command'
+Cript::HidrCommand.new(ARGV).run!

data/lib/cript/cript_command.rb

@@ -0,0 +1,125 @@
+require 'cript'
+require 'optparse'
+
+module Cript
+  class CriptCommand
+
+    attr_reader :options
+
+    def initialize(argv)
+      @argv = argv.dup
+
+      @options = {
+        mode:    nil,
+        infile:  '-',
+        outfile: '-',
+        public:  File.join(ENV['HOME'], '.ssh/id_rsa.pub'),
+        private: File.join(ENV['HOME'], '.ssh/id_rsa'),
+        force:   false,
+        debug:   false
+      }
+
+      parse!
+    end
+
+    def run!
+      cripter = build_cripter
+      data = read_data
+      get_writer do |writer|
+        if @options[:mode] == 'encrypt'
+          writer.print cripter.encrypt(data)
+        else
+          writer.print cripter.decrypt(data)
+        end
+      end
+    end
+
+    private
+
+    def parser
+      @parser ||= OptionParser.new do |opts|
+        opts.banner = "Usage: cript [options]"
+
+        opts.separator ""
+        opts.separator "Mode:"
+        opts.on("-e", "--encrypt", "encrypt mode") { @options[:mode] = 'encrypt' }
+        opts.on("-d", "--decrypt", "decrypt mode") { @options[:mode] = 'decrypt' }
+
+        opts.separator ""
+        opts.separator "Keys:"
+        opts.on("--private PRIVATE", "private key path (default: #{@options[:private]})") { |priv| @options[:private] = priv }
+        opts.on("--public PUBLIC", "public key path (default: #{@options[:public]})") { |pub| @options[:public] = pub }
+
+        opts.separator ""
+        opts.separator "Files:"
+        opts.on("-i", "--infile FILE", "infile (default: '#{@options[:infile]}')") { |file| @options[:infile] = file }
+        opts.on("-o", "--outfile FILE", "outfile (default: '#{@options[:outfile]}')") { |file| @options[:outfile] = file }
+        opts.on("-f", "--force", "force overwrite outfile (default: #{@options[:force]})") { @options[:force] = true }
+
+        opts.separator ""
+        opts.separator "Common options:"
+
+        opts.on_tail("-D", "--debug", "Set debugging on") { @options[:debug] = true }
+        opts.on_tail("-h", "--help", "Show this message") { puts opts; exit }
+        opts.on_tail('-v', '--version', "Show version") { puts Cript::VERSION; exit }
+      end
+    end
+
+    def parse!
+      parser.parse!(@argv)
+    end
+
+    # run methods
+
+    def build_cripter
+      if @options[:mode] == 'encrypt'
+        Cript::Simple.new(public_key_path: @options[:public])
+      elsif @options[:mode] == 'decrypt'
+        Cript::Simple.new(private_key_path: @options[:private])
+      else
+        STDERR.puts "Mode is required (encrypt or decrypt)"
+        exit 1
+      end
+    end
+
+    def read_data
+      if @options[:infile] == '-'
+        # requires ARGV clear
+        STDIN.read
+      elsif File.file?(@options[:infile])
+        File.read(@options[:infile])
+      else
+        STDERR.puts "Invalid infile: #{@options[:infile]}"
+        exit 1
+      end
+    end
+
+    def get_writer
+      begin
+        if @options[:outfile] == '-'
+          writer = STDOUT
+        elsif File.file?(@options[:outfile])
+          if @options[:force]
+            writer = File.open(@options[:outfile], 'wb')
+          else
+            STDERR.puts "Not overwriting file without force"
+            exit 1
+          end
+        else
+          writer = File.open(@options[:outfile], 'wb')
+        end
+
+        yield(writer)
+      rescue => e
+        STDERR.puts "Error writing data: #{e}"
+        exit 1
+      ensure
+        # clean-up
+        if writer && @options[:outfile] != '-'
+          writer.close
+        end
+      end
+    end
+
+  end
+end

data/lib/cript/hidr.rb

@@ -8,9 +8,11 @@ module Cript
   class Hidr
 
     CHARS = {
+      binary:  ["0", "1"],
       ascii:   ["\s","\t"],
       unicode: ["\u200B","\uFEFF"],
-      orly:    ["\u0CA0", "\u005F"]
+      orly:    ["\u0CA0", "\u005F"],
+      niceday: ["\s", "\u263A"]
     }
 
     class << self

data/lib/cript/hidr_command.rb

@@ -0,0 +1,136 @@
+require 'cript'
+require 'optparse'
+
+module Cript
+  class HidrCommand
+
+    attr_reader :options
+
+    def initialize(argv)
+      @argv = argv.dup
+
+      @options = {
+        mode:    nil,
+        infile:  '-',
+        outfile: '-',
+        force:   false,
+        b0:      '0',
+        b1:      '1',
+        debug:   false
+      }
+
+      parse!
+    end
+
+    def run!
+      validate_mode
+      hidr = build_hidr
+      data = read_data
+      get_writer do |writer|
+        if @options[:mode] == 'hide'
+          writer.print hidr.hide(data)
+        else
+          writer.print hidr.show(data)
+        end
+      end
+    end
+
+    private
+
+    def parser
+      @parser ||= OptionParser.new do |opts|
+        opts.banner = "Usage: hidr [options]"
+
+        opts.separator ""
+        opts.separator "Mode:"
+        opts.on("-h", "--hide", "hide mode") { @options[:mode] = 'hide' }
+        opts.on("-s", "--show", "show mode") { @options[:mode] = 'show' }
+
+        opts.separator ""
+        opts.separator "Bits:"
+        opts.on("-0", "--zero CHAR", "zero char (default: '#{@options[:b0]}')") { |char| @options[:b0] = char }
+        opts.on("-1", "--one CHAR", "one char (default: '#{@options[:b1]}')") { |char| @options[:b1] = char }
+        opts.on("-b", "--builtin BUILTIN", "built-in binary set (overrides zero and one, options: #{Cript::Hidr::CHARS.keys.join(', ')})") { |builtin| @options[:builtin] = builtin.to_s.strip.to_sym }
+
+        opts.separator ""
+        opts.separator "Files:"
+        opts.on("-i", "--infile FILE", "infile (default: '#{@options[:infile]}')") { |file| @options[:infile] = file }
+        opts.on("-o", "--outfile FILE", "outfile (default: '#{@options[:outfile]}')") { |file| @options[:outfile] = file }
+        opts.on("-f", "--force", "force overwrite outfile (default: #{@options[:force]})") { @options[:force] = true }
+
+        opts.separator ""
+        opts.separator "Common options:"
+
+        opts.on_tail("-D", "--debug", "Set debugging on") { @options[:debug] = true }
+        opts.on_tail("-H", "--help", "Show this message") { puts opts; exit }
+        opts.on_tail('-v', '--version', "Show version") { puts Cript::VERSION; exit }
+      end
+    end
+
+    def parse!
+      parser.parse!(@argv)
+    end
+
+    # run methods
+
+    def validate_mode
+      unless %w{ hide show }.include?(@options[:mode])
+        STDERR.puts "Mode (show or hide) is required."
+        exit 1
+      end
+    end
+
+    def build_hidr
+      if @options[:builtin]
+        if Cript::Hidr::CHARS.keys.include?(@options[:builtin])
+          Cript::Hidr.send(@options[:builtin])
+        else
+          STDERR.puts "Invalid builtin: #{@options[:builtin]}"
+          exit 1
+        end
+      else
+        Cript::Hidr.new(b0: @options[:b0], b1: @options[:b1])
+      end
+    end
+
+    def read_data
+      if @options[:infile] == '-'
+        # requires ARGV clear
+        STDIN.read
+      elsif File.file?(@options[:infile])
+        File.read(@options[:infile])
+      else
+        STDERR.puts "Invalid infile: #{@options[:infile]}"
+        exit 1
+      end
+    end
+
+    def get_writer
+      begin
+        if @options[:outfile] == '-'
+          writer = STDOUT
+        elsif File.file?(@options[:outfile])
+          if @options[:force]
+            writer = File.open(@options[:outfile], 'wb')
+          else
+            STDERR.puts "Not overwriting file without force"
+            exit 1
+          end
+        else
+          writer = File.open(@options[:outfile], 'wb')
+        end
+
+        yield(writer)
+      rescue => e
+        STDERR.puts "Error writing data: #{e}"
+        exit 1
+      ensure
+        # clean-up
+        if writer && @options[:outfile] != '-'
+          writer.close
+        end
+      end
+    end
+
+  end
+end

data/lib/cript/version.rb

@@ -1,3 +1,3 @@
 module Cript
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/cript_command_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+require 'cript/cript_command'
+
+describe Cript::CriptCommand do
+
+  context 'parse' do
+    it 'should parse encrypt options' do
+      c = Cript::CriptCommand.new("-e --public /tmp/fake_key.pub -i /tmp/in.txt -o /tmp/out.txt -f -D".split(" "))
+      c.options[:mode].should eql('encrypt')
+      c.options[:public].should eql('/tmp/fake_key.pub')
+      c.options[:infile].should eql('/tmp/in.txt')
+      c.options[:outfile].should eql('/tmp/out.txt')
+      c.options[:force].should be_true
+      c.options[:debug].should be_true
+    end
+
+    it 'should parse decrypt options' do
+      c = Cript::CriptCommand.new("-d --private /tmp/fake_key -i /tmp/in.txt -o /tmp/out.txt -f -D".split(" "))
+      c.options[:mode].should eql('decrypt')
+      c.options[:private].should eql('/tmp/fake_key')
+      c.options[:infile].should eql('/tmp/in.txt')
+      c.options[:outfile].should eql('/tmp/out.txt')
+      c.options[:force].should be_true
+      c.options[:debug].should be_true
+    end
+  end
+end

data/spec/hidr_command_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+require 'cript/hidr_command'
+
+describe Cript::HidrCommand do
+
+  context 'parse' do
+    it 'should parse hide options' do
+      c = Cript::HidrCommand.new("-h -0 a -1 b -i /tmp/in.txt -o /tmp/out.txt -f -D".split(" "))
+      c.options[:mode].should eql('hide')
+      c.options[:b0].should eql('a')
+      c.options[:b1].should eql('b')
+      c.options[:infile].should eql('/tmp/in.txt')
+      c.options[:outfile].should eql('/tmp/out.txt')
+      c.options[:force].should be_true
+      c.options[:debug].should be_true
+    end
+
+    it 'should parse show options' do
+      c = Cript::HidrCommand.new("-s -0 a -1 b -i /tmp/in.txt -o /tmp/out.txt -f -D".split(" "))
+      c.options[:mode].should eql('show')
+      c.options[:b0].should eql('a')
+      c.options[:b1].should eql('b')
+      c.options[:infile].should eql('/tmp/in.txt')
+      c.options[:outfile].should eql('/tmp/out.txt')
+      c.options[:force].should be_true
+      c.options[:debug].should be_true
+    end
+
+    it 'should recognize built-in hidrs' do
+      c = Cript::HidrCommand.new("-s -b orly -i /tmp/in.txt -o /tmp/out.txt -f -D".split(" "))
+      hidr = c.send(:build_hidr)
+      opts = hidr.instance_variable_get(:@o)
+      opts[:b0].should eql("\u0CA0")
+      opts[:b1].should eql("\u005F")
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cript
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-27 00:00:00.000000000 Z
+date: 2013-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -62,7 +62,9 @@ dependencies:
 description: Simple Encryption Tools for Ruby
 email:
 - atongen@gmail.com
-executables: []
+executables:
+- cript
+- hidr
 extensions: []
 extra_rdoc_files: []
 files:
@@ -72,16 +74,22 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/cript
+- bin/hidr
 - cript.gemspec
 - lib/cript.rb
+- lib/cript/cript_command.rb
 - lib/cript/cripter.rb
 - lib/cript/ehash.rb
 - lib/cript/hidr.rb
+- lib/cript/hidr_command.rb
 - lib/cript/naive.rb
 - lib/cript/simple.rb
 - lib/cript/store.rb
 - lib/cript/version.rb
+- spec/cript_command_spec.rb
 - spec/ehash_spec.rb
+- spec/hidr_command_spec.rb
 - spec/hidr_spec.rb
 - spec/naive_spec.rb
 - spec/simple_spec.rb
@@ -112,7 +120,9 @@ signing_key:
 specification_version: 3
 summary: Simple Encryption Tools for Ruby
 test_files:
+- spec/cript_command_spec.rb
 - spec/ehash_spec.rb
+- spec/hidr_command_spec.rb
 - spec/hidr_spec.rb
 - spec/naive_spec.rb
 - spec/simple_spec.rb