kbsecret 1.2.0 → 1.3.0.pre.1

data/lib/kbsecret/cli/command/pass.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "clipboard"
+
+module KBSecret
+  class CLI
+    module Command
+      # The implementation of `kbsecret pass`.
+      class Pass < Abstract
+        def initialize(argv)
+          super(argv) do |cli|
+            cli.slop do |o|
+              o.banner = <<~HELP
+                Usage:
+                  kbsecret pass [options] <record>
+              HELP
+
+              o.string "-s", "--session", "the session to search in", default: :default
+              o.bool "-c", "--clipboard", "dump the password in the clipboard"
+            end
+
+            cli.dreck do
+              string :label
+            end
+
+            cli.ensure_session!
+          end
+        end
+
+        # @see Command::Abstract#setup!
+        def setup!
+          @record = cli.session[cli.args[:label]]
+        end
+
+        # @see Command::Abstract#validate!
+        def validate!
+          cli.die "No such login record." unless @record && @record.type == :login
+        end
+
+        # @see Command::Abstract#run!
+        def run!
+          if cli.opts.clipboard?
+            Clipboard.copy @record.password
+          else
+            puts @record.password
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kbsecret/cli/command/raw_edit.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module KBSecret
+  class CLI
+    module Command
+      # The implementation of `kbsecret raw-edit`.
+      class RawEdit < Abstract
+        def initialize(argv)
+          super(argv) do |cli|
+            cli.slop do |o|
+              o.banner = <<~HELP
+                Usage:
+                  kbsecret raw-edit [options] <record>
+              HELP
+
+              o.string "-s", "--session", "the session to search in", default: :default
+            end
+
+            cli.dreck do
+              string :label
+            end
+
+            cli.ensure_session!
+          end
+        end
+
+        # @see Command::Abstract#setup!
+        def setup!
+          @record = cli.session[cli.args[:label]]
+        end
+
+        # @see Command::Abstract#validate!
+        def validate!
+          cli.die "Missing $EDITOR." unless ENV["EDITOR"]
+          cli.die "No such record." unless @record
+        end
+
+        # @see Command::Abstract#run!
+        def run!
+          Process.spawn("#{ENV["EDITOR"]} #{@record.path}")
+          @record.sync! # just to bump the timestamp
+        end
+      end
+    end
+  end
+end

data/lib/kbsecret/cli/command/rm.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "tty-prompt"
+
+module KBSecret
+  class CLI
+    module Command
+      # The implementation of `kbsecret rm`.
+      class Rm < Abstract
+        def initialize(argv)
+          super(argv) do |cli|
+            cli.slop do |o|
+              o.banner = <<~HELP
+                Usage:
+                  kbsecret rm [options] <record [record ...]>
+              HELP
+
+              o.string "-s", "--session", "the session containing the record", default: :default
+              o.bool "-i", "--interactive", "ask for confirmation before deleting"
+            end
+
+            cli.dreck do
+              list :string, :labels
+            end
+
+            cli.ensure_session!
+          end
+        end
+
+        # @see Command::Abstract#setup!
+        def setup!
+          @selected_records = cli.session.records.select do |record|
+            cli.args[:labels].include? record.label
+          end
+        end
+
+        # @see Command::Abstract#validate!
+        def validate!
+          cli.die "No such record(s)." if @selected_records.empty?
+        end
+
+        # @see Command::Abstract#run!
+        def run!
+          $VERBOSE = nil # tty-prompt blasts us with irrelevant warnings on 2.4
+
+          tty = TTY::Prompt.new
+
+          confirm = if cli.opts.interactive?
+                      tty.yes?("Delete '#{selected_records.join(", ")}'?")
+                    else true
+                    end
+
+          @selected_records.each { |r| cli.session.delete_record(r.label) } if confirm
+        end
+      end
+    end
+  end
+end

