kbsecret 0.9.5 → 0.9.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a93f10c5ff4add094ea83dc950239250ffda4e31
-  data.tar.gz: 3d8ddfe46e26ed3751d541b762c56804fb194c35
+  metadata.gz: 95af6343b31d058c770ddc7c9ee0a82c3a5f984c
+  data.tar.gz: 6d07e7ea5d2a10b0d2f3a46979d447c3785642ed
 SHA512:
-  metadata.gz: d92789c5a47dfccb4422545b9bdf5c7bfc3d086599783336c982cc02a2e37749bab41e9cfc5579db9a3451b726683e044d3efaa302eefd3e5e79d2037af31719
-  data.tar.gz: 2fc805de715e71bbfc577f9f1258b9b2b46d5cad421126173afd6d8d3864b386e8da035c6b3e99caaa5e361f86d49abfec5e4a93a982dad050ce9e5b0318d5be
+  metadata.gz: b60c937f2a8bf3c9271299f602727059af992b0bc2510040ce057fbcd08beae232af1c84d8fa1def9a0e32c362511ec7e6906772a655ed1e8c756f1c83025ba2
+  data.tar.gz: 1f11837a4cdd43d7f4439a48544bbf54a7e46715ef069495cf106469bebb65634d5948ee2b370d7d9c75bae960506c2482656321b96031642d8549122db26095

data/lib/kbsecret/cli.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require "colored2"
 require "slop"
 require "dreck"
 require "abbrev"
+require "pastel"
 
 module KBSecret
   # An encapsulation of useful methods for kbsecret's CLI.
@@ -13,6 +13,9 @@ module KBSecret
     # Abbreviations for record types (e.g., `env` for `environment`).
     TYPE_ALIASES = Hash.new { |_, k| k }.update(Abbrev.abbrev(Record.record_types)).freeze
 
+    # ANSI color objects for prettifying output.
+    GREEN, YELLOW, RED = ->(p) { [p.green, p.yellow, p.red].map(&:detach) }.call(Pastel.new)
+
     # @return [Slop::Result, nil] the result of option parsing, if requested
     #   via {#slop}
     attr_reader :opts
@@ -155,7 +158,7 @@ module KBSecret
     # @return [void]
     def info(msg)
       return unless @opts.verbose?
-      STDERR.puts "#{"Info".green}: #{msg}"
+      STDERR.puts "#{GREEN["Info"]}: #{msg}"
     end
 
     # Print an informational message via {#info} and exit successfully.
@@ -172,7 +175,7 @@ module KBSecret
     # @return [void]
     def warn(msg)
       return if @opts.no_warn?
-      STDERR.puts "#{"Warning".yellow}: #{msg}"
+      STDERR.puts "#{YELLOW["Warning"]}: #{msg}"
     end
 
     # Print an error message and terminate.
@@ -180,7 +183,7 @@ module KBSecret
     # @return [void]
     # @note This method does not return!
     def die(msg)
-      pretty = "#{"Fatal".red}: #{msg}"
+      pretty = "#{RED["Fatal"]}: #{msg}"
       abort pretty
     end
 
@@ -190,7 +193,7 @@ module KBSecret
       # @return [void]
       # @note This method does not return!
       def die(msg)
-        pretty = "#{"Fatal".red}: #{msg}"
+        pretty = "#{RED["Fatal"]}: #{msg}"
         abort pretty
       end
 

data/lib/kbsecret/cli/kbsecret-cp

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "kbsecret"
+include KBSecret
+
+cmd = CLI.create do |c|
+  c.slop do |o|
+    o.banner = <<~HELP
+      Usage:
+        kbsecret cp [options] <source> <destination> <record [record ...]>
+    HELP
+
+    o.bool "-f", "--force", "force copying (ignore overwrites)"
+    o.bool "-m", "--move", "delete the record after copying"
+  end
+
+  c.dreck do
+    string :src_sess
+    string :dst_sess
+    list :string, :labels
+  end
+end
+
+cmd.guard do
+  src_sess = Session.new label: cmd.args[:src_sess]
+  dst_sess = Session.new label: cmd.args[:dst_sess]
+
+  selected_records = src_sess.records.select { |r| cmd.args[:labels].include?(r.label) }
+  cmd.die "No such record(s)." if selected_records.empty?
+
+  overlaps = dst_sess.record_labels & selected_records.map(&:label)
+
+  # the code below actually handles the overwriting if necessary, but we fail early here for
+  # friendliness and to avoid half-copying the selected records
+  unless overlaps.empty? || cmd.opts.force?
+    cmd.die "Refusing to overwrite existing record(s) without --force."
+  end
+
+  selected_records.each do |record|
+    dst_sess.import_record(record, overwrite: cmd.opts.force?)
+    src_sess.delete_record(label) if cmd.opts.move?
+  end
+end

