kbsecret 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78a85052182c04cc8a63759dfe1ffebcab9febf1
-  data.tar.gz: 57cf4570ac91c7ef25a3533f7ac1750d7b1dd510
+  metadata.gz: d8b8f4651e863a5f86291010e03b05ce5755f1c2
+  data.tar.gz: d8c56ff9124e244f352e3fe02101ac7e85c62314
 SHA512:
-  metadata.gz: 4f98b14697eae67ab73822f4629793da398087003d701f74b123415a5f20cdf666919a886ef599564505bd5fe49f46f767dcd6656ca851f5351ecaa3356a74e3
-  data.tar.gz: 02ceed6620e31589f595ef39fdd50bb669739845d1ef1fb5c74a7e0f4c0b68e760d554207db59aaf2468b49ce936929955e420de1703b84c5605ee9da7eb59d4
+  metadata.gz: 23ddcab27f3bce089b8905a147d85ec5e8abfa053f157a02ef08eb21413e021aa3d7a66fbe678a21efc45240b979820a2a6fc09ecf6bd6ec61ebcdaa9745c2be
+  data.tar.gz: da1bbc994c6e861e8f3a5f9092c5dab9541b2029d4b6306b11d3c4c84bbbc7facf2046eb03e6fd6fb67658e94e9ef6c66e1ed2a0b21b3d245e0dc9c918f8d8b0

data/bin/kbsecret-dump-fields

@@ -24,11 +24,10 @@ cmd = CLI.new do
   ensure_session!
 end
 
-session = Session.new label: cmd.opts[:session]
 label   = cmd.args[:label]
-record  = session[label]
+record  = cmd.session[label]
 
-CLI.die "No such record." unless record
+cmd.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

@@ -24,8 +24,7 @@ cmd = CLI.new do
   ensure_session!
 end
 
-session = Session.new label: cmd.opts[:session]
-records = session.records :environment
+records = cmd.session.records :environment
 
 selected_records = if cmd.opts.all?
                      records
@@ -35,6 +34,8 @@ selected_records = if cmd.opts.all?
                      end
                    end
 
+cmd.warn "No records selected." if selected_records.empty?
+
 selected_records.each do |record|
   if cmd.opts.value_only?
     puts record.value

data/bin/kbsecret-list

@@ -20,9 +20,7 @@ cmd = CLI.new do
   ensure_session!
 end
 
-session = Session.new label: cmd.opts[:session]
-
-records = session.records cmd.opts[:type]
+records = cmd.session.records cmd.opts[:type]
 
 records.each do |record|
   puts record.label

data/bin/kbsecret-login

@@ -25,8 +25,7 @@ cmd = CLI.new do
   ensure_session!
 end
 
-session = Session.new label: cmd.opts[:session]
-records = session.records :login
+records = cmd.session.records :login
 
 selected_records = if cmd.opts.all?
                      records
@@ -36,6 +35,8 @@ selected_records = if cmd.opts.all?
                      end
                    end
 
+cmd.warn "No records selected." if selected_records.empty?
+
 selected_records.each do |record|
   if cmd.opts.terse?
     fields = %i[label username password].map { |m| record.send(m) }

data/bin/kbsecret-new

@@ -33,14 +33,12 @@ cmd = CLI.new do
   ensure_session!
 end
 
-session = Session.new label: cmd.opts[:session]
-
 type          = cmd.args[:type]
 label         = cmd.args[:label]
 resolved_type = TYPE_ALIASES[type]
 
-if session.record?(label) && !cmd.opts.force?
-  CLI.die "Refusing to overwrite an existing record without --force."
+if cmd.session.record?(label) && !cmd.opts.force?
+  cmd.die "Refusing to overwrite an existing record without --force."
 end
 
 fields = if $stdin.tty? && !cmd.opts.args?
@@ -55,7 +53,7 @@ fields = if $stdin.tty? && !cmd.opts.args?
          end
 
 begin
-  session.add_record(resolved_type, label, *fields)
+  cmd.session.add_record(resolved_type, label, *fields)
 rescue => e
-  CLI.die "#{e}."
+  cmd.die "#{e}."
 end

