keyrack 0.1.0 → 0.1.1

data/README.rdoc

@@ -3,6 +3,52 @@
 Keyrack is a simple password manager with local or remote storage and RSA
 encryption.
 
+== Installation
+
+  gem install keyrack
+
+== Configuration
+
+=== Format
+
+The configuration file is a YAML file that requires the following data:
+* *key*: path to the RSA file you want to use
+* *store*: options for store (see below)
+
+=== 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
+
+=== Examples
+
+Filesystem example
+  store:
+    type: filesystem
+    path: ~/.keyrack/database
+  key: ~/.keyrack/id_rsa
+
+SSH example
+  store:
+    type: ssh
+    host: example.com
+    user: foobar
+    path: ~/junk.dat
+  key: ~/.keyrack/id_rsa
+
+== Usage
+
+  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.
+
 == Contributing to keyrack
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/keyrack/database.rb

@@ -1,10 +1,10 @@
 module Keyrack
   class Database
     def initialize(config)
-      store_config = config[:store].dup
-      @store = Store[store_config.delete(:type)].new(store_config)
-      key_path = File.expand_path(config[:key])
-      @key = OpenSSL::PKey::RSA.new(File.read(key_path), config[:password])
+      store_config = config['store'].dup
+      @store = Store[store_config.delete('type')].new(store_config)
+      key_path = File.expand_path(config['key'])
+      @key = OpenSSL::PKey::RSA.new(File.read(key_path), config['password'])
       @data = decrypt
     end
 

data/lib/keyrack/runner.rb

@@ -1,12 +1,16 @@
 module Keyrack
   class Runner
     def initialize(argv)
+      options = {
+        :config_path => "~/.keyrack/config"
+      }
       OptionParser.new do |opts|
-        opts.on("-c", "--config FILE", "Specify configuration file") do |f|
-          @options = YAML.load_file(f)
+        opts.on("-c", "--config [FILE]", "Specify configuration file (Default: #{options[:config_path]}") do |f|
+          options[:config_path] = f
         end
       end.parse(argv)
 
+      @options = YAML.load_file(File.expand_path(options[:config_path]))
       @ui = UI::Console.new
       password = @ui.get_password
       @database = Database.new(@options.merge(:password => password))

data/lib/keyrack/store.rb

@@ -2,8 +2,8 @@ module Keyrack
   module Store
     def self.[](name)
       case name
-      when :filesystem then Filesystem
-      when :ssh then SSH
+      when :filesystem, 'filesystem' then Filesystem
+      when :ssh, 'ssh' then SSH
       end
     end
   end

data/lib/keyrack/store/filesystem.rb

@@ -2,7 +2,7 @@ module Keyrack
   module Store
     class Filesystem
       def initialize(options)
-        @path = File.expand_path(options[:path])
+        @path = File.expand_path(options['path'])
       end
 
       def read

data/lib/keyrack/store/ssh.rb

@@ -2,9 +2,9 @@ module Keyrack
   module Store
     class SSH
       def initialize(options)
-        @host = options[:host]
-        @user = options[:user]
-        @path = options[:path]
+        @host = options['host']
+        @user = options['user']
+        @path = options['path']
       end
 
       def read

data/test/fixtures/config.yml

@@ -1,4 +1,4 @@
-:store:
-  :type: :filesystem
-  :path: /tmp/keyrack.dat
-:key: test/fixtures/id_rsa
+'store':
+  'type': 'filesystem'
+  'path': /tmp/keyrack.dat
+'key': test/fixtures/id_rsa

data/test/keyrack/store/test_filesystem.rb

@@ -5,19 +5,19 @@ module Keyrack
     class TestFilesystem < Test::Unit::TestCase
       def test_read
         path = fixture_path('foo.txt')
-        store = Filesystem.new(:path => path)
+        store = Filesystem.new('path' => path)
         assert_equal File.read(path), store.read
       end
 
       def test_write
         path = get_tmpname
-        store = Filesystem.new(:path => path)
+        store = Filesystem.new('path' => path)
         store.write("foobar")
         assert_equal "foobar", File.read(path)
       end
 
       def test_read_returns_nil_for_non_existant_file
-        store = Filesystem.new(:path => 'blargityblargh')
+        store = Filesystem.new('path' => 'blargityblargh')
         assert_nil store.read
       end
     end