data/lib/kbsecret/cli/kbsecret-new

@@ -38,6 +38,8 @@ type          = cmd.args[:type]
 label         = cmd.args[:label]
 resolved_type = CLI::TYPE_ALIASES[type]
 
+# the code below actually handles the overwriting if necessary, but we fail early here
+# for friendliness and to avoid prompting the user for input unnecessarily
 if cmd.session.record?(label) && !cmd.opts.force?
   cmd.die "Refusing to overwrite an existing record without --force."
 end
@@ -61,4 +63,6 @@ fields = if cmd.opts.terse?
            end
          end
 
-cmd.guard { cmd.session.add_record(resolved_type, label, *fields) }
+cmd.guard do
+  cmd.session.add_record resolved_type, label, *fields, overwrite: cmd.opts.force?
+end

data/lib/kbsecret/cli/kbsecret-session

@@ -11,9 +11,9 @@ def new_session(label, cmd)
   end
 
   if cmd.opts[:team]
-    teams = Keybase::Local::Team.list_memberships["teams"]
+    teams = Keybase::Local::Team.list_self_memberships.teams
 
-    unless teams.any? { |t| t["fq_name"] == cmd.opts[:team] }
+    unless teams.any? { |t| t.fq_name == cmd.opts[:team] }
       cmd.die "No such team (either nonexistent or non-member)."
     end
 

data/lib/kbsecret/exceptions.rb

@@ -9,6 +9,7 @@ module KBSecret
 
     # Raised during record loading if a particular file can't be loaded
     class RecordLoadError < KBSecretError
+      # @param path [String] the path to the record
       def initialize(path)
         base = File.basename(path)
         super "Failed to load record in file: '#{base}'"
@@ -17,6 +18,7 @@ module KBSecret
 
     # Raised during record creation if an unknown record type is requested.
     class RecordTypeUnknownError < KBSecretError
+      # @param type [String, Symbol] the record type
       def initialize(type)
         super "Unknown record type: '#{type}'"
       end
@@ -24,13 +26,25 @@ module KBSecret
 
     # Raised during record creation if too many/few arguments are given.
     class RecordCreationArityError < KBSecretError
+      # @param exp [Integer] the number of expected arguments
+      # @param act [Integer] the number of actual arguments
       def initialize(exp, act)
         super "Needed #{exp} arguments for this record, got #{act}"
       end
     end
 
+    # Raised when record creation or import would cause an unintended overwrite.
+    class RecordOverwriteError < KBSecretError
+      # @param session [Session] the session being modified
+      # @param label [String] the label being overwritten in the session
+      def initialize(session, label)
+        super "Record '#{label}' already exists in '#{session.label}'"
+      end
+    end
+
     # Raised during session load if an error occurs.
     class SessionLoadError < KBSecretError
+      # @param msg [String] the error message
       def initialize(msg)
         super "Session loading failure: #{msg}"
       end
@@ -38,13 +52,23 @@ module KBSecret
 
     # Raised during session lookup if an unknown session is requested.
     class SessionUnknownError < KBSecretError
+      # @param sess [String, Symbol] the label of the session
       def initialize(sess)
         super "Unknown session: '#{sess}'"
       end
     end
 
+    # Raised during record import if the source is the same as the destination.
+    class SessionImportError < KBSecretError
+      # @param session [Session] the session being imported into
+      def initialize(session)
+        super "Session '#{session.label}' cannot import records from itself"
+      end
+    end
+
     # Raised during generator lookup if an unknown profile is requested.
     class GeneratorUnknownError < KBSecretError
+      # @param gen [String, Symbol] the label of the generator
       def initialize(gen)
         super "Unknown generator profile: '#{gen}'"
       end
