configliere 0.3.4 → 0.4.4

data/bin/configliere-encrypt

@@ -0,0 +1,85 @@
+#!/usr/bin/env ruby
+$: << File.dirname(__FILE__)+'/../lib'
+require 'configliere'
+
+Settings.use :commands
+
+Settings.description =  %Q{Client for the configliere gem: manipulate configuration and passwords for automated scripts}
+
+Settings.define_command :dump,    :description => "Show the whole contents of the file"
+Settings.define_command :list,    :description => "Show all params in the configliere file."
+Settings.define_command :get,     :description => "show values given as commandline args, eg: #{File.basename($0)} get this that"
+Settings.define_command :set,     :description => "sets values given as commandline args, eg: #{File.basename($0)} set this=1 that=3"
+Settings.define_command :delete,  :description => "sets values given as commandline args, eg: #{File.basename($0)} delete this that"
+Settings.define_command :encrypt, :description => "encrypt the param"
+Settings.define_command :decrypt, :description => "Store the param as decrypted back into the file. Can be undone with 'encrypt'."
+
+Settings.define :from,   :flag => 'f', :type => :filename, :description => "Configliere config file to load"
+Settings.define :into,   :flag => 'i', :type => :filename, :description => "Configliere config file to save into"
+
+Settings.resolve!
+ARGV.replace []
+
+Store = Configliere.new
+Store.read(Settings.from) if Settings.from
+
+#
+# Execute
+#
+
+case Settings.command_name
+when :dump
+  puts Store.to_hash.to_yaml
+
+when :list
+  $stderr.puts "Param names in #{Settings.from}:"
+  Store.each do |attr, val|
+    puts "  #{attr}"
+  end
+
+when :get
+  $stderr.puts "Values for #{Settings.rest.join(", ")} from #{Settings.from}"
+  Settings.rest.map(&:to_sym).each do |attr|
+    puts "%-23s\t%s" % ["#{attr}:", Store[attr]]
+  end
+
+when :set
+  $stderr.puts "Setting #{Settings.rest.join(", ")} for #{Settings.from}"
+  Settings.rest.each do |attr_val|
+    attr, val = attr_val.split('=', 2)
+    attr = attr.to_sym
+    if val.nil? then warn "Please specify a value for #{attr}" ; next ; end
+    Store[attr] = val
+
+    puts "%-23s\t%s" % ["#{attr}:", val.inspect]
+  end
+
+when :delete
+  $stderr.puts "Deleting #{Settings.rest.join(", ")} from #{Settings.from}. O, I die, Horatio."
+  Settings.rest.map(&:to_sym).each do |attr|
+    Store.delete(attr)
+  end
+
+when :encrypt
+  Store.use :encrypted
+  $stderr.puts "Encrypting #{Settings.rest.join(", ")} from #{Settings.from}. Fnord"
+  Settings.rest.each{|attr| Store.define attr, :encrypted => true }
+  Store.encrypt_pass = Settings.encrypt_pass || Settings[:encrypt_pass]
+  Store.resolve!
+
+when :decrypt
+  Store.use :encrypted
+  $stderr.puts "Decrypting #{Settings.rest.join(", ")} from #{Settings.from}. Fnord"
+  Settings.rest.each{|attr| Store.define attr, :encrypted => true }
+  Store.encrypt_pass = Settings.encrypt_pass || Settings[:encrypt_pass]
+  Store.resolve!
+
+  puts Store.to_hash.to_yaml
+
+else
+  Settings.die "Please use one of the given commands"
+end
+
+if Settings.into
+  Store.save!(Settings.into)
+end

data/bin/configliere-list