data/lib/kbsecret/cli/command/session.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+module KBSecret
+  class CLI
+    module Command
+      # The implementation of `kbsecret session`.
+      class Session < Abstract
+        # The list of subcommands supported by `kbsecret session`.
+        SUBCOMMANDS = %w[new rm].freeze
+
+        def initialize(argv)
+          super(argv) do |cli|
+            cli.slop cmds: SUBCOMMANDS do |o|
+              o.banner = <<~HELP
+                Usage:
+                  kbsecret session [options] <new|rm> <label>
+              HELP
+
+              o.string "-t", "--team", "the team to create the session under"
+              o.array "-u", "--users", "the Keybase users", default: [Keybase::Local.current_user]
+              o.string "-r", "--root", "the secret root directory"
+              o.bool "-c", "--create-team", "create the Keybase team if it does not exist"
+              o.bool "-f", "--force", "force creation (ignore overwrites, etc.)"
+              o.bool "-n", "--no-notify", "do not send a notification to session members"
+              o.bool "-d", "--delete", "unlink the session in addition to deconfiguration"
+            end
+
+            cli.dreck do
+              string :command
+              string :session
+            end
+
+            cli.ensure_session! :argument if cli.args[:command] == "rm"
+          end
+        end
+
+        # @see Command::Abstract#setup!
+        def setup!
+          @label = cli.args[:session]
+          @subcmd = cli.args[:command]
+        end
+
+        # @see Command::Abstract#validate!
+        def validate!
+          cli.die "Unknown subcommand: #{@subcmd}." unless SUBCOMMANDS.include?(@subcmd)
+        end
+
+        # @see Command::Abstract#run!
+        def run!
+          case @subcmd
+          when "new"
+            new_session
+          when "rm"
+            rm_session
+          end
+        end
+
+        # @api private
+        # @return [void]
+        def new_session
+          if Config.session?(@label) && !cli.opts.force?
+            cli.die "Refusing to overwrite a session without --force."
+          end
+
+          if cli.opts[:team]
+            teams = Keybase::Local::Team.list_self_memberships.teams
+
+            unless teams.map(&:fq_name).include?(cli.opts[:team])
+              if cli.opts.create_team?
+                cli.guard do
+                  Keybase::Local::Team.create_team cli.opts[:team]
+                  Keybase::Local::Team.add_members cli.opts[:team], users: [{
+                    username: Keybase::Local.current_user,
+                    role: "admin",
+                  }]
+                end
+              else
+                cli.die "No such team (either nonexistent or non-member)."
+              end
+            end
+
+            Config.configure_session(@label, team: cli.opts[:team], root: @label)
+          else
+            cli.die "Missing `-r', `--root' option." unless cli.opts[:root]
+
+            cli.opts[:users].each do |user|
+              cli.die "Nonexistent Keybase user: #{user}." unless Keybase::API.user? user
+            end
+
+            unless cli.opts[:users].include? Keybase::Local.current_user
+              cli.warn "You didn't include yourself in the user list, but I'll add you."
+              cli.opts[:users] << Keybase::Local.current_user
+            end
+
+            Config.configure_session(@label, users: cli.opts[:users], root: cli.opts[:root])
+
+            unless cli.opts.no_notify? && cli.opts[:users] != [Keybase::Local.current_user]
+              users = cli.opts[:users].join(",")
+
+              Keybase::Local::Chat.send_message cli.opts[:users], <<~MESSAGE
+                You've been added to a KBSecret session!
+
+                To access this session, please run the following:
+
+                ```
+                  $ kbsecret session new -r '#{cli.opts[:root]}' -u #{users} <label>
+                ```
+
+                If you don't have KBSecret installed, you can install it from `gem`:
+
+                ```
+                  $ gem install kbsecret
+                ```
+              MESSAGE
+            end
+          end
+        end
+
+        # @api private
+        # @return [void]
+        def rm_session
+          cli.session.unlink! if cli.opts.delete?
+          Config.deconfigure_session @label
+        end
+      end
+    end
+  end
+end

data/lib/kbsecret/cli/command/sessions.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module KBSecret
+  class CLI
+    module Command
+      # The implementation of `kbsecret sessions`.
+      class Sessions < Abstract
+        def initialize(argv)
+          super(argv) do |cli|
+            cli.slop do |o|
+              o.banner = <<~HELP
+                Usage:
+                  kbsecret sessions [options]
+              HELP
+
+              o.bool "-a", "--show-all", "show each session in depth (i.e. metadata)"
+            end
+          end
+        end
+
+        # @see Command::Abstract#run!
+        def run!
+          Config.session_labels.each do |sess_name|
+            session_hash = Config.session(sess_name)
+            session      = cli.guard { Session[sess_name] }
+
+            puts sess_name
+
+            next unless cli.opts.show_all?
+
+            if session_hash[:team]
+              puts <<~DETAIL
+                \tTeam: #{session_hash[:team]}
+                \tSecrets root: #{session_hash[:root]} (#{session.path})
+              DETAIL
+            else
+              puts <<~DETAIL
+                \tUsers: #{session_hash[:users].join(", ")}
+                \tSecrets root: #{session_hash[:root]} (#{session.path})
+              DETAIL
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kbsecret/cli/command/stash_file.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "base64"
+
+module KBSecret
+  class CLI
+    module Command
+      # The implementation of `kbsecret stash-file`.
+      class StashFile < Abstract
+        def initialize(argv)
+          super(argv) do |cli|
+            cli.slop do |o|
+              o.banner = <<~HELP
+                Usage:
+                  kbsecret stash-file <record> [file]
+              HELP
+
+              o.string "-s", "--session", "the session to add to", default: :default
+              o.bool "-f", "--force", "force creation (ignore overwrites, etc.)"
+              o.bool "-b", "--base64", "encode the file as base64"
+            end
+
+            cli.dreck do
+              string :label
+              string :filename
+            end
+
+            cli.ensure_session!
+          end
+        end
+
+        # @see Command::Abstract#setup!
+        def setup!
+          @label = cli.args[:label]
+          @filename = cli.args[:filename]
+        end
+
+        # @see Command::Abstract#validate!
+        def validate!
+          if cli.session.record?(@label) && !cli.opts.force?
+            cli.die "Refusing to overwrite a record without --force."
+          end
+
+          cli.die "No such file." unless File.file?(@filename) || @filename == "-"
+        end
+
+        # @see Command::Abstract#run!
+        def run!
+          contents = if @filename == "-"
+                       STDIN.read
+                     elsif File.file?(@filename)
+                       File.read(@filename)
+                     end
+
+          contents = Base64.encode64(contents) if cli.opts.base64?
+
+          cli.guard { cli.session.add_record(:unstructured, @label, contents) }
+        end
+      end
+    end
+  end
+end

