pwl 0.0.1 → 0.0.2

data/Gemfile

@@ -1,22 +1,20 @@
 source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
 
-gem 'encryptor'
-gem 'commander'
-gem 'activesupport'
+gem 'encryptor', "~> 1.1"
+gem 'commander', "~> 4.1"
+gem 'activesupport', "~> 3.2"
+gem 'jbuilder', '~> 0.4'
 
 group :test do
-  gem "rake"
-  gem 'simplecov', :require => false
-  gem 'nokogiri-diff'
+  gem "rake", '~> 0.9'
+  gem 'simplecov', '~> 0.6', :require => false
+  gem 'nokogiri-diff', '~> 0.1'
 end
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "rdoc", "~> 3.12"
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.8.3"
+  gem "rdoc", "~> 3.1"
+  gem "bundler", "~> 1.1"
+  gem "jeweler", "~> 1.8"
 end

data/Gemfile.lock

@@ -1,22 +1,26 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    activesupport (3.2.2)
+    activesupport (3.2.3)
       i18n (~> 0.6)
       multi_json (~> 1.0)
+    blankslate (2.1.2.4)
     commander (4.1.2)
       highline (~> 1.6.11)
     encryptor (1.1.3)
     git (1.2.5)
     highline (1.6.11)
     i18n (0.6.0)
+    jbuilder (0.4.0)
+      activesupport (>= 3.0.0)
+      blankslate (>= 2.1.2.4)
     jeweler (1.8.3)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
       rdoc
-    json (1.6.5)
-    multi_json (1.1.0)
+    json (1.7.0)
+    multi_json (1.3.4)
     nokogiri (1.4.7)
     nokogiri-diff (0.1.0)
       nokogiri (~> 1.4.1)
@@ -24,8 +28,8 @@ GEM
     rake (0.9.2.2)
     rdoc (3.12)
       json (~> 1.4)
-    simplecov (0.6.1)
-      multi_json (~> 1.0)
+    simplecov (0.6.2)
+      multi_json (~> 1.3)
       simplecov-html (~> 0.5.3)
     simplecov-html (0.5.3)
     tdiff (0.3.2)
@@ -34,12 +38,13 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  activesupport
-  bundler (~> 1.0.0)
-  commander
-  encryptor
-  jeweler (~> 1.8.3)
-  nokogiri-diff
-  rake
-  rdoc (~> 3.12)
-  simplecov
+  activesupport (~> 3.2)
+  bundler (~> 1.1)
+  commander (~> 4.1)
+  encryptor (~> 1.1)
+  jbuilder (~> 0.4)
+  jeweler (~> 1.8)
+  nokogiri-diff (~> 0.1)
+  rake (~> 0.9)
+  rdoc (~> 3.1)
+  simplecov (~> 0.6)

data/README.md

@@ -19,7 +19,7 @@ Before it can store passwords, pwl needs to initialize the password database. Th
 
 Storing a password requires a name under which the password can be retrieved later on:
 
-      pwl put "Mail Account" s3cret
+      pwl add "Mail Account" s3cret
 
 This command will store the password "s3cret" under the name "Mail Account". Later on this password can be retrieved using the get command:
 

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/bin/pwl

@@ -7,44 +7,45 @@ $:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
 require 'pwl'
 
 program :version, Pwl::VERSION
-program :description, "#{program(:name)} is a secure password manager for the command line."
+program :description, "#{program(:name)} is a secure password locker for the command line."
 
 EXIT_CODES = {
   :success               => Pwl::Message.new('Success.'),
   :aborted               => Pwl::Message.new('Aborted by user.', 1),
   :passwords_dont_match  => Pwl::ErrorMessage.new('Passwords do not match.', 2),
   :no_value_found        => Pwl::Message.new('No value found for <%= name %>.', 3, :name => 'NAME'),
-  :file_exists           => Pwl::ErrorMessage.new('There already exists a store at <%= file %>. Use --force to overwrite it or --file to specify a different store.', 4, :file => 'FILE'),
-  :file_not_found        => Pwl::ErrorMessage.new('Store file <%= file %> could not be found.', 5, :file => 'FILE'),
+  :file_exists           => Pwl::ErrorMessage.new('There already exists a locker at <%= file %>. Use --force to overwrite it or --file to specify a different locker.', 4, :file => 'FILE'),
+  :file_not_found        => Pwl::ErrorMessage.new('Locker file <%= file %> could not be found.', 5, :file => 'FILE'),
   :name_blank            => Pwl::ErrorMessage.new('Name may not be blank.', 6),
   :value_blank           => Pwl::ErrorMessage.new('Value may not be blank.', 7),
   :list_empty            => Pwl::Message.new('List is empty.', 8),
   :list_empty_filter     => Pwl::Message.new('No names found that match filter <%= filter %>.', 9, :filter => 'FILTER'),
   :validation_new_failed => Pwl::ErrorMessage.new('<%= message %>.', 10, :message => 'Validation of new master password failed'),
+  :unknown_export_format => Pwl::ErrorMessage.new('<%= format %> is not a known export format.', 11, :format => 'FORMAT'),
 }
 
