kbsecret 0.5.5 → 0.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3c46fd341e3a2db07a7278ce4ef7e5e5f99f1ee
-  data.tar.gz: 9e236b7d3ad0c3396c76c85b3aa12b7f253376b9
+  metadata.gz: f988059d109942e54868a06c593c2f20f62972c6
+  data.tar.gz: a6d1d9b5b52fcb4f136eab7ead9d404111855fc9
 SHA512:
-  metadata.gz: 2ebe7c26ed449cb6ba40979682f36efd77315c16e4b09ccaa5148665eda1b86a933c2a5f1362c598494f538729e13a65e2cd83a3dca880a94485dfd8294578fe
-  data.tar.gz: 8adbafa4fec10a672742c4f3a4e44e4bedd802ee20c0b38bab67b18f7de8c7bdd4d43f0f1bd84d0fdfcb572ce430dec9bf76279cc0906472b11234952258338d
+  metadata.gz: e627e140303c2966e2f824e751edd7bdd9e48bb999160b1ba9b498b8f1c14ceebc128ac331c20d0a5729665810033851f575ce200803c11a0ef179f90ca4698e
+  data.tar.gz: 9700504918200ff1dd434a65466cecf666575205bcae655cac6208f12f942a8aa12e8a6348560b99f28c4f084baa51ee35c197d589ec342e3cb2ba5817036f80

data/README.md

@@ -72,7 +72,9 @@ default
 dev-team
 
 # add an environment record to the dev-team session
-$ kbsecret new environment api-key API_KEY 0xBADBEEF -s dev-team
+$ kbsecret new environment api-key -s dev-team
+Variable?
+Value?
 
 # list all records under the dev-team session
 $ kbsecret list -s dev-team

data/bin/kbsecret-dump-fields

@@ -11,28 +11,29 @@ cmd = CLI.new do
       Dump all fields for the given record.
 
       Usage:
-        kbsecret dump-fields [--session <name>] <label>
+        kbsecret dump-fields [--session <session>] <record>
     EOS
 
-    o.string "-s", "--session", "the session name", default: :default
-    o.bool "-x", "--terse", "output in field:value format"
+    o.string "-s", "--session", "the session to search in", default: :default
+    o.bool "-x", "--terse", "output in field<sep>value format"
     o.string "-i", "--ifs", "separate terse pairs with this string", default: CLI.ifs
   end
 
   dreck do
     string :label
   end
-end
 
-session = CLI.ensure_session cmd.opts[:session]
+  ensure_session!
+end
 
-label = cmd.args[:label]
-record = session[label]
+session = Session.new label: cmd.opts[:session]
+label   = cmd.args[:label]
+record  = session[label]
 
 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)
+field_pairs  = record.class.data_fields.zip(field_values)
 
 if cmd.opts.terse?
   puts field_pairs.map { |f, v| "#{f}#{cmd.opts[:ifs]}#{v}" }.join "\n"

data/bin/kbsecret-env

@@ -11,14 +11,14 @@ cmd = CLI.new do
       Retrieve environment records in a source-able format.
 
       Usage:
-        kbsecret env [--session <name>] [--all] <label1 label2 ...>
+        kbsecret env [--session <session>] [--all] <record [record ...]>
 
       Examples:
         kbsecret env --all
         kbsecret env staging beta
     EOS
 
-    o.string "-s", "--session", "the session name", default: :default
+    o.string "-s", "--session", "the session to search in", 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"
   end
@@ -26,9 +26,11 @@ cmd = CLI.new do
   dreck do
     list :string, :labels
   end
+
+  ensure_session!
 end
 
-session = CLI.ensure_session cmd.opts[:session]
+session = Session.new label: cmd.opts[:session]
 records = session.records :environment
 
 selected_records = if cmd.opts.all?

data/bin/kbsecret-list

@@ -11,16 +11,18 @@ cmd = CLI.new do
       List all secrets known to the specified session (or the default session).
 
       Usage:
-        kbsecret list [--session <name>] [--show-all]
+        kbsecret list [--session <session>] [--show-all]
     EOS
 
-    o.string "-s", "--session", "the session name", default: :default
+    o.string "-s", "--session", "the session to list from", 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)"
   end
+
+  ensure_session!
 end
 
-session = CLI.ensure_session cmd.opts[:session]
+session = Session.new label: cmd.opts[:session]
 
 records = session.records cmd.opts[:type]
 

data/bin/kbsecret-login

