kbsecret 0.5.4 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d434d011a5ebe51e4a0f41d54841808ba134cccb
-  data.tar.gz: caed655325cafac65f949dd221cb67eec29693a6
+  metadata.gz: a3c46fd341e3a2db07a7278ce4ef7e5e5f99f1ee
+  data.tar.gz: 9e236b7d3ad0c3396c76c85b3aa12b7f253376b9
 SHA512:
-  metadata.gz: 483587fd9c6d2053bc579035c581119780e531acb57970378202d77749043e4e6f0b9384ac2a62b6df217e9f04c46b95b56d732b0ca82e39d690d8e1030ce566
-  data.tar.gz: c0d70ec9cd4d87c49ee2286f7d445298cbe2d7849d2090f09d5e501d79d74d24d78785d93920a65ae89b0816a30ac5169bc29d92fad180477f0812169549e356
+  metadata.gz: 2ebe7c26ed449cb6ba40979682f36efd77315c16e4b09ccaa5148665eda1b86a933c2a5f1362c598494f538729e13a65e2cd83a3dca880a94485dfd8294578fe
+  data.tar.gz: 8adbafa4fec10a672742c4f3a4e44e4bedd802ee20c0b38bab67b18f7de8c7bdd4d43f0f1bd84d0fdfcb572ce430dec9bf76279cc0906472b11234952258338d

data/README.md

@@ -34,7 +34,7 @@ $ bundle install --path vendor/bundle
 $ RUBYLIB=./lib PATH=./bin:${PATH} bundle exec ./bin/kbsecret help
 ```
 
-You can also build installation packages:
+You can also build (very experimental) installation packages:
 
 ```bash
 $ bundle exec make deb # for apt/dpkg based systems
@@ -115,4 +115,4 @@ Please feel free to contribute completion scripts for other shells!
 * zsh/fish completions
 * facility for moving sessions (add users, change session label, etc)
 * glob for available sessions instead of requiring explicit configuration
-* complete general record unit tests, individual unit tests for record types and utilities
+* unit tests for command-line utilities

data/bin/kbsecret

@@ -15,7 +15,9 @@ end.freeze
 
 ALIASES = Hash.new { |_, k| k }.update(
   "--help" => "help",
-  "-h" => "help"
+  "-h" => "help",
+  "--version" => "version",
+  "-v" => "version"
 ).freeze
 
 ALL_CMDS = (ALIASES.keys + BUILTIN_CMDS + EXT_CMDS).freeze

data/bin/kbsecret-dump-fields

@@ -3,7 +3,9 @@
 
 require "kbsecret"
 
-cmd = KBSecret::CLI.new do
+include KBSecret
+
+cmd = CLI.new do
   slop do |o|
     o.banner = <<~EOS
       Dump all fields for the given record.
@@ -14,7 +16,7 @@ cmd = KBSecret::CLI.new do
 
     o.string "-s", "--session", "the session name", default: :default
     o.bool "-x", "--terse", "output in field:value format"
-    o.string "-i", "--ifs", "separate terse pairs with this string", default: ":"
+    o.string "-i", "--ifs", "separate terse pairs with this string", default: CLI.ifs
   end
 
   dreck do
@@ -22,12 +24,12 @@ cmd = KBSecret::CLI.new do
   end
 end
 
-session = KBSecret::CLI.ensure_session cmd.opts[:session]
+session = CLI.ensure_session cmd.opts[:session]
 
 label = cmd.args[:label]
 record = session[label]
 
-KBSecret::CLI.die "No such record." unless record
+CLI.die "No such record." unless record
 
 field_values = record.class.data_fields.map { |f| record.send f }
 field_pairs = record.class.data_fields.zip(field_values)

data/bin/kbsecret-env

@@ -3,7 +3,9 @@
 
 require "kbsecret"
 
-cmd = KBSecret::CLI.new do
+include KBSecret
+
+cmd = CLI.new do
   slop do |o|
     o.banner = <<~EOS
       Retrieve environment records in a source-able format.
@@ -26,7 +28,7 @@ cmd = KBSecret::CLI.new do
   end
 end
 
-session = KBSecret::CLI.ensure_session cmd.opts[:session]
+session = CLI.ensure_session cmd.opts[:session]
 records = session.records :environment
 
 selected_records = if cmd.opts.all?

data/bin/kbsecret-list

@@ -3,7 +3,9 @@
 
 require "kbsecret"
 