-program :help, 'Exit Status',  "#{program(:name)} sets the following exit status:\n\n" + EXIT_CODES.values.sort{|l,r| l.exit_code <=> r.exit_code}.collect{|m| "      #{m.exit_code.to_s}: #{m.to_s}"}.join("\n")
+program :help, 'Exit Status',  "#{program(:name)} sets the following exit status:\n\n" + EXIT_CODES.values.sort{|l,r| l.exit_code <=> r.exit_code}.collect{|m| "      #{m.exit_code.to_s.rjust(EXIT_CODES.size.to_s.size)}: #{m.to_s}"}.join("\n")
 program :help, 'Author', 'Nicholas E. Rabenau <nerab@gmx.at>'
 
-DEFAULT_STORE_FILE = File.expand_path("~/.#{program(:name)}.pstore")
+DEFAULT_LOCKER_FILE = File.expand_path("~/.#{program(:name)}.pstore")
 DEFAULT_EXPORT_TEMPLATE = File.join(File.dirname(__FILE__), *%w[.. templates export.html.erb])
 
-store_file = DEFAULT_STORE_FILE
+locker_file = DEFAULT_LOCKER_FILE
 
 global_option '-V', '--verbose', 'Enable verbose output'
-global_option('-f', '--file FILE', 'Determine the file that holds the store'){|file| store_file = file}
+global_option('-f', '--file FILE', 'Determine the file that holds the locker'){|file| locker_file = file}
 global_option '-g', '--gui', 'Request the master password using an OS-specific GUI dialog. This option takes precedence over STDIN.'
 
 command :init do |c|
   c.syntax = "#{program(:name)} #{c.name}"
-  c.summary = 'Initializes a new store'
-  c.description = 'This command initializes a new password store. Password quality is enforced using validation rules.'
-  c.example "Initializes a new password store in #{DEFAULT_STORE_FILE}", "#{program(:name)} #{c.name}"
-  c.example "Initializes a new password store in /tmp/crackme.txt", "#{program(:name)} #{c.name} --file /tmp/crackme.txt"
-  c.option '--force', 'Force-overwrite an existing store file'
+  c.summary = 'Initializes a new locker'
+  c.description = 'This command initializes a new password locker. Password quality is enforced using validation rules.'
+  c.example "Initializes a new password locker in #{DEFAULT_LOCKER_FILE}", "#{program(:name)} #{c.name}"
+  c.example "Initializes a new password locker in /tmp/crackme.txt", "#{program(:name)} #{c.name} --file /tmp/crackme.txt"
+  c.option '--force', 'Force-overwrite an existing locker file'
   c.action do |args, options|
-    # Store checks this too, but we want to fail fast.
-    exit_with(:file_exists, options.verbose, :file => store_file) if File.exists?(store_file) && !options.force
+    # Locker checks this too, but we want to fail fast.
+    exit_with(:file_exists, options.verbose, :file => locker_file) if File.exists?(locker_file) && !options.force
 
     begin
       begin
@@ -64,8 +65,8 @@ command :init do |c|
       exit_with(:aborted, options.verbose)
     end
 
-    Pwl::Store.new(store_file, master_password, {:force => options.force})
-    STDERR.puts "Successfully initialized new store at #{store_file}" if options.verbose
+    Pwl::Locker.new(locker_file, master_password, {:force => options.force})
+    STDERR.puts "Successfully initialized new locker at #{locker_file}" if options.verbose
   end
 end
 
@@ -75,12 +76,12 @@ command :get do |c|
   c.description = 'This command retrieves the value stored under NAME and prints it on STDOUT.'
   c.example 'Reads the value stored under the name "foo" and prints it to STDOUT', "#{program(:name)} #{c.name} foo"
   c.action do |args, options|