@@ -11,25 +11,27 @@ cmd = CLI.new do
       Retrieve login records.
 
       Usage:
-        kbsecret login [--session <name>] <label1 label2 ...>
+        kbsecret login [--session <session>] <record [record ...]>
 
       Examples:
         kbsecret login --terse --ifs "*" gmail
         kbsecret login gmail netflix
     EOS
 
-    o.string "-s", "--session", "the session name", default: :default
+    o.string "-s", "--session", "the session to search in", 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.bool "-x", "--terse", "output in label<sep>username<sep>password format"
     o.string "-i", "--ifs", "separate terse fields with this string", default: CLI.ifs
   end
 
   dreck do
     list :string, :labels
   end
+
+  ensure_session!
 end
 
-session = CLI.ensure_session cmd.opts[:session]
+session = Session.new label: cmd.opts[:session]
 records = session.records :login
 
 selected_records = if cmd.opts.all?

data/bin/kbsecret-new

@@ -24,7 +24,7 @@ cmd = CLI.new do
         kbsecret new environment foo-api
     EOS
 
-    o.string "-s", "--session", "the session name", default: :default
+    o.string "-s", "--session", "the session to contain the record", default: :default
     o.bool "-f", "--force", "force creation (ignore overwrites, etc.)"
     o.bool "-a", "--args", "use trailing arguments as fields, even with a tty"
     o.bool "-e", "--echo", "echo input to tty (only affects interactive input)"
@@ -35,9 +35,11 @@ cmd = CLI.new do
     string :label
     list :string, :fields
   end
+
+  ensure_session!
 end
 
-session = CLI.ensure_session cmd.opts[:session]
+session = Session.new label: cmd.opts[:session]
 
 type          = cmd.args[:type]
 label         = cmd.args[:label]

data/bin/kbsecret-pass

@@ -12,23 +12,25 @@ cmd = CLI.new do
       Retrieve a login record's password.
 
       Usage:
-        kbsecret pass [--session <name>] [--clipboard] <label>
+        kbsecret pass [--session <session>] [--clipboard] <record>
 
       Examples:
         kbsecret pass gmail | xclip
         kbsecret pass --clipboard gmail
     EOS
 
-    o.string "-s", "--session", "the session name", default: :default
+    o.string "-s", "--session", "the session to search in", default: :default
     o.bool "-c", "--clipboard", "dump the password in the clipboard"
   end
 
   dreck do
     string :label
   end
+
+  ensure_session!
 end
 
-session = CLI.ensure_session cmd.opts[:session]
+session = Session.new label: cmd.opts[:session]
 label   = cmd.args[:label]
 record  = session[label]
 

data/bin/kbsecret-raw-edit

@@ -11,21 +11,23 @@ cmd = CLI.new do
       Edit the raw JSON of a record in $EDITOR.
 
       Usage:
-        kbsecret raw-edit [--session <name>] <label>
+        kbsecret raw-edit [--session <session>] <record>
 
       Examples:
         kbsecret raw-edit gmail
     EOS
 
-    o.string "-s", "--session", "the session name", default: :default
+    o.string "-s", "--session", "the session to search in", default: :default
   end
 
   dreck do
     string :label
   end
+
+  ensure_session!
 end
 
-session = CLI.ensure_session cmd.opts[:session]
+session = Session.new label: cmd.opts[:session]
 label   = cmd.args[:label]
 record  = session[label]
 

data/bin/kbsecret-rm

@@ -14,22 +14,23 @@ cmd = CLI.new do
       Delete a record.
 
       Usage:
-        kbsecret rm [--session <name>] [--interactive] <label>
+        kbsecret rm [--session <session>] [--interactive] <record>
     EOS
 
-    o.string "-s", "--session", "the session name", default: :default
+    o.string "-s", "--session", "the session containing the record", default: :default
     o.bool "-i", "--interactive", "ask for confirmation before deleting"
   end
 
   dreck do
     string :label
   end
+
+  ensure_session!
 end
 
 label   = cmd.args[:label]
-session = CLI.ensure_session cmd.opts[:session]
+session = Session.new label: cmd.opts[:session]
 
-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

@@ -11,7 +11,7 @@ cmd = CLI.new do
       Deconfigure (and optionally delete) a session.
 
       Usage:
-        kbsecret rm-session --delete <label>
+        kbsecret rm-session [--delete] <session>
 
       Example:
         kbsecret rm-session old-keys
@@ -22,13 +22,15 @@ cmd = CLI.new do
   end
 
   dreck do
