pwss 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0d6de35d7d59295771fff8e0710f121b9fcaf3c
-  data.tar.gz: 15b6b84a494a01fdb2c94833481dc1bbc5c08818
+  metadata.gz: beca8e8821633787a38795eeff8ede8471aae201
+  data.tar.gz: 5fe7c3c6926bd4646af646cf5f5b6d94110263bc
 SHA512:
-  metadata.gz: 2a6951a825180bdda38b6a26da7895bbb422862466cadfc1ea95703a050ae2c542ba2b61fb45a489c2ed3af83f6429843bc8dec6a668933acba6f305258b077e
-  data.tar.gz: 1ce2596579e801b3313ec443a98aac562ec94b3c2a933b59b3ad51bc35f1c8bdcd730c0c3795a0ff8318be528fb1a37177e6c0ec7b9288ea6fc35f9fe05a25e4
+  metadata.gz: 81f03cb7c8c3d1fc9f5c5cd43be63039a1d916f1d4ef107df38fb13953c82bde320db9b95b3147e95ed0dacda5f200e651517552f0f332e48e000c2557e189ac
+  data.tar.gz: c5189e3f75c9b4fcf0aa2ce05aa79330c19e7e4c0de790e0ba8e0995e25c100bc08fe881238a045a6d9bbed1f257524d57a64dea10bed009d0d15f46662dac5b

data/README.textile

@@ -2,7 +2,7 @@ h1. Pwss
 
 A password manager in the spirit of "pws":https://github.com/janlelis/pws.
 
-PWSS can store multiple entries in a file and, more important, it allows user to specify various types of entries (e.g., BankAccount) and different infos for each entry (e.g., URL for Internet passwords).
+PWSS can store multiple entries in a file and it allows user to specify various types of entries (e.g., BankAccount) and different infos for each entry (e.g., URL for Internet passwords).
 
 Features:
 
@@ -62,9 +62,9 @@ A typical usage scenario is the following:
 
 *Using multiple safes.* If you want to create multiple password files or store a password file in a non-standard location, use the @-f@ (@--filename@) option:
 
-# @pwss -f MYFILE init@
-# @pwss -f MYFILE add@
-# @pwss -f MYFILE get@
+# @pwss init -f MYFILE@
+# @pwss add -f MYFILE@
+# @pwss get -f MYFILE@
 
 *Do not forget to use the extension @.enc@, if your password file to be encrypted.* (See "Encrypted and Plain files", below.)
 
@@ -72,7 +72,7 @@ A typical usage scenario is the following:
 
 bc. $ pwss get my_email -w 3
 
-will retrieve entry whose title is @my_email@ and make the password available in the clipboard for @2@ seconds.
+will retrieve entry whose title is @my_email@ and make the password available in the clipboard for @3@ seconds.
 
 Use @0@ to keep the password in the clipboard till a key is pressed.
 
@@ -163,6 +163,10 @@ Notice that only @title@ and @password@ are required.
 
 h2. Changelog
 
+* *Release 0.4.0*
+** New @--stdout@ option will output password to standard output (useful for integration with other applications)
+** New @--select N@ option will automatically select the @N@th entry (rather than asking the user to select an entry).
+
 * *Release 0.3.0*
 ** internal refactoring: CLI parsing is now based on "Slop":https://github.com/leejarvis/slop.  The documentation has been revised and should now be simpler to understand.
 ** added some controls to avoid overwriting existing files (in particular: init, encrypt, and decrypt).  The command is now less Unix-like, but I hope you will appreciate a bit more safety.

data/bin/pwss

@@ -165,20 +165,26 @@ opts = Slop.parse :help => true do
     banner "pwss get [options] string"
     description "Get password for entry matching <string> in the title field"
 
-    on "-f", "--filename=", "Password file to use."
-    on "-w", "--wait=", "Seconds password is available in the clipboard (0 = interactive).", as: Integer
+    on "-f", "--filename=", "Password file to use"
+    on "-w", "--wait=", "Seconds password is available in the clipboard (0 = interactive)", as: Integer
+    on "--stdout", "Output the password to standard output"
+    on "--select=", "Select the N-th matching entry", as: Integer
 
     run  do |opts, args|
       filename = opts.to_hash[:filename] || DEFAULT_FILENAME
       waiting = opts.to_hash[:wait] || DEFAULT_SECS