-    # Store checks this too, but we want to fail fast and provide a message.
-    exit_with(:file_not_found, options.verbose, :file => store_file) unless File.exists?(store_file)
+    # Locker checks this too, but we want to fail fast and provide a message.
+    exit_with(:file_not_found, options.verbose, :file => locker_file) unless File.exists?(locker_file)
     exit_with(:name_blank, options.verbose) if 0 == args.size || args[0].blank?
 
     begin
-      result = Pwl::Store.open(store_file, get_password('Enter master password:', options.gui)).get(args[0])
+      result = Pwl::Locker.open(locker_file, get_password("Enter the master password for #{program(:name)}:", options.gui)).get(args[0])
       if result.blank?
         exit_with(:no_value_found, options.verbose, :name => args[0])
       else
@@ -101,13 +102,13 @@ command :list do |c|
   c.example 'Prints all names separated by comma', "#{program(:name)} #{c.name} --separator ,"
   c.option '-s', '--separator SEPARATOR', String, 'Separate names by SEPARATOR'
   c.action do |args, options|
-    # Store checks this too, but we want to fail fast and provide a message.
-    exit_with(:file_not_found, options.verbose, :file => store_file) unless File.exists?(store_file)
+    # Locker checks this too, but we want to fail fast and provide a message.
+    exit_with(:file_not_found, options.verbose, :file => locker_file) unless File.exists?(locker_file)
 
     options.default :separator => ' '
 
     begin
-      result = Pwl::Store.open(store_file, get_password('Enter master password:', options.gui)).list(args[0]).join(options.separator)
+      result = Pwl::Locker.open(locker_file, get_password("Enter the master password for #{program(:name)}:", options.gui)).list(args[0]).join(options.separator)
       if !result.blank?
         puts result
       else
@@ -123,19 +124,19 @@ command :list do |c|
   end
 end
 
-command :put do |c|
+command :add do |c|
   c.syntax = "#{program(:name)} #{c.name} NAME [VALUE]"
   c.summary = 'Stores VALUE under NAME'
-  c.description = 'Adds or updates the entry stored under NAME. If NAME is already present in the store, it will be updated with VALUE. If NAME is not already present in the store, a new entry will be created. If VALUE is not given, it will be read from STDIN.'
+  c.description = 'Adds or updates the entry stored under NAME. If NAME is already present in the locker, it will be updated with VALUE. If NAME is not already present in the locker, a new entry will be created. If VALUE is not given, it will be read from STDIN.'
   c.example 'Stores the value "bar" under the name "foo"', "#{program(:name)} #{c.name} foo bar"
   c.example 'Reads STDIN and stores that as value under the name "foo"', "#{program(:name)} #{c.name} foo"
   c.action do |args, options|
-    exit_with(:file_not_found, options.verbose, :file => store_file) unless File.exists?(store_file)
+    exit_with(:file_not_found, options.verbose, :file => locker_file) unless File.exists?(locker_file)
     exit_with(:name_blank, options.verbose) if 0 == args.size || args[0].blank?
 
     # Ask for the master password _before_ it may be necessary to ask for the value in a terminal
     begin
-      store = Pwl::Store.open(store_file, get_password('Enter master password:', options.gui))
+      locker = Pwl::Locker.open(locker_file, get_password("Enter the master password for #{program(:name)}:", options.gui))
     rescue Pwl::Dialog::Cancelled
       exit_with(:aborted, options.verbose)
     end
@@ -157,7 +158,7 @@ command :put do |c|
       end
     end
 
-    store.put(args[0], value)
+    locker.add(args[0], value)
     STDERR.puts "Successfully stored new value under #{args[0]}." if options.verbose
   end
 end
@@ -165,19 +166,19 @@ end
 command :delete do |c|
   c.syntax = "#{program(:name)} #{c.name} NAME"
   c.summary = 'Deletes the entry stored under NAME'
-  c.description = 'Deletes the complete entry that is stored under NAME. If NAME is not present in the store, an error will thrown.'
+  c.description = 'Deletes the complete entry that is stored under NAME. If NAME is not present in the locker, an error will thrown.'
   c.example 'Deletes what was stored under the name "foo"', "#{program(:name)} #{c.name} foo"
   c.action do |args, options|
-    exit_with(:file_not_found, options.verbose, :file => store_file) unless File.exists?(store_file)
+    exit_with(:file_not_found, options.verbose, :file => locker_file) unless File.exists?(locker_file)
     exit_with(:name_blank, options.verbose) if 0 == args.size || args[0].blank?
 
     begin