@@ -0,0 +1,85 @@
+#!/usr/bin/env ruby
+$: << File.dirname(__FILE__)+'/../lib'
+require 'configliere'
+
+Settings.use :commands
+
+Settings.description =  %Q{Client for the configliere gem: manipulate configuration and passwords for automated scripts}
+
+Settings.define_command :dump,    :description => "Show the whole contents of the file"
+Settings.define_command :list,    :description => "Show all params in the configliere file."
+Settings.define_command :get,     :description => "show values given as commandline args, eg: #{File.basename($0)} get this that"
+Settings.define_command :set,     :description => "sets values given as commandline args, eg: #{File.basename($0)} set this=1 that=3"
+Settings.define_command :delete,  :description => "sets values given as commandline args, eg: #{File.basename($0)} delete this that"
+Settings.define_command :encrypt, :description => "encrypt the param"
+Settings.define_command :decrypt, :description => "Store the param as decrypted back into the file. Can be undone with 'encrypt'."
+
+Settings.define :from,   :flag => 'f', :type => :filename, :description => "Configliere config file to load"
+Settings.define :into,   :flag => 'i', :type => :filename, :description => "Configliere config file to save into"
+
+Settings.resolve!
+ARGV.replace []
+
+Store = Configliere.new
+Store.read(Settings.from) if Settings.from
+
+#
+# Execute
+#
+
+case Settings.command_name
+when :dump
+  puts Store.to_hash.to_yaml
+
+when :list
+  $stderr.puts "Param names in #{Settings.from}:"
+  Store.each do |attr, val|
+    puts "  #{attr}"
+  end
+
+when :get
+  $stderr.puts "Values for #{Settings.rest.join(", ")} from #{Settings.from}"
+  Settings.rest.map(&:to_sym).each do |attr|
+    puts "%-23s\t%s" % ["#{attr}:", Store[attr]]
+  end
+
+when :set
+  $stderr.puts "Setting #{Settings.rest.join(", ")} for #{Settings.from}"
+  Settings.rest.each do |attr_val|
+    attr, val = attr_val.split('=', 2)
+    attr = attr.to_sym
+    if val.nil? then warn "Please specify a value for #{attr}" ; next ; end
+    Store[attr] = val
+
+    puts "%-23s\t%s" % ["#{attr}:", val.inspect]
+  end
+
+when :delete
+  $stderr.puts "Deleting #{Settings.rest.join(", ")} from #{Settings.from}. O, I die, Horatio."
+  Settings.rest.map(&:to_sym).each do |attr|
+    Store.delete(attr)
+  end
+
+when :encrypt
+  Store.use :encrypted
+  $stderr.puts "Encrypting #{Settings.rest.join(", ")} from #{Settings.from}. Fnord"
+  Settings.rest.each{|attr| Store.define attr, :encrypted => true }
+  Store.encrypt_pass = Settings.encrypt_pass || Settings[:encrypt_pass]
+  Store.resolve!
+
+when :decrypt
+  Store.use :encrypted
+  $stderr.puts "Decrypting #{Settings.rest.join(", ")} from #{Settings.from}. Fnord"
+  Settings.rest.each{|attr| Store.define attr, :encrypted => true }
+  Store.encrypt_pass = Settings.encrypt_pass || Settings[:encrypt_pass]
+  Store.resolve!
+
+  puts Store.to_hash.to_yaml
+
+else
+  Settings.die "Please use one of the given commands"
+end
+
+if Settings.into
+  Store.save!(Settings.into)
+end

data/bin/configliere-set

