yak 1.0.3 → 1.0.4

data/History.txt

@@ -1,3 +1,17 @@
+=== 1.0.4 / 2010-02-23
+
+  * Enhancemennts:
+
+    * Added support for bash completion
+
+  * Bugfixes:
+
+    * Fixed CipherError namespace change for different Ruby versions
+
+    * List option now only returns keys
+
+    * Rdoc README processing error fixed
+
 === 1.0.3 / 2010-02-22
 
   * Enhancements:

data/Manifest.txt

@@ -1,5 +1,6 @@
 bin/yak
 lib/yak.rb
+script/yak_completion
 History.txt
 Manifest.txt
 Rakefile

data/README.txt

@@ -1,5 +1,7 @@
 = Yak
 
+http://github.com/yaksnrainbows/yak
+
 == Description
 
 Yak is a simple command line app to store and retrieve passwords securely
@@ -13,17 +15,17 @@ Config can be set in ~/.yakrc.
 
 Session is the length of time in seconds that Yak will remember the
 master password:
-  :session: 30
+  :session : 30
 
 If using sessions is not desired and you want to enter the
 master password every time, set:
-  :session: false
+  :session : false
 
 Always set the password by default, use:
-  :password: plain_text_password
+  :password : plain_text_password
 
 Turn off password confirmation prompts when a new password is entered:
-  :confirm_prompt: false
+  :confirm_prompt : false
 
 
 == Usage
@@ -43,9 +45,9 @@ Retrieving a saved password:
   $ yak gmail
   # copies the gmail password to the clipboard
 
-  $ yak --list gmail
-  >> gmail: my_password
-  # matches all password keys to /gmail/ and outputs to stdout
+  $ yak -p gmail
+  >> my_password
+  # outputs gmail password to stdout
 
 Removing a stored password:
   $ yak -r gmail
@@ -55,12 +57,12 @@ Changing the master password:
   $ yak -n
   # prompts for old password first, then the new password
 
-Listing key/password pairs:
+Listing keys:
   $ yak --list
   # returns all saved pairs
 
   $ yak --list key
-  # returns all saved pairs with a key matching /key/
+  # returns all keys matching /key/
 
   $ yak --list ^key$
-  # returns unique saved pair with a key matching /^key$/
+  # returns unique key matching /^key$/

data/lib/yak.rb

@@ -22,12 +22,20 @@ require 'session'
 #   :confirm_prompt: false
 # To set the path to the yak data file:
 #   :data_file: /path/to/file
+# Using bash completion for stored keys:
+#   :bash_completion: true    #=> completion only available during session
+#   :bash_completion: :always #=> completion always available
 
 class Yak
 
-  VERSION = "1.0.3"
+  # Version of Yak.
+  VERSION = "1.0.4"
 
-  DEFAULT_CONFIG = {:session => 30}
+  # Default config used.
+  DEFAULT_CONFIG = {:session => 30, :bash_completion => true}
+
+  # Different versions of ruby have a different namespace for CipherError
+  CIPHER_ERROR = OpenSSL::Cipher::CipherError rescue OpenSSL::CipherError
 
   ##
   # Run Yak with argv:
@@ -46,14 +54,14 @@ class Yak
 
     yak = new user, config
 
-    yak.connect_data
     yak.start_session
+    yak.connect_data
 
     args = [options[:action], yak, options[:key], options[:value]].compact
 
     self.send(*args)
 
-  rescue OpenSSL::Cipher::CipherError => e
+  rescue CIPHER_ERROR => e
     $stderr << "Bad password.\n"
     exit 1
   end
@@ -68,8 +76,42 @@ class Yak
     return if File.file? user_config_file
 
     hl = HighLine.new $stdin, $stderr
-    hl.say "Thanks for installing Yak!"
+    hl.say "\n\nThanks for installing Yak!\n\n"
+
+    setup_bash_completion
+
+    data_file  = prompt_data_loc user, hl
+
+    new_config = DEFAULT_CONFIG.merge(:data_file => data_file)
+
+    make_config_file user, new_config
+  end
+
+
+  ##
+  # Check and setup bash completion.
+
+  def self.setup_bash_completion
+    completion_dir  = "/etc/bash_completion.d"
+
+    completion_file = File.join File.dirname(__FILE__),
+      "../script/yak_completion"
+    completion_file = File.expand_path completion_file
+
+    if File.directory? completion_dir
+      FileUtils.cp completion_file, File.join(completion_dir, ".")
+    else
+      $stderr << "\nError: Could not find directory #{completion_dir}\n"
+      $stderr << "If you would like to use yak's bash completion, "
+      $stderr << "make sure to source #{completion_file} in .bashrc\n\n"
+    end
+  end
+
 