-cmd = KBSecret::CLI.new do
+include KBSecret
+
+cmd = CLI.new do
   slop do |o|
     o.banner = <<~EOS
       List all secrets known to the specified session (or the default session).
@@ -18,7 +20,7 @@ cmd = KBSecret::CLI.new do
   end
 end
 
-session = KBSecret::CLI.ensure_session cmd.opts[:session]
+session = CLI.ensure_session cmd.opts[:session]
 
 records = session.records cmd.opts[:type]
 

data/bin/kbsecret-login

@@ -3,7 +3,9 @@
 
 require "kbsecret"
 
-cmd = KBSecret::CLI.new do
+include KBSecret
+
+cmd = CLI.new do
   slop do |o|
     o.banner = <<~EOS
       Retrieve login records.
@@ -19,7 +21,7 @@ cmd = KBSecret::CLI.new do
     o.string "-s", "--session", "the session name", default: :default
     o.bool "-a", "--all", "retrieve all login records, not just listed ones"
     o.bool "-x", "--terse", "output in label:username:password format"
-    o.string "-i", "--ifs", "separate terse fields with this string", default: ":"
+    o.string "-i", "--ifs", "separate terse fields with this string", default: CLI.ifs
   end
 
   dreck do
@@ -27,7 +29,7 @@ cmd = KBSecret::CLI.new do
   end
 end
 
-session = KBSecret::CLI.ensure_session cmd.opts[:session]
+session = CLI.ensure_session cmd.opts[:session]
 records = session.records :login
 
 selected_records = if cmd.opts.all?

data/bin/kbsecret-new

@@ -5,10 +5,12 @@ require "kbsecret"
 require "abbrev"
 require "tty-prompt"
 
+include KBSecret
+
 # allows for abbreviated types (e.g., `kbsecret new env ...`)
-TYPE_ALIASES = Abbrev.abbrev(KBSecret::Record.record_types).freeze
+TYPE_ALIASES = Abbrev.abbrev(Record.record_types).freeze
 
-cmd = KBSecret::CLI.new do
+cmd = CLI.new do
   slop do |o|
     o.banner = <<~EOS
       Create a new secret record.
@@ -35,19 +37,19 @@ cmd = KBSecret::CLI.new do
   end
 end
 
-session = KBSecret::CLI.ensure_session cmd.opts[:session]
+session = CLI.ensure_session cmd.opts[:session]
 
 type          = cmd.args[:type]
 label         = cmd.args[:label]
 resolved_type = TYPE_ALIASES[type]
 
 if session.record?(label) && !cmd.opts.force?
-  KBSecret::CLI.die "Refusing to overwrite an existing record without --force."
+  CLI.die "Refusing to overwrite an existing record without --force."
 end
 
 fields = if $stdin.tty? && !cmd.opts.args?
            prompt = TTY::Prompt.new
-           klass = KBSecret::Record.class_for(resolved_type)
+           klass = Record.class_for(resolved_type)
            klass.data_fields.map do |field|
              prompt.ask("#{field.capitalize}?", echo: cmd.opts.echo?)
            end
@@ -58,5 +60,5 @@ fields = if $stdin.tty? && !cmd.opts.args?
 begin
   session.add_record(resolved_type, label, *fields)
 rescue => e
-  KBSecret::CLI.die "#{e}."
+  CLI.die "#{e}."
 end

data/bin/kbsecret-new-session

@@ -4,7 +4,9 @@
 require "keybase"
 require "kbsecret"
 
-cmd = KBSecret::CLI.new do
+include KBSecret
+
+cmd = CLI.new do
   slop do |o|
     o.banner = <<~EOS
       Create a new session.
@@ -25,8 +27,8 @@ end
 
 session_label = cmd.opts[:label]
 
