keybox 1.1.1 → 1.2.0

data/CHANGES

@@ -1,5 +1,14 @@
-= keybox Changelog
-=== Version 1.1.1
+= Changelog
+
+=== Version 1.2.0 - 2007-09-09
+
+* Added Feature [#11796] Change initial setup prompts to NOT have colorized output and ask the user what color scheme is appropriate for them
+* Update to use HighLine 1.4.0
+* general code cleanup
+* rework rake tasks to keep in line with other projects
+* switch to webby for site generation
+
+=== Version 1.1.1 - 2007-06-21
 
 * update all tests to use latest RSpec syntax
 * Fixed Bug [#8231] storage::container.find() does not work for anything but AccountEntry classes
@@ -9,7 +18,7 @@
 * Fixed Bug [#11684] apostrophe's in additional information cause errors
 * Updated to using HighLine 1.2.9 (fixes Bug #9827)
 
-=== Version 1.1.0
+=== Version 1.1.0 - 2007-01-27
 
 * keybox now uses HighLine for terminal input/output
 * Added --color SCHEME option to support custom colorized output
@@ -18,7 +27,7 @@
 * Fixed configuration bug where command line options were not 
   correctly overwriting default options.
 
-=== Version 1.0.0
+=== Version 1.0.0 - 2007-01-14
 
 * Initial public release
 * +keybox+ - Full basic functionality 

data/README

@@ -92,6 +92,9 @@ applications.
 * webgen >= 0.4.1
 * highline >= 1.2.6
 
+To run the RSpec test, you have to remove the termios library if it is installed. 
+stdin, stdout, and stderr are redirected and this doesn't play well with termios in highline.
+
 == INSTALL:
 
 * gem install keybox

data/bin/keybox

@@ -6,9 +6,15 @@
 #----------------------------------------------------------------------
 # bootstrap
 #----------------------------------------------------------------------
-$: << File.expand_path(File.join(File.dirname(__FILE__),"..","lib"))
-require 'keybox'
-require 'keybox/application/password_safe'
+begin
+    require 'keybox'
+    require 'keybox/application/password_safe'
+rescue LoadError 
+    path = File.expand_path(File.join(File.dirname(__FILE__),"..","lib"))
+    raise if $:.include? path
+    $: << path
+    retry
+end
 
 #----------------------------------------------------------------------
 # instantiate the program and pass it the commandline parameters

data/bin/kpg

@@ -6,9 +6,15 @@
 #----------------------------------------------------------------------
 # bootstrap
 #----------------------------------------------------------------------
-$: << File.expand_path(File.join(File.dirname(__FILE__),"..","lib"))
-require 'keybox'
-require 'keybox/application/password_generator'
+begin
+    require 'keybox'
+    require 'keybox/application/password_generator'
+rescue LoadError 
+    path = File.expand_path(File.join(File.dirname(__FILE__),"..","lib"))
+    raise if $:.include? path
+    $: << path
+    retry
+end
 
 #----------------------------------------------------------------------
 # instantiate the program and pass it the commandline parameters

data/lib/keybox.rb

@@ -1,22 +1,16 @@
 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,1,1].freeze
-    AUTHOR      = "Jeremy Hinegardner".freeze
-    AUTHOR_EMAIL= "jeremy@hinegardner.org".freeze
-    HOMEPAGE    = "http://keybox.rubyforge.org".freeze
-    COPYRIGHT   = "2006, 2007 #{AUTHOR}".freeze
-    DESCRIPTION = <<DESC
-Keybox is a set of command line applications and ruby libraries for
-secure password storage and password generation. 
-DESC
+    APP_ROOT_DIR        = File.dirname(File.expand_path(File.join(__FILE__,".."))).freeze
+    APP_LIB_DIR         = File.join(APP_ROOT_DIR,"lib").freeze
+    APP_RESOURCE_DIR    = File.join(APP_ROOT_DIR,"resources").freeze
+    APP_VENDOR_DIR      = File.join(APP_ROOT_DIR,"vendor").freeze
+    APP_BIN_DIR         = File.join(APP_ROOT_DIR,"bin").freeze
 end
 
 $: << Keybox::APP_LIB_DIR
 
+require 'keybox/version'
+require 'keybox/specification'
+require 'keybox/gemspec'
 require 'keybox/cipher'
 require 'keybox/digest'
 require 'keybox/entry'

data/lib/keybox/application/base.rb

@@ -89,11 +89,13 @@ module Keybox
             end
 
             def default_options
-                options = OpenStruct.new
-                options.debug           = 0
-                options.show_version    = false
-                options.show_help       = false
-                return options
+                if not @default_options then
+                    @default_options = OpenStruct.new
+                    @default_options.debug           = 0
+                    @default_options.show_version    = false
+                    @default_options.show_help       = false
+                end
+                return @default_options
             end
 
             def configuration_file_options
@@ -121,7 +123,7 @@ module Keybox
                     @stderr.puts @error_message
                     exit 1
                 elsif @parsed_options.show_version then
-                    @highline.say "#{@parser.program_name}: version #{Keybox::VERSION.join(".")}"
+                    @highline.say "#{@parser.program_name}: version #{Keybox::VERSION}"
                     exit 0
                 elsif @parsed_options.show_help then
                     @highline.say @parser.to_s

data/lib/keybox/application/password_generator.rb

@@ -75,17 +75,19 @@ module Keybox
             end
             
             def default_options
-                options = OpenStruct.new
-                options.debug               = 0
-                options.show_version        = false
-                options.show_help           = false
-                options.algorithm           = :random
-                options.number_to_generate  = 6
-                options.min_length          = 8
-                options.max_length          = 10
-                options.use_symbols         = options_to_symbol_sets(["all"])
-                options.require_symbols     = options_to_symbol_sets([])
-                return options
+                if not @default_options then
+                    @default_options = OpenStruct.new
+                    @default_options.debug               = 0
+                    @default_options.show_version        = false
+                    @default_options.show_help           = false
+                    @default_options.algorithm           = :random
+                    @default_options.number_to_generate  = 6
+                    @default_options.min_length          = 8
+                    @default_options.max_length          = 10
+                    @default_options.use_symbols         = options_to_symbol_sets(["all"])
+                    @default_options.require_symbols     = options_to_symbol_sets([])
+                end
+                return @default_options
             end
 
             def options_to_symbol_sets(args)

data/lib/keybox/application/password_safe.rb

@@ -19,7 +19,7 @@ module Keybox
             DEFAULT_DIRECTORY    = File.join(home_directory,".keybox")
             DEFAULT_DB           = File.join(DEFAULT_DIRECTORY,"database.yaml")
             DEFAULT_CONFIG       = File.join(DEFAULT_DIRECTORY,"config.yaml")
-            DEFAULT_COLOR_SCHEME = :dark_bg
+            DEFAULT_COLOR_SCHEME = :none
 
             ACTION_LIST       = %w(add delete edit show list master-password)
 
@@ -113,15 +113,17 @@ module Keybox
             end
 
             def default_options
-                options = OpenStruct.new
-                options.debug                       = 0
-                options.show_help                   = false
-                options.show_version                = false
-                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
+                if not @default_options then 
+                    @default_options                            = OpenStruct.new
+                    @default_options.debug                      = 0
+                    @default_options.show_help                  = false
+                    @default_options.show_version               = false
+                    @default_options.config_file                = Keybox::Application::PasswordSafe::DEFAULT_CONFIG
+                    @default_options.db_file                    = Keybox::Application::PasswordSafe::DEFAULT_DB
+                    @default_options.use_password_hash_for_url  = false
+                    @default_options.color_scheme               = Keybox::Application::PasswordSafe::DEFAULT_COLOR_SCHEME
+                end
+                return @default_options
             end
 
             # load options from the configuration file, if the file
@@ -136,6 +138,7 @@ module Keybox
                 # if the file is 0 bytes, then this is illegal and needs
                 # to be overwritten.
                 if not File.exists?(file_path) or File.size(file_path) == 0 then
+                    determine_color_scheme
                     FileUtils.mkdir_p(File.dirname(file_path))
                     File.open(file_path,"w") do |f|
                         YAML.dump(default_options.marshal_dump,f)
@@ -144,6 +147,20 @@ module Keybox
                 options = YAML.load_file(file_path) || Hash.new
             end
 
+            # determine the color scheme to store in the initial creation of the configuration
+            # file.  We ask the user which of the color schemes will work best for them.
+            def determine_color_scheme
+                @default_options.color_scheme = @highline.choose do |menu|
+                    menu.layout     = :one_line
+                    menu.select_by  = :name
+                    menu.header     = nil
+                    menu.prompt     = "What color scheme would you like? "
+                    menu.choice("none") { :none }
+                    menu.choice("dark terminal background") { :dark_bg }
+                    menu.choice("light terminal background") { :light_bg }
+                end
+            end
+            
             #
             # load the given color scheme.  If the scheme cannot be
             # found it will default to the +:none+ scheme which has no
@@ -160,7 +177,7 @@ module Keybox
             #   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) ]
+                    search_directories  = [ Keybox::APP_RESOURCE_DIR, File.dirname(@options.config_file) ]
                     scheme_basename     = "#{@options.color_scheme.to_s}.color_scheme.yaml"
                     scheme_path         = nil
                    
@@ -204,7 +221,7 @@ module Keybox
 
                     else
                         # if we don't have a file then set the color
-                        # scheme to nil and we're done
+                        # scheme to :none and we're done
                         @options.color_scheme = :none
                         ::HighLine.color_scheme = ::HighLine::ColorScheme.new(NONE_SCHEME)
                     end
@@ -267,7 +284,6 @@ module Keybox
                     hsay "-" * 40, :separator_bar
                     hsay entry, :normal
                     hsay "-" * 40, :separator_bar
-                    
 
                     gathered = hagree "Is this information correct? (y/n)"
                 end
@@ -463,9 +479,10 @@ module Keybox
                     if @actions.size == 0 then
                         @actions << [:list, ".*"]
                     end
+                    
                     action, param = *@actions.shift
                     self.send(action, param)
-
+                    
                     if @db.modified? then 
                         hsay "Database modified, saving.", :information
                         @db.save

data/lib/keybox/gemspec.rb

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'keybox/specification'
+require 'keybox/version'
+require 'rake'
+
+module Keybox
+    SPEC = Keybox::Specification.new do |spec|
+                spec.name               = "keybox"
+                spec.version            = Keybox::VERSION
+                spec.rubyforge_project  = "keybox"
+                spec.author             = "Jeremy Hinegardner"
+                spec.email              = "jeremy@hinegardner.org"
+                spec.homepage           = "http://keybox.rubyforge.org"
+
+                spec.summary            = "Secure pasword storage."
+                spec.description        = <<-DESC
+                A set of command line applications and ruby libraries for
+                secure password storage and password generation.
+                DESC
+
+                spec.extra_rdoc_files   = FileList["CHANGES", "COPYING", "README"]
+                spec.has_rdoc           = true
+                spec.rdoc_main          = "README"
+                spec.rdoc_options       = [ "--line-numbers" , "--inline-source" ]
+
+                spec.test_files         = FileList["spec/**/*.rb"]
+                spec.default_executable = "#{spec.name}"
+                spec.executables        = Dir.entries(Keybox::APP_BIN_DIR).delete_if { |f| f =~ /\A\./ }
+                spec.files              = spec.test_files + spec.extra_rdoc_files + 
+                                          FileList["lib/**/*.rb", "resources/**/*", "data/**/*"]
+
+                spec.add_dependency("highline", ">= 1.4.0")
+
+                spec.required_ruby_version  = ">= 1.8.5"
+
+                spec.platform = Gem::Platform::RUBY
+
+                spec.remote_user        = "jjh"
+                spec.local_site_dir     = "doc"
+                spec.local_rdoc_dir     = "doc/rdoc"
+                spec.remote_rdoc_dir    = "rdoc/"
+                spec.local_coverage_dir = "doc/coverage"
+
+                spec.remote_site_dir    = ""
+                
+                spec.post_install_message = "\e[1m\e[31m\e[40mTry `keybox --help` for more information\e[0m"
+                
+
+           end
+end
+
+

data/lib/keybox/highline_util.rb

@@ -1,7 +1,7 @@
 begin
     # first try to use the gem
     require 'rubygems'
-    gem 'highline', ">=1.2.6"
+    gem 'highline', ">=1.4.0"
 rescue Gem::LoadError
     # If that fails, then use what ships with keybox
     $: << File.join(Keybox::APP_VENDOR_DIR,"highline")

data/lib/keybox/specification.rb

@@ -0,0 +1,128 @@
+require 'rubygems'
+require 'rubygems/specification'
+require 'rake'
+
+module Keybox
+    # Add some additional items to Gem::Specification
+    # A Keybox::Specification adds additional pieces of information the
+    # typical gem specification
+    class Specification 
+
+        RUBYFORGE_ROOT = "/var/www/gforge-projects/"
+      
+        # user that accesses remote site
+        attr_accessor :remote_user
+
+        # remote host, default 'rubyforge.org'
+        attr_accessor :remote_host
+
+        # name the rdoc main
+        attr_accessor :rdoc_main
+
+        # local directory in development holding the generated rdoc
+        # default 'doc'
+        attr_accessor :local_rdoc_dir
+
+        # remote directory for storing rdoc, default 'doc'
+        attr_accessor :remote_rdoc_dir
+
+        # local directory for coverage report
+        attr_accessor :local_coverage_dir
+        
+        # remote directory for storing coverage reports
+        # This defaults to 'coverage'
+        attr_accessor :remote_coverage_dir
+
+        # local directory for generated website, default +site/public+
+        attr_accessor :local_site_dir
+       
+        # remote directory relative to +remote_root+ for the website.
+        # website.
+        attr_accessor :remote_site_dir
+
+        # is a .tgz to be created?, default 'true'
+        attr_accessor :need_tar
+
+        # is a .zip to be created, default 'true'
+        attr_accessor :need_zip
+
+
+        def initialize
+            @remote_user = nil
+            @remote_host = "rubyforge.org"
+
+            @rdoc_main              = "README"
+            @local_rdoc_dir         = "doc"
+            @remote_rdoc_dir        = "doc"
+            @local_coverage_dir     = "coverage"
+            @remote_coverage_dir    = "coverage"
+            @local_site_dir         = "site/public"
+            @remote_site_dir        = "."
+            
+            @need_tar   = true
+            @need_zip   = true
+
+            @spec                   = Gem::Specification.new
+
+            yield self if block_given?
+
+            # update rdoc options to take care of the rdoc_main if it is
+            # there, and add a default title if one is not given
+            if not @spec.rdoc_options.include?("--main") then
+                @spec.rdoc_options.concat(["--main", rdoc_main])
+            end
+
+            if not @spec.rdoc_options.include?("--title") then
+                @spec.rdoc_options.concat(["--title","'#{name} -- #{summary}'"])
+            end
+        end
+
+        # if this gets set then it overwrites what would be the
+        # rubyforge default.  If rubyforge project is not set then use
+        # name.  If rubyforge project and name are set, but they are
+        # different then assume that name is a subproject of the
+        # rubyforge project
+        def remote_root 
+            if rubyforge_project.nil? or 
+                rubyforge_project == name then
+                return RUBYFORGE_ROOT + "#{name}/"
+            else
+                return RUBYFORGE_ROOT + "#{rubyforge_project}/#{name}/"
+            end
+        end
+
+        # rdoc files is the same as what would be generated during gem
+        # installation. That is, everything in the require paths plus
+        # the extra_rdoc_files
+        #
+        def rdoc_files 
+            flist = extra_rdoc_files.dup
+            @spec.require_paths.each do |rp|
+                flist << FileList["#{rp}/**/*.rb"]
+            end
+            flist.flatten.uniq
+        end
+
+        # calculate the remote directories
+        def remote_root_location
+            "#{remote_user}@#{remote_host}:#{remote_root}"
+        end
+           
+        def remote_rdoc_location
+            remote_root_location + @remote_rdoc_dir
+        end
+
+        def remote_coverage_location
+            remote_root_loation + @remote_coverage_dir
+        end
+
+        def remote_site_location
+            remote_root_location + @remote_site_dir
+        end
+
+        # we delegate any other calls to spec
+        def method_missing(method_id,*params,&block)
+            @spec.send method_id, *params, &block
+        end
+    end
+end