kbsecret 0.9.2 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ea5a40cccc819bf7cb2bb06da3c6bb9dd229dd9
-  data.tar.gz: 73eff88e740a90839345b06590ff6a1d3f48ce96
+  metadata.gz: 85210b583f9f421d8e922ae4de0e1cf561f133ee
+  data.tar.gz: 07d1ce007b5b149f147e9079191875c39ca9e6f2
 SHA512:
-  metadata.gz: 73aad2d0a5668860063dfabb86496b56860a2ec5010d7f2df1d29761a5dd4e915fbb97d201f015dcdd6e33b93c6e9460329d9cfb7087af5e5af5881aa7b5dd18
-  data.tar.gz: 8c874c9a2a838e5f130bb4c3629d6212ba88ba0fafbcee32e1cdbcfa32138c0d737c07258261ec9dcb36b1d1cb00de5e7bf5dff3a5c3b52ddae90766739dc429
+  metadata.gz: 8ef1b720fa023840e640d1f608adf5e98c58c9af8822ef20fc2222fefd836c1aa5071851685f6594ca975711b2ac4c81c5f41dca2586149aa7d03d19cbfeece8
+  data.tar.gz: d5f854aaa737f0da2092e54452f54663cefbe0603b8be0806ac7bd98b99e5d85a660d150b2a5e6b39c8ebb0684493a2d7db17edfa0601793a8423359563228f9

data/README.md