data/lib/kbsecret/cli/command/todo.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module KBSecret
+  class CLI
+    module Command
+      # The implementation of `kbsecret todo`.
+      class Todo < Abstract
+        # The list of subcommands supported by `kbsecret todo`.
+        SUBCOMMANDS = %w[start suspend complete].freeze
+
+        def initialize(argv)
+          super(argv) do |cli|
+            cli.slop cmds: SUBCOMMANDS do |o|
+              o.banner = <<~HELP
+                Usage:
+                  kbsecret todo <start|suspend|complete> <record>
+              HELP
+
+              o.string "-s", "--session", "the session to search in", default: :default
+            end
+
+            cli.dreck do
+              string :command
+              string :label
+            end
+
+            cli.ensure_session!
+          end
+        end
+
+        # @see Command::Abstract#setup!
+        def setup!
+          @todo = cli.session[cli.args[:label]]
+          @subcmd = cli.args[:command]
+        end
+
+        # @see Command::Abstract#validate!
+        def validate!
+          cli.die "No such todo record:." unless @todo && @todo.type == :todo
+          cli.die "Unknown subcommand: #{@subcmd}." unless SUBCOMMANDS.include?(@subcmd)
+        end
+
+        # @see Command::Abstract#setup!
+        def run!
+          case @subcmd
+          when "start" then start_todo
+          when "suspend" then suspend_todo
+          when "complete" then complete_todo
+          end
+        end
+
+        # Starts the todo associated with the current invocation, unless already started.
+        # @return [void]
+        def start_todo
+          cli.die "That task is already started!" if @todo.started?
+          @todo.start!
+          puts "#{@todo.label}: '#{@todo.todo}' marked as started at #{@todo.start}"
+        end
+
+        # Suspends the todo associated with the current invocation, unless already suspended.
+        # @return [void]
+        def suspend_todo
+          cli.die "That task is already suspended!" if @todo.suspended?
+          @todo.suspend!
+          puts "#{@todo.label}: '#{@todo.todo}' marked as suspended at #{@todo.stop}"
+        end
+
+        # Completes the todo associated with the current invocation, unless already completed.
+        # @return [void]
+        def complete_todo
+          cli.die "That task is already completed!" if @todo.completed?
+          @todo.complete!
+          puts "#{@todo.label}: '#{@todo.todo}' marked as completed at #{@todo.stop}"
+        end
+      end
+    end
+  end
+end

data/lib/kbsecret/cli/command.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+# we have to require abstract first because ruby's module resolution is bad
+require_relative "command/abstract"
+Dir[File.join(__dir__, "command/*.rb")].each { |t| require_relative t }
+
+module KBSecret
+  class CLI
+    # The namespace for {KBSecret}'s internal commands.
+    module Command
+      module_function
+
+      # @return [Array<Class>] the class objects of all non-abstract commands
+      def command_classes
+        klasses = constants.map(&Command.method(:const_get)).grep(Class)
+        klasses.delete(Command::Abstract)
+        klasses
+      end
+
+      # @return [Array<String>] the CLI-friendly names of all commands
+      def command_names
+        command_classes.map(&:command_name)
+      end
+
+      # @param command_name [String] the CLI-friendly name of the command
+      # @return [Class, nil] the command class corresponding to the given name, or `nil`
+      def command_for(command_name)
+        klass = command_classes.find { |c| c.command_name == command_name }
+        # TODO: raise here if nil?
+        klass
+      end
+
+      # @param command_name [String] the CLI-friendly name of the command to run
+      # @param args [Array<String>] the arguments, if any, to pass to the command
+      # @return [void]
+      def run!(command_name, *args)
+        klass = command_for command_name
+        cmd = klass.new(args)
+        cmd.setup!
+        cmd.validate!
+        cmd.run!
+      end
+    end
+  end
+end