data/bin/kbsecret-new-session

@@ -23,7 +23,7 @@ end
 session_label = cmd.opts[:label]
 
 if Config.session?(session_label) && !cmd.opts.force?
-  CLI.die "Refusing to overwrite an existing session without --force."
+  cmd.die "Refusing to overwrite an existing session without --force."
 end
 
 session_hash = {

data/bin/kbsecret-pass

@@ -24,12 +24,11 @@ cmd = CLI.new do
   ensure_session!
 end
 
-session = Session.new label: cmd.opts[:session]
 label   = cmd.args[:label]
-record  = session[label]
+record  = cmd.session[label]
 
-CLI.die "No such record." unless record
-CLI.die "'#{record}' is not a login record." unless record.type == :login
+cmd.die "No such record." unless record
+cmd.die "'#{record}' is not a login record." unless record.type == :login
 
 if cmd.opts.clipboard?
   Clipboard.copy record.password

data/bin/kbsecret-raw-edit

@@ -22,11 +22,10 @@ cmd = CLI.new do
   ensure_session!
 end
 
-session = Session.new label: cmd.opts[:session]
 label   = cmd.args[:label]
-record  = session[label]
+record  = cmd.session[label]
 
-CLI.die "No such record." unless record
+cmd.die "No such record." unless record
 
 Process.spawn("#{ENV["EDITOR"]} #{record.path}")
 record.sync! # just to bump the timestamp

data/bin/kbsecret-rm

@@ -26,16 +26,15 @@ cmd = CLI.new do
   ensure_session!
 end
 
-label   = cmd.args[:label]
-session = Session.new label: cmd.opts[:session]
+label = cmd.args[:label]
 
-CLI.die "I can't delete a nonexistent record." unless session.record? label
+cmd.die "Can't delete a nonexistent record." unless cmd.session.record? label
 
 tty = TTY::Prompt.new
 
 confirm = if cmd.opts.interactive?
-            tty.yes?("Delete '#{label}' from the #{session.label} session?")
+            tty.yes?("Delete '#{label}' from the #{cmd.session.label} session?")
           else true
           end
 
-session.delete_record(label) if confirm
+cmd.session.delete_record(label) if confirm

data/bin/kbsecret-rm-session

@@ -24,7 +24,6 @@ end
 
 label = cmd.args[:session]
 
-session = Session.new label: label
-session.unlink! if cmd.opts.delete?
+cmd.session.unlink! if cmd.opts.delete?
 
 Config.deconfigure_session label

data/bin/kbsecret-sessions

@@ -18,7 +18,7 @@ end
 
 Config.session_labels.each do |sess_name|
   session_hash = Config.session(sess_name)
-  session      = Session.new label: sess_name
+  session      = cmd.guard { Session.new label: sess_name }
 
   puts sess_name
 

data/bin/kbsecret-stash-file

@@ -23,18 +23,17 @@ cmd = CLI.new do
   ensure_session!
 end
 
-session  = Session.new label: cmd.opts[:session]
 label    = cmd.args[:label]
 filename = cmd.args[:filename]
 
-CLI.die "Missing a record label to create." unless label
+cmd.die "Missing a record label to create." unless label
 
 contents = if filename.empty? || filename == "-"
              STDIN.read
            elsif File.file?(filename)
              File.read(filename)
            else
-             CLI.die "That file doesn't exist."
+             cmd.die "That file doesn't exist."
            end
 
-session.add_record(:unstructured, label, contents)
+cmd.session.add_record(:unstructured, label, contents)

data/bin/kbsecret-todo

@@ -23,26 +23,25 @@ cmd = CLI.new do
   ensure_session!
 end
 
-session = Session.new label: cmd.opts[:session]
 label   = cmd.args[:label]
-todo    = session[label]
+todo    = cmd.session[label]
 
-CLI.die "No such record." unless todo
-CLI.die "'#{todo}' is not a todo record." unless todo.type == :todo
+cmd.die "No such record." unless todo
+cmd.die "'#{todo}' is not a todo record." unless todo.type == :todo
 
 case cmd.args[:command]
 when "start"
-  CLI.die "That task is already started!" if todo.started?
+  cmd.die "That task is already started!" if todo.started?
   todo.start!
   puts "#{todo.label}: '#{todo.todo}' marked as started at #{todo.start}"
 when "suspend"
-  CLI.die "That task is already suspended!" if todo.suspended?
+  cmd.die "That task is already suspended!" if todo.suspended?
   todo.suspend!
   puts "#{todo.label}: '#{todo.todo}' marked as suspended at #{todo.stop}"
 when "complete"
-  CLI.die "That task is already completed!" if todo.completed?
+  cmd.die "That task is already completed!" if todo.completed?
   todo.complete!
   puts "#{todo.label}: '#{todo.todo}' marked as completed at #{todo.stop}"
 else
-  CLI.die "Unknown action: #{command}."
+  cmd.die "Unknown action: #{command}."
 end

data/lib/kbsecret/cli.rb

@@ -7,12 +7,18 @@ require "dreck"
 module KBSecret
   # An encapsulation of useful methods for kbsecret's CLI.
   class CLI
-    # @return [Slop::Result] the result of option parsing
+    # @return [Slop::Result, nil] the result of option parsing, if requested
+    #   via {#slop}
     attr_reader :opts
 
-    # @return [Dreck::Result] the result of trailing argument parsing
+    # @return [Dreck::Result, nil] the result of trailing argument parsing, if
+    #   requested via {#dreck}
     attr_reader :args
 
+    # @return [Session, nil] the session associated with the command, if requested
+    #   via {#ensure_session!}
+    attr_reader :session
+
     # Encapsulate both the options and trailing arguments passed to a `kbsecret` command.
     # @example
     #  cmd = KBSecret::CLI.new do
@@ -32,11 +38,7 @@ module KBSecret
     #  cmd.args # => Dreck::Result
     def initialize(&block)
       @trailing = ARGV
-      @opts = nil
-      @args = nil
-      instance_eval(&block)
-    rescue => e
-      self.class.die "#{e.to_s.capitalize}."
+      guard { instance_eval(&block) }
     end
 
     # Parse options for a kbsecret utility, adding some default options for
@@ -92,6 +94,18 @@ module KBSecret
     def ensure_session!(where = :option)
       label = where == :option ? @opts[:session] : @args[:session]
       raise "Unknown session: '#{label}'" unless Config.session? label
+      @session = Session.new label: label
+    end
+
+    # "Guard" a block by propagating any exceptions as fatal (unrecoverable)
+    #   errors.
+    # @return [Object] the result of the block
+    # @note This should be used to guard chunks of code that are likely to
+    #   raise exceptions. The amount of code guarded should be minimized.
+    def guard
+      yield
+    rescue => e
+      die "#{e.to_s.capitalize}."
     end
 
     # Print an informational message if verbose output has been enabled.
@@ -124,7 +138,6 @@ module KBSecret
       # @param msg [String] the message to print
       # @return [void]
       # @note This method does not return!
-      # @deprecated use {#die} instead.
       def die(msg)
         pretty = "#{"Fatal".red}: #{msg}"
         abort pretty

data/lib/kbsecret/exceptions.rb

@@ -5,6 +5,14 @@ module KBSecret
   class KBSecretError < RuntimeError
   end
 
+  # Raised during record loading if a particular file can't be loaded
+  class RecordLoadError < KBSecretError
+    def initialize(path)
+      base = File.basename(path)
+      super "Failed to load record in file: #{base}"
+    end
+  end
+
   # Raised during record creation if an unknown record type is requested.
   class RecordTypeUnknownError < KBSecretError
     def initialize(type)

data/lib/kbsecret/record.rb

@@ -44,6 +44,8 @@ module KBSecret
       hsh   = JSON.parse(File.read(path), symbolize_names: true)
       klass = record_classes.find { |c| c.type == hsh[:type].to_sym }
       klass&.load!(session, hsh)
+    rescue
+      raise RecordLoadError, path
     end
   end
 end

data/lib/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kbsecret
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - William Woodruff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-04 00:00:00.000000000 Z
+date: 2017-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fpm