kbsecret 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f807d04b3f3365845cb00d88dc4c117815f8338
-  data.tar.gz: d5aa5f00590f7660391758f9408eb567b8ff9258
+  metadata.gz: 8d652f203478d7a4d2500fbb5b9c0987014a0b59
+  data.tar.gz: 9ce0b6fe98e4d48be2ca27d56518c4942a3717e3
 SHA512:
-  metadata.gz: ffb8f5e6d8658c48911ee49b7f2f9cc4127bbb3c92aea221a9b06b9727d15bde4f283170def0f9f9337b40186baa970434b89994ea6050aeace0f31f7c45cd10
-  data.tar.gz: 3a0656fc05c14ae990ceea61619476edf8c67ceb7b21f88e4b092e7894466f69600926f62620f2e1b786832d73c31b239c48f5fc959c3a31d08e97cdd362d84a
+  metadata.gz: 835518bd8f610440bfbfb3231a00e3470435b97aeba5ab3b6e0ced99c55afba87100b55377c6c7af1c4000c197637e62c42dfd5ac8449158da7397acac282817
+  data.tar.gz: dd8c91cbb42ad8872835cd04fea5d2c0c7c697d27b23f88173351b8d758e5894e563853da27bd8ed4df7217aec2837d86d2cc764388ea3207aac7719ca8f1793

data/bin/kbsecret-rm-session

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+
+require "kbsecret"
+require "slop"
+
+opts = Slop.parse suppress_errors: true do |o|
+  o.banner = <<~EOS
+    Deconfigure (and optionally delete) a session.
+
+    Usage:
+      kbsecret rm-session --delete <label>
+
+    Example:
+      kbsecret rm-session old-keys
+      kbsecret rm-session --delete even-older-keys
+  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 { |o| o.flags }.join "\n"
+    exit
+  end
+end
+
+label = opts.args.shift
+
+abort "Fatal: I need the label of a session to deconfigure." unless label
+
+unless KBSecret::Config.session? label
+  abort "Fatal: Unknown session: '#{label}'."
+end
+
+if opts.delete?
+  session = KBSecret::Session.new label: label
+  session.unlink!
+end
+
+KBSecret::Config.deconfigure_session label

data/lib/kbsecret/config.rb

@@ -51,13 +51,25 @@ module KBSecret
     end
 
     # Configure a session.
-    # @param label [Symbol] the session label
+    # @param label [String, Symbol] the session label
     # @param hsh [Hash] the session configuration
+    # @return [void]
     def self.configure_session(label, hsh)
       @@config[:sessions][label.to_sym] = hsh
       File.open(CONFIG_FILE, "w") { |io| io.write @@config.to_yaml }
     end
 
+    # 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!}.
+    def self.deconfigure_session(label)
+      @@config[:sessions].delete(label.to_sym)
+      File.open(CONFIG_FILE, "w") { |io| io.write @@config.to_yaml }
+    end
+
     if File.exist?(CONFIG_FILE)
       user_config = YAML.load_file(CONFIG_FILE)
     else

data/lib/kbsecret/session.rb

@@ -1,3 +1,5 @@
+require "fileutils"
+
 module KBSecret
   # Represents a session of N keybase users with collective read/write
   # access to a collection of records.
@@ -12,13 +14,13 @@ module KBSecret
     # @return [String] the fully-qualified path of the session
     attr_reader :directory
 
-    # @param label [Symbol] the label of the session to initialize
+    # @param label [String, Symbol] the label of the session to initialize
     # @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}.
     def initialize(label: :default)
-      @label = label
-      @config = Config.session(label.to_sym)
+      @label = label.to_sym
+      @config = Config.session(@label)
 
       @directory = rel_path config[:root], mkdir: true
       @records = load_records!
@@ -79,6 +81,15 @@ module KBSecret
       record_labels.include?(label)
     end
 
+    # Delete the entire session.
+    # @return [void]
+    # @note Use this with caution, as *all* files under the session directory
+    #   will be deleted. Furthermore, the session directory itself will
+    #   be deleted, and this object will become garbage.
+    def unlink!
+      FileUtils.rm_rf(directory)
+    end
+
     private
 
     def record_paths

data/lib/kbsecret.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kbsecret
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - William Woodruff
@@ -77,6 +77,7 @@ executables:
 - kbsecret-todo
 - kbsecret-new
 - kbsecret-dump-fields
+- kbsecret-rm-session
 - kbsecret-env
 - kbsecret-new-session
 - kbsecret-list
@@ -97,6 +98,7 @@ files:
 - bin/kbsecret-pass
 - bin/kbsecret-raw-edit
 - bin/kbsecret-rm
+- bin/kbsecret-rm-session
 - bin/kbsecret-sessions
 - bin/kbsecret-todo
 - lib/kbsecret.rb