pwl 0.0.1 → 0.0.2

data/lib/pwl/presenter/html.rb

@@ -0,0 +1,19 @@
+require 'erb'
+
+module Pwl
+  module Presenter
+    class Html
+      attr_reader :locker # used by the ERB template
+      DEFAULT_EXPORT_TEMPLATE = File.join(File.dirname(__FILE__), *%w[.. .. .. templates export.html.erb])
+
+      def initialize(locker)
+          @locker = locker
+          @template = ERB.new(File.read(DEFAULT_EXPORT_TEMPLATE))
+      end
+
+      def to_s
+        @template.result(binding)
+      end
+    end
+  end
+end

data/lib/pwl/presenter/json.rb

@@ -0,0 +1,22 @@
+require 'jbuilder'
+
+module Pwl
+  module Presenter
+    class Json
+      def initialize(locker)
+          @locker = locker
+      end
+
+      def to_s
+        Jbuilder.encode do |json|
+          json.(@locker, :created, :last_accessed, :last_modified)
+
+          json.entries @locker.all do |json, entry|
+            json.key entry.first
+            json.value entry.last
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pwl/presenter/yaml.rb

@@ -0,0 +1,23 @@
+require 'yaml'
+
+module Pwl
+  module Presenter
+    class Yaml
+      def initialize(locker)
+          @locker = locker
+      end
+
+      def to_s
+        result = {}
+        result[:created] = @locker.created.to_s
+        result[:last_accessed] = @locker.last_accessed.to_s
+        result[:last_modified] = @locker.last_modified.to_s
+        result[:entries] = []
+        @locker.all.each{|entry|
+          result[:entries] << {:key => entry.first, :value => entry.last}
+        }
+        result.to_yaml
+      end
+    end
+  end
+end

data/pwl.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "pwl"
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nicholas E. Rabenau"]
-  s.date = "2012-03-22"
+  s.date = "2012-05-02"
   s.description = "pwl is a secure password locker for the commandline"
   s.email = "nerab@gmx.net"
   s.executables = ["pwl", "pwl"]
@@ -33,22 +33,31 @@ Gem::Specification.new do |s|
     "lib/pwl/dialog/cocoa.rb",
     "lib/pwl/dialog/console.rb",
     "lib/pwl/dialog/gnome.rb",
+    "lib/pwl/locker.rb",
     "lib/pwl/message.rb",
     "lib/pwl/password_policy.rb",
-    "lib/pwl/store.rb",
+    "lib/pwl/presenter/html.rb",
+    "lib/pwl/presenter/json.rb",
+    "lib/pwl/presenter/yaml.rb",
     "pwl.gemspec",
     "templates/export.html.erb",
+    "test/acceptance/test_add.rb",
     "test/acceptance/test_basics.rb",
     "test/acceptance/test_delete.rb",
     "test/acceptance/test_dialogs.rb",
     "test/acceptance/test_export.rb",
+    "test/acceptance/test_export_json.rb",
+    "test/acceptance/test_export_yaml.rb",
     "test/acceptance/test_get.rb",
     "test/acceptance/test_init.rb",
     "test/acceptance/test_list.rb",
     "test/acceptance/test_passwd.rb",
-    "test/acceptance/test_put.rb",
     "test/fixtures/test_all.html",
+    "test/fixtures/test_all.json",
+    "test/fixtures/test_all.yaml",
     "test/fixtures/test_empty.html",
+    "test/fixtures/test_empty.json",
+    "test/fixtures/test_empty.yaml",
     "test/helper.rb",
     "test/unit/test_error.rb",
     "test/unit/test_message.rb",