+      stdout_opt = opts.to_hash[:stdout]
+      entry_no = opts.to_hash[:select] || nil
 
       string, _ = file2string filename
       entries = YAML::load(string) || Array.new
 
-      password = Pwss::get args.join(" "), entries
-      if password
-        Cipher.password_to_clipboard password, waiting 
+      password = Pwss::get args.join(" "), entries, entry_no
+
+      if password then
+        stdout_opt ? printf("%s", password) : Cipher.password_to_clipboard(password, waiting)
       end
+
     end
   end
 
@@ -189,12 +195,12 @@ opts = Slop.parse :help => true do
     description "Add an entry and copy its password in the clipboard"
 
     on "-f", "--filename=", "Password file to use."
-    on "-w", "--wait=", "Seconds password is available in the clipboard (0 = interactive).", as: Integer
+    on "-w", "--wait=", "Seconds password is available in the clipboard (0 = interactive)", as: Integer
       
-    on "-e", "--entry=", "Create an entry of type TYPE (Entry, CreditCard, BankAccount, SoftwareLicense).\n                        Default to 'Entry', which is good enough for websites credentials."
+    on "-e", "--entry=", "Create an entry of type TYPE (Entry, CreditCard, BankAccount, SoftwareLicense).\n                        Default to 'Entry', which is good enough for websites credentials"
 
     on "-g", "--generate=", "Generate a random password of given length.", as: Integer
-    on "-a", "--alnum", "Use only alphanumeric chars for the randomly generated password."
+    on "-a", "--alnum", "Use only alphanumeric chars for the randomly generated password"
 
     run do |opts, args|
       filename = opts.to_hash[:filename] || DEFAULT_FILENAME

data/lib/pwss.rb

@@ -7,8 +7,11 @@ require 'yaml'
 
 module Pwss
 
-  def self.get search_string, entries
-    id = choose_entry search_string, entries
+  # entry_no is the relative id of an entry, specified by the user from the command line
+  # (useful when the search criteria returns more than one match, in an order which is known
+  # to the user)
+  def self.get search_string, entries, entry_no = nil
+    id = choose_entry search_string, entries, false, entry_no
 
     entries[id]["password"]
   end
@@ -60,7 +63,7 @@ module Pwss
   # Let the user select an entry from data
   # (data is a YAML string with an array of entries)
   #
-  def self.choose_entry search_string, entries, confirm_even_if_one = false
+  def self.choose_entry search_string, entries, confirm_even_if_one = false, entry_no = nil
     # here we have a nuisance: we want the user to choose one entry
     # by relative id (e.g. the third found), but we need to return
     # the absolute id (to update the right entry in the safe)
@@ -68,14 +71,11 @@ module Pwss
     # ... so we just keep track of the real ids with an array
     #     the relative id is the index in the array
 
-    index = 0
     found = Array.new
-    entries.each do |entry|
+    entries.each_with_index do |entry, index|
       if entry["title"].downcase.include?(search_string.downcase)
-        print_entry found.size, entry
         found << index
       end
-      index += 1
     end
 
     if found.size == 0 then
@@ -83,7 +83,15 @@ module Pwss
       exit -1
     end
 
-    if found.size > 1 or confirm_even_if_one then
+    if entry_no then
+      # accept entry_no even if there is one entry
+      id = entry_no
+    elsif found.size > 1 or confirm_even_if_one then
+      # print the entry or the entries found together with their relative ids
+      found.each_with_index do |absolute_index, relative_index|
+        print_entry relative_index, entries[absolute_index]
+      end
+
       printf "\nVarious matches." if found.size > 1
       printf "\nSelect entry by ID (0..#{found.size-1}); -1 or empty string to exit: "
 
@@ -98,6 +106,7 @@ module Pwss
       end
     else
       id = 0
+      print_entry 0, entries[found[id]]
     end
 
     found[id]

data/lib/pwss/version.rb

@@ -1,3 +1,3 @@
 module Pwss
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pwss
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Adolfo Villafiorita
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-08 00:00:00.000000000 Z
+date: 2015-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler