kbsecret 0.7.2 → 0.8.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f7ecf6f46bf93d8b097aff9017725676147e6a2
-  data.tar.gz: 5e80a9ab48b57a1f2da0e560351230fafe46e9e0
+  metadata.gz: 8f9e6f8ce574fa59a334356df9e032d0a9eaf520
+  data.tar.gz: 58c8df01baa2fe0a7ace5703fd8d1c4a73caa29b
 SHA512:
-  metadata.gz: ea1c32677807dd0c0fcd234087c4f092fb64d9814de5b912e2649b4dfe3f4914a0eb5554cecdfab3c03e7f2deae52b7ab3069d8df80e6be3062ae8fcb8211e31
-  data.tar.gz: f04e0bb37a20cb9af814685bbe7193e638943e6f30f53aebe554506761639eca2ebf2f65170cf5a0d40819d2f97b9320c43a1a94b2da9f499ef9946c8f920e9a
+  metadata.gz: 91d6dbb411d5f653d35b5d094283a0654429ecad6d125ea461347749c06fe0b98c054a7edf0e58039261dd15406ce98ed8c24d1b6559ec8ef7bc5bc736efeb3d
+  data.tar.gz: c2360326474745633cffb71f4c6e02b21b58865d753657f1de3272a3c0b7d104ce6f005aefb46dc756c93562fe2b10e94a65442f7b505e73d8a6f78787720e9d

data/README.md