data/test/keyrack/store/test_ssh.rb

@@ -4,13 +4,13 @@ module Keyrack
   module Store
     class TestSSH < Test::Unit::TestCase
       def test_read
-        store = SSH.new(:host => 'example.com', :user => 'dude', :path => 'foo.txt')
+        store = SSH.new('host' => 'example.com', 'user' => 'dude', 'path' => 'foo.txt')
         Net::SCP.expects(:download!).with("example.com", "dude", "foo.txt").returns("foo")
         assert_equal "foo", store.read
       end
 
       def test_write
-        store = SSH.new(:host => 'example.com', :user => 'dude', :path => 'foo.txt')
+        store = SSH.new('host' => 'example.com', 'user' => 'dude', 'path' => 'foo.txt')
         Net::SCP.expects(:upload!).with do |host, user, local, remote|
           host == 'example.com' && user == 'dude' && local.is_a?(StringIO) &&
             local.read == "foo" && remote == "foo.txt"
@@ -19,7 +19,7 @@ module Keyrack
       end
 
       def test_read_returns_nil_for_non_existant_file
-        store = SSH.new(:host => 'example.com', :user => 'dude', :path => 'foo.txt')
+        store = SSH.new('host' => 'example.com', 'user' => 'dude', 'path' => 'foo.txt')
         Net::SCP.expects(:download!).with("example.com", "dude", "foo.txt").raises(Net::SCP::Error)
         assert_nil store.read
       end

data/test/keyrack/test_database.rb

@@ -5,9 +5,9 @@ module Keyrack
     def setup
       @path = get_tmpname
       @database = Keyrack::Database.new({
-        :store => { :type => :filesystem, :path => @path },
-        :key => fixture_path('id_rsa'),
-        :password => 'secret'
+        'store' => { 'type' => 'filesystem', 'path' => @path },
+        'key' => fixture_path('id_rsa'),
+        'password' => 'secret'
       })
       @database.add('Twitter', 'username', 'password')
       @database.save
@@ -23,9 +23,9 @@ module Keyrack
 
     def test_reading_existing_database
       database = Keyrack::Database.new({
-        :store => { :type => :filesystem, :path => @path },
-        :key => fixture_path('id_rsa'),
-        :password => 'secret'
+        'store' => { 'type' => 'filesystem', 'path' => @path },
+        'key' => fixture_path('id_rsa'),
+        'password' => 'secret'
       })
       expected = {:username => 'username', :password => 'password'}
       assert_equal(expected, database.get('Twitter'))

data/test/keyrack/test_runner.rb

@@ -4,8 +4,8 @@ module Keyrack
   class TestRunner < Test::Unit::TestCase
     def test_console
       config = {
-        :store => { :type => :filesystem, :path => 'foobar' },
-        :key => fixture_path('id_rsa')
+        'store' => { 'type' => 'filesystem', 'path' => 'foobar' },
+        'key' => fixture_path('id_rsa')
       }
       config_path = get_tmpname
       File.open(config_path, 'w') { |f| f.print(config.to_yaml) }

data/test/keyrack/test_store.rb

@@ -4,10 +4,12 @@ module Keyrack
   class TestStore < Test::Unit::TestCase
     def test_get_filesystem
       assert_equal Store::Filesystem, Store[:filesystem]
+      assert_equal Store::Filesystem, Store['filesystem']
     end
 
     def test_get_ssh
       assert_equal Store::SSH, Store[:ssh]
+      assert_equal Store::SSH, Store['ssh']
     end
   end
 end

data/test/keyrack/ui/test_console.rb

@@ -6,9 +6,9 @@ module Keyrack
       def setup
         @path = get_tmpname
         @database = Database.new({
-          :store => { :type => :filesystem, :path => @path },
-          :key => fixture_path('id_rsa'),
-          :password => 'secret'
+          'store' => { 'type' => 'filesystem', 'path' => @path },
+          'key' => fixture_path('id_rsa'),
+          'password' => 'secret'
         })
         @database.add('Twitter', 'username', 'password')
         @database.save

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Jeremy Stephens
@@ -274,7 +274,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -93442259
+      hash: -3950856831119826099
       segments: 
       - 0
       version: "0"