kbsecret 0.9.4 → 0.9.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd2a0e23781f3ff9dee95614c891c6189b0f2c55
-  data.tar.gz: da14eb5eaff0117faf18f3f1f12930d1c9119137
+  metadata.gz: a93f10c5ff4add094ea83dc950239250ffda4e31
+  data.tar.gz: 3d8ddfe46e26ed3751d541b762c56804fb194c35
 SHA512:
-  metadata.gz: 1b45a84051c81d24ec69163ec858d7a2cb05d6ce97141497747429816aab6dde958db5580b31f6ed57be33517356efc73a4300d08487f7bb84cdf5f29ad7d761
-  data.tar.gz: 76b13c940c7d334d2df583f9ea22a198761690febf2c0dc68aa7cf20a87cc9f6cbb75585ab8dbbed66c0b0b14d9c62d1e1deaf87f3a2720cd581a4b1da12ffa4
+  metadata.gz: d92789c5a47dfccb4422545b9bdf5c7bfc3d086599783336c982cc02a2e37749bab41e9cfc5579db9a3451b726683e044d3efaa302eefd3e5e79d2037af31719
+  data.tar.gz: 2fc805de715e71bbfc577f9f1258b9b2b46d5cad421126173afd6d8d3864b386e8da035c6b3e99caaa5e361f86d49abfec5e4a93a982dad050ce9e5b0318d5be

data/README.md

@@ -50,7 +50,7 @@ $ cp man/*.1 ${YOUR_MAN_DIR}
 
 ### Shell Completion
 
-KBSecret provides shell completion functions for bash and zsh.
+KBSecret provides shell completion functions for bash, zsh, and fish.
 
 To generate the completions for Bash:
 
@@ -64,6 +64,8 @@ $ cp completions/kbsecret.bash ${YOUR_COMPLETION_DIR}
 To use the completions for zsh, add the completions directory to your `$fpath` or copy the
 `completions/_kbsecret` file to any of the directories in it.
 
+To use the fish completions, copy `completions/kbsecret.fish` to your `~/.config/fish/completions` folder.
+
 Please feel free to contribute completion scripts for other shells!
 
 ### Contributing
@@ -78,6 +80,8 @@ If you have an idea for a new feature, please suggest it! Pull requests are also
 If you'd like help or would just like to chat about KBSecret's development, please
 join us in `#kbsecret` on Freenode.
 
+We also have a Keybase team. Please let us know on IRC if you'd like to be added to it.
+
 ## Licensing
 
 KBSecret is licensed under the MIT License.

data/lib/kbsecret.rb

@@ -12,7 +12,7 @@ require_relative "kbsecret/cli"
 
 # The primary namespace for {KBSecret}.
 module KBSecret
-  # fail very early if the user doesn't have keybase and KBFS running
+  # fail very early if the user doesn't have Keybase running and KBFS mounted
   raise Keybase::Local::Exceptions::KeybaseNotRunningError unless Keybase::Local.running?
-  raise Keybase::Local::Exceptions::KBFSNotRunningError unless Dir.exist?(Config[:mount])
+  raise Keybase::Local::Exceptions::KBFSNotRunningError unless Keybase::Local::KBFS.mounted?
 end

data/lib/kbsecret/cli.rb

@@ -8,6 +8,7 @@ require "abbrev"
 module KBSecret
   # An encapsulation of useful methods for kbsecret's CLI.
   # Most methods in this class assume that they are being called from the context of
+  # a command-line utility.
   class CLI
     # Abbreviations for record types (e.g., `env` for `environment`).
     TYPE_ALIASES = Hash.new { |_, k| k }.update(Abbrev.abbrev(Record.record_types)).freeze

data/lib/kbsecret/cli/kbsecret-env

@@ -37,12 +37,14 @@ selected_records = if cmd.opts.all?
                      end
                    end
 
-selected_records.each do |record|
-  if cmd.opts.value_only?
-    puts record.value
-  elsif cmd.opts.no_export?
-    puts record.to_assignment
-  else
-    puts record.to_export
-  end
-end
+cmd.die "No such record(s)." if selected_records.empty?
+
+env_output = if cmd.opts.no_export?
+               selected_records.map(&:to_assignment).join(" ")
+             elsif cmd.opts.value_only?
+               selected_records.map(&:value).join("\n")
+             else
+               selected_records.map(&:to_export).join("\n")
+             end
+
+puts env_output

data/lib/kbsecret/cli/kbsecret-generator

@@ -9,7 +9,7 @@ cmd = CLI.create do |c|
   c.slop cmds: %w[new rm] do |o|
     o.banner = <<~HELP
       Usage:
-        kbsecret new-generator [options] <new|rm> <generator>
+        kbsecret generator [options] <new|rm> <generator>
     HELP
 
     o.string "-F", "--format", "the format of the secrets generated", default: "hex"

data/lib/kbsecret/cli/kbsecret-login

@@ -37,6 +37,8 @@ selected_records = if cmd.opts.all?
                      end
                    end
 
+cmd.die "No such record(s)." if selected_records.empty?
+
 selected_records.each do |record|
   if cmd.opts.terse?
     fields = %i[label username password].map { |m| record.send(m) }

data/lib/kbsecret/cli/kbsecret-new

@@ -12,12 +12,10 @@ cmd = CLI.create do |c|
     o.banner = <<~HELP
       Usage:
         kbsecret new [options] <type> <label>
-        kbsecret new [options] --args <type> <label> <fields>
     HELP
 
     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)"
     o.bool "-G", "--generate", "generate secret fields (interactive only)"
     o.string "-g", "--generator", "the generator to use for secret fields",
@@ -29,7 +27,6 @@ cmd = CLI.create do |c|
   c.dreck do
     string :type
     string :label
-    list :string, :fields if c.opts.args?
   end
 
   c.ensure_generator!
@@ -49,28 +46,19 @@ if cmd.opts.generate?
   generator = cmd.guard { Generator.new cmd.opts[:generator] }
 end
 
-fields = if ($stdin.tty? && !cmd.opts.args?) || cmd.opts.terse?
+fields = if cmd.opts.terse?
+           STDIN.read.chomp.split cmd.opts[:ifs]
+         else
            prompt = TTY::Prompt.new
            klass = Record.class_for(resolved_type)
-
-           if cmd.opts.terse?
-             fields = STDIN.read.chomp.split cmd.opts[:ifs]
-           else
-             klass.external_fields.map do |field|
-               if cmd.opts.generate? && klass.sensitive?(field)
-                 generator.secret
-               else
-                 prompt.ask "#{field.capitalize}?",
-                            echo: !klass.sensitive?(field) || cmd.opts.echo?
-               end
+           klass.external_fields.map do |field|
+             if cmd.opts.generate? && klass.sensitive?(field)
+               generator.secret
+             else
+               prompt.ask "#{field.capitalize}?",
+                          echo: !klass.sensitive?(field) || cmd.opts.echo?
              end
            end
-         else
-           cmd.warn <<~WARNING
-             Argument input is dangerous and deprecated, and will be removed by 1.0.
-           WARNING
-
-           cmd.args[:fields]
          end
 
 cmd.guard { cmd.session.add_record(resolved_type, label, *fields) }

data/lib/kbsecret/cli/kbsecret-new-session

@@ -6,67 +6,6 @@ require "kbsecret"
 
 include KBSecret
 
-cmd = CLI.create do |c|
-  c.slop do |o|
-    o.banner = <<~HELP
-      Usage:
-        kbsecret new-session [options]
-    HELP
+STDERR.puts "This command has been deprecated in favor of 'kbsecret-session'. It will be removed in release 1.0"
 
-    o.string "-t", "--team", "the team to create the session under"
-    o.string "-l", "--label", "the session label", required: true
-    o.array "-u", "--users", "the keybase users", default: [Keybase::Local.current_user]
-    o.string "-r", "--root", "the secret root directory"
-    o.bool "-f", "--force", "force creation (ignore overwrites, etc.)"
-    o.bool "-n", "--no-notify", "do not send a notification to session members"
-  end
-end
-
-session_label = cmd.opts[:label]
-
-if Config.session?(session_label) && !cmd.opts.force?
-  cmd.die "Refusing to overwrite an existing session without --force."
-end
-
-if cmd.opts[:team]
-  teams = Keybase::Local::Team.list_memberships["teams"]
-
-  unless teams.any? { |t| t["fq_name"] == cmd.opts[:team] }
-    cmd.die "No such team (either nonexistent or non-member)."
-  end
-
-  Config.configure_session(session_label, team: cmd.opts[:team], root: session_label)
-else
-  cmd.die "Missing `-r', `--root' option." unless cmd.opts[:root]
-
-  cmd.opts[:users].each do |user|
-    cmd.die "Nonexistent Keybase user: '#{user}'." unless Keybase::API.user? user
-  end
-
-  unless cmd.opts[:users].include? Keybase::Local.current_user
-    cmd.warn "You didn't include yourself in the user list, but I'll add you."
-    cmd.opts[:users] << Keybase::Local.current_user
-  end
-
-  Config.configure_session(session_label, users: cmd.opts[:users], root: cmd.opts[:root])
-
-  unless cmd.opts.no_notify? && cmd.opts[:users] != [Keybase::Local.current_user]
-    users = cmd.opts[:users].join(",")
-
-    Keybase::Local::Chat.send_message cmd.opts[:users], <<~MESSAGE
-      You've been added to a KBSecret session!
-
-      To access this session, please run the following:
-
-      ```
-        $ kbsecret new-session -l '<your label>' -r '#{cmd.opts[:root]}' -u #{users}
-      ```
-
-      If you don't have KBSecret installed, you can install it from `gem`:
-
-      ```
-        $ gem install kbsecret
-      ```
-    MESSAGE
-  end
-end
+exec "kbsecret", "session", "new", *ARGV

data/lib/kbsecret/cli/kbsecret-rm

@@ -12,7 +12,7 @@ cmd = CLI.create do |c|
   c.slop do |o|
     o.banner = <<~HELP
       Usage:
-        kbsecret rm [options] <record>
+        kbsecret rm [options] <record [record ...]>
     HELP
 
     o.string "-s", "--session", "the session containing the record", default: :default
@@ -20,21 +20,25 @@ cmd = CLI.create do |c|
   end
 
   c.dreck do
-    string :label
+    list :string, :labels
   end
 
   c.ensure_session!
 end
 
-label = cmd.args[:label]
+records = cmd.session.records
 
-cmd.die "Can't delete a nonexistent record." unless cmd.session.record? label
+selected_records = records.select do |record|
+  cmd.args[:labels].include? record.label
+end
+
+cmd.die "No such record(s)." if selected_records.empty?
 
 tty = TTY::Prompt.new
 
 confirm = if cmd.opts.interactive?
-            tty.yes?("Delete '#{label}' from the #{cmd.session.label} session?")
+            tty.yes?("Delete '#{selected_records.join(", ")}' from the #{cmd.session.label} session?")
           else true
           end
 
-cmd.session.delete_record(label) if confirm
+selected_records.each { |r| cmd.session.delete_record(r.label) } if confirm

data/lib/kbsecret/cli/kbsecret-rm-session

@@ -5,25 +5,6 @@ require "kbsecret"
 
 include KBSecret
 
-cmd = CLI.create do |c|
-  c.slop do |o|
-    o.banner = <<~HELP
-      Usage:
-        kbsecret rm-session [options] <session>
-    HELP
+STDERR.puts "This command has been deprecated in favor of 'kbsecret-session'. It will be removed in release 1.0"
 
-    o.bool "-d", "--delete", "unlink the session in addition to deconfiguration"
-  end
-
-  c.dreck do
-    string :session
-  end
-
-  c.ensure_session! :argument
-end
-
-label = cmd.args[:session]
-
-cmd.session.unlink! if cmd.opts.delete?
-
-Config.deconfigure_session label
+exec "kbsecret", "session", "rm", *ARGV

data/lib/kbsecret/cli/kbsecret-session

@@ -0,0 +1,94 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "kbsecret"
+
+include KBSecret
+
+def new_session(label, cmd)
+  if Config.session?(label) && !cmd.opts.force?
+    cmd.die "Refusing to overwrite an existing session without --force."
+  end
+
+  if cmd.opts[:team]
+    teams = Keybase::Local::Team.list_memberships["teams"]
+
+    unless teams.any? { |t| t["fq_name"] == cmd.opts[:team] }
+      cmd.die "No such team (either nonexistent or non-member)."
+    end
+
+    Config.configure_session(label, team: cmd.opts[:team], root: label)
+  else
+    cmd.die "Missing `-r', `--root' option." unless cmd.opts[:root]
+
+    cmd.opts[:users].each do |user|
+      cmd.die "Nonexistent Keybase user: '#{user}'." unless Keybase::API.user? user
+    end
+
+    unless cmd.opts[:users].include? Keybase::Local.current_user
+      cmd.warn "You didn't include yourself in the user list, but I'll add you."
+      cmd.opts[:users] << Keybase::Local.current_user
+    end
+
+    Config.configure_session(label, users: cmd.opts[:users], root: cmd.opts[:root])
+
+    unless cmd.opts.no_notify? && cmd.opts[:users] != [Keybase::Local.current_user]
+      users = cmd.opts[:users].join(",")
+
+      Keybase::Local::Chat.send_message cmd.opts[:users], <<~MESSAGE
+        You've been added to a KBSecret session!
+
+        To access this session, please run the following:
+
+        ```
+          $ kbsecret new-session -r '#{cmd.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
+
+def rm_session(label, cmd)
+  cmd.session.unlink! if cmd.opts.delete?
+  Config.deconfigure_session label
+end
+
+cmd = CLI.create do |c|
+  c.slop cmds: %w[new rm] 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 "-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
+
+  c.dreck do
+    string :command
+    string :session
+  end
+
+  c.ensure_session! :argument if c.args[:command] == "rm"
+end
+
+session_label = cmd.args[:session]
+
+case cmd.args[:command]
+when "new"
+  new_session session_label, cmd
+when "rm"
+  rm_session session_label, cmd
+else
+  cmd.die "Unknown subcommand: '#{cmd.args[:command]}'."
+end

data/lib/version.rb

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

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: kbsecret
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.9.5
 platform: ruby
 authors:
 - William Woodruff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-11 00:00:00.000000000 Z
+date: 2017-10-30 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0.pre.alpha.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0.pre.alpha.2
 - !ruby/object:Gem::Dependency
   name: fpm
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.3
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.51'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.51'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -156,14 +184,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: slop
   requirement: !ruby/object:Gem::Requirement
@@ -217,6 +245,7 @@ files:
 - lib/kbsecret/cli/kbsecret-raw-edit
 - lib/kbsecret/cli/kbsecret-rm
 - lib/kbsecret/cli/kbsecret-rm-session
+- lib/kbsecret/cli/kbsecret-session
 - lib/kbsecret/cli/kbsecret-sessions
 - lib/kbsecret/cli/kbsecret-stash-file
 - lib/kbsecret/cli/kbsecret-todo