@@ -50,9 +50,9 @@ $ cp man/*.1 ${YOUR_MAN_DIR}
 
 ### Shell Completion
 
-KBSecret provides shell completion functions for bash.
+KBSecret provides shell completion functions for bash and zsh.
 
-To generate them:
+To generate the completions for Bash:
 
 ```bash
 $ bundle exec make bash
@@ -61,6 +61,9 @@ $ CMDS='foo bar baz' bundle exec make bash
 $ cp completions/kbsecret.bash ${YOUR_COMPLETION_DIR}
 ```
 
+To use the completions for zsh, add the completions directory to your `$fpath` or copy the
+`completions/_kbsecret` file to any of the directories in it.
+
 Please feel free to contribute completion scripts for other shells!
 
 ### Contributing

data/bin/kbsecret

@@ -28,7 +28,7 @@ ALIASES = Hash.new { |_, k| k }.update(
 
 ALL_CMDS = (ALIASES.keys + BUILTIN_CMDS + INTERNAL_CMDS + EXT_CMDS).freeze
 
-KBSECRET_HELP = <<~EOS
+KBSECRET_HELP = <<~KBSECRET_HELP
   Usage:
     kbsecret <command> <args ...>
 
@@ -37,7 +37,7 @@ KBSECRET_HELP = <<~EOS
 
   For more information about a particular command, try:
     kbsecret help <command>
-EOS
+KBSECRET_HELP
 
 def internal?(cmd)
   INTERNAL_CMDS.include?(cmd)
@@ -86,26 +86,26 @@ end
 
 # lol
 def help_help
-  puts <<~EOS
+  puts <<~HELP_HELP
     Usage:
       kbsecret help <command>
 
     For a list of all commands, see:
       kbsecret help
-  EOS
+  HELP_HELP
 end
 
 def version(*_args)
-  puts <<~EOS
+  puts <<~VERSION
     kbsecret version #{KBSecret::VERSION}.
-  EOS
+  VERSION
 end
 
 def version_help
-  puts <<~EOS
+  puts <<~VERSION_HELP
     Usage:
       kbsecret version
-  EOS
+  VERSION_HELP
 end
 
 def commands(*_args)
@@ -113,10 +113,10 @@ def commands(*_args)
 end
 
 def commands_help
-  puts <<~EOS
+  puts <<~COMMANDS_HELP
     Usage:
       kbsecret commands
-  EOS
+  COMMANDS_HELP
 end
 
 def types(*_args)
@@ -124,10 +124,10 @@ def types(*_args)
 end
 
 def types_help
-  puts <<~EOS
+  puts <<~TYPES_HELP
     Usage:
       kbsecret types
-  EOS
+  TYPES_HELP
 end
 
 def conf(*_args)
@@ -138,10 +138,10 @@ def conf(*_args)
 end
 
 def conf_help
-  puts <<~EOS
+  puts <<~CONF_HELP
     Usage:
       kbsecret conf
-  EOS
+  CONF_HELP
 end
 
 command = normalize(ARGV.shift || "help")

data/lib/kbsecret/cli/kbsecret-dump-fields

@@ -7,10 +7,10 @@ include KBSecret
 
 cmd = CLI.create do |c|
   c.slop do |o|
-    o.banner = <<~EOS
+    o.banner = <<~HELP
       Usage:
         kbsecret dump-fields [options] <record>
-    EOS
+    HELP
 
     o.string "-s", "--session", "the session to search in", default: :default
     o.bool "-x", "--terse", "output in field<sep>value format"

data/lib/kbsecret/cli/kbsecret-env

@@ -7,10 +7,10 @@ include KBSecret
 
 cmd = CLI.create do |c|
   c.slop do |o|
-    o.banner = <<~EOS
+    o.banner = <<~HELP
       Usage:
         kbsecret env [options] <record [record ...]>
-    EOS
+    HELP
 
     o.string "-s", "--session", "the session to search in", default: :default
     o.bool "-a", "--all", "retrieve all environment records, not just listed ones"

data/lib/kbsecret/cli/kbsecret-generator

@@ -7,10 +7,10 @@ include KBSecret
 
 cmd = CLI.create do |c|
   c.slop cmds: %w[new rm] do |o|
-    o.banner = <<~EOS
+    o.banner = <<~HELP
       Usage:
         kbsecret new-generator [options] <new|rm> <generator>
-    EOS
+    HELP
 
     o.string "-F", "--format", "the format of the secrets generated", default: "hex"
     o.integer "-l", "--length", "the length, in bytes, of the secrets generated",

data/lib/kbsecret/cli/kbsecret-generators

@@ -7,10 +7,10 @@ include KBSecret
 
 cmd = CLI.create do |c|
   c.slop do |o|
-    o.banner = <<~EOS
+    o.banner = <<~HELP
       Usage:
         kbsecret generators [options]
-    EOS
+    HELP
 
     o.bool "-a", "--show-all", "show each generator in depth (i.e. metadata)"
   end
@@ -21,8 +21,8 @@ Config[:generators].each do |label, config|
 
   next unless cmd.opts.show_all?
 
-  puts <<~EOS
+  puts <<~DETAIL
     \tFormat: #{config[:format]}
     \tLength: #{config[:length]}
-  EOS
+  DETAIL
 end

data/lib/kbsecret/cli/kbsecret-list

@@ -7,10 +7,10 @@ include KBSecret
 
 cmd = CLI.create do |c|
   c.slop do |o|
-    o.banner = <<~EOS
+    o.banner = <<~HELP
       Usage:
         kbsecret list [options]
-    EOS
+    HELP
 
     o.string "-s", "--session", "the session to list from", default: :default
     o.string "-t", "--type", "the type of secrets to list", default: nil
@@ -28,9 +28,9 @@ records.each do |record|
 
   next unless cmd.opts.show_all?
 
-  puts <<~EOS
+  puts <<~DETAIL
     \tType: #{record.type}
     \tLast changed: #{Time.at(record.timestamp)}
     \tRaw data: #{record.data}
-  EOS
+  DETAIL
 end

data/lib/kbsecret/cli/kbsecret-login

@@ -7,10 +7,10 @@ include KBSecret
 
 cmd = CLI.create do |c|
   c.slop do |o|
-    o.banner = <<~EOS
+    o.banner = <<~HELP
       Usage:
         kbsecret login [options] <record [record ...]>
-    EOS
+    HELP
 
     o.string "-s", "--session", "the session to search in", default: :default
     o.bool "-a", "--all", "retrieve all login records, not just listed ones"
@@ -42,10 +42,10 @@ selected_records.each do |record|
     fields = %i[label username password].map { |m| record.send(m) }
     puts fields.join(cmd.opts[:ifs])
   else
-    puts <<~EOS
+    puts <<~DETAIL
       Label: #{record.label}
       \tUsername: #{record.username}
       \tPassword: #{record.password}
-    EOS
+    DETAIL
   end
 end

data/lib/kbsecret/cli/kbsecret-new

@@ -12,11 +12,11 @@ TYPE_ALIASES = Hash.new { |_, k| k }.update(Abbrev.abbrev(Record.record_types)).
 
 cmd = CLI.create do |c|
   c.slop do |o|
-    o.banner = <<~EOS
+    o.banner = <<~HELP
       Usage:
         kbsecret new [options] <type> <label>
         kbsecret new [options] --args <type> <label> <fields>
-    EOS
+    HELP
 
     o.string "-s", "--session", "the session to contain the record", default: :default
     o.bool "-f", "--force", "force creation (ignore overwrites, etc.)"
@@ -69,9 +69,9 @@ fields = if ($stdin.tty? && !cmd.opts.args?) || cmd.opts.terse?
              end
            end
          else
-           cmd.warn <<~EOS
+           cmd.warn <<~WARNING
              Argument input is dangerous and deprecated, and will be removed by 1.0.
-           EOS
+           WARNING
 
            cmd.args[:fields]
          end

data/lib/kbsecret/cli/kbsecret-new-session

@@ -8,13 +8,13 @@ include KBSecret
 
 cmd = CLI.create do |c|
   c.slop do |o|
-    o.banner = <<~EOS
+    o.banner = <<~HELP
       Usage:
         kbsecret new-session [options]
-    EOS
+    HELP
 
     o.string "-t", "--team", "the team to create the session under"
-    o.string "-l", "--label", "the session label"
+    o.string "-l", "--label", "the session label", required: true
     o.array "-u", "--users", "the keybase users", default: [Keybase::Local.current_user]
     o.string "-r", "--root", "the secret root directory"
     o.bool "-f", "--force", "force creation (ignore overwrites, etc.)"
@@ -51,7 +51,7 @@ else
   unless cmd.opts.no_notify? && cmd.opts[:users] != [Keybase::Local.current_user]
     users = cmd.opts[:users].join(",")
 
-    Keybase::Local::Chat.send_message cmd.opts[:users], <<~EOM
+    Keybase::Local::Chat.send_message cmd.opts[:users], <<~MESSAGE
       You've been added to a KBSecret session!
 
       To access this session, please run the following:
@@ -65,6 +65,6 @@ else
       ```
         $ gem install kbsecret
       ```
-    EOM
+    MESSAGE
   end
 end

data/lib/kbsecret/cli/kbsecret-pass

@@ -8,10 +8,10 @@ include KBSecret
 
 cmd = CLI.create do |c|
   c.slop do |o|
-    o.banner = <<~EOS
+    o.banner = <<~HELP
       Usage:
         kbsecret pass [options] <record>
-    EOS
+    HELP
 
     o.string "-s", "--session", "the session to search in", default: :default
     o.bool "-c", "--clipboard", "dump the password in the clipboard"

data/lib/kbsecret/cli/kbsecret-raw-edit

@@ -7,10 +7,10 @@ include KBSecret
 
 cmd = CLI.create do |c|
   c.slop do |o|
-    o.banner = <<~EOS
+    o.banner = <<~HELP
       Usage:
         kbsecret raw-edit [options] <record>
-    EOS
+    HELP
 
     o.string "-s", "--session", "the session to search in", default: :default
   end

data/lib/kbsecret/cli/kbsecret-rm

@@ -10,10 +10,10 @@ $VERBOSE = nil # tty-prompt blasts us with irrelevant warnings on 2.4
 
 cmd = CLI.create do |c|
   c.slop do |o|
-    o.banner = <<~EOS
+    o.banner = <<~HELP
       Usage:
         kbsecret rm [options] <record>
-    EOS
+    HELP
 
     o.string "-s", "--session", "the session containing the record", default: :default
     o.bool "-i", "--interactive", "ask for confirmation before deleting"

data/lib/kbsecret/cli/kbsecret-rm-session

@@ -7,10 +7,10 @@ include KBSecret
 
 cmd = CLI.create do |c|
   c.slop do |o|
-    o.banner = <<~EOS
+    o.banner = <<~HELP
       Usage:
         kbsecret rm-session [options] <session>
-    EOS
+    HELP
 
     o.bool "-d", "--delete", "unlink the session in addition to deconfiguration"
   end

data/lib/kbsecret/cli/kbsecret-sessions

@@ -7,10 +7,10 @@ include KBSecret
 
 cmd = CLI.create do |c|
   c.slop do |o|
-    o.banner = <<~EOS
+    o.banner = <<~HELP
       Usage:
         kbsecret sessions [options]
-    EOS
+    HELP
 
     o.bool "-a", "--show-all", "show each session in depth (i.e. metadata)"
   end
@@ -25,14 +25,14 @@ Config.session_labels.each do |sess_name|
   next unless cmd.opts.show_all?
 
   if session_hash[:team]
-    puts <<~EOS
+    puts <<~DETAIL
       \tTeam: #{session_hash[:team]}
       \tSecrets root: #{session_hash[:root]} (#{session.path})
-    EOS
+    DETAIL
   else
-    puts <<~EOS
+    puts <<~DETAIL
       \tUsers: #{session_hash[:users].join(", ")}
       \tSecrets root: #{session_hash[:root]} (#{session.path})
-    EOS
+    DETAIL
   end
 end

data/lib/kbsecret/cli/kbsecret-stash-file

@@ -8,10 +8,10 @@ include KBSecret
 
 cmd = CLI.create do |c|
   c.slop do |o|
-    o.banner = <<~EOS
+    o.banner = <<~HELP
       Usage:
         kbsecret stash-file <record> [file]
-    EOS
+    HELP
 
     o.string "-s", "--session", "the session to add to", default: :default
     o.bool "-f", "--force", "force creation (ignore overwrites, etc.)"

data/lib/kbsecret/cli/kbsecret-todo

@@ -7,10 +7,10 @@ include KBSecret
 
 cmd = CLI.create do |c|
   c.slop cmds: %w[start suspend complete] do |o|
-    o.banner = <<~EOS
+    o.banner = <<~HELP
       Usage:
         kbsecret todo <start|suspend|complete> <record>
-    EOS
+    HELP
 
     o.string "-s", "--session", "the session to search in", default: :default
   end

data/lib/kbsecret/cli.rb

@@ -67,7 +67,7 @@ module KBSecret
         o.bool "--debug", "produce full backtraces on errors"
 
         o.on "-h", "--help", "show this help message" do
-          puts o
+          puts o.to_s prefix: "  "
           exit
         end
 
@@ -141,7 +141,7 @@ module KBSecret
     def guard
       yield
     rescue => e
-      STDERR.puts e.backtrace if @opts.debug?
+      STDERR.puts e.backtrace if @opts&.debug?
       die "#{e.to_s.capitalize}."
     end
 

data/lib/kbsecret/record.rb

@@ -50,7 +50,7 @@ module KBSecret
       hsh   = JSON.parse(File.read(path), symbolize_names: true)
       klass = class_for hsh[:type]
       klass&.load!(session, hsh)
-    rescue
+    rescue JSON::JSONError
       raise Exceptions::RecordLoadError, path
     end
   end

data/lib/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kbsecret
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.3
 platform: ruby
 authors:
 - William Woodruff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-21 00:00:00.000000000 Z
+date: 2017-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fpm
@@ -156,28 +156,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: slop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.4'
+        version: '4.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.4'
+        version: '4.6'
 - !ruby/object:Gem::Dependency
   name: tty-prompt
   requirement: !ruby/object:Gem::Requirement