-if KBSecret::Config.session?(session_label) && !cmd.opts.force?
-  KBSecret::CLI.die "Refusing to overwrite an existing session without --force."
+if Config.session?(session_label) && !cmd.opts.force?
+  CLI.die "Refusing to overwrite an existing session without --force."
 end
 
 session_hash = {
@@ -34,4 +36,4 @@ session_hash = {
   root: cmd.opts[:root],
 }
 
-KBSecret::Config.configure_session(session_label, session_hash)
+Config.configure_session(session_label, session_hash)

data/bin/kbsecret-pass

@@ -4,7 +4,9 @@
 require "kbsecret"
 require "clipboard"
 
-cmd = KBSecret::CLI.new do
+include KBSecret
+
+cmd = CLI.new do
   slop do |o|
     o.banner = <<~EOS
       Retrieve a login record's password.
@@ -26,12 +28,12 @@ cmd = KBSecret::CLI.new do
   end
 end
 
-session = KBSecret::CLI.ensure_session cmd.opts[:session]
+session = CLI.ensure_session cmd.opts[:session]
 label   = cmd.args[:label]
 record  = session[label]
 
-KBSecret::CLI.die "No such record." unless record
-KBSecret::CLI.die "'#{record}' is not a login record." unless record.type == :login
+CLI.die "No such record." unless record
+CLI.die "'#{record}' is not a login record." unless record.type == :login
 
 if cmd.opts.clipboard?
   Clipboard.copy record.password

data/bin/kbsecret-raw-edit

@@ -3,7 +3,9 @@
 
 require "kbsecret"
 
-cmd = KBSecret::CLI.new do
+include KBSecret
+
+cmd = CLI.new do
   slop do |o|
     o.banner = <<~EOS
       Edit the raw JSON of a record in $EDITOR.
@@ -23,11 +25,11 @@ cmd = KBSecret::CLI.new do
   end
 end
 
-session = KBSecret::CLI.ensure_session cmd.opts[:session]
+session = CLI.ensure_session cmd.opts[:session]
 label   = cmd.args[:label]
 record  = session[label]
 
-KBSecret::CLI.die "No such record." unless record
+CLI.die "No such record." unless record
 
 Process.spawn("#{ENV["EDITOR"]} #{record.path}")
 record.sync! # just to bump the timestamp

data/bin/kbsecret-rm

@@ -4,9 +4,11 @@
 require "kbsecret"
 require "tty-prompt"
 
+include KBSecret
+
 $VERBOSE = nil # tty-prompt blasts us with irrelevant warnings on 2.4
 
-cmd = KBSecret::CLI.new do
+cmd = CLI.new do
   slop do |o|
     o.banner = <<~EOS
       Delete a record.
@@ -25,10 +27,10 @@ cmd = KBSecret::CLI.new do
 end
 
 label   = cmd.args[:label]
-session = KBSecret::CLI.ensure_session cmd.opts[:session]
+session = CLI.ensure_session cmd.opts[:session]
 
-KBSecret::CLI.die "I need the label of a record to delete." unless label
-KBSecret::CLI.die "I can't delete a nonexistent record." unless session.record? label
+CLI.die "I need the label of a record to delete." unless label
+CLI.die "I can't delete a nonexistent record." unless session.record? label
 
 tty = TTY::Prompt.new
 

data/bin/kbsecret-rm-session

@@ -3,7 +3,9 @@
 
 require "kbsecret"
 
-cmd = KBSecret::CLI.new do
+include KBSecret
+
+cmd = CLI.new do
   slop do |o|
     o.banner = <<~EOS
       Deconfigure (and optionally delete) a session.
@@ -26,7 +28,7 @@ end
 
 label = cmd.args[:label]
 
-session = KBSecret::CLI.ensure_session label
+session = CLI.ensure_session label
 session.unlink! if cmd.opts.delete?
 
-KBSecret::Config.deconfigure_session label
+Config.deconfigure_session label

data/bin/kbsecret-sessions

@@ -3,7 +3,9 @@
 
 require "kbsecret"
 
-cmd = KBSecret::CLI.new do
+include KBSecret
+
+cmd = CLI.new do
   slop do |o|
     o.banner = <<~EOS
       List all available sessions.
@@ -17,9 +19,9 @@ cmd = KBSecret::CLI.new do
   end
 end
 
-KBSecret::Config.session_labels.each do |sess_name|
-  session_hash = KBSecret::Config.session(sess_name)
-  session      = KBSecret::Session.new label: sess_name
+Config.session_labels.each do |sess_name|
+  session_hash = Config.session(sess_name)
+  session      = Session.new label: sess_name
 
   puts sess_name
 

data/bin/kbsecret-stash-file

@@ -3,7 +3,9 @@
 
 require "kbsecret"
 
-cmd = KBSecret::CLI.new do
+include KBSecret
+
+cmd = CLI.new do
   slop do |o|
     o.banner = <<~EOS
       Stash the given file (or stdin) as an unstructured record.
@@ -25,18 +27,18 @@ cmd = KBSecret::CLI.new do
   end
 end
 
-session  = KBSecret::CLI.ensure_session cmd.opts[:session]
+session  = CLI.ensure_session cmd.opts[:session]
 label    = cmd.args[:label]
 filename = cmd.args[:filename]
 
-KBSecret::CLI.die "Missing a record label to create." unless label
+CLI.die "Missing a record label to create." unless label
 
 contents = if filename.empty? || filename == "-"
              STDIN.read
            elsif File.file?(filename)
              File.read(filename)
            else
-             KBSecret::CLI.die "That file doesn't exist."
+             CLI.die "That file doesn't exist."
            end
 
 session.add_record(:unstructured, label, contents)

data/bin/kbsecret-todo

@@ -3,7 +3,9 @@
 
 require "kbsecret"
 
-cmd = KBSecret::CLI.new do
+include KBSecret
+
+cmd = CLI.new do
   slop cmds: %w[start suspend complete] do |o|
     o.banner = <<~EOS
       Manage 'to do' records.
@@ -26,27 +28,27 @@ cmd = KBSecret::CLI.new do
   end
 end
 
-session = KBSecret::CLI.ensure_session cmd.opts[:session]
+session = CLI.ensure_session cmd.opts[:session]
 label   = cmd.args[:label]
 
 todo = session[label]
 
-KBSecret::CLI.die "No such record." unless todo
-KBSecret::CLI.die "'#{todo}' is not a todo record." unless todo.type == :todo
+CLI.die "No such record." unless todo
+CLI.die "'#{todo}' is not a todo record." unless todo.type == :todo
 
 case cmd.args[:command]
 when "start"
-  KBSecret::CLI.die "That task is already started!" if todo.started?
+  CLI.die "That task is already started!" if todo.started?
   todo.start!
   puts "#{todo.label}: '#{todo.todo}' marked as started at #{todo.start}"
 when "suspend"
-  KBSecret::CLI.die "That task is already suspended!" if todo.suspended?
+  CLI.die "That task is already suspended!" if todo.suspended?
   todo.suspend!
   puts "#{todo.label}: '#{todo.todo}' marked as suspended at #{todo.stop}"
 when "complete"
-  KBSecret::CLI.die "That task is already completed!" if todo.completed?
+  CLI.die "That task is already completed!" if todo.completed?
   todo.complete!
   puts "#{todo.label}: '#{todo.todo}' marked as completed at #{todo.stop}"
 else
-  KBSecret::CLI.die "Unknown action: #{command}."
+  CLI.die "Unknown action: #{command}."
 end

data/lib/kbsecret/cli.rb

@@ -91,6 +91,13 @@ module KBSecret
         Session.new label: sess_label
       end
 
+      # Finds a reasonable default field separator by checking the environment first
+      #  and then falling back to ":".
+      # @return [String] the field separator
+      def ifs
+        ENV["IFS"] || ":"
+      end
+
       # Parse arguments for a kbsecret utility, adding some default options for
       #  introspection and help output.
       # @param cmds [Array<String>] additional commands to print in `--introspect-flags`

data/lib/version.rb

@@ -2,5 +2,5 @@
 
 module KBSecret
   # kbsecret's current version
-  VERSION = "0.5.4"
+  VERSION = "0.5.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kbsecret
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.5
 platform: ruby
 authors:
 - William Woodruff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-24 00:00:00.000000000 Z
+date: 2017-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fpm
@@ -153,20 +153,20 @@ dependencies:
 description: Manages your passwords, environment, and more via KBFS.
 email: william@tuffbizz.com
 executables:
-- kbsecret-sessions
-- kbsecret-raw-edit
-- kbsecret-stash-file
-- kbsecret-new-session
-- kbsecret-new
-- kbsecret-dump-fields
+- kbsecret-pass
+- kbsecret
 - kbsecret-rm
-- kbsecret-list
 - kbsecret-login
+- kbsecret-raw-edit
 - kbsecret-todo
-- kbsecret-pass
-- kbsecret-env
+- kbsecret-new
+- kbsecret-dump-fields
+- kbsecret-stash-file
 - kbsecret-rm-session
-- kbsecret
+- kbsecret-env
+- kbsecret-new-session
+- kbsecret-list
+- kbsecret-sessions
 extensions: []
 extra_rdoc_files: []
 files: