keybox 1.0.0 → 1.1.0

data/CHANGES

@@ -1,4 +1,13 @@
 = keybox Changelog
+=== Version 1.1.0
+
+* keybox now uses HighLine for terminal input/output
+* Added --color SCHEME option to support custom colorized output
+  and non-colorzed output
+  - ships with light_bg and dark_bg schemes, dark_bg is default
+* Fixed configuration bug where command line options were not 
+  correctly overwriting default options.
+
 === Version 1.0.0
 
 * Initial public release

data/README

@@ -1,7 +1,7 @@
 Keybox
 
 * Homepage[http://keybox.rubyforge.org]
-* [Rubyforge Project]http://rubyforge.org/projects/keybox/
+* {Rubyforge Project}[http://rubyforge.org/projects/keybox/]
 * email jeremy at hinegardner dot org
 
 == DESCRIPTION:
@@ -33,6 +33,8 @@ applications.
     General Options:
         -f, --file DATABASE_FILE         The Database File to use
         -c, --config CONFIG_FILE         The Configuration file to use
+            --color SCHEME               The color scheme to use
+                                         none,dark_bg,light_bg,<other>
         -D, --debug                      Ouput debug information to STDERR
             --[no-]use-hash-for-url      Use the password hash algorithm 
                                            for URL accounts
@@ -52,6 +54,7 @@ applications.
         -i, --import-from-csv FILE       Import from a CSV file
         -x, --export-to-csv FILE         Export contents to a CSV file
 
+
 * kpg command line application
 
     Usage: kpg [options]
@@ -77,16 +80,17 @@ applications.
 == REQUIREMENTS:
 
 === For running: 
-* A basic ruby install that is compiled against OpenSSL >= 0.9.8 
+* For a gem install keybox depends upon HighLine[http://highline.rubyforge.org] >= 1.2.6.
+* For a source install keybox ships with HighLine 1.2.6
 
 === For development:
-* A basic ruby install that is compiled against OpenSSL >= 0.9.8 
 * rake >= 0.7.1
 * rcov >= 0.7.0.1
 * RedCloth >= 3.0.4
 * rspec  >= 0.7.3
 * rubyforge >= 0.4.0
 * webgen >= 0.4.1
+* highline >= 1.2.6
 
 == INSTALL:
 

data/bin/keybox

@@ -6,7 +6,8 @@
 #----------------------------------------------------------------------
 # bootstrap
 #----------------------------------------------------------------------
-require File.expand_path(File.join(File.dirname(__FILE__),"..","lib","keybox"))
+$: << File.expand_path(File.join(File.dirname(__FILE__),"..","lib"))
+require 'keybox'
 require 'keybox/application/password_safe'
 
 #----------------------------------------------------------------------

data/bin/kpg

@@ -6,7 +6,8 @@
 #----------------------------------------------------------------------
 # bootstrap
 #----------------------------------------------------------------------
-require File.expand_path(File.join(File.dirname(__FILE__),"..","lib","keybox"))
+$: << File.expand_path(File.join(File.dirname(__FILE__),"..","lib"))
+require 'keybox'
 require 'keybox/application/password_generator'
 
 #----------------------------------------------------------------------

data/data/dark_bg.color_scheme.yaml

@@ -0,0 +1,32 @@
+# yaml document for the dark background scheme
+# 
+# The colorized elements of keybox are:
+#   :prompt         -> Whenever you are asked to input information
+#   :header         -> Header line on a table of output
+#   :header_bar     -> Horizontal bar under a table header
+#   :line_number    -> Number at the beginning of a line of tabular
+#                      output
+#   :even_row       -> Color of an even numbered row of tabular data
+#   :odd_row        -> Color of an odd numbered row of tabular data
+#   :information    -> Informational message from keybox
+#   :error          -> Error message from keybox
+#   :private        -> Private data being displayed
+#   :separator      -> Separator between name : value pairs
+#   :separator_bar  -> Separator displayed entries
+#   :name           -> Names from name : value pairs
+#   :value          -> Values from name : value pairs
+---
+:normal:        [ :clear            ]
+:prompt:        [ :bold, :white     ]
+:header:        [ :bold, :yellow    ]
+:header_bar:    [ :blue             ]
+:line_number:   [ :bold, :white     ]
+:even_row:      [ :bold, :magenta   ]
+:odd_row:       [ :bold, :cyan      ]
+:information:   [ :bold, :green     ]
+:error:         [ :bold, :red       ]
+:private:       [ :bold, :red       ]
+:separator:     [ :bold, :white     ]
+:separator_bar: [ :bold, :blue      ]
+:name:          [ :bold, :blue      ]
+:value:         [ :bold, :cyan      ]

data/data/light_bg.color_scheme.yaml

@@ -0,0 +1,32 @@
+# yaml document for the dark background scheme
+# 
+# The colorized elements of keybox are:
+#   :prompt         -> Whenever you are asked to input information
+#   :header         -> Header line on a table of output
+#   :header_bar     -> Horizontal bar under a table header
+#   :line_number    -> Number at the beginning of a line of tabular
+#                      output
+#   :even_row       -> Color of an even numbered row of tabular data
+#   :odd_row        -> Color of an odd numbered row of tabular data
+#   :information    -> Informational message from keybox
+#   :error          -> Error message from keybox
+#   :private        -> Private data being displayed
+#   :separator      -> Separator between name : value pairs
+#   :separator_bar  -> Separator displayed entries
+#   :name           -> Names from name : value pairs
+#   :value          -> Values from name : value pairs
+---
+:normal:        [ :clear    ]
+:prompt:        [ :red      ]
+:header:        [ :green    ]
+:header_bar:    [ :magenta  ]
+:line_number:   [ :cyan     ]
+:even_row:      [ :blue     ]
+:odd_row:       [ :red      ]
+:information:   [ :green    ]
+:error:         [ :bold, :yellow, :on_red ]
+:private:       [ :bold, :red, :on_black  ]
+:separator:     [ :cyan     ]
+:separator_bar: [ :green    ]
+:name:          [ :magenta  ]
+:value:         [ :blue     ]

data/lib/keybox.rb

@@ -2,8 +2,9 @@ module Keybox
     APP_ROOT_DIR    = File.dirname(File.expand_path(File.join(__FILE__,".."))).freeze
     APP_LIB_DIR     = File.join(APP_ROOT_DIR,"lib").freeze
     APP_DATA_DIR    = File.join(APP_ROOT_DIR,"data").freeze
+    APP_VENDOR_DIR  = File.join(APP_ROOT_DIR,"vendor").freeze
     
-    VERSION     = [1,0,0].freeze
+    VERSION     = [1,1,0].freeze
     AUTHOR      = "Jeremy Hinegardner".freeze
     AUTHOR_EMAIL= "jeremy@hinegardner.org".freeze
     HOMEPAGE    = "http://keybox.rubyforge.org".freeze
@@ -25,5 +26,4 @@ require 'keybox/randomizer'
 require 'keybox/storage'
 require 'keybox/string_generator'
 require 'keybox/uuid'
-require 'keybox/term_io'
 require 'keybox/convert'

data/lib/keybox/application/base.rb

@@ -1,5 +1,6 @@
 require 'optparse'
 require 'ostruct'
+require 'keybox/highline_util'
 
 #------------------------------------------------------------------------
 # Base class for applications in keybox
@@ -21,22 +22,21 @@ module Keybox
             attr_accessor :error_message
 
             # these allow for testing instrumentation
-            attr_accessor :stdout
-            attr_accessor :stderr
-            attr_accessor :stdin
+            attr_reader :stdout
+            attr_reader :stderr
+            attr_reader :stdin
+            attr_reader :highline
 
             def initialize(argv = [])
                 # make sure we have an empty array, we could be
                 # initially passed nil explicitly
                 argv ||= []
 
-                # for testing instrumentation
-                @stdin  = $stdin
-                @stdout = $stdout
-                @stderr = $stderr
+                # setup default io streams
+                set_io
 
                 @options        = self.default_options
-                @parsed_options = self.default_options
+                @parsed_options = OpenStruct.new
                 @parser         = self.option_parser
                 @error_message  = nil
 
@@ -49,6 +49,21 @@ module Keybox
                 end
             end
 
+            #
+            # Allow the IO to be reset.  This is generally just for
+            # testing instrumentation, but it may be useful for
+            # something else too.
+            #
+            def set_io(stdin = $stdin,stdout = $stdout,stderr = $stderr)
+                # for testing instrumentation
+                @stdin    = stdin
+                @stdout   = stdout
+                @stderr   = stderr
+                
+                # Instance of HighLine for the colorization of output
+                @highline = ::HighLine.new(@stdin,@stdout)
+            end
+
             def option_parser
                 OptionParser.new do |op|
                     op.separator ""
@@ -80,7 +95,7 @@ module Keybox
             # then merge in the command line options
             def merge_options
                 options = default_options.marshal_dump
-                configuration_file_options.each_pair do |key,value|
+                self.configuration_file_options.each_pair do |key,value|
                     options[key] = value
                 end
 
@@ -97,17 +112,17 @@ module Keybox
                     @stderr.puts @error_message
                     exit 1
                 elsif @parsed_options.show_version then
-                    @stdout.puts "#{@parser.program_name}: version #{Keybox::VERSION.join(".")}"
+                    @highline.say "#{@parser.program_name}: version #{Keybox::VERSION.join(".")}"
                     exit 0
                 elsif @parsed_options.show_help then
-                    @stdout.puts @parser
+                    @highline.say @parser.to_s
                     exit 0
                 end
             end
 
             def run 
                 error_version_help
-                @stdout.puts "Keybox Base Application.  Doing nothing but output this line."
+                @highline.say "Keybox Base Application.  Doing nothing but output this line."
             end
         end
     end

data/lib/keybox/application/password_safe.rb

@@ -11,14 +11,15 @@ require 'fileutils'
 module Keybox
     module Application 
         class PasswordSafe < Base
-            include Keybox::TermIO
+            include Keybox::HighLineUtil
 
             attr_accessor :actions
             attr_reader   :db
 
-            DEFAULT_DIRECTORY = File.join(ENV["HOME"],".keybox")
-            DEFAULT_DB        = File.join(DEFAULT_DIRECTORY,"database.yaml")
-            DEFAULT_CONFIG    = File.join(DEFAULT_DIRECTORY,"config.yaml")
+            DEFAULT_DIRECTORY    = File.join(ENV["HOME"],".keybox")
+            DEFAULT_DB           = File.join(DEFAULT_DIRECTORY,"database.yaml")
+            DEFAULT_CONFIG       = File.join(DEFAULT_DIRECTORY,"config.yaml")
+            DEFAULT_COLOR_SCHEME = :dark_bg
 
             ACTION_LIST       = %w(add delete edit show list master-password)
 
@@ -48,6 +49,10 @@ module Keybox
                         @parsed_options.config_file = cfile
                     end
 
+                    op.on("--color SCHEME","The color scheme to use", "none,dark_bg,light_bg,<other>") do |scheme|
+                        @parsed_options.color_scheme = scheme.to_sym
+                    end
+                          
                     op.on("-D", "--debug", "Ouput debug information to STDERR") do 
                         @parsed_options.debug = true
                     end
@@ -56,7 +61,6 @@ module Keybox
                         @parsed_options.use_password_hash_for_url = r
                     end
 
-
                     op.separator ""
                     op.separator "Commands, one and only one of these is required:"
                     
@@ -116,6 +120,7 @@ module Keybox
                 options.config_file                 = Keybox::Application::PasswordSafe::DEFAULT_CONFIG
                 options.db_file                     = Keybox::Application::PasswordSafe::DEFAULT_DB
                 options.use_password_hash_for_url   = false
+                options.color_scheme                = Keybox::Application::PasswordSafe::DEFAULT_COLOR_SCHEME
                 return options
             end
 
@@ -126,7 +131,6 @@ module Keybox
             # we use the default unless the parsed_options contain a
             # configuration file then we use that one
             def configuration_file_options
-
                 file_path = @parsed_options.config_file || DEFAULT_CONFIG
 
                 # if the file is 0 bytes, then this is illegal and needs
@@ -140,13 +144,85 @@ module Keybox
                 options = YAML.load_file(file_path) || Hash.new
             end
 
+            #
+            # load the given color scheme.  If the scheme cannot be
+            # found it will default to the +:none+ scheme which has no
+            # color
+            #
+            # The color_scheme file exists either in the application data
+            # directory, or in the same directory as the configuration
+            # file.
+            # 
+            # The file name convention for the scheme file is
+            # +schemename.color_scheme.yaml+.  So for instance the default
+            # +:dark_bg+ color scheme file is named:
+            #
+            #   dark_bg.color_scheme.yaml
+            def load_color_scheme
+                if @options.color_scheme != :none then
+                    search_directories  = [ Keybox::APP_DATA_DIR, File.dirname(@options.config_file) ]
+                    scheme_basename     = "#{@options.color_scheme.to_s}.color_scheme.yaml"
+                    scheme_path         = nil
+                   
+                    # get the path to the file
+                    search_directories.each do |sd|
+                        if File.exists?(File.join(sd,scheme_basename)) then
+                            scheme_path = File.join(sd,scheme_basename)
+                            break
+                        end
+                    end
+                  
+                    # if we have a file then load it and make sure we have
+                    # all the valid labels.
+                    if scheme_path then
+                        initial_color_scheme = YAML::load(File.read(scheme_path))
+                      
+                        # make sure that everything is a Symbol and in the
+                        # process make sure that all of the required labels
+                        # are there.
+                        color_scheme = {}
+                        initial_color_scheme.each_pair do |label,ansi_seq|
+                            color_scheme[label.to_sym] = ansi_seq.collect { |a| a.to_sym }
+                        end
+
+                        # validate that all the required color labels exist
+                        if (NONE_SCHEME.keys - color_scheme.keys).size == 0 then
+                            ::HighLine.color_scheme = ::HighLine::ColorScheme.new(color_scheme)
+                        else
+                            @options.color_scheme   = :none  
+                            ::HighLine.color_scheme = ::HighLine::ColorScheme.new(NONE_SCHEME)
+
+                            @stdout.puts "The color scheme in file '#{scheme_path}' is Invalid"
+                            @stdout.puts "It is missing the following items:"
+
+                            (NONE_SCHEME.keys - color_scheme.keys).each do |missing_label|
+                                @stdout.puts "\t :#{missing_label}"
+                            end
+
+                            @stdout.puts "Not using any color scheme."
+                        end
+
+                    else
+                        # if we don't have a file then set the color
+                        # scheme to nil and we're done
+                        @options.color_scheme = :none
+                        ::HighLine.color_scheme = ::HighLine::ColorScheme.new(NONE_SCHEME)
+                    end
+                else
+                    ::HighLine.color_scheme = ::HighLine::ColorScheme.new(NONE_SCHEME)
+                end
+            end
+
+            #
+            # load the database from its super secret location
+            #
             def load_database
                 password = nil
                 if not File.exists?(@options.db_file) then
-                    color_puts "Creating initial database.", :yellow
-                    password  = prompt("Initial Password for (#{@options.db_file})", false, true)
+                    hsay 'Creating initial database.', :information
+                    password  = prompt("Initial Password for (#{@options.db_file})", :echo => "*", :validate => true)
                 else
-                    password  = prompt("Password for (#{@options.db_file})", false)
+                    password  = prompt("Password for (#{@options.db_file})", :echo => "*")
                 end
                 @db = Keybox::Storage::Container.new(password,@options.db_file)
             end
@@ -172,7 +248,7 @@ module Keybox
 
                 end
                 new_entry = gather_info(entry)
-                color_puts "Adding #{new_entry.title} to database", :green
+                hsay "Adding #{new_entry.title} to database.", :information
                 @db << new_entry
             end
 
@@ -181,19 +257,19 @@ module Keybox
             def gather_info(entry)
                 gathered = false
                 while not gathered do
-                    color_puts "Gathering information for entry '#{entry.title}'", :yellow
+                    hsay "Gathering information for entry '#{entry.title}'", :information
 
                     entry = fill_entry(entry)
 
                     # dump the info we have gathered and make sure that
                     # it is the input that the user wants to store.
                    
-                    color_puts "-" * 40, :blue
-                    @stdout.puts entry
-                    color_puts "-" * 40, :blue
-                    if prompt_y_n("Is this information correct (y/n) [N] ?") then
-                        gathered = true
-                    end
+                    hsay "-" * 40, :separator_bar
+                    hsay entry, :normal
+                    hsay "-" * 40, :separator_bar
+                    
+
+                    gathered = hagree "Is this information correct? (y/n)"
                 end
 
                 entry
@@ -206,16 +282,16 @@ module Keybox
                 matches = @db.find(account)
                 count = 0
                 matches.each do |match|
-                    color_puts "-" * 40, :blue
-                    @stdout.puts match
-                    color_puts "-" * 40, :blue
+                    hsay "-" * 40, :separator_bar
+                    hsay match, :normal
+                    hsay "-" * 40, :separator_bar
 
-                    if prompt_y_n("Delete this entry (y/n) [N] ?") then
+                    if hagree "Delete this entry (y/n) ?" then
                         @db.delete(match)
                         count += 1
                     end
                 end
-                color_puts "#{count} records matching '#{account}' deleted.", :green
+                hsay "#{count} records matching '#{account}' deleted.", :information
             end
 
             #
@@ -225,19 +301,19 @@ module Keybox
                 matches = @db.find(account)
                 count = 0
                 matches.each do |match|
-                    color_puts "-" * 40, :blue
-                    @stdout.puts match
-                    color_puts "-" * 40, :blue
+                    hsay "-" * 40, :separator_bar
+                    hsay match, :normal
+                    hsay "-" * 40, :separator_bar
 
-                    if prompt_y_n("Edit this entry (y/n) [N] ?") then
+                    if hagree "Edit this entry (y/n) ?" then
                         entry = gather_info(match)
                         @db.delete(match)
                         @db << entry
                         count += 1
-                        color_puts "Entry '#{entry.title}' updated.", :green
+                        hsay "Entry '#{entry.title}' updated.", :information
                     end
                 end
-                color_puts "#{count} records matching '#{account}' edited.", :green
+                hsay "#{count} records matching '#{account}' edited.", :information
             end
 
             #
@@ -260,25 +336,26 @@ module Keybox
 
                     full_length = lengths.values.inject(0) { |sum,n| sum + n}
                     header = "  # #{"Title".ljust(lengths[:title])}    #{"Username".ljust(lengths[:username])}    #{add_info}"
-                    color_puts header, :yellow 
+                    hsay header, :header
                     #  3 spaces for number column + 1 space after and 4 spaces between
                     #  each other column
-                    color_puts "-" * (header.length), :blue, false
+                    hsay"-" * (header.length), :header_bar
 
                     matches.each_with_index do |match,i|
-                        color_print sprintf("%3d ", i + 1), :white
+                        line_number = sprintf("%3d", i + 1)
                         # toggle colors
-                        color = [:cyan, :magenta][i % 2]
+                        color = [:even_row, :odd_row][i % 2]
                         columns = []
                         [:title, :username, :additional_info].each do |f|
                             t = match.send(f)
                             t = "-" if t.nil? or t.length == 0 
                             columns << t.ljust(lengths[f])
                         end
-                        color_puts columns.join(" " * 4), color
+                        cdata = columns.join(" " * 4)
+                        @highline.say("<%= color('#{line_number}',:line_number) %> <%= color('#{cdata}','#{color}') %>")
                     end
                 else
-                    color_puts "No matching records were found.", :green
+                    hsay "No matching records were found.", :information
                 end
             end
 
@@ -289,31 +366,33 @@ module Keybox
                 matches = @db.find(account)
                 if matches.size > 0 then
                     matches.each_with_index do |match,i|
-                        color_puts "#{sprintf("%3d",i + 1)}. #{match.title}", :yellow
+                        hsay "#{sprintf("%3d",i + 1)}. #{match.title}", :header
                         max_name_length = match.max_field_length + 1
                         match.each do |name,value|
                             next if name == "title"
                             next if value.length == 0
 
                             name_out = name.rjust(max_name_length)
-                            color_print name_out, :blue
-                            color_print " : ", :white
+                            @highline.say("<%= color('#{name_out}', :name) %> <%= color(':',:separator) %> ")
 
                             if match.private_field?(name) then
-                                color_print value, :red
-                                color_print " (press any key).", :white
-                                junk = get_one_char
-                                color_print "\r#{name_out}", :blue
-                                color_print " : ", :white
-                                color_puts "#{"*" * 20}\e[K", :red
+                                @highline.ask(
+                                   "<%= color('#{value}',:private) %> <%= color('(press any key).', :prompt) %> "
+                                ) do |q|
+                                    q.overwrite = true
+                                    q.echo      = false
+                                    q.character = true
+                                end
+                                
+                                @highline.say("<%= color('#{name_out}', :name) %> <%= color(':',:separator) %> <%= color('#{'*' * 20}', :private) %>")
                             else
-                                color_puts value, :cyan
+                                hsay value, :value
                             end
                         end
                         @stdout.puts
                     end
                 else
-                    color_puts "No matching records were found.", :green
+                    hsay "No matching records were found.", :information
                 end
             end
 
@@ -321,9 +400,8 @@ module Keybox
             # Change the master password on the database
             #
             def master_password(ignore_this)
-                new_password = prompt("Enter new master password", false, true, 30)
-                @db.passphrase = new_password
-                color_puts "New master password set.", :green
+                @db.passphrase = prompt("Enter new master password", :echo => '*', :validate => true, :width => 45) 
+                hsay "New master password set.", :information
             end
 
             #
@@ -334,14 +412,14 @@ module Keybox
                 entries.each do |entry|
                     @db << entry
                 end
-                color_puts "Imported #{entries.size} records from #{file}.", :green
+                hsay "Imported #{entries.size} records from #{file}.", :information
             end
 
             #
             # Export data from the database into a CSV file
             def export_to_csv(file)
                 Keybox::Convert::CSV.to_file(@db.records, file)
-                color_puts "Exported #{@db.records.size} records to #{file}.", :green
+                hsay "Exported #{@db.records.size} records to #{file}.", :information
             end
 
             def fill_entry(entry)
@@ -360,12 +438,12 @@ module Keybox
                     # we don't echo private field prompts and we validate
                     # them
                     if entry.private_field?(field) then
-                        echo = false
+                        echo = '*'
                         validate = true
                         p = "#{field}"
                     end
 
-                    value = prompt(p,echo,validate,max_length)
+                    value = prompt("#{p}",:echo => echo ,:validate => validate,:width => max_length)
 
                     if value.nil? or value.size == 0 then
                         value = default
@@ -379,6 +457,7 @@ module Keybox
                 begin
                     error_version_help
                     merge_options
+                    load_color_scheme
                     load_database
 
                     if @actions.size == 0 then
@@ -388,20 +467,19 @@ module Keybox
                     self.send(action, param)
 
                     if @db.modified? then 
-                        color_puts "Database modified, saving.", :green
+                        hsay "Database modified, saving.", :information
                         @db.save
                     else
-                        color_puts "Database not modified.", :green
+                        hsay "Database not modified.", :information
                     end
                 rescue SignalException => se
                     @stdout.puts
-                    color_puts "Interrupted", :red
-                    color_puts "There may be private information on your screen.", :red
-                    color_puts "Please close this terminal.", :red
+                    hsay "Interrupted", :error
+                    hsay "There may be private information on your screen.", :error
+                    hsay "Please close this terminal.", :error
                     exit 1
                 rescue StandardError => e
-                    @stdout.puts
-                    color_puts "Error: #{e.message}", :red
+                    hsay "Error: #{e.message}", :error
                     exit 1
                 end
             end