kbsecret 0.3.5 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8b802b8fb4a82e3770e3499246ae1a6762cab0b8
-  data.tar.gz: 0bf498fbdc1ba933f8b05c44d44bd6ba13305bbd
+  metadata.gz: 84a1ecab08084cc71d8fb221a3a66984ca666e4b
+  data.tar.gz: cb5712d9720862406333252f437cf690b56f3f59
 SHA512:
-  metadata.gz: 4c507fc4cd4ab5652ea9f60a4307297c6754b07d4bac54bb7b80fc155850cdb9f0620151ac68386f58559208c7b7d51554e4eaca3d5f7f8fbdeb081ab11c97f2
-  data.tar.gz: f26e2393541371c80f2354d2f397221130b19c607075d974241872fb3381da85f29757f5f4eb3c5f43882a0fed3b35c1f70f691dcf6ae699d0271a1622ee1751
+  metadata.gz: 710f4ed51abb06d69d8287fd496b2e18545ca36c895d388bdba991faa87ffb57a511a6f582ea06ed0d5230e16ce5d8dfc18a4d4b4563a18c3f79ea701a3676ad
+  data.tar.gz: 71e11b76e2f36dce94006e4b31bd421d712aa2101f6ec721030b32390feec0afb157be25194050bd2befecd48d4cfc61560cc483a95c18ace30ae0d0213b7bfb

data/bin/kbsecret-dump-fields

@@ -2,9 +2,8 @@
 # frozen_string_literal: true
 
 require "kbsecret"
-require "slop"
 
-opts = Slop.parse suppress_errors: true do |o|
+opts = KBSecret::CLI.slop do |o|
   o.banner = <<~EOS
     Dump all fields for the given record.
 
@@ -15,16 +14,6 @@ opts = Slop.parse suppress_errors: true do |o|
   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.on "-h", "--help" do
-    puts o
-    exit
-  end
-
-  o.on "--introspect-flags" do
-    puts o.options.flat_map(&:flags).join "\n"
-    exit
-  end
 end
 
 session = KBSecret::CLI.ensure_session opts[:session]

data/bin/kbsecret-env

@@ -2,9 +2,8 @@
 # frozen_string_literal: true
 
 require "kbsecret"
-require "slop"
 
-opts = Slop.parse suppress_errors: true do |o|
+opts = KBSecret::CLI.slop do |o|
   o.banner = <<~EOS
     Retrieve environment records in a source-able format.
 
@@ -19,16 +18,6 @@ opts = Slop.parse suppress_errors: true do |o|
   o.string "-s", "--session", "the session name", default: :default
   o.bool "-a", "--all", "retrieve all environment records, not just listed ones"
   o.bool "-v", "--value-only", "print only the environment value, not the key"
-
-  o.on "-h", "--help" do
-    puts o
-    exit
-  end
-
-  o.on "--introspect-flags" do
-    puts o.options.flat_map(&:flags).join "\n"
-    exit
-  end
 end
 
 session = KBSecret::CLI.ensure_session opts[:session]

data/bin/kbsecret-list

@@ -2,9 +2,8 @@
 # frozen_string_literal: true
 
 require "kbsecret"
-require "slop"
 
-opts = Slop.parse suppress_errors: true do |o|
+opts = KBSecret::CLI.slop do |o|
   o.banner = <<~EOS
     List all secrets known to the specified session (or the default session).
 
@@ -15,16 +14,6 @@ opts = Slop.parse suppress_errors: true do |o|
   o.string "-s", "--session", "the session name", default: :default
   o.string "-t", "--type", "the type of secrets to list", default: nil
   o.bool "-a", "--show-all", "show everything in each secret (i.e. metadata)"
-
-  o.on "-h", "--help" do
-    puts o
-    exit
-  end
-
-  o.on "--introspect-flags" do
-    puts o.options.flat_map(&:flags).join "\n"
-    exit
-  end
 end
 
 session = KBSecret::CLI.ensure_session opts[:session]

data/bin/kbsecret-login

@@ -2,9 +2,8 @@
 # frozen_string_literal: true
 
 require "kbsecret"
-require "slop"
 
-opts = Slop.parse suppress_errors: true do |o|
+opts = KBSecret::CLI.slop do |o|
   o.banner = <<~EOS
     Retrieve login records.
 
@@ -20,16 +19,6 @@ opts = Slop.parse suppress_errors: true do |o|
   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.on "-h", "--help" do
-    puts o
-    exit
-  end
-
-  o.on "--introspect-flags" do
-    puts o.options.flat_map(&:flags).join "\n"
-    exit
-  end
 end
 
 session = KBSecret::CLI.ensure_session opts[:session]

