Begin porting the command line interface to use Thor. #11.

This commit ports the `encrypt` submethod and the actual bin.

Author: rsutphin

bcdatabase.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
   s.add_dependency "activesupport", ">= 2.0"
   s.add_dependency "highline", "~> 1.5"
   s.add_dependency "i18n"
+  s.add_dependency 'thor', '~> 0.14.6'
 
   s.add_development_dependency 'bundler', '~> 1.0.15'
   s.add_development_dependency 'rake', '~> 0.9.2'

bin/bcdatabase

@@ -1,26 +1,20 @@
-#!/usr/bin/env ruby -W
+#!/usr/bin/env ruby
 
-require 'rubygems'
-require 'bcdatabase/commands'
-
-module Bcdatabase::Commands
-  UTILITY_NAME = File.basename(__FILE__)
+# Allow this executable to be run directly from the source as well as
+# from an installed gem.
+begin
+  lib = File.expand_path('../../lib', __FILE__)
+  unless $LOAD_PATH.include?(lib)
+    $LOAD_PATH << lib
+    require 'rubygems'
+  end
 end
 
-###### MAIN
-
-command = ARGV.shift
-unless command
-  $stderr.puts "Please specify a command."
-  $stderr.puts Bcdatabase::Commands.help
-  exit(1)
-end
+require 'bcdatabase'
 
-klass = Bcdatabase::Commands[command]
-unless klass
-  $stderr.puts "Unknown command #{command}."
-  $stderr.puts Bcdatabase::Commands.help
-  exit(2)
+begin
+  Bcdatabase::CLI.start
+rescue Interrupt => e
+  $stderr.puts "Interrupted"
+  exit 1
 end
-
-exit(klass.new(ARGV).main)

lib/bcdatabase.rb

@@ -8,6 +8,7 @@
 
 module Bcdatabase
   autoload :VERSION,  'bcdatabase/version'
+  autoload :CLI,      'bcdatabase/cli'
   autoload :Commands, 'bcdatabase/commands'
 
   DEFAULT_BASE_PATH = File.join('/', 'etc', 'nubic', 'db')

lib/bcdatabase/cli.rb

@@ -0,0 +1,26 @@
+require 'bcdatabase'
+require 'thor'
+
+module Bcdatabase
+  class CLI < Thor
+    desc "encrypt [INPUT [OUTPUT]]",
+      "Encrypts every password in a bcdatabase YAML file."
+    long_desc <<-DESC
+      This command finds all the keys named 'password' in the input
+      YAML and substitutes appropriate 'epassword' keys.
+
+      If inputfile is specified, the source will be that file. If not,
+      the source will be standard in.
+
+      If inputfile and outputfile are specified, the new file will be
+      written to the output file. Otherwise the output will go to
+      standard out. Input and output may be the same file.
+
+      You can't read from standard in and write to a file directly;
+      use shell file redirection if you need to do that.
+    DESC
+    def encrypt(inputfile=nil, outputfile=nil)
+      Commands::Encrypt.new(inputfile, outputfile).run
+    end
+  end
+end

lib/bcdatabase/commands.rb

@@ -8,6 +8,8 @@
 HL = HighLine.new
 
 module Bcdatabase::Commands
+  autoload :Encrypt, 'bcdatabase/commands/encrypt'
+
   class Base
     protected
 
@@ -70,57 +72,6 @@ def interactive
     end
   end
 