@@ -52,6 +76,7 @@ module KBSecret
 
     # Raised during generator creation if an unknown generator format is requested.
     class GeneratorFormatError < KBSecretError
+      # @param fmt [String, Symbol] the format of the generator
       def initialize(fmt)
         super "Unknown generator format: '#{fmt}'"
       end
@@ -59,6 +84,7 @@ module KBSecret
 
     # Raised during generator creation if a non-positive generator length is requested.
     class GeneratorLengthError < KBSecretError
+      # @param length [Integer] the length of the generator
       def initialize(length)
         super "Bad secret generator length (#{length}, must be positive)"
       end

data/lib/kbsecret/session.rb

@@ -62,17 +62,25 @@ module KBSecret
     # @param type [String, Symbol] the type of record (see {Record.record_types})
     # @param label [String, Symbol] the new record's label
     # @param args [Array<String>] the record-type specific arguments
+    # @param overwrite [Boolean] whether or not to overwrite an existing record if necessary
     # @return [void]
     # @raise [Exceptions::UnknownRecordTypeError] if the requested type does not exist
     #  in {Record.record_types}
     # @raise [Exceptions::RecordCreationArityError] if the number of specified record
     #  arguments does not match the record type's constructor
-    def add_record(type, label, *args)
+    # @raise [Exceptions::RecordOverwriteError] if the record addition would cause an
+    #  unchecked overwrite
+    def add_record(type, label, *args, overwrite: false)
       klass = Record.class_for(type.to_sym)
       arity = klass.external_fields.length
 
       raise Exceptions::RecordCreationArityError.new(arity, args.size) unless arity == args.size
 
+      if record? label
+        raise Exceptions::RecordOverwriteError.new(self, label) unless overwrite
+        delete_record label
+      end
+
       body   = klass.external_fields.zip(args).to_h
       record = klass.new(self, label.to_s, **body)
 
@@ -80,6 +88,26 @@ module KBSecret
       record.sync!
     end
 
+    # Import an existing record from another session.
+    # @param record [Record] the record to import
+    # @param overwrite [Boolean] whether or not to overwrite an existing record if necessary
+    # @return [void]
+    # @raise [Exceptions::SessionImportError] if the record's source session is our session
+    # @raise [Exceptions::RecordOverwriteError] if record import would cause an unchecked overwrite
+    def import_record(record, overwrite: false)
+      raise Exceptions::SessionImportError, self if self == record.session
+
+      if record? record.label
+        raise Exceptions::RecordOverwriteError.new(self, record.label) unless overwrite
+        delete_record record.label
+      end
+
+      klass = record.class
+      imported_record = klass.load!(self, record.to_h)
+      records << imported_record
+      imported_record.sync!
+    end
+
     # Delete a record from the session, if it exists. Does nothing if
     # no such record can be found.
     # @param label [String, Symbol] the label of the record to delete
@@ -113,6 +141,15 @@ module KBSecret
       Dir[File.join(path, "*.json")]
     end
 
+    # Compare two sessions for equality.
+    # @param other [Session] the other object to compare against
+    # @return [Boolean] whether or not the two sessions are equal
+    # @note The equality of two sessions is determined *solely* by them having the same
+    #  session directory, *not* by having the same label *or* the same in-memory state.
+    def ==(other)
+      other.class == self.class && other.path == path
+    end
+
     # Load all records associated with the session.
     # @return [Array<Record::Abstract>] all records in the session
     # @api private

data/lib/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kbsecret
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 0.9.6
 platform: ruby
 authors:
 - William Woodruff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-30 00:00:00.000000000 Z
+date: 2017-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aruba
@@ -137,61 +137,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: colored2
+  name: dreck
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: 0.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: 0.2.1
 - !ruby/object:Gem::Dependency
-  name: dreck
+  name: inih
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: inih
+  name: keybase-unofficial
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: keybase-unofficial
+  name: pastel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: slop
   requirement: !ruby/object:Gem::Requirement
@@ -233,6 +233,7 @@ files:
 - bin/kbsecret
 - lib/kbsecret.rb
 - lib/kbsecret/cli.rb
+- lib/kbsecret/cli/kbsecret-cp
 - lib/kbsecret/cli/kbsecret-dump-fields
 - lib/kbsecret/cli/kbsecret-env
 - lib/kbsecret/cli/kbsecret-generator