data/bin/kbsecret-new

@@ -2,14 +2,13 @@
 # frozen_string_literal: true
 
 require "kbsecret"
-require "slop"
 require "abbrev"
 require "tty-prompt"
 
 # allows for abbreviated types (e.g., `kbsecret new env ...`)
 TYPE_ALIASES = Abbrev.abbrev(KBSecret::Record.record_types).freeze
 
-opts = Slop.parse suppress_errors: true do |o|
+opts = KBSecret::CLI.slop do |o|
   o.banner = <<~EOS
     Create a new secret record.
 
@@ -27,16 +26,6 @@ opts = Slop.parse suppress_errors: true do |o|
   o.bool "-f", "--force", "force creation (ignore overwrites, etc.)"
   o.bool "-i", "--interactive", "input record fields interactively"
   o.bool "-e", "--echo", "echo input to tty (only affects --interactive)"
-
-  o.on "-h", "--help" do
-    puts o
-    exit
-  end
-
-  o.on "--introspect-flags" do
-    puts o.options.flat_map(&:flags).join "\n"
-    exit
-  end
 end
 
 session = KBSecret::CLI.ensure_session opts[:session]

data/bin/kbsecret-new-session

@@ -3,9 +3,8 @@
 
 require "keybase"
 require "kbsecret"
-require "slop"
 
-opts = Slop.parse suppress_errors: true do |o|
+opts = KBSecret::CLI.slop do |o|
   o.banner = <<~EOS
     Create a new session.
 
@@ -20,16 +19,6 @@ opts = Slop.parse suppress_errors: true do |o|
   o.array "-u", "--users", "the keybase users", default: [Keybase.current_user]
   o.string "-r", "--root", "the secret root directory", default: "kbsecret"
   o.bool "-f", "--force", "force creation (ignore overwrites, etc.)"
-
-  o.on "-h", "--help" do
-    puts o
-    exit
-  end
-
-  o.on "--introspect-flags" do
-    puts o.options.flat_map(&:flags).join "\n"
-    exit
-  end
 end
 
 session_label = opts[:label]

data/bin/kbsecret-pass

@@ -2,10 +2,9 @@
 # frozen_string_literal: true
 
 require "kbsecret"
-require "slop"
 require "clipboard"
 
-opts = Slop.parse suppress_errors: true do |o|
+opts = KBSecret::CLI.slop do |o|
   o.banner = <<~EOS
     Retrieve a login record's password.
 
@@ -19,16 +18,6 @@ opts = Slop.parse suppress_errors: true do |o|
 
   o.string "-s", "--session", "the session name", default: :default
   o.bool "-c", "--clipboard", "dump the password in the clipboard"
-
-  o.on "-h", "--help" do
-    puts o
-    exit
-  end
-
-  o.on "--introspect-flags" do
-    puts o.options.flat_map(&:flags).join "\n"
-    exit
-  end
 end
 
 session       = KBSecret::CLI.ensure_session opts[:session]

data/bin/kbsecret-raw-edit

@@ -2,9 +2,8 @@
 # frozen_string_literal: true
 
 require "kbsecret"
-require "slop"
 
-opts = Slop.parse suppress_errors: true do |o|
+opts = KBSecret::CLI.slop do |o|
   o.banner = <<~EOS
     Edit the raw JSON of a record in $EDITOR.
 
@@ -16,16 +15,6 @@ opts = Slop.parse suppress_errors: true do |o|
   EOS
 
   o.string "-s", "--session", "the session name", default: :default
-
-  o.on "-h", "--help" do
-    puts o
-    exit
-  end
-
-  o.on "--introspect-flags" do
-    puts o.options.flat_map(&:flags).join "\n"
-    exit
-  end
 end
 
 session = KBSecret::CLI.ensure_session opts[:session]

data/bin/kbsecret-rm

@@ -2,12 +2,11 @@
 # frozen_string_literal: true
 
 require "kbsecret"
-require "slop"
 require "tty-prompt"
 
 $VERBOSE = nil # tty-prompt blasts us with irrelevant warnings on 2.4
 
-opts = Slop.parse suppress_errors: true do |o|
+opts = KBSecret::CLI.slop do |o|
   o.banner = <<~EOS
     Delete a record.
 
@@ -17,16 +16,6 @@ opts = Slop.parse suppress_errors: true do |o|
 
   o.string "-s", "--session", "the session name", default: :default
   o.bool "-i", "--interactive", "ask for confirmation before deleting"
