kbsecret 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 04bf388d61371a29a5f721a4a39a03037fbd674c
-  data.tar.gz: 4bc34dd530c79ecb34816c0013a36c47ecb969e4
+  metadata.gz: 78a85052182c04cc8a63759dfe1ffebcab9febf1
+  data.tar.gz: 57cf4570ac91c7ef25a3533f7ac1750d7b1dd510
 SHA512:
-  metadata.gz: 6933f6c00c8ced6ebec24956790109f0238324e69194637fe7cabbb8be7cdac21e5de9732eba3c043f8cbc92d93def83195682013c1d019aca497423a04ff44a
-  data.tar.gz: 3fbd02c35aaf1531b0365e7475ab3047c6b07ac442bd83f195d656b613fae4d1a3f8e4d450ce1d770312c59a61fc4518f4e3e084f60ac425c0105ce02f071ed4
+  metadata.gz: 4f98b14697eae67ab73822f4629793da398087003d701f74b123415a5f20cdf666919a886ef599564505bd5fe49f46f767dcd6656ca851f5351ecaa3356a74e3
+  data.tar.gz: 02ceed6620e31589f595ef39fdd50bb669739845d1ef1fb5c74a7e0f4c0b68e760d554207db59aaf2468b49ce936929955e420de1703b84c5605ee9da7eb59d4

data/bin/kbsecret

@@ -29,7 +29,7 @@ KBSECRET_HELP = <<~EOS
   Available commands:
     #{ALL_CMDS.join(", ")}
 
-  More more information about a particular command, try:
+  For more information about a particular command, try:
     kbsecret help <command>
 EOS
 

data/bin/kbsecret-dump-fields

@@ -8,10 +8,8 @@ include KBSecret
 cmd = CLI.new do
   slop do |o|
     o.banner = <<~EOS
-      Dump all fields for the given record.
-
       Usage:
-        kbsecret dump-fields [--session <session>] <record>
+        kbsecret dump-fields [options] <record>
     EOS
 
     o.string "-s", "--session", "the session to search in", default: :default

data/bin/kbsecret-env

@@ -8,14 +8,8 @@ include KBSecret
 cmd = CLI.new do
   slop do |o|
     o.banner = <<~EOS
-      Retrieve environment records in a source-able format.
-
       Usage:
-        kbsecret env [--session <session>] [--all] <record [record ...]>
-
-      Examples:
-        kbsecret env --all
-        kbsecret env staging beta
+        kbsecret env [options] <record [record ...]>
     EOS
 
     o.string "-s", "--session", "the session to search in", default: :default

data/bin/kbsecret-list

@@ -8,10 +8,8 @@ include KBSecret
 cmd = CLI.new do
   slop do |o|
     o.banner = <<~EOS
-      List all secrets known to the specified session (or the default session).
-
       Usage:
-        kbsecret list [--session <session>] [--show-all]
+        kbsecret list [options]
     EOS
 
     o.string "-s", "--session", "the session to list from", default: :default

data/bin/kbsecret-login

@@ -8,14 +8,8 @@ include KBSecret
 cmd = CLI.new do
   slop do |o|
     o.banner = <<~EOS
-      Retrieve login records.
-
       Usage:
-        kbsecret login [--session <session>] <record [record ...]>
-
-      Examples:
-        kbsecret login --terse --ifs "*" gmail
-        kbsecret login gmail netflix
+        kbsecret login [options] <record [record ...]>
     EOS
 
     o.string "-s", "--session", "the session to search in", default: :default

data/bin/kbsecret-new

@@ -13,15 +13,9 @@ TYPE_ALIASES = Abbrev.abbrev(Record.record_types).freeze
 cmd = CLI.new do
   slop do |o|
     o.banner = <<~EOS
-      Create a new secret record.
-
       Usage:
         kbsecret new [options] <type> <label>
         kbsecret new [options] --args <type> <label> <fields>
-
-      Examples:
-        kbsecret new login gmail
-        kbsecret new environment foo-api
     EOS
 
     o.string "-s", "--session", "the session to contain the record", default: :default