-  class Encrypt < Base
-    def initialize(argv)
-      @input = argv.shift
-      @output = argv.shift
-    end
-
-    def self.summary
-      "Encrypts all the password entries in a bcdatabase YAML file"
-    end
-
-    def self.help
-      help_message("encrypt [inputfile [outputfile]]") do |msg|
-        msg << "Specifically, this command finds all the keys named 'password'"
-        msg << "  in the input YAML and substitutes appropriate 'epassword'"
-        msg << "  keys."
-        msg << ""
-        msg << "If inputfile is specified, the source will be that file."
-        msg << "  If not, the source will be standard in."
-        msg << ""
-        msg << "If inputfile and outputfile are specified, the new file"
-        msg << "  will be written to the output file.  Otherwise the output"
-        msg << "  will go to standard out.  Input and output may be the same"
-        msg << "  file."
-        msg << ""
-        msg << "You can't read from standard in and write to a file directly; "
-        msg << "  use shell file redirection if you need to do that."
-      end
-    end
-
-    def main
-      inio =
-        if @input
-          open(@input, "r")
-        else
-          $stdin
-        end
-      # try to preserve the order by replacing everything using regexes
-      contents = inio.read
-      contents.gsub!(/\bpassword:(\s*)(\S+)\s*?$/) { "epassword:#{$1}#{Bcdatabase.encrypt($2)}" }
-      outio =
-        if @output
-          open(@output, "w")
-        else
-          $stdout
-        end
-      outio.write(contents)
-      outio.close
-      0
-    end
-  end
-
   class Help < Base
     def initialize(argv)
       @cmd = argv.shift

lib/bcdatabase/commands/encrypt.rb

@@ -0,0 +1,30 @@
+require 'bcdatabase/commands'
+
+module Bcdatabase::Commands
+  class Encrypt
+    def initialize(inputfile=nil, outputfile=nil)
+      @input = inputfile
+      @output = outputfile
+    end
+
+    def run
+      inio =
+        if @input
+          open(@input, "r")
+        else
+          $stdin
+        end
+      # try to preserve the order by replacing everything using regexes
+      contents = inio.read
+      contents.gsub!(/\bpassword:(\s*)(\S+)\s*?$/) { "epassword:#{$1}#{Bcdatabase.encrypt($2)}" }
+      outio =
+        if @output
+          open(@output, "w")
+        else
+          $stdout
+        end
+      outio.write(contents)
+      outio.close
+    end
+  end
+end

spec/bcdatabase/commands/encrypt_spec.rb

@@ -0,0 +1,85 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+module Bcdatabase::Commands
+  describe Encrypt do
+    let(:pprod_path) { File.join(ENV['BCDATABASE_PATH'], 'pprod.yaml') }
+
+    before do
+      enable_fake_cipherment
+      ENV['BCDATABASE_PATH'] = (tmpdir + 'base').tap { |d| d.mkpath }
+
+      temporary_yaml 'pprod', {
+        'wh' => {
+          'password' => 'zanzibar'
+        },
+        'app' => {
+          'epassword' => 'etalocohc'
+        }
+      }
+    end
+
+    after do
+      ENV['BCDATABASE_PATH'] = nil
+      disable_fake_cipherment
+    end
+
+    def run_with(inputfile, outputfile=nil)
+      capture_std do
+        Encrypt.new(inputfile, outputfile).run
+      end
+    end
+
+    def run_with_input(*lines)
+      replace_stdin(*lines) do
+        capture_std do
+          Encrypt.new.run
+        end
+      end
+    end
+
+    shared_examples 'general behavior' do
+      let(:yaml_output) { YAML.load(output) }
+
+      it 'reads from the appropriate input' do
+        output.should =~ /wh:/
+      end
+
+      it 'encrypts the password' do
+        yaml_output['wh']['epassword'].should == 'rabiznaz'
+      end
+
+      it 'removes the unencrypted password' do
+        yaml_output['wh'].should_not have_key('password')
+      end
+
+      it 'leaves any existing epasswords alone' do
+        yaml_output['app']['epassword'].should == 'etalocohc'
+      end
+    end
+
+    describe 'with zero arguments' do
+      subject { run_with_input('wh:', '  password: zanzibar', 'app:', '  epassword: etalocohc') }
+
+      let(:output) { subject[:out] }
+
+      include_examples 'general behavior'
+    end
+
+    describe 'with one argument' do
+      subject { run_with(pprod_path) }
+
+      let(:output) { subject[:out] }
+
+      include_examples 'general behavior'
+    end
+
+    describe 'with two arguments' do
+      subject { run_with(pprod_path, out_path) }
+
+      let(:out_path) { tmpdir + 'encrypted.yml' }
+      let(:output) { subject; File.read(out_path) }
+
+      include_examples 'general behavior'
+    end
+  end
+end