+  ##
+  # Prompt the user for the location of the data file.
+
+  def self.prompt_data_loc user, hl
     data_file_opts = []
 
     usrhome = File.expand_path "~#{user}/"
@@ -86,10 +128,7 @@ class Yak
       end
     end
 
-    data_file  = File.join data_path, ".yakdata"
-    new_config = DEFAULT_CONFIG.merge(:data_file => data_file)
-
-    make_config_file user, new_config
+    File.join data_path, ".yakdata"
   end
 
 
@@ -112,46 +151,68 @@ class Yak
 
     File.open(user_config_file, "w+"){|f| f.write config_str }
     $stderr << "Created Yak config file #{user_config_file}:\n"
-    $stderr << "#{config_str}\n"
+    $stderr << "#{config_str}---\n\n"
   end
 
 
+  ##
+  # Remove a key/value pair from a yak instance.
+
   def self.remove yak, name
     yak.remove name
     yak.write_data
   end
 
 
+  ##
+  # Add a key/value pair to a yak instance.
+
   def self.store yak, name, value=nil
     yak.store name, value
     yak.write_data
   end
 
 
+  ##
+  # Get a password value from a yak instance and copy it to the clipboard.
+
   def self.retrieve yak, name
     send_to_clipboard yak.retrieve(name)
   end
 
 
+  ##
+  # Get a password value from a yak instance and output it to the stdout.
+
   def self.print_password yak, name
     $stdout << "#{yak.retrieve(name)}\n"
   end
 
 
+  ##
+  # Delete the data file of a yak instance after confirming with the user.
+
   def self.delete_data yak
     yak.delete_data_file! true
   end
 
 
+  ##
+  # List matched keys of a yak instance.
+
   def self.list yak, name=nil
     key_regex = /#{name || ".+"}/
 
     yak.data.each do |key, value|
-      $stdout << "#{key}: #{value}\n" if key =~ key_regex
+      $stdout << "#{key}\n" if key =~ key_regex
     end
   end
 
 
+  ##
+  # Assign a new master password to a yak instance.
+  # Prompts the user if no value is given.
+
   def self.new_password yak, value=nil
     yak.new_password value
     yak.write_data
@@ -159,30 +220,35 @@ class Yak
   end
 
 
+  ##
+  # Send the passed string to the keyboard.
+  # Only supports darwin (pbcopy), linux (xclip) and cygwin (putclip).
+
   def self.send_to_clipboard string
     copy_cmd = case RUBY_PLATFORM
-               when /darwin/
-                 "echo -n \"#{string}\" | pbcopy"
-               when /linux/
-                 "echo -n \"#{string}\" | xclip"
-               when /cigwin/
-                 "echo -n \"#{string}\" | putclip"
-               when /(win|mingw)/
-                 "echo \"#{string}\" | clip"
+               when /darwin/ then "pbcopy"
+               when /linux/  then "xclip"
+               when /cygwin/ then "putclip"
                else
                  $stderr << "No clipboad cmd for platform #{RUBY_PLATFORM}\n"
                  exit 1
                end
 
-    Session::Bash.new.execute copy_cmd
+    Session::Bash.new.execute "echo -n \"#{string}\" | #{copy_cmd}"
   end
 
 
+  ##
+  # Get a user's yak config file. Typically ~user/.yakrc.
+
   def self.yak_config_file user
     File.expand_path "~#{user}/.yakrc"
   end
 
 
+  ##
+  # Parse ARGV data.
+
   def self.parse_args argv
     options = {}
 
@@ -192,7 +258,7 @@ class Yak
       opt.release = nil
 
       opt.banner = <<-EOF
-#{opt.program_name} is a simple app to store and retrieve passwords securely.
+Yak is a simple app to store and retrieve passwords securely.
 Retrieved passwords get copied to the clipboard by default.
 
   Usage:
@@ -220,7 +286,7 @@ Retrieved passwords get copied to the clipboard by default.
       end
 
       opt.on('-l', '--list [REGEX]',
-             'List key/password pairs to the stdout') do |key|
+             'List keys to the stdout') do |key|
         options[:action] = :list
         options[:key]    = key
       end
@@ -257,7 +323,7 @@ Retrieved passwords get copied to the clipboard by default.
   end
 
 
-  attr_reader :user, :data
+  attr_reader :user, :data, :use_completion
 
   ##
   # Create a new Yak instance for a given user:
@@ -280,6 +346,9 @@ Retrieved passwords get copied to the clipboard by default.
     @password_file = File.join @yak_dir, "password"
     @data_file     = options[:data_file] || File.join(@yak_dir, "data")
 
+    @key_list_file  = File.join @yak_dir, "keys"
+    @use_completion = options[:bash_completion]
+
     @session_pid = nil
     @session_pid = File.read(@pid_file).to_i if File.file? @pid_file
 