@@ -61,34 +70,37 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/nerab/pwl"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.15"
+  s.rubygems_version = "1.8.24"
   s.summary = "Command-line password locker"
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<encryptor>, [">= 0"])
-      s.add_runtime_dependency(%q<commander>, [">= 0"])
-      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
-      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_runtime_dependency(%q<encryptor>, ["~> 1.1"])
+      s.add_runtime_dependency(%q<commander>, ["~> 4.1"])
+      s.add_runtime_dependency(%q<activesupport>, ["~> 3.2"])
+      s.add_runtime_dependency(%q<jbuilder>, ["~> 0.4"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.1"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.1"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8"])
     else
-      s.add_dependency(%q<encryptor>, [">= 0"])
-      s.add_dependency(%q<commander>, [">= 0"])
-      s.add_dependency(%q<activesupport>, [">= 0"])
-      s.add_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_dependency(%q<encryptor>, ["~> 1.1"])
+      s.add_dependency(%q<commander>, ["~> 4.1"])
+      s.add_dependency(%q<activesupport>, ["~> 3.2"])
+      s.add_dependency(%q<jbuilder>, ["~> 0.4"])
+      s.add_dependency(%q<rdoc>, ["~> 3.1"])
+      s.add_dependency(%q<bundler>, ["~> 1.1"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8"])
     end
   else
-    s.add_dependency(%q<encryptor>, [">= 0"])
-    s.add_dependency(%q<commander>, [">= 0"])
-    s.add_dependency(%q<activesupport>, [">= 0"])
-    s.add_dependency(%q<rdoc>, ["~> 3.12"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    s.add_dependency(%q<encryptor>, ["~> 1.1"])
+    s.add_dependency(%q<commander>, ["~> 4.1"])
+    s.add_dependency(%q<activesupport>, ["~> 3.2"])
+    s.add_dependency(%q<jbuilder>, ["~> 0.4"])
+    s.add_dependency(%q<rdoc>, ["~> 3.1"])
+    s.add_dependency(%q<bundler>, ["~> 1.1"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8"])
   end
 end
 

data/templates/export.html.erb

@@ -44,12 +44,12 @@
         <td colspan="2">
           This <a href="http://rdoc.info/github/nerab/pwl/master/frames">pwl</a> export was created on <%= DateTime.now.strftime('%F %R') %>.
         <br/>
-          The database at <%= store.path %> was <%= "last modified #{store.last_modified.strftime('%F %R')}" rescue 'never modified' %>.
+          The database at <%= locker.path %> was <%= "last modified #{locker.last_modified.strftime('%F %R')}" rescue 'never modified' %>.
         </td>
       </tr>
     </tfoot>
     <tbody>
-      <% store.all.each{|key, value|%>
+      <% locker.all.each{|key, value|%>
       <tr>
         <td><%= key %></td>
         <td><%= value %></td>

data/test/acceptance/test_add.rb

@@ -0,0 +1,19 @@
+require 'helper'
+
+# Tests `pwl add`
+class TestAdd < Test::Pwl::AppTestCase
+  def test_add_blank_key
+    assert_error('may not be blank', 'add')
+  end
+
+  def test_add_simple
+    assert_successful('', 'add foo bar')
+    assert_successful('^bar$', 'get foo')
+  end
+
+  def test_add_update
+    assert_successful('', 'add foo bar')
+    assert_successful('', 'add foo baz') # just do it twice
+    assert_successful('^baz$', 'get foo')
+  end
+end

data/test/acceptance/test_delete.rb

@@ -7,7 +7,7 @@ class TestDelete < Test::Pwl::AppTestCase
   end
 
   def test_delete_simple
-    assert_successful('', 'put foo bar')
+    assert_successful('', 'add foo bar')
     assert_successful('', 'delete foo')
     assert_error('No entry was found for foo', 'get foo')
   end

data/test/acceptance/test_export.rb

@@ -4,23 +4,23 @@ require 'nokogiri/diff'
 # Tests `pwl export`
 class TestExport < Test::Pwl::AppTestCase
   def test_empty
-    fixture = fixture("test_empty.html").gsub('CREATED_STAMP', DateTime.now.strftime('%F %R')).gsub('MODIFIED_STAMP', 'never').gsub('DATABASE_FILE', store_file)
+    fixture = fixture("test_empty.html").gsub('CREATED_STAMP', DateTime.now.strftime('%F %R')).gsub('MODIFIED_STAMP', 'never').gsub('DATABASE_FILE', locker_file)
     assert_successful_html(fixture, 'export')
   end
 
   def test_all
     test_vector = Hash['foo', 'one', 'bar', 'two', 'Chuck Norris', 'Roundhouse Kick']
     test_vector.each{|k,v|
-      assert_successful('', "put '#{k}' '#{v}'")
+      assert_successful('', "add '#{k}' '#{v}'")
     }
     
     now = DateTime.now.strftime('%F %R')
-    fixture = fixture("test_all.html").gsub('CREATED_STAMP', now).gsub('MODIFIED_STAMP', now).gsub('DATABASE_FILE', store_file)
+    fixture = fixture("test_all.html").gsub('CREATED_STAMP', now).gsub('MODIFIED_STAMP', now).gsub('DATABASE_FILE', locker_file)
     
     assert_successful_html(fixture, 'export')
   end
 
-  def assert_successful_html(expected_out, cmd, password = store_password)
+  def assert_successful_html(expected_out, cmd, password = locker_password)
     out, err, rc = execute(cmd, password)
     assert_equal(0, rc.exitstatus, "Expected exit status 0, but it was #{rc.exitstatus}. STDERR was: #{err}")
     assert(err.empty?, "Expected empty STDERR, but it yielded #{err}")

data/test/acceptance/test_export_json.rb

@@ -0,0 +1,59 @@
+require 'helper'
+require 'json'
+
+# Tests `pwl export --format json`
+class TestExportJSON < Test::Pwl::AppTestCase
+  def test_empty
+    fixture = fixture("test_empty.json")
+    assert_successful_json(fixture, 'export --format json')
+  end
+
+  def test_all
+    test_vector = Hash['foo', 'one', 'bar', 'two', 'Chuck Norris', 'Roundhouse Kick']
+    test_vector.each{|k,v|
+      assert_successful('', "add '#{k}' '#{v}'")
+    }
+    
+    now = DateTime.now.strftime('%F %R')
+    fixture = fixture("test_all.json")
+    
+    assert_successful_json(fixture, 'export --format json')
+  end
+
+  def assert_successful_json(expected_out, cmd, password = locker_password)
+    out, err, rc = execute(cmd, password)
+    assert_equal(0, rc.exitstatus, "Expected exit status 0, but it was #{rc.exitstatus}. STDERR was: #{err}")
+    assert(err.empty?, "Expected empty STDERR, but it yielded #{err}")
+
+    actual   = JSON.parse(out)
+    expected = JSON.parse(expected_out)
+    
+    # fix up actuals to match expectations
+    actual["created"] = "2012-03-28T21:54:21+02:00"
+    actual["last_accessed"] = "2012-03-28T22:01:49+02:00"
+    actual["last_modified"] = "2012-03-29T22:46:29+02:00"
+
+    # This is essentially the same as
+    #   assert_equal(expected, actual)
+    # but it provides better diagnostic output on error
+    json_diff(expected, actual)
+  end
+  
+  private
+  def json_diff(expected, actual, context = nil)
+    assert_equal(expected.class, actual.class)
+    
+    case expected
+    when Hash
+      actual.keys.each do |key|
+        json_diff(expected[key], actual[key], "#{context}/#{String == expected[key].class ? '@' : ''}#{key}")
+      end
+    when Array
+      actual.each_with_index do |e, i|
+        json_diff(expected[i], actual[i], "#{context}[#{i}]")
+      end
+    else
+      assert_equal(expected, actual, "#{context} is not the same:")
+    end
+  end
+end

data/test/acceptance/test_export_yaml.rb

@@ -0,0 +1,59 @@
+require 'helper'
+require 'yaml'
+
+# Tests `pwl export --format yaml`
+class TestExportYAML < Test::Pwl::AppTestCase
+  def test_empty
+    fixture = fixture("test_empty.yaml")
+    assert_successful_yaml(fixture, 'export --format yaml')
+  end
+
+  def test_all
+    test_vector = Hash['foo', 'one', 'bar', 'two', 'Chuck Norris', 'Roundhouse Kick']
+    test_vector.each{|k,v|
+      assert_successful('', "add '#{k}' '#{v}'")
+    }
+    
+    now = DateTime.now.strftime('%F %R')
+    fixture = fixture("test_all.yaml")
+    
+    assert_successful_yaml(fixture, 'export --format yaml')
+  end
+
+  def assert_successful_yaml(expected_out, cmd, password = locker_password)
+    out, err, rc = execute(cmd, password)
+    assert_equal(0, rc.exitstatus, "Expected exit status 0, but it was #{rc.exitstatus}. STDERR was: #{err}")
+    assert(err.empty?, "Expected empty STDERR, but it yielded #{err}")
+
+    actual   = YAML.load(out)
+    expected = YAML.load(expected_out)
+    
+    # fix up actuals to match expectations
+    actual[:created] = "2012-03-28T21:54:21+02:00"
+    actual[:last_accessed] = "2012-03-28T22:01:49+02:00"
+    actual[:last_modified] = "2012-03-29T22:46:29+02:00"
+
+    # This is essentially the same as
+    #   assert_equal(expected, actual)
+    # but it provides better diagnostic output on error
+    yaml_diff(expected, actual)
+  end
+  
+  private
+  def yaml_diff(expected, actual, context = nil)
+    #assert_equal(expected.class, actual.class)
+    
+    case expected
+    when Hash
+      actual.keys.each do |key|
+        yaml_diff(expected[key], actual[key], "#{context}/#{String == expected[key].class ? '@' : ''}#{key}")
+      end
+    when Array
+      actual.each_with_index do |e, i|
+        yaml_diff(expected[i], actual[i], "#{context}[#{i}]")
+      end
+    else
+      assert_equal(expected, actual, "#{context} is not the same:")
+    end
+  end
+end

data/test/acceptance/test_get.rb

@@ -11,7 +11,7 @@ class TestGet < Test::Pwl::AppTestCase
   end
 
   def test_get_known_key
-    assert_successful('', 'put foo bar') # TODO Use a fixture instead of put
+    assert_successful('', 'add foo bar') # TODO Use a fixture instead of add
     assert_successful('^bar$', 'get foo')
   end
 end

data/test/acceptance/test_init.rb

@@ -13,11 +13,11 @@ class TestInit < Test::Pwl::AppTestCase
   # **************
   # Enter master password again:
   # **************
-  # Successfully initialized new store at ...
+  # Successfully initialized new locker at ...
   # $
   #
   def test_matching_passwords
-    cmd = "bin/pwl init --force --verbose --file \"#{@store_file}\""
+    cmd = "bin/pwl init --force --verbose --file \"#{@locker_file}\""
 
     PTY.spawn(cmd){|pwl_out, pwl_in, pid|
       assert_response('Enter new master password:', pwl_out)
@@ -26,7 +26,7 @@ class TestInit < Test::Pwl::AppTestCase
       assert_response('Enter master password again:', pwl_out)
       pwl_in.puts("secr3tPassw0rd")
 
-      assert_response('Successfully initialized new store', pwl_out)
+      assert_response('Successfully initialized new locker', pwl_out)
     }
   end
 
@@ -44,7 +44,7 @@ class TestInit < Test::Pwl::AppTestCase
   # $
   #
   def test_unmatching_passwords
-    cmd = "bin/pwl init --force --verbose --file \"#{store_file}\""
+    cmd = "bin/pwl init --force --verbose --file \"#{locker_file}\""
 
     PTY.spawn(cmd){|pwl_out, pwl_in, pid|
       assert_response('Enter new master password:', pwl_out)
@@ -58,14 +58,14 @@ class TestInit < Test::Pwl::AppTestCase
   end
 
   #
-  # Tests that initing an existing store without --force does not touch the existing store
+  # Tests that initing an existing locker without --force does not touch the existing locker
   #
   def test_exists
     assert_error('already exists', "init")
   end
 
   #
-  # Tests that cancelling a forced re-init does not change the store file
+  # Tests that cancelling a forced re-init does not change the locker file
   #
   def test_cancel
     # TODO

data/test/acceptance/test_list.rb

@@ -3,7 +3,7 @@ require 'helper'
 # Tests `pwl list`
 class TestList < Test::Pwl::AppTestCase
   def test_list_empty
-    assert_empty(store.list)
+    assert_empty(locker.list)
     assert_error('^$', 'list')
     assert_error('^List is empty\.$', 'list --verbose')
   end
@@ -11,7 +11,7 @@ class TestList < Test::Pwl::AppTestCase
   def test_list_all
     test_vector = Hash['foo', 'one', 'bar', 'two', 'Chuck Norris', 'Roundhouse Kick']
     test_vector.each{|k,v|
-      assert_successful('', "put '#{k}' '#{v}'")
+      assert_successful('', "add '#{k}' '#{v}'")
     }
 
     assert_successful(test_vector.keys.join('-'), 'list -s "-"')
@@ -20,7 +20,7 @@ class TestList < Test::Pwl::AppTestCase
   def test_list_filter
     test_vector = Hash['foo', 'one', 'foot', 'two', 'Homer Simpson', 'Apu Nahasapeemapetilon']
     test_vector.each{|k,v|
-      assert_successful('', "put '#{k}' '#{v}'")
+      assert_successful('', "add '#{k}' '#{v}'")
     }
 
     filter = 'foo'