@@ -0,0 +1,85 @@
+#!/usr/bin/env ruby
+$: << File.dirname(__FILE__)+'/../lib'
+require 'configliere'
+
+Settings.use :commands
+
+Settings.description =  %Q{Client for the configliere gem: manipulate configuration and passwords for automated scripts}
+
+Settings.define_command :dump,    :description => "Show the whole contents of the file"
+Settings.define_command :list,    :description => "Show all params in the configliere file."
+Settings.define_command :get,     :description => "show values given as commandline args, eg: #{File.basename($0)} get this that"
+Settings.define_command :set,     :description => "sets values given as commandline args, eg: #{File.basename($0)} set this=1 that=3"
+Settings.define_command :delete,  :description => "sets values given as commandline args, eg: #{File.basename($0)} delete this that"
+Settings.define_command :encrypt, :description => "encrypt the param"
+Settings.define_command :decrypt, :description => "Store the param as decrypted back into the file. Can be undone with 'encrypt'."
+
+Settings.define :from,   :flag => 'f', :type => :filename, :description => "Configliere config file to load"
+Settings.define :into,   :flag => 'i', :type => :filename, :description => "Configliere config file to save into"
+
+Settings.resolve!
+ARGV.replace []
+
+Store = Configliere.new
+Store.read(Settings.from) if Settings.from
+
+#
+# Execute
+#
+
+case Settings.command_name
+when :dump
+  puts Store.to_hash.to_yaml
+
+when :list
+  $stderr.puts "Param names in #{Settings.from}:"
+  Store.each do |attr, val|
+    puts "  #{attr}"
+  end
+
+when :get
+  $stderr.puts "Values for #{Settings.rest.join(", ")} from #{Settings.from}"
+  Settings.rest.map(&:to_sym).each do |attr|
+    puts "%-23s\t%s" % ["#{attr}:", Store[attr]]
+  end
+
+when :set
+  $stderr.puts "Setting #{Settings.rest.join(", ")} for #{Settings.from}"
+  Settings.rest.each do |attr_val|
+    attr, val = attr_val.split('=', 2)
+    attr = attr.to_sym
+    if val.nil? then warn "Please specify a value for #{attr}" ; next ; end
+    Store[attr] = val
+
+    puts "%-23s\t%s" % ["#{attr}:", val.inspect]
+  end
+
+when :delete
+  $stderr.puts "Deleting #{Settings.rest.join(", ")} from #{Settings.from}. O, I die, Horatio."
+  Settings.rest.map(&:to_sym).each do |attr|
+    Store.delete(attr)
+  end
+
+when :encrypt
+  Store.use :encrypted
+  $stderr.puts "Encrypting #{Settings.rest.join(", ")} from #{Settings.from}. Fnord"
+  Settings.rest.each{|attr| Store.define attr, :encrypted => true }
+  Store.encrypt_pass = Settings.encrypt_pass || Settings[:encrypt_pass]
+  Store.resolve!
+
+when :decrypt
+  Store.use :encrypted
+  $stderr.puts "Decrypting #{Settings.rest.join(", ")} from #{Settings.from}. Fnord"
+  Settings.rest.each{|attr| Store.define attr, :encrypted => true }
+  Store.encrypt_pass = Settings.encrypt_pass || Settings[:encrypt_pass]
+  Store.resolve!
+
+  puts Store.to_hash.to_yaml
+
+else
+  Settings.die "Please use one of the given commands"
+end
+
+if Settings.into
+  Store.save!(Settings.into)
+end

data/configliere.gemspec

@@ -5,36 +5,47 @@
 
 Gem::Specification.new do |s|
   s.name = %q{configliere}
-  s.version = "0.3.4"
+  s.version = "0.4.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["mrflip"]
-  s.date = %q{2011-04-03}
-  s.default_executable = %q{configliere}
+  s.authors = ["infochimps", "mrflip"]
+  s.date = %q{2011-05-16}
   s.description = %q{ You've got a script. It's got some settings. Some settings are for this module, some are for that module. Most of them don't change. Except on your laptop, where the paths are different.  Or when you're in production mode. Or when you're testing from the command line.
 
    "" So, Consigliere of mine, I think you should tell your Don what everyone knows. "" -- Don Corleone
 
 Configliere manage settings from many sources: static constants, simple config files, environment variables, commandline options, straight ruby. You don't have to predefine anything, but you can ask configliere to type-convert, require, document or password-obscure any of its fields. Modules can define config settings independently of each other and the main program.
 }