-      store = Pwl::Store.open(store_file, get_password('Enter master password:', options.gui))
+      locker = Pwl::Locker.open(locker_file, get_password("Enter the master password for #{program(:name)}:", options.gui))
     rescue Pwl::Dialog::Cancelled
       exit_with(:aborted, options.verbose)
     end
 
-    store.delete(args[0])
+    locker.delete(args[0])
     STDERR.puts "Successfully deleted the value under #{args[0]}." if options.verbose
   end
 end
@@ -185,12 +186,12 @@ end
 command :passwd do |c|
   c.syntax = "#{program(:name)} #{c.name} [NEW_MASTER_PASSWORD]"
   c.summary = 'Changes the master password to NEW_MASTER_PASSWORD.'
-  c.description = 'This command changes the master password of the store. Password quality is enforced using validation rules.'
+  c.description = 'This command changes the master password of the locker. Password quality is enforced using validation rules.'
   c.action do |args, options|
-    exit_with(:file_not_found, options.verbose, :file => store_file) unless File.exists?(store_file)
+    exit_with(:file_not_found, options.verbose, :file => locker_file) unless File.exists?(locker_file)
 
     begin
-      store = Pwl::Store.open(store_file, get_password('Enter current master password:', options.gui))
+      locker = Pwl::Locker.open(locker_file, get_password("Enter the current master password for #{program(:name)}:", options.gui))
 
       if !STDIN.tty? && !options.gui
         # If we are in a pipe and do not run in GUI mode, we accept the new master password as args[0]
@@ -204,7 +205,7 @@ command :passwd do |c|
       else
         # If running interactively (console or gui), we loop until we get a valid password or break
         begin
-          new_master_password = get_password('Enter new master password:', options.gui)
+          new_master_password = get_password("Enter the new master password for #{program(:name)}:", options.gui)
         end while begin
           validate!(new_master_password)
         rescue Pwl::InvalidMasterPasswordError => e
@@ -213,7 +214,7 @@ command :passwd do |c|
         end
 
         # Confirm new password
-        if new_master_password != get_password('Enter new master password again:', options.gui)
+        if new_master_password != get_password("Enter the new master password for #{program(:name)} again:", options.gui)
           exit_with(:passwords_dont_match, options.verbose)
         end
       end
@@ -221,8 +222,8 @@ command :passwd do |c|
       exit_with(:aborted, options.verbose)
     end
 
-    store.change_password!(new_master_password)
-    STDERR.puts "Successfully changed master password." if options.verbose
+    locker.change_password!(new_master_password)
+    STDERR.puts "Successfully changed master password for #{program(:name)}." if options.verbose
   end
 end
 
@@ -231,13 +232,20 @@ command :export do |c|
   c.summary = 'Exports all entries.'
   c.description = 'This command prints all entries to STDOUT.'
   c.example 'Prints all entries', "#{program(:name)} #{c.name}"
+  c.option '--format FORMAT', String, 'Specify export format. Default is html.'
+  c.example 'Prints all entries in HTML format (default)', "#{program(:name)} #{c.name} --format html"
+  c.example 'Prints all entries in JSON format', "#{program(:name)} #{c.name} --format json"
+  c.example 'Prints all entries in YAML format', "#{program(:name)} #{c.name} --format yaml"
   c.action do |args, options|
-    exit_with(:file_not_found, options.verbose, :file => store_file) unless File.exists?(store_file)
+    exit_with(:file_not_found, options.verbose, :file => locker_file) unless File.exists?(locker_file)
+    options.default :format => 'html'
 
+    presenter = {:html => Pwl::Presenter::Html, :json => Pwl::Presenter::Json, :yaml => Pwl::Presenter::Yaml}[options.format.to_sym]
+    exit_with(:unknown_export_format, options.verbose, :format => options.format) if presenter.nil?
+    
     begin
-      template = ERB.new(File.read(DEFAULT_EXPORT_TEMPLATE))
-      store = Pwl::Store.open(store_file, get_password('Enter master password:', options.gui))
-      puts template.result(binding)
+      locker = Pwl::Locker.open(locker_file, get_password("Enter the master password for #{program(:name)}:", options.gui))
+      puts presenter.new(locker).to_s
     rescue Pwl::Dialog::Cancelled
       exit_with(:aborted, options.verbose)
     end