@@ -1,4 +1,4 @@
-KBSsecret
+KBSecret
 ========
 
 [![Gem Version](https://badge.fury.io/rb/kbsecret.svg)](https://badge.fury.io/rb/kbsecret)

data/bin/kbsecret

@@ -5,6 +5,12 @@ require "kbsecret"
 
 BUILTIN_CMDS = %w[help version commands types conf].freeze
 
+INTERNAL_CMD_PATH = File.expand_path("../lib/kbsecret/cli")
+
+INTERNAL_PATHS = Dir[File.join(INTERNAL_CMD_PATH, "*")].freeze
+
+INTERNAL_CMDS = INTERNAL_PATHS.map { |p| File.basename(p).sub!("kbsecret-", "") }
+
 EXT_PATHS = ENV["PATH"].split(File::PATH_SEPARATOR).map do |path|
   Dir[File.join(path, "kbsecret-*")]
 end.flatten.uniq.freeze
@@ -20,7 +26,7 @@ ALIASES = Hash.new { |_, k| k }.update(
   "-v" => "version"
 ).freeze
 
-ALL_CMDS = (ALIASES.keys + BUILTIN_CMDS + EXT_CMDS).freeze
+ALL_CMDS = (ALIASES.keys + BUILTIN_CMDS + INTERNAL_CMDS + EXT_CMDS).freeze
 
 KBSECRET_HELP = <<~EOS
   Usage:
@@ -33,6 +39,10 @@ KBSECRET_HELP = <<~EOS
     kbsecret help <command>
 EOS
 
+def internal?(cmd)
+  INTERNAL_CMDS.include?(cmd)
+end
+
 def external?(cmd)
   EXT_CMDS.include?(cmd)
 end
@@ -51,7 +61,12 @@ end
 
 def expand(cmd)
   return cmd if alias?(cmd) || builtin?(cmd)
-  "kbsecret-#{cmd}"
+
+  if internal? cmd
+    File.join(INTERNAL_CMD_PATH, "kbsecret-#{cmd}")
+  else
+    "kbsecret-#{cmd}"
+  end
 end
 
 def help(*args)
@@ -60,10 +75,10 @@ def help(*args)
     puts KBSECRET_HELP
   elsif builtin? command
     send "#{command}_help"
-  elsif external? command
-    # XXX: this probably doesn't make sense, since not every user command
-    # will implement --help.
+  elsif internal? command
     exec expand(command), "--help"
+  elsif external? command
+    KBSecret::CLI.die "Help is not available for external commands."
   else
     KBSecret::CLI.die "Unknown command: '#{command}'."
   end
@@ -141,9 +156,9 @@ end
 
 command = normalize(ARGV.shift || "help")
 
-if builtin? command
+if builtin?(command)
   send command, *ARGV
-elsif external? command
+elsif external?(command) || internal?(command)
   exec expand(command), *ARGV
 else
   KBSecret::CLI.die "Unknown command: '#{command}'."

data/lib/kbsecret.rb

@@ -10,7 +10,7 @@ require_relative "kbsecret/session"
 require_relative "kbsecret/generator"
 require_relative "kbsecret/cli"
 
-# The primary namespace for kbsecret.
+# The primary namespace for {KBSecret}.
 module KBSecret
   # fail very early if the user doesn't have keybase and KBFS running
   raise Keybase::KeybaseNotRunningError unless Keybase.running?

data/lib/kbsecret/config.rb

@@ -19,12 +19,12 @@ module KBSecret
     CONFIG_FACETS = {
       session: {
         plural: :sessions,
-        except: SessionUnknownError,
+        except: Exceptions::SessionUnknownError,
       },
 
       generator: {
         plural: :generators,
-        except: GeneratorUnknownError,
+        except: Exceptions::GeneratorUnknownError,
       },
     }.freeze
 
@@ -65,44 +65,44 @@ module KBSecret
       @config[key]
     end
 
-    # @!method session
+    # @!method session(label)
     #   Retrieve a session's configuration.
     #   @param label [String, Symbol] the session's label
     #   @return [Hash] the session configuration
-    #   @raise [SessionUnknownError] if no such session exists
+    #   @raise [Exceptions::SessionUnknownError] if no such session exists
     # @!method session_labels
     #   @return [Array<Symbol>] all configured session labels
-    # @!method session?
+    # @!method session?(label)
     #   @param label [String, Symbol] the session label
     #   @return [Boolean] whether or not the given session is configured
-    # @!method configure_session
+    # @!method configure_session(label, hsh)
     #   Configure a session.
     #   @param label [String, Symbol] the session label
     #   @param hsh [Hash] the session configuration
     #   @return [void]
-    # @!method deconfigure_session
+    # @!method deconfigure_session(label)
     #   Deconfigure a session.
     #   @param label [String, Symbol] the session label
     #   @return [void]
     #   @note This only removes the given session from the configuration, making
     #    it "invisible" to `kbsecret`. To actually remove all files associated
     #    with a session, see {KBSecret::Session#unlink!}.
-    # @!method generator
+    # @!method generator(label)
     #   Retrieve a generator's configuration.
-    #   @param gen [String, Symbol] the generator's label
+    #   @param label [String, Symbol] the generator's label
     #   @return [Hash] the generator configuration
-    #   @raise [GeneratorUnknownError] if no such generator exists
+    #   @raise [Exceptions::GeneratorUnknownError] if no such generator exists
     # @!method generator_labels
     #   @return [Array<Symbol>] all configured session labels
-    # @!method generator?
-    #   @param gen [String, Symbol] the generator label
+    # @!method generator?(label)
+    #   @param label [String, Symbol] the generator label
     #   @return [Boolean] whether or not the given generator is configured
-    # @!method configure_generator
+    # @!method configure_generator(label, hsh)
     #   Configure a secret generator.
     #   @param label [String, Symbol] the generator label (profile name)
     #   @param hsh [Hash] the generator configuration
     #   @return [void]
-    # @!method deconfigure_generator
+    # @!method deconfigure_generator(label)
     #   Deconfigure a generator.
     #   @param label [String, Symbol] the generator label (profile name)
     #   @return [void]

data/lib/kbsecret/exceptions.rb

@@ -1,64 +1,67 @@
 # frozen_string_literal: true
 
 module KBSecret
-  # A generic error in kbsecret.
-  class KBSecretError < RuntimeError
-  end
+  # A namespace for all exceptions used by {KBSecret}.
+  module Exceptions
+    # A generic error in {KBSecret}.
+    class KBSecretError < RuntimeError
+    end
 
-  # Raised during record loading if a particular file can't be loaded
-  class RecordLoadError < KBSecretError
-    def initialize(path)
-      base = File.basename(path)
-      super "Failed to load record in file: '#{base}'"
+    # Raised during record loading if a particular file can't be loaded
+    class RecordLoadError < KBSecretError
+      def initialize(path)
+        base = File.basename(path)
+        super "Failed to load record in file: '#{base}'"
+      end
     end
-  end
 
-  # Raised during record creation if an unknown record type is requested.
-  class RecordTypeUnknownError < KBSecretError
-    def initialize(type)
-      super "Unknown record type: '#{type}'"
+    # Raised during record creation if an unknown record type is requested.
+    class RecordTypeUnknownError < KBSecretError
+      def initialize(type)
+        super "Unknown record type: '#{type}'"
+      end
     end
-  end
 
-  # Raised during record creation if too many/few arguments are given.
-  class RecordCreationArityError < KBSecretError
-    def initialize(exp, act)
-      super "Needed #{exp} arguments for this record, got #{act}"
+    # Raised during record creation if too many/few arguments are given.
+    class RecordCreationArityError < KBSecretError
+      def initialize(exp, act)
+        super "Needed #{exp} arguments for this record, got #{act}"
+      end
     end
-  end
 
-  # Raised during session load if an error occurs.
-  class SessionLoadError < KBSecretError
-    def initialize(msg)
-      super "Session loading failure: #{msg}"
+    # Raised during session load if an error occurs.
+    class SessionLoadError < KBSecretError
+      def initialize(msg)
+        super "Session loading failure: #{msg}"
+      end
     end
-  end
 
-  # Raised during session lookup if an unknown session is requested.
-  class SessionUnknownError < KBSecretError
-    def initialize(sess)
-      super "Unknown session: '#{sess}'"
+    # Raised during session lookup if an unknown session is requested.
+    class SessionUnknownError < KBSecretError
+      def initialize(sess)
+        super "Unknown session: '#{sess}'"
+      end
     end
-  end
 
-  # Raised during generator lookup if an unknown profile is requested.
-  class GeneratorUnknownError < KBSecretError
-    def initialize(gen)
-      super "Unknown generator profile: '#{gen}'"
+    # Raised during generator lookup if an unknown profile is requested.
+    class GeneratorUnknownError < KBSecretError
+      def initialize(gen)
+        super "Unknown generator profile: '#{gen}'"
+      end
     end
-  end
 
-  # Raised during generator creation if an unknown generator format is requested.
-  class GeneratorFormatError < KBSecretError
-    def initialize(fmt)
-      super "Unknown generator format: '#{fmt}'"
+    # Raised during generator creation if an unknown generator format is requested.
+    class GeneratorFormatError < KBSecretError
+      def initialize(fmt)
+        super "Unknown generator format: '#{fmt}'"
+      end
     end
-  end
 
-  # Raised during generator creation if a non-positive generator length is requested.
-  class GeneratorLengthError < KBSecretError
-    def initialize(length)
-      super "Bad secret generator length (#{length}, must be positive)"
+    # Raised during generator creation if a non-positive generator length is requested.
+    class GeneratorLengthError < KBSecretError
+      def initialize(length)
+        super "Bad secret generator length (#{length}, must be positive)"
+      end
     end
   end
 end

data/lib/kbsecret/generator.rb

@@ -15,14 +15,14 @@ module KBSecret
     attr_reader :length
 
     # @param profile [Symbol, String] the label of the generator profile to use
-    # @raise [GeneratorLengthError] if the profile has a non-positive length
-    # @raise [GeneratorFormatError] if the profile has an unknown format
+    # @raise [Exceptions::GeneratorLengthError] if the profile has a non-positive length
+    # @raise [Exceptions::GeneratorFormatError] if the profile has an unknown format
     def initialize(profile = :default)
       @format = Config.generator(profile)[:format].to_sym
       @length = Config.generator(profile)[:length].to_i
 
-      raise GeneratorLengthError, @length unless @length.positive?
-      raise GeneratorFormatError, @format unless GENERATOR_TYPES.include?(@format)
+      raise Exceptions::GeneratorLengthError, @length unless @length.positive?
+      raise Exceptions::GeneratorFormatError, @format unless GENERATOR_TYPES.include?(@format)
     end
 
     # @return [String] a new secret based on the {format} and {length} of the {Generator}

data/lib/kbsecret/record.rb

@@ -24,10 +24,10 @@ module KBSecret
 
     # @param type [String, Symbol] the record type
     # @return [Class] the record class corresponding to the given type
-    # @raise [RecordTypeUnknownError] if the requested type is unknown
+    # @raise [Exceptions::RecordTypeUnknownError] if the requested type is unknown
     def self.class_for(type)
       klass = record_classes.find { |c| c.type == type.to_sym }
-      raise RecordTypeUnknownError, type unless klass
+      raise Exceptions::RecordTypeUnknownError, type unless klass
       klass
     end
 
@@ -42,14 +42,14 @@ module KBSecret
     # @param session [Session] the session to load into
     # @param path [String] the fully-qualified record path
     # @return [Record::AbstractRecord] the loaded record
-    # @raise [RecordLoadError] if an error occurs during record loading
+    # @raise [Exceptions::RecordLoadError] if an error occurs during record loading
     # @api private
     def self.load_record!(session, path)
       hsh   = JSON.parse(File.read(path), symbolize_names: true)
       klass = record_classes.find { |c| c.type == hsh[:type].to_sym }
       klass&.load!(session, hsh)
     rescue
-      raise RecordLoadError, path
+      raise Exceptions::RecordLoadError, path
     end
   end
 end

data/lib/kbsecret/session.rb

@@ -17,7 +17,7 @@ module KBSecret
     attr_reader :directory
 
     # @param label [String, Symbol] the label of the session to initialize
-    # @raise [SessionLoadError] if the session has no users or any invalid Keybase users
+    # @raise [Exceptions::SessionLoadError] if the session has no users or any invalid Keybase users
     # @note This does not *create* a new session, but loads one already
     #  specified in {Config::CONFIG_FILE}. To *create* a new session,
     #  see {Config.configure_session}.
@@ -25,10 +25,10 @@ module KBSecret
       @label     = label.to_sym
       @config    = Config.session(@label)
 
-      raise SessionLoadError, "no users in session" if @config[:users].empty?
+      raise Exceptions::SessionLoadError, "no users in session" if @config[:users].empty?
 
       @config[:users].each do |user|
-        raise SessionLoadError, "unknown Keybase user: '#{user}'" unless Keybase::API.user? user
+        raise Exceptions::SessionLoadError, "unknown user: '#{user}'" unless Keybase::API.user? user
       end
 
       @directory = rel_path mkdir: true
@@ -64,15 +64,15 @@ module KBSecret
     # @param label [String, Symbol] the new record's label
     # @param args [Array<String>] the record-type specific arguments
     # @return [void]
-    # @raise [UnknownRecordTypeError] if the requested type does not exist
+    # @raise [Exceptions::UnknownRecordTypeError] if the requested type does not exist
     #  in {Record.record_types}
-    # @raise [RecordCreationArityError] if the number of specified record
+    # @raise [Exceptions::RecordCreationArityError] if the number of specified record
     #  arguments does not match the record type's constructor
     def add_record(type, label, *args)
       klass = Record.class_for(type.to_sym)
       arity = klass.external_fields.length
 
-      raise RecordCreationArityError.new(arity, args.size) unless arity == args.size
+      raise Exceptions::RecordCreationArityError.new(arity, args.size) unless arity == args.size
 
       body   = klass.external_fields.zip(args).to_h
       record = klass.new(self, label.to_s, **body)

data/lib/version.rb

@@ -2,5 +2,5 @@
 
 module KBSecret
   # kbsecret's current version
-  VERSION = "0.7.2"
+  VERSION = "0.8.0.pre.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kbsecret
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.8.0.pre.1
 platform: ruby
 authors:
 - William Woodruff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-19 00:00:00.000000000 Z
+date: 2017-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fpm
@@ -153,22 +153,7 @@ dependencies:
 description: Manages your passwords, environment, and more via KBFS.
 email: william@tuffbizz.com
 executables:
-- kbsecret-pass
 - kbsecret
-- kbsecret-rm
-- kbsecret-login
-- kbsecret-raw-edit
-- kbsecret-todo
-- kbsecret-generator
-- kbsecret-new
-- kbsecret-generators
-- kbsecret-dump-fields
-- kbsecret-stash-file
-- kbsecret-rm-session
-- kbsecret-env
-- kbsecret-new-session
-- kbsecret-list
-- kbsecret-sessions
 extensions: []
 extra_rdoc_files: []
 files:
@@ -176,23 +161,23 @@ files:
 - LICENSE
 - README.md
 - bin/kbsecret
-- bin/kbsecret-dump-fields
-- bin/kbsecret-env
-- bin/kbsecret-generator
-- bin/kbsecret-generators
-- bin/kbsecret-list
-- bin/kbsecret-login
-- bin/kbsecret-new
-- bin/kbsecret-new-session
-- bin/kbsecret-pass
-- bin/kbsecret-raw-edit
-- bin/kbsecret-rm
-- bin/kbsecret-rm-session
-- bin/kbsecret-sessions
-- bin/kbsecret-stash-file
-- bin/kbsecret-todo
 - lib/kbsecret.rb
 - lib/kbsecret/cli.rb
+- lib/kbsecret/cli/kbsecret-dump-fields
+- lib/kbsecret/cli/kbsecret-env
+- lib/kbsecret/cli/kbsecret-generator
+- lib/kbsecret/cli/kbsecret-generators
+- lib/kbsecret/cli/kbsecret-list
+- lib/kbsecret/cli/kbsecret-login
+- lib/kbsecret/cli/kbsecret-new
+- lib/kbsecret/cli/kbsecret-new-session
+- lib/kbsecret/cli/kbsecret-pass
+- lib/kbsecret/cli/kbsecret-raw-edit
+- lib/kbsecret/cli/kbsecret-rm
+- lib/kbsecret/cli/kbsecret-rm-session
+- lib/kbsecret/cli/kbsecret-sessions
+- lib/kbsecret/cli/kbsecret-stash-file
+- lib/kbsecret/cli/kbsecret-todo
 - lib/kbsecret/config.rb
 - lib/kbsecret/exceptions.rb
 - lib/kbsecret/generator.rb
@@ -220,9 +205,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.11