-  s.email = %q{flip@infochimps.org}
-  s.executables = ["configliere"]
+  s.email = %q{coders@infochimps.org}
+  s.executables = ["configliere", "configliere-decrypt", "configliere-delete", "configliere-dump", "configliere-encrypt", "configliere-list", "configliere-set"]
   s.extra_rdoc_files = [
     "LICENSE",
     "README.textile"
   ]
   s.files = [
     ".document",
+    ".watchr",
     "CHANGELOG.textile",
+    "Gemfile",
+    "Gemfile.lock",
     "LICENSE",
     "README.textile",
     "Rakefile",
     "VERSION",
     "bin/configliere",
+    "bin/configliere-decrypt",
+    "bin/configliere-delete",
+    "bin/configliere-dump",
+    "bin/configliere-encrypt",
+    "bin/configliere-list",
+    "bin/configliere-set",
     "configliere.gemspec",
     "examples/config_block_script.rb",
     "examples/encrypted_script.rb",
     "examples/env_var_script.rb",
+    "examples/help_message_demo.rb",
+    "examples/independent_config.rb",
+    "examples/prompt.rb",
     "examples/simple_script.rb",
     "examples/simple_script.yaml",
     "lib/configliere.rb",
@@ -42,68 +53,87 @@ Configliere manage settings from many sources: static constants, simple config f
     "lib/configliere/commands.rb",
     "lib/configliere/config_block.rb",
     "lib/configliere/config_file.rb",
-    "lib/configliere/core_ext.rb",
-    "lib/configliere/core_ext/blank.rb",
-    "lib/configliere/core_ext/hash.rb",
-    "lib/configliere/core_ext/sash.rb",
     "lib/configliere/crypter.rb",
+    "lib/configliere/deep_hash.rb",
     "lib/configliere/define.rb",
     "lib/configliere/encrypted.rb",
     "lib/configliere/env_var.rb",
     "lib/configliere/param.rb",
+    "lib/configliere/prompt.rb",
     "spec/configliere/commandline_spec.rb",
     "spec/configliere/commands_spec.rb",
     "spec/configliere/config_block_spec.rb",
     "spec/configliere/config_file_spec.rb",
-    "spec/configliere/core_ext/hash_spec.rb",
-    "spec/configliere/core_ext/sash_spec.rb",
     "spec/configliere/crypter_spec.rb",
+    "spec/configliere/deep_hash_spec.rb",
     "spec/configliere/define_spec.rb",
     "spec/configliere/encrypted_spec.rb",
     "spec/configliere/env_var_spec.rb",
     "spec/configliere/param_spec.rb",
+    "spec/configliere/prompt_spec.rb",
     "spec/configliere_spec.rb",
     "spec/spec.opts",
     "spec/spec_helper.rb"
   ]