-    string :label
+    string :session
   end
+
+  ensure_session! :argument
 end
 
-label = cmd.args[:label]
+label = cmd.args[:session]
 
-session = CLI.ensure_session label
+session = Session.new label: label
 session.unlink! if cmd.opts.delete?
 
 Config.deconfigure_session label

data/bin/kbsecret-stash-file

@@ -11,23 +11,25 @@ cmd = CLI.new do
       Stash the given file (or stdin) as an unstructured record.
 
       Usage:
-        kbsecret stash-file <label> [file]
+        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 name", default: :default
+    o.string "-s", "--session", "the session to add to", default: :default
   end
 
   dreck errors: false do
     string :label
     string :filename
   end
+
+  ensure_session!
 end
 
-session  = CLI.ensure_session cmd.opts[:session]
+session  = Session.new label: cmd.opts[:session]
 label    = cmd.args[:label]
 filename = cmd.args[:filename]
 

data/bin/kbsecret-todo

@@ -11,7 +11,7 @@ cmd = CLI.new do
       Manage 'to do' records.
 
       Usage:
-        kbsecret todo <start|suspend|complete> <label>
+        kbsecret todo <start|suspend|complete> <record>
 
       Examples:
         kbsecret todo start unit-tests
@@ -19,19 +19,20 @@ cmd = CLI.new do
         kbsecret todo complete shopping
     EOS
 
-    o.string "-s", "--session", "the session name", default: :default
+    o.string "-s", "--session", "the session to search in", default: :default
   end
 
   dreck do
     string :command
     string :label
   end
+
+  ensure_session!
 end
 
-session = CLI.ensure_session cmd.opts[:session]
+session = Session.new label: cmd.opts[:session]
 label   = cmd.args[:label]
-
-todo = session[label]
+todo    = session[label]
 
 CLI.die "No such record." unless todo
 CLI.die "'#{todo}' is not a todo record." unless todo.type == :todo

data/lib/kbsecret/cli.rb

@@ -17,12 +17,15 @@ module KBSecret
     # @example
     #  cmd = KBSecret::CLI.new do
     #    slop do |o|
+    #      o.string "-s", "--session", "session label"
     #      o.bool "-f", "--foo", "whatever"
     #    end
     #
     #    dreck do
     #      string :name
     #    end
+    #
+    #    ensure_session!
     #  end
     #
     #  cmd.opts # => Slop::Result
@@ -32,6 +35,8 @@ module KBSecret
       @opts = nil
       @args = nil
       instance_eval(&block)
+    rescue => e
+      self.class.die e.to_s.capitalize
     end
 
     # Parse options for a kbsecret utility, adding some default options for
@@ -39,7 +44,7 @@ module KBSecret
     # @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}.
+    # @note This should be called within the block passed to {#initialize}.
     def slop(cmds: [], errors: false)
       @opts = Slop.parse suppress_errors: !errors do |o|
         yield o
@@ -60,15 +65,28 @@ module KBSecret
     end
 
     # Parse trailing arguments for a kbsecret utility, using the elements remaining
-    #  after options have been removed and interpreted via {slop}.
+    #  after options have been removed and interpreted via {#slop}.
     # @param errors [Boolean] whether or not to produce (strict) Dreck errors
-    # @note *If* {slop} is called, it must be called before this.
+    # @note *If* {#slop} is called, it must be called before this.
     def dreck(errors: true, &block)
       @args = Dreck.parse @trailing, strict: errors do
         instance_eval(&block)
       end
-    rescue => e
-      KBSecret::CLI.die "#{e.to_s.capitalize}."
+    end
+
+    # Ensure that a session passed in as an option or argument already exists
+    #   (i.e., is already configured).
+    # @param where [Symbol] Where to look for the session label to test.
+    #   If `:option` is passed, then the session is expected to be the value of
+    #   the `--session` option. If `:argument` is passed, then the session is expected
+    #   to be in the argument list labeled as `:argument` by Dreck.
+    # @return [void]
+    # @raise [RuntimeError] if the expected session is not configured.
+    # @note {#slop} and {#dreck} should be called before this, depending on whether
+    #   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
     end
 
     class << self
@@ -85,6 +103,7 @@ module KBSecret
       # @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
 

data/lib/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kbsecret
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.5.6
 platform: ruby
 authors:
 - William Woodruff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-25 00:00:00.000000000 Z
+date: 2017-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fpm
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: '1.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement