keyrack 0.1.1 → 0.1.2

data/.tmux.conf

@@ -0,0 +1,2 @@
+neww -n 'autotest' 'autotest'
+neww -n 'vim' 'vim'

data/README.rdoc

@@ -17,24 +17,27 @@ The configuration file is a YAML file that requires the following data:
 
 === Store types
 
-* *filesystem*
-  * Required options:
-    * *path*: path to the keyrack database
-* +ssh+
-  * Required options:
-    * *host*: host name
-    * *user*: user name
-    * *path*: path to the keyrack database on remote host
+==== filesystem
+* Required options:
+  * *path*: path to the keyrack database
+
+==== ssh
+* Required options:
+  * *host*: host name
+  * *user*: user name
+  * *path*: path to the keyrack database on remote host
 
 === Examples
 
-Filesystem example
+==== Filesystem example
+
   store:
     type: filesystem
     path: ~/.keyrack/database
   key: ~/.keyrack/id_rsa
 
-SSH example
+==== SSH example
+
   store:
     type: ssh
     host: example.com
@@ -46,8 +49,23 @@ SSH example
 
   keyrack [-c path-to-config]
 
-By default, keyrack will look for <b>~/.keyrack/config</b>.  The database file
-(merely a RSA-encrypted YAML file) will be created on save if it doesn't exist.
+By default, Keyrack will look for <b>~/.keyrack/config</b>.  The database file
+(merely a RSA-encrypted Ruby hash) will be created on save if it doesn't exist.
+It's a good idea to generate a seperate RSA key for use with Keyrack, especially
+if you are using the SSH store and are connecting from multiple locations.  To
+generate a key, try: <code>ssh-keygen -C keyrack -f ~/.keyrack/id_rsa</code>
+
+Starting keyrack will display a simple menu in your terminal, like this:
+
+  1. Twitter [foobar]
+  2. Facebook [foobar@example.com]
+  3. Twitter [otherfoobar]
+  n. Add new
+  s. Save
+  q. Quit
+
+Selecting <b>1</b> in this case will copy the Twitter password for the foobar user
+to your clipboard.
 
 == Contributing to keyrack
 

data/Rakefile

@@ -23,14 +23,14 @@ Jeweler::Tasks.new do |gem|
   # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
   #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
   #  gem.add_development_dependency 'rspec', '> 1.2.3'
-  gem.add_runtime_dependency 'net-scp'
-  gem.add_runtime_dependency 'highline'
-  gem.add_runtime_dependency 'clipboard'
-  gem.add_development_dependency 'rspec', '> 1.2.3'
-  gem.add_development_dependency "bundler", "~> 1.0.0"
-  gem.add_development_dependency "jeweler", "~> 1.5.1"
-  gem.add_development_dependency "rcov", ">= 0"
-  gem.add_development_dependency "mocha"
+#  gem.add_runtime_dependency 'net-scp'
+#  gem.add_runtime_dependency 'highline'
+#  gem.add_runtime_dependency 'clipboard'
+#  gem.add_development_dependency 'rspec', '> 1.2.3'
+#  gem.add_development_dependency "bundler", "~> 1.0.0"
+#  gem.add_development_dependency "jeweler", "~> 1.5.1"
+#  gem.add_development_dependency "rcov", ">= 0"
+#  gem.add_development_dependency "mocha"
 end
 Jeweler::RubygemsDotOrgTasks.new
 

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/keyrack.gemspec

@@ -0,0 +1,97 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{keyrack}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jeremy Stephens"]
+  s.date = %q{2010-12-12}
+  s.default_executable = %q{keyrack}
+  s.description = %q{Simple password manager with local/remote database storage and RSA encryption.}
+  s.email = %q{viking@pillageandplunder.net}
+  s.executables = ["keyrack"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rvmrc",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "bin/keyrack",
+    "lib/keyrack.rb",
+    "lib/keyrack/database.rb",
+    "lib/keyrack/runner.rb",
+    "lib/keyrack/store.rb",
+    "lib/keyrack/store/filesystem.rb",
+    "lib/keyrack/store/ssh.rb",
+    "lib/keyrack/ui.rb",
+    "lib/keyrack/ui/console.rb",
+    "test/fixtures/config.yml",
+    "test/fixtures/foo.txt",
+    "test/fixtures/id_rsa",
+    "test/fixtures/id_rsa.pub",
+    "test/helper.rb",
+    "test/keyrack/store/test_filesystem.rb",
+    "test/keyrack/store/test_ssh.rb",
+    "test/keyrack/test_database.rb",
+    "test/keyrack/test_runner.rb",
+    "test/keyrack/test_store.rb",
+    "test/keyrack/ui/test_console.rb"
+  ]
+  s.homepage = %q{http://github.com/viking/keyrack}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Simple password manager}
+  s.test_files = [
+    "test/helper.rb",
+    "test/keyrack/store/test_filesystem.rb",
+    "test/keyrack/store/test_ssh.rb",
+    "test/keyrack/test_database.rb",
+    "test/keyrack/test_runner.rb",
+    "test/keyrack/test_store.rb",
+    "test/keyrack/ui/test_console.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_runtime_dependency(%q<net-scp>, [">= 0"])
+      s.add_runtime_dependency(%q<highline>, [">= 0"])
+      s.add_runtime_dependency(%q<clipboard>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+    else
+      s.add_dependency(%q<net-scp>, [">= 0"])
+      s.add_dependency(%q<highline>, [">= 0"])
+      s.add_dependency(%q<clipboard>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<net-scp>, [">= 0"])
+    s.add_dependency(%q<highline>, [">= 0"])
+    s.add_dependency(%q<clipboard>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+  end
+end
+

data/lib/keyrack.rb

@@ -8,6 +8,7 @@ require 'clipboard'
 module Keyrack
 end
 
+require File.dirname(__FILE__) + '/keyrack/utils'
 require File.dirname(__FILE__) + '/keyrack/database'
 require File.dirname(__FILE__) + '/keyrack/store'
 require File.dirname(__FILE__) + '/keyrack/ui'

data/lib/keyrack/database.rb

@@ -6,10 +6,12 @@ module Keyrack
       key_path = File.expand_path(config['key'])
       @key = OpenSSL::PKey::RSA.new(File.read(key_path), config['password'])
       @data = decrypt
+      @dirty = false
     end
 
     def add(site, username, password)
       @data[site] = { :username => username, :password => password }
+      @dirty = true
     end
 
     def get(site)
@@ -20,8 +22,13 @@ module Keyrack
       @data.keys
     end
 
+    def dirty?
+      @dirty
+    end
+
     def save
       @store.write(@key.public_encrypt(Marshal.dump(@data)))
+      @dirty = false
     end
 
     private

data/lib/keyrack/ui/console.rb

@@ -12,7 +12,7 @@ module Keyrack
 
       def menu
         entries = []
-        choices = %w{n s q}
+        choices = %w{n q}
         @database.sites.each_with_index do |site, i|
           entry = @database.get(site)
           entries << entry
@@ -20,7 +20,10 @@ module Keyrack
           @highline.say("% 2d. %s [%s]" % [i+1, site, entry[:username]])
         end
         @highline.say(" n. Add new")
-        @highline.say(" s. Save")
+        if @database.dirty?
+          @highline.say(" s. Save")
+          choices << "s"
+        end
         @highline.say(" q. Quit")
         result = @highline.ask(" ?  ") { |q| q.in = choices }
         case result
@@ -29,7 +32,11 @@ module Keyrack
         when "s"
           :save
         when "q"
-          :quit
+          if @database.dirty? && !@highline.agree("Really quit?  You have unsaved changes! [yn] ")
+            nil
+          else
+            :quit
+          end
         else
           Clipboard.copy(entries[result.to_i - 1][:password])
           @highline.say("The password has been copied to your clipboard.")
@@ -39,9 +46,27 @@ module Keyrack
 
       def get_new_entry
         result = {}
-        result[:site]     = @highline.ask("Site:     ")
+        result[:site]     = @highline.ask("Label: ")
         result[:username] = @highline.ask("Username: ")
-        result[:password] = @highline.ask("Password: ")
+        if @highline.agree("Generate password? [yn] ")
+          loop do
+            password = Utils.generate_password
+            if @highline.agree("Generated #{@highline.color(password, :blue)}.  Sound good? [yn] ")
+              result[:password] = password
+              break
+            end
+          end
+        else
+          loop do
+            password = @highline.ask("Password: ") { |q| q.echo = false }
+            confirmation = @highline.ask("Password (again): ") { |q| q.echo = false }
+            if password == confirmation
+              result[:password] = password
+              break
+            end
+            @highline.say("Passwords didn't match.  Try again!")
+          end
+        end
         result
       end
     end

data/lib/keyrack/utils.rb

@@ -0,0 +1,11 @@
+module Keyrack
+  module Utils
+    def self.generate_password
+      result = "        "
+      result.length.times do |i|
+        result[i] = (33 + rand(94)).chr
+      end
+      result
+    end
+  end
+end

data/test/keyrack/test_database.rb

@@ -34,5 +34,11 @@ module Keyrack
     def test_sites
       assert_equal(%w{Twitter}, @database.sites)
     end
+
+    def test_dirty
+      assert !@database.dirty?
+      @database.add('Foo', 'bar', 'baz')
+      assert @database.dirty?
+    end
   end
 end

data/test/keyrack/test_utils.rb

@@ -0,0 +1,10 @@
+require 'helper'
+
+module Keyrack
+  class TestUtils < Test::Unit::TestCase
+    def test_generate_password
+      result = Utils.generate_password
+      assert_match result, /^[!-~]{8}$/
+    end
+  end
+end

data/test/keyrack/ui/test_console.rb

@@ -22,11 +22,10 @@ module Keyrack
 
         highline.expects(:say).with(" 1. Twitter [username]")
         highline.expects(:say).with(" n. Add new")
-        highline.expects(:say).with(" s. Save")
         highline.expects(:say).with(" q. Quit")
 
         question = mock('question')
-        question.expects(:in=).with(%w{n s q 1})
+        question.expects(:in=).with(%w{n q 1})
         highline.expects(:ask).yields(question).returns('1')
         Clipboard.expects(:copy).with('password')
         highline.expects(:say).with("The password has been copied to your clipboard.")
@@ -41,11 +40,10 @@ module Keyrack
 
         highline.expects(:say).with(" 1. Twitter [username]")
         highline.expects(:say).with(" n. Add new")
-        highline.expects(:say).with(" s. Save")
         highline.expects(:say).with(" q. Quit")
 
         question = mock('question')
-        question.expects(:in=).with(%w{n s q 1})
+        question.expects(:in=).with(%w{n q 1})
         highline.expects(:ask).yields(question).returns('n')
         assert_equal :new, console.menu
       end
@@ -58,20 +56,38 @@ module Keyrack
 
         highline.expects(:say).with(" 1. Twitter [username]")
         highline.expects(:say).with(" n. Add new")
-        highline.expects(:say).with(" s. Save")
         highline.expects(:say).with(" q. Quit")
 
         question = mock('question')
-        question.expects(:in=).with(%w{n s q 1})
+        question.expects(:in=).with(%w{n q 1})
         highline.expects(:ask).yields(question).returns('q')
         assert_equal :quit, console.menu
       end
 
+      def test_select_quit_from_menu_when_database_is_dirty
+        highline = mock('highline')
+        HighLine.expects(:new).returns(highline)
+        console = Console.new
+        console.database = @database
+        @database.stubs(:dirty?).returns(true)
+
+        highline.expects(:say).with(" 1. Twitter [username]")
+        highline.expects(:say).with(" n. Add new")
+        highline.expects(:say).with(" s. Save")
+        highline.expects(:say).with(" q. Quit")
+
+        question = mock('question', :in= => nil)
+        highline.expects(:ask).yields(question).returns('q')
+        highline.expects(:agree).with("Really quit?  You have unsaved changes! [yn] ").returns(false)
+        assert_equal nil, console.menu
+      end
+
       def test_select_save_from_menu
         highline = mock('highline')
         HighLine.expects(:new).returns(highline)
         console = Console.new
         console.database = @database
+        @database.stubs(:dirty?).returns(true)
 
         highline.expects(:say).with(" 1. Twitter [username]")
         highline.expects(:say).with(" n. Add new")
@@ -79,7 +95,7 @@ module Keyrack
         highline.expects(:say).with(" q. Quit")
 
         question = mock('question')
-        question.expects(:in=).with(%w{n s q 1})
+        question.expects(:in=).with(%w{n q 1 s})
         highline.expects(:ask).yields(question).returns('s')
         assert_equal :save, console.menu
       end
@@ -95,16 +111,40 @@ module Keyrack
         assert_equal "foobar", console.get_password
       end
 
-      def test_get_new_entry
+      def test_get_new_entry_with_manual_password
         highline = mock('highline')
         HighLine.expects(:new).returns(highline)
         console = Console.new
 
-        highline.expects(:ask).with("Site:     ").returns("Foo")
-        highline.expects(:ask).with("Username: ").returns("bar")
-        highline.expects(:ask).with("Password: ").returns("baz")
+        seq = sequence("new entry")
+        highline.expects(:ask).with("Label: ").returns("Foo").in_sequence(seq)
+        highline.expects(:ask).with("Username: ").returns("bar").in_sequence(seq)
+        highline.expects(:agree).with("Generate password? [yn] ").returns(false).in_sequence(seq)
+        highline.expects(:ask).with("Password: ").yields(mock { expects(:echo=).with(false) }).returns("baz").in_sequence(seq)
+        highline.expects(:ask).with("Password (again): ").yields(mock { expects(:echo=).with(false) }).returns("bar").in_sequence(seq)
+        highline.expects(:say).with("Passwords didn't match.  Try again!").in_sequence(seq)
+        highline.expects(:ask).with("Password: ").yields(mock { expects(:echo=).with(false) }).returns("baz").in_sequence(seq)
+        highline.expects(:ask).with("Password (again): ").yields(mock { expects(:echo=).with(false) }).returns("baz").in_sequence(seq)
         assert_equal({:site => "Foo", :username => "bar", :password => "baz"}, console.get_new_entry)
       end
+
+      def test_get_new_entry_generated_password
+        highline = mock('highline')
+        HighLine.expects(:new).returns(highline)
+        console = Console.new
+
+        seq = sequence("new entry")
+        highline.expects(:ask).with("Label: ").returns("Foo").in_sequence(seq)
+        highline.expects(:ask).with("Username: ").returns("bar").in_sequence(seq)
+        highline.expects(:agree).with("Generate password? [yn] ").returns(true).in_sequence(seq)
+        Utils.expects(:generate_password).returns('foobar').in_sequence(seq)
+        highline.expects(:color).with('foobar', :blue).returns('bluefoobar').in_sequence(seq)
+        highline.expects(:agree).with("Generated bluefoobar.  Sound good? [yn] ").returns(false).in_sequence(seq)
+        Utils.expects(:generate_password).returns('foobar').in_sequence(seq)
+        highline.expects(:color).with('foobar', :blue).returns('bluefoobar').in_sequence(seq)
+        highline.expects(:agree).with("Generated bluefoobar.  Sound good? [yn] ").returns(true).in_sequence(seq)
+        assert_equal({:site => "Foo", :username => "bar", :password => "foobar"}, console.get_new_entry)
+      end
     end
   end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Jeremy Stephens
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-12 00:00:00 -06:00
+date: 2010-12-13 00:00:00 -06:00
 default_executable: keyrack
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -112,116 +112,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: net-scp
-  requirement: &id008 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :runtime
-  prerelease: false
-  version_requirements: *id008
-- !ruby/object:Gem::Dependency 
-  name: highline
-  requirement: &id009 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :runtime
-  prerelease: false
-  version_requirements: *id009
-- !ruby/object:Gem::Dependency 
-  name: clipboard
-  requirement: &id010 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :runtime
-  prerelease: false
-  version_requirements: *id010
-- !ruby/object:Gem::Dependency 
-  name: rspec
-  requirement: &id011 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">"
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 2
-        - 3
-        version: 1.2.3
-  type: :development
-  prerelease: false
-  version_requirements: *id011
-- !ruby/object:Gem::Dependency 
-  name: bundler
-  requirement: &id012 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        - 0
-        version: 1.0.0
-  type: :development
-  prerelease: false
-  version_requirements: *id012
-- !ruby/object:Gem::Dependency 
-  name: jeweler
-  requirement: &id013 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 5
-        - 1
-        version: 1.5.1
-  type: :development
-  prerelease: false
-  version_requirements: *id013
-- !ruby/object:Gem::Dependency 
-  name: rcov
-  requirement: &id014 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  prerelease: false
-  version_requirements: *id014
-- !ruby/object:Gem::Dependency 
-  name: mocha
-  requirement: &id015 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  prerelease: false
-  version_requirements: *id015
 description: Simple password manager with local/remote database storage and RSA encryption.
 email: viking@pillageandplunder.net
 executables: 
@@ -234,6 +124,7 @@ extra_rdoc_files:
 files: 
 - .document
 - .rvmrc
+- .tmux.conf
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -241,6 +132,7 @@ files:
 - Rakefile
 - VERSION
 - bin/keyrack
+- keyrack.gemspec
 - lib/keyrack.rb
 - lib/keyrack/database.rb
 - lib/keyrack/runner.rb
@@ -249,6 +141,7 @@ files:
 - lib/keyrack/store/ssh.rb
 - lib/keyrack/ui.rb
 - lib/keyrack/ui/console.rb
+- lib/keyrack/utils.rb
 - test/fixtures/config.yml
 - test/fixtures/foo.txt
 - test/fixtures/id_rsa
@@ -259,6 +152,7 @@ files:
 - test/keyrack/test_database.rb
 - test/keyrack/test_runner.rb
 - test/keyrack/test_store.rb
+- test/keyrack/test_utils.rb
 - test/keyrack/ui/test_console.rb
 has_rdoc: true
 homepage: http://github.com/viking/keyrack
@@ -274,7 +168,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -3950856831119826099
+      hash: 528577741293551689
       segments: 
       - 0
       version: "0"
@@ -300,4 +194,5 @@ test_files:
 - test/keyrack/test_database.rb
 - test/keyrack/test_runner.rb
 - test/keyrack/test_store.rb
+- test/keyrack/test_utils.rb
 - test/keyrack/ui/test_console.rb