-
-  o.on "-h", "--help" do
-    puts o
-    exit
-  end
-
-  o.on "--introspect-flags" do
-    puts o.options.flat_map(&:flags).join "\n"
-    exit
-  end
 end
 
 session = KBSecret::CLI.ensure_session opts[:session]

data/bin/kbsecret-rm-session

@@ -2,9 +2,8 @@
 # frozen_string_literal: true
 
 require "kbsecret"
-require "slop"
 
-opts = Slop.parse suppress_errors: true do |o|
+opts = KBSecret::CLI.slop do |o|
   o.banner = <<~EOS
     Deconfigure (and optionally delete) a session.
 
@@ -17,16 +16,6 @@ opts = Slop.parse suppress_errors: true do |o|
   EOS
 
   o.bool "-d", "--delete", "unlink the session in addition to deconfiguration"
-
-  o.on "-h", "--help" do
-    puts o
-    exit
-  end
-
-  o.on "--introspect-flags" do
-    puts o.options.flat_map(&:flags).join "\n"
-    exit
-  end
 end
 
 label = opts.args.shift

data/bin/kbsecret-sessions

@@ -2,9 +2,8 @@
 # frozen_string_literal: true
 
 require "kbsecret"
-require "slop"
 
-opts = Slop.parse suppress_errors: true do |o|
+opts = KBSecret::CLI.slop do |o|
   o.banner = <<~EOS
     List all available sessions.
     The sessions listed can be passed to other commands via the -s flag.
@@ -14,16 +13,6 @@ opts = Slop.parse suppress_errors: true do |o|
   EOS
 
   o.bool "-a", "--show-all", "show each session in depth (i.e. metadata)"
-
-  o.on "-h", "--help" do
-    puts o
-    exit
-  end
-
-  o.on "--introspect-flags" do
-    puts o.options.flat_map(&:flags).join "\n"
-    exit
-  end
 end
 
 KBSecret::Config.session_labels.each do |sess_name|

data/bin/kbsecret-stash-file

@@ -2,9 +2,8 @@
 # frozen_string_literal: true
 
 require "kbsecret"
-require "slop"
 
-opts = Slop.parse suppress_errors: true do |o|
+opts = KBSecret::CLI.slop do |o|
   o.banner = <<~EOS
     Stash the given file (or stdin) as an unstructured record.
 
@@ -17,16 +16,6 @@ opts = Slop.parse suppress_errors: true do |o|
   EOS
 
   o.string "-s", "--session", "the session name", default: :default
-
-  o.on "-h", "--help" do
-    puts o
-    exit
-  end
-
-  o.on "--introspect-flags" do
-    puts o.options.flat_map(&:flags).join "\n"
-    exit
-  end
 end
 
 session         = KBSecret::CLI.ensure_session opts[:session]

data/bin/kbsecret-todo

@@ -2,9 +2,8 @@
 # frozen_string_literal: true
 
 require "kbsecret"
-require "slop"
 
-opts = Slop.parse suppress_errors: true do |o|
+opts = KBSecret::CLI.slop cmds: %w[start suspend complete] do |o|
   o.banner = <<~EOS
     Manage 'to do' records.
 
@@ -18,18 +17,6 @@ opts = Slop.parse suppress_errors: true do |o|
   EOS
 
   o.string "-s", "--session", "the session name", default: :default
-
-  o.on "-h", "--help" do
-    puts o
-    exit
-  end
-
-  o.on "--introspect-flags" do
-    subcmds = %w[start suspend complete]
-    comp = o.options.flat_map(&:flags) + subcmds
-    puts comp.join "\n"
-    exit
-  end
 end
 
 session        = KBSecret::CLI.ensure_session opts[:session]

data/lib/kbsecret/cli.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
 require "pastel"
+require "slop"
 
 module KBSecret
   # An encapsulation of useful methods for kbsecret's CLI.
   module CLI
     class << self
       # The pastel object used to generate colorful output.
+      # @api private
       PASTEL = Pastel.new
 
       # Print an error message and terminate.
@@ -27,6 +29,28 @@ module KBSecret
 
         Session.new label: sess_label
       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
+      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.rb

@@ -11,7 +11,7 @@ require_relative "kbsecret/cli"
 # The primary namespace for kbsecret.
 module KBSecret
   # kbsecret's current version
-  VERSION = "0.3.5"
+  VERSION = "0.3.6"
 
   # fail very early if the user doesn't have keybase and KBFS running
   raise Keybase::KeybaseNotRunningError unless Keybase.running?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kbsecret
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
 platform: ruby
 authors:
 - William Woodruff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-05 00:00:00.000000000 Z
+date: 2017-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: keybase-unofficial