@@ -264,5 +272,5 @@ def get_text(prompt, gui = false)
 end
 
 def validate!(pwd)
-  Pwl::Store.password_policy.validate!(pwd)
+  Pwl::Locker.password_policy.validate!(pwd)
 end

data/lib/pwl.rb

@@ -1,13 +1,17 @@
 require 'pstore'
 require 'encryptor'
-require 'active_support/core_ext/object/blank'
+require 'date'
+require 'active_support'
 
 $:.unshift File.join(File.dirname(__FILE__), *%w[pwl])
 
 require 'message'
 require 'password_policy'
-require 'store'
+require 'locker'
 require 'dialog'
+require 'presenter/html'
+require 'presenter/json'
+require 'presenter/yaml'
 
 module Pwl
   VERSION = File.read(File.join(File.dirname(__FILE__), *%w[.. VERSION]))

data/lib/pwl/{store.rb → locker.rb}

@@ -1,7 +1,5 @@
-require 'date'
-
 module Pwl
-  class Store
+  class Locker
     class FileAlreadyExistsError < StandardError
       def initialize(file)
         super("The file #{file} already exists")
@@ -10,7 +8,7 @@ module Pwl
 
     class NotInitializedError < StandardError
       def initialize(file)
-        super("The store at #{file} was not initialized yet")
+        super("The locker at #{file} was not initialized yet")
       end
     end
 
@@ -22,7 +20,7 @@ module Pwl
 
     class FileNotFoundError < StandardError
       def initialize(file)
-        super("The file #{file} for the store was not found")
+        super("The file #{file} for the locker was not found")
       end
     end
 
@@ -56,28 +54,28 @@ module Pwl
       DEFAULT_PASSWORD_POLICY = ReasonableComplexityPasswordPolicy.new
 
       #
-      # Constructs a new store (not only the object, but also the file behind it).
+      # Constructs a new locker (not only the object, but also the file behind it).
       #
       def new(file, master_password, options = {})
         if File.exists?(file) && !options[:force] # don't allow accedidential override of existing file
           raise FileAlreadyExistsError.new(file)
         else
           password_policy.validate!(master_password)
-          store = load(file, master_password)
-          store.reset!
+          locker = load(file, master_password)
+          locker.reset!
         end
 
-        store
+        locker
       end
 
       #
-      # Opens an existing store. Throws if the backing file does not exist or isn't initialized.
+      # Opens an existing locker. Throws if the backing file does not exist or isn't initialized.
       #
       def open(file, master_password)
         raise FileNotFoundError.new(file) unless File.exists?(file)
-        store = load(file, master_password)
-        store.authenticate # do not allow openeing without successful authentication
-        store
+        locker = load(file, master_password)
+        locker.authenticate # do not allow openeing without successful authentication
+        locker
       end
 
       def password_policy
@@ -90,9 +88,9 @@ module Pwl
     end
 
     #
-    # Create a new store object by loading an existing file.
+    # Create a new locker object by loading an existing file.
     #
-    # Beware: New is overridden; it performs additional actions after before and after #initialize
+    # Beware: New is overridden; it performs additional actions before and after #initialize
     #
     def initialize(file, master_password)
       @backend = PStore.new(file, true)
@@ -113,7 +111,7 @@ module Pwl
     end
 
     #
-    # Check that the master password is correct. This is done to prevent opening an existing but blank store with the wrong password.
+    # Check that the master password is correct. This is done to prevent opening an existing but blank locker with the wrong password.
     #
     def authenticate
       begin
@@ -142,7 +140,7 @@ module Pwl
     #
     # Store value stored under key
     #
-    def put(key, value)
+    def add(key, value)
       raise BlankKeyError if key.blank?
       raise BlankValueError if value.blank?
       @backend.transaction{
@@ -218,28 +216,28 @@ module Pwl
     end
 
     #
-    # Return the date when the store was created
+    # Return the date when the locker was created
     #
     def created
       @backend.transaction(true){@backend[:system][:created]}
     end
 
     #
-    # Return the date when the store was last accessed
+    # Return the date when the locker was last accessed
     #
     def last_accessed
       @backend.transaction(true){@backend[:system][:last_accessed]}
     end
 
     #
-    # Return the date when the store was last modified
+    # Return the date when the locker was last modified
     #
     def last_modified
       @backend.transaction(true){@backend[:system][:last_modified]}
     end
 
     #
-    # Return the path to the file backing this store
+    # Return the path to the file backing this locker
     #
     def path
       @backend.path