-  s.homepage = %q{http://github.com/mrflip/configliere}
+  s.homepage = %q{http://infochimps.com/labs}
+  s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
+  s.rubygems_version = %q{1.5.0}
   s.summary = %q{Wise, discreet configuration management}
   s.test_files = [
     "examples/config_block_script.rb",
     "examples/encrypted_script.rb",
     "examples/env_var_script.rb",
+    "examples/help_message_demo.rb",
+    "examples/independent_config.rb",
+    "examples/prompt.rb",
     "examples/simple_script.rb",
     "spec/configliere/commandline_spec.rb",
     "spec/configliere/commands_spec.rb",
     "spec/configliere/config_block_spec.rb",
     "spec/configliere/config_file_spec.rb",
-    "spec/configliere/core_ext/hash_spec.rb",
-    "spec/configliere/core_ext/sash_spec.rb",
     "spec/configliere/crypter_spec.rb",
+    "spec/configliere/deep_hash_spec.rb",
     "spec/configliere/define_spec.rb",
     "spec/configliere/encrypted_spec.rb",
     "spec/configliere/env_var_spec.rb",
     "spec/configliere/param_spec.rb",
+    "spec/configliere/prompt_spec.rb",
     "spec/configliere_spec.rb",
     "spec/spec_helper.rb"
   ]
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
-      s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.12"])
+      s.add_development_dependency(%q<yard>, ["~> 0.6.7"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.5.0"])
+      s.add_development_dependency(%q<spork>, ["~> 0.9.0.rc5"])
+      s.add_development_dependency(%q<RedCloth>, [">= 0"])
+      s.add_development_dependency(%q<gorillib>, [">= 0.0.4"])
+      s.add_development_dependency(%q<highline>, [">= 1.5.2"])
     else
-      s.add_dependency(%q<rspec>, [">= 1.2.9"])
-      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.12"])
+      s.add_dependency(%q<yard>, ["~> 0.6.7"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rspec>, ["~> 2.5.0"])
+      s.add_dependency(%q<spork>, ["~> 0.9.0.rc5"])
+      s.add_dependency(%q<RedCloth>, [">= 0"])
+      s.add_dependency(%q<gorillib>, [">= 0.0.4"])
+      s.add_dependency(%q<highline>, [">= 1.5.2"])
     end
   else
-    s.add_dependency(%q<rspec>, [">= 1.2.9"])
-    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.12"])
+    s.add_dependency(%q<yard>, ["~> 0.6.7"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rspec>, ["~> 2.5.0"])
+    s.add_dependency(%q<spork>, ["~> 0.9.0.rc5"])
+    s.add_dependency(%q<RedCloth>, [">= 0"])
+    s.add_dependency(%q<gorillib>, [">= 0.0.4"])
+    s.add_dependency(%q<highline>, [">= 1.5.2"])
   end
 end
 

data/examples/config_block_script.rb

@@ -8,9 +8,16 @@ Settings.define :dest_time, :type => DateTime
 Settings :passenger => 'einstein', :dest_time => '1955-11-05'
 
 Settings.finally do |c|
-  p [self, 'finally', c[:passenger], c.passenger]
+  p ['(2) takes the settings object as arg', self, c[:passenger], c.passenger]
   # Einstein the dog should only be sent one minute into the future.
   c.dest_time = (Time.now + 60) if c.passenger == 'einstein'
 end
+
+Settings.finally{ p ['(3) note that blocks go in order'] }
+
+Settings.define :mc_fly, :default => 'wuss',
+  :finally => lambda{ p ['(4) here is a block in the define'] ; Settings.mc_fly = 'badass' }
+
+p ["(1) :finally blocks are called when you invoke resolve!"]
 Settings.resolve!
-p Settings
+p ['(5) here are the settings', Settings]

data/examples/encrypted_script.rb

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-require 'rubygems'
+$: << File.dirname(__FILE__)+'/../lib'
 require 'configliere'
 DUMP_FILENAME = '/tmp/encrypted_script.yml'
 
@@ -9,6 +9,10 @@ DUMP_FILENAME = '/tmp/encrypted_script.yml'
 #   ./examples/encrypted_script.rb
 #
 
+def dump_settings
+  puts "  #{Settings.inspect} -- #{Settings.encrypt_pass}"
+end
+
 puts %Q{Many times, scripts need to save values you\'d rather not leave as
 plaintext: API keys, database passwords, etc. Instead of leaving them in plain
 sight, you may wish to obscure their value on disk and use a secondary password
@@ -17,24 +21,29 @@ to unlock it.
 View source for this script to see commands you might use (from the irb console
 or in a standalone script) to store the obscured values for later decryption.}
 
-Settings.use :config_file, :define, :encrypted, :encrypt_pass => 'password1'
-Settings.define :password, :encrypted => true, :default => 'plaintext'
+Settings.use :config_file
+Settings.encrypt_pass = 'password1'
+Settings.define :secret, :encrypted => true, :default => 'plaintext'
 Settings.resolve!
 
-puts "\nIn-memory version still has password in plaintext..."
-puts "  #{Settings.inspect}"
-puts "But the saved version will have encrypted password (see #{DUMP_FILENAME}):"
+puts "\nIn-memory version still has secret in plaintext..."
+dump_settings
+puts "But the saved version will have encrypted secret (see #{DUMP_FILENAME}):"
 puts "  #{Settings.send(:export).inspect}"
 Settings.save!(DUMP_FILENAME)
 
+puts "Let's reset the Settings:"
+Settings.delete :secret
+dump_settings
 puts "If we now load the saved file, the parameter's value is decrypted on resolve:"
-Settings[:password] = 'nothing up my sleeve'
 Settings.read('/tmp/encrypted_script.yml')
-Settings.resolve!
-puts "  #{Settings.inspect}"
-
-# unset encrypt_pass
-Settings.encrypt_pass = nil
+begin
+  Settings.resolve!
+rescue StandardError => e
+  warn "  #{e.class}: #{e}"
+  warn "\nTry rerunning with \n  ENCRYPT_PASS=password1 #{$0} #{$ARGV}"
+end
+dump_settings
 
 puts %Q{\nOf course, in your script you\'ll have to supply the decryption
 password.  The best thing is to use an environment variable -- a user can spy on
@@ -42,11 +51,14 @@ your commandline parameters using "ps" or "top".  The following will fail unless
 you supply the correct password ("password1") in the ENCRYPT_PASS environment
 variable:\n\n}
 
-Settings.define :encrypt_pass, :env_var => 'ENCRYPT_PASS'
+Settings.encrypt_pass = ENV['ENCRYPT_PASS'] # this will happen normally, but we overrode it above
+
 Settings.read('/tmp/encrypted_script.yml')
 begin
   Settings.resolve!
-  puts "  #{Settings.inspect}"
-rescue RuntimeError => e
-  warn "  #{e}"
+  puts "You guessed the password!"
+  dump_settings
+rescue StandardError => e
+  warn "  #{e.class}: #{e}"
+  warn "\nTry rerunning with \n  ENCRYPT_PASS=password1 #{$0} #{$ARGV}"
 end