@@ -297,15 +366,17 @@ Retrieved passwords get copied to the clipboard by default.
   def start_session
     return unless @session_length
 
+    pswd = sha_password # Do stdio before writing to file!
+
     end_session if has_session?
 
     pid = fork do
       sleep @session_length
-      FileUtils.rm_f [@password_file, @pid_file]
+      remove_session_files
     end
 
+    File.open(@password_file, "w+"){|f| f.write pswd }
     File.open(@pid_file,      "w+"){|f| f.write pid }
-    File.open(@password_file, "w+"){|f| f.write sha_password }
 
     Process.detach pid
   end
@@ -317,7 +388,16 @@ Retrieved passwords get copied to the clipboard by default.
   def end_session
     return unless @session_pid
     Process.kill 9, @session_pid rescue false
+    remove_session_files
+  end
+
+
+  ##
+  # Deletes files used during a session.
+
+  def remove_session_files
     FileUtils.rm_f [@password_file, @pid_file]
+    FileUtils.rm_f @key_list_file unless @use_completion == :always
   end
 
 
@@ -388,7 +468,11 @@ Retrieved passwords get copied to the clipboard by default.
     if data_file_exists?
       data = ""
       File.open(@data_file, "rb"){|f| data << f.read }
+
       @data = YAML.load decrypt(data)
+
+      write_key_list if @use_completion
+
     else
       @data = {}
       write_data
@@ -443,6 +527,16 @@ Retrieved passwords get copied to the clipboard by default.
   def write_data password=nil
     data = encrypt @data.to_yaml, password
     File.open(@data_file, "w+"){|f| f.write data}
+
+    write_key_list if @use_completion == :always
+  end
+
+
+  ##
+  # Write the key list file. Used for bash completion.
+
+  def write_key_list
+    File.open(@key_list_file, "w+"){|f| f.write @data.keys.join(" ") }
   end
 
 
@@ -478,6 +572,11 @@ Retrieved passwords get copied to the clipboard by default.
   end
 
 
+  ##
+  # Get the cypher output:
+  #   get_cypher_out :encrypt, plain_string
+  #   get_cypher_out :decrypt, encrypted_string
+
   def get_cypher_out method, string, password=nil
     password ||= sha_password
 

data/script/yak_completion

@@ -0,0 +1,44 @@
+#!/bin/bash
+
+_valid_yak_option()
+{
+  local valid_prevs prevs_num curr_prev prev
+
+  prev="$1"
+
+  valid_prevs=( '-a' '--add' '-r' '--remove' '-l' '--list' '-p' '--print' 'yak' )
+  prevs_num=${#valid_prevs[@]}
+
+  for ((i=0;i<$prevs_num;i++)); do
+    curr_prev=${valid_prevs[${i}]}
+
+    if [ "$prev" == $curr_prev ]; then
+      echo "$prev"
+      return 0
+    fi
+  done
+  
+  return 1
+}
+
+_yak() 
+{
+  local cur prev opts yak_keys
+  COMPREPLY=()
+  cur="${COMP_WORDS[COMP_CWORD]}"
+  prev="${COMP_WORDS[COMP_CWORD-1]}"
+
+  yak_keys="$HOME/.yak/keys"
+
+
+  if [ -f "$yak_keys" ] && [ $(_valid_yak_option "$prev") ]; then
+    opts=$(cat $yak_keys)
+    COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )
+    return 0
+  fi
+
+  return 1
+}
+
+complete -F _yak yak
+

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: yak
 version: !ruby/object:Gem::Version 
-  version: 1.0.3
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 4
+  version: 1.0.4
 platform: ruby
 authors: 
 - Jeremie Castagna
@@ -14,54 +19,46 @@ default_executable:
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: highline
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 1
         version: 1.5.1
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: session
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 4
+        - 0
         version: 2.4.0
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: rubyforge
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 2.0.3
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: gemcutter
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 0.3.0
-    version: 
+  type: :runtime
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: hoe
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.5.0
-    version: 
+        segments: 
+        - 2
+        - 3
+        - 3
+        version: 2.3.3
+  type: :development
+  version_requirements: *id003
 description: |-
   Yak is a simple command line app to store and retrieve passwords securely
   under a master password, and allows one password repository per system user.
@@ -79,12 +76,13 @@ extra_rdoc_files:
 files: 
 - bin/yak
 - lib/yak.rb
+- script/yak_completion
 - History.txt
 - Manifest.txt
 - Rakefile
 - README.txt
 has_rdoc: true
-homepage: 
+homepage: http://github.com/yaksnrainbows/yak
 licenses: []
 
 post_install_message: 
@@ -97,18 +95,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: yak
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Yak is a simple command line app to store and retrieve passwords securely under a master password, and allows one password repository per system user