data/bin/kbsecret-new-session

@@ -9,18 +9,13 @@ include KBSecret
 cmd = CLI.new do
   slop do |o|
     o.banner = <<~EOS
-      Create a new session.
-
       Usage:
-        kbsecret new-session --label <label> --users <user1,...> --root <dir>
-
-      Example:
-        kbsecret new-session -l dev -u me,otherperson -r devsecrets
+        kbsecret new-session [options] --label <label> --root <dir>
     EOS
 
-    o.string "-l", "--label", "the session label", default: :default
+    o.string "-l", "--label", "the session label"
     o.array "-u", "--users", "the keybase users", default: [Keybase.current_user]
-    o.string "-r", "--root", "the secret root directory", default: "kbsecret"
+    o.string "-r", "--root", "the secret root directory"
     o.bool "-f", "--force", "force creation (ignore overwrites, etc.)"
   end
 end

data/bin/kbsecret-pass

@@ -9,14 +9,8 @@ include KBSecret
 cmd = CLI.new do
   slop do |o|
     o.banner = <<~EOS
-      Retrieve a login record's password.
-
       Usage:
-        kbsecret pass [--session <session>] [--clipboard] <record>
-
-      Examples:
-        kbsecret pass gmail | xclip
-        kbsecret pass --clipboard gmail
+        kbsecret pass [options] <record>
     EOS
 
     o.string "-s", "--session", "the session to search in", default: :default

data/bin/kbsecret-raw-edit

@@ -8,13 +8,8 @@ include KBSecret
 cmd = CLI.new do
   slop do |o|
     o.banner = <<~EOS
-      Edit the raw JSON of a record in $EDITOR.
-
       Usage:
-        kbsecret raw-edit [--session <session>] <record>
-
-      Examples:
-        kbsecret raw-edit gmail
+        kbsecret raw-edit [options] <record>
     EOS
 
     o.string "-s", "--session", "the session to search in", default: :default

data/bin/kbsecret-rm

@@ -11,10 +11,8 @@ $VERBOSE = nil # tty-prompt blasts us with irrelevant warnings on 2.4
 cmd = CLI.new do
   slop do |o|
     o.banner = <<~EOS
-      Delete a record.
-
       Usage:
-        kbsecret rm [--session <session>] [--interactive] <record>
+        kbsecret rm [options] <record>
     EOS
 
     o.string "-s", "--session", "the session containing the record", default: :default

data/bin/kbsecret-rm-session

@@ -8,14 +8,8 @@ include KBSecret
 cmd = CLI.new do
   slop do |o|
     o.banner = <<~EOS
-      Deconfigure (and optionally delete) a session.
-
       Usage:
-        kbsecret rm-session [--delete] <session>
-
-      Example:
-        kbsecret rm-session old-keys
-        kbsecret rm-session --delete even-older-keys
+        kbsecret rm-session [options] <session>
     EOS
 
     o.bool "-d", "--delete", "unlink the session in addition to deconfiguration"

data/bin/kbsecret-sessions

@@ -8,11 +8,8 @@ include KBSecret
 cmd = CLI.new do
   slop do |o|
     o.banner = <<~EOS
-      List all available sessions.
-      The sessions listed can be passed to other commands via the -s flag.
-
       Usage:
-        kbsecret sessions [--show-all]
+        kbsecret sessions [options]
     EOS
 
     o.bool "-a", "--show-all", "show each session in depth (i.e. metadata)"

data/bin/kbsecret-stash-file

@@ -8,14 +8,8 @@ include KBSecret
 cmd = CLI.new do
   slop do |o|
     o.banner = <<~EOS
-      Stash the given file (or stdin) as an unstructured record.
-
       Usage:
         kbsecret stash-file <record> [file]
-
-      Example:
-        kbsecret stash-file foo ~/foo
-        echo "using stdin" | kbsecret stash-file from-stdin
     EOS
 
     o.string "-s", "--session", "the session to add to", default: :default

data/bin/kbsecret-todo

@@ -8,15 +8,8 @@ include KBSecret
 cmd = CLI.new do
   slop cmds: %w[start suspend complete] do |o|
     o.banner = <<~EOS