data/lib/kbsecret/cli.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "cli/command"
+
 require "slop"
 require "dreck"
 require "abbrev"
@@ -47,14 +49,14 @@ module KBSecret
     #
     #  cmd.opts # => Slop::Result
     #  cmd.args # => Dreck::Result
-    def self.create(&block)
-      CLI.new(&block)
+    def self.create(argv = ARGV, &block)
+      CLI.new(argv, &block)
     end
 
     # @api private
     # @deprecated see {create}
-    def initialize
-      @argv = ARGV.dup
+    def initialize(argv = ARGV)
+      @argv = argv.dup
       guard { yield self }
     end
 

data/lib/kbsecret/config.rb

@@ -65,7 +65,7 @@ module KBSecret
     # Writes the user's configuration to disk.
     # @return [void]
     def self.sync!
-      File.open(CONFIG_FILE, "w") { |io| io.write @config.to_yaml }
+      File.write(CONFIG_FILE, @config.to_yaml)
     end
 
     # Retrieve a configured value.
@@ -167,8 +167,6 @@ module KBSecret
     user_config = if File.exist?(CONFIG_FILE)
                     YAML.load_file(CONFIG_FILE)
                   else
-                    FileUtils.mkdir_p CONFIG_DIR
-                    FileUtils.mkdir_p CUSTOM_TYPES_DIR
                     DEFAULT_CONFIG
                   end
 
@@ -182,6 +180,9 @@ module KBSecret
     @config[:sessions].merge!(DEFAULT_SESSION)
     @config[:generators].merge!(DEFAULT_GENERATOR)
 
+    FileUtils.mkdir_p CONFIG_DIR
+    FileUtils.mkdir_p CUSTOM_TYPES_DIR
+
     sync!
   end
 end

data/lib/kbsecret/record/abstract.rb

@@ -5,7 +5,7 @@ require "forwardable"
 
 module KBSecret
   module Record
-    # Represents an abstract kbsecret record that can be subclassed to produce
+    # Represents an abstract {KBSecret} record that can be subclassed to produce
     # more useful records.
     # @abstract
     class Abstract
@@ -61,7 +61,7 @@ module KBSecret
               @timestamp = Time.now.to_i
               sync!
             end
-          ]
+          ], __FILE__, __LINE__ - 10
         end
 
         # @param field [Symbol] the field's name

data/lib/kbsecret/record.rb

@@ -12,22 +12,24 @@ Dir[File.join(__dir__, "record/*.rb")].each { |t| require_relative t }
 module KBSecret
   # The namespace for {KBSecret} record types.
   module Record
+    module_function
+
     # @return [Array<Class>] the class objects of all non-abstract record types
-    def self.record_classes
+    def record_classes
       klasses = constants.map(&Record.method(:const_get)).grep(Class)
       klasses.delete(Record::Abstract)
       klasses
     end
 
     # @return [Array<Symbol>] the types of all records
-    def self.record_types
+    def record_types
       record_classes.map(&:type)
     end
 
     # @param type [String, Symbol] the record type
     # @return [Class] the record class corresponding to the given type
     # @raise [Exceptions::RecordTypeUnknownError] if the requested type is unknown
-    def self.class_for(type)
+    def class_for(type)
       klass = record_classes.find { |c| c.type == type.to_sym }
       raise Exceptions::RecordTypeUnknownError, type unless klass
       klass
@@ -35,7 +37,7 @@ module KBSecret
 
     # @param type [String, Symbol] the record type
     # @return [Boolean] whether a record class exists of the given type
-    def self.type?(type)
+    def type?(type)
       return false unless type
       record_types.include?(type.to_sym)
     end
@@ -46,11 +48,11 @@ module KBSecret
     # @return [Record::AbstractRecord] the loaded record
     # @raise [Exceptions::RecordLoadError] if an error occurs during record loading
     # @api private
-    def self.load_record!(session, path)
+    def load_record!(session, path)
       hsh   = JSON.parse(File.read(path), symbolize_names: true)
       klass = class_for hsh[:type]
-      klass&.load!(session, hsh)
-    rescue JSON::JSONError
+      klass.load!(session, hsh)
+    rescue Exceptions::RecordTypeUnknownError, JSON::JSONError
       raise Exceptions::RecordLoadError, path
     end
   end

data/lib/kbsecret/version.rb

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