-      Manage 'to do' records.
-
       Usage:
         kbsecret todo <start|suspend|complete> <record>
-
-      Examples:
-        kbsecret todo start unit-tests
-        kbsecret todo suspend laundry
-        kbsecret todo complete shopping
     EOS
 
     o.string "-s", "--session", "the session to search in", default: :default

data/lib/kbsecret/cli.rb

@@ -36,25 +36,30 @@ module KBSecret
       @args = nil
       instance_eval(&block)
     rescue => e
-      self.class.die e.to_s.capitalize
+      self.class.die "#{e.to_s.capitalize}."
     end
 
     # Parse options for a kbsecret utility, adding some default options for
-    #  introspection and help output.
+    #  introspection, verbosity, and help output.
     # @param cmds [Array<String>] additional commands to print in `--introspect-flags`
     # @param errors [Boolean] whether or not to produce Slop errors
     # @return [Slop::Result] the result of argument parsing
     # @note This should be called within the block passed to {#initialize}.
-    def slop(cmds: [], errors: false)
+    def slop(cmds: [], errors: true)
       @opts = Slop.parse suppress_errors: !errors do |o|
+        o.separator "Options:"
+
         yield o
 
-        o.on "-h", "--help" do
+        o.bool "-V", "--verbose", "produce more verbose output"
+        o.bool "-w", "--no-warn", "suppress warning messages"
+
+        o.on "-h", "--help", "show this help message" do
           puts o
           exit
         end
 
-        o.on "--introspect-flags" do
+        o.on "--introspect-flags", "dump recognized flags and subcommands" do
           comp = o.options.flat_map(&:flags) + cmds
           puts comp.join "\n"
           exit
@@ -86,7 +91,32 @@ module KBSecret
     #   options or arguments are being tested for a valid session.
     def ensure_session!(where = :option)
       label = where == :option ? @opts[:session] : @args[:session]
-      raise "Unknown session: '#{label}'." unless Config.session? label
+      raise "Unknown session: '#{label}'" unless Config.session? label
+    end
+
+    # Print an informational message if verbose output has been enabled.
+    # @param msg [String] the message to print
+    # @return [void]
+    def info(msg)
+      return unless @opts.verbose?
+      STDERR.puts "#{"Info".green}: #{msg}"
+    end
+
+    # Print a warning message unless warnings have been suppressed.
+    # @param msg [String] the message to print
+    # @return [void]
+    def warn(msg)
+      return if @opts.no_warn?
+      STDERR.puts "#{"Warning".yellow}: #{msg}"
+    end
+
+    # Print an error message and terminate.
+    # @param msg [String] the message to print
+    # @return [void]
+    # @note This method does not return!
+    def die(msg)
+      pretty = "#{"Fatal".red}: #{msg}"
+      abort pretty
     end
 
     class << self
@@ -94,51 +124,18 @@ 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
       end
 
-      # Instantiate a session if it exists, and terminate otherwise.
-      # @param sess_label [String, Symbol] the session label to instantiate
-      # @return [void]
-      # @note This method does not return if the given session is not configured!
-      # @deprecated Use {#ensure_session!} instead.
-      def ensure_session(sess_label)
-        die "Unknown session: '#{sess_label}'." unless Config.session? sess_label
-
-        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`
-      # @param errors [Boolean] whether or not to produce Slop errors
-      # @return [Slop::Result] the result of argument parsing
-      # @deprecated Use {#initialize} instead.
-      def slop(cmds: [], errors: false)
-        Slop.parse suppress_errors: !errors do |o|
-          yield o
-
-          o.on "-h", "--help" do
-            puts o
-            exit
-          end
-
-          o.on "--introspect-flags" do
-            comp = o.options.flat_map(&:flags) + cmds
-            puts comp.join "\n"
-            exit
-          end
-        end
-      end
     end
   end
 end

data/lib/kbsecret/record/todo.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KBSecret
   module Record
     # Represents a record containing a 'to do' item and its status.

data/lib/version.rb

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

metadata

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