kbsecret 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 726c2a148f51589eeef719b170d7f5102532b0f1
-  data.tar.gz: 2500fec63f6f4a1f843197fc2e5e69be64232723
+  metadata.gz: ae1880e11964e5822acd83b77193d94a961780c2
+  data.tar.gz: ab15ecaf1b1b2eaddcd6542fd70c701356b56b31
 SHA512:
-  metadata.gz: cec6a334486cf1286c2a11e4192b834a477c4472535192a1ecaf136dc54068fd64d3bae22e90340e5463580d2202a5a4fb2a9d5cff103a21165a9bba015673d1
-  data.tar.gz: 0acfe368d0e5891a58d905917885980449cd38f9c9d87b0c634d16f2b4b019140d63d152c5f22a052aebbe0837b86c19c3f49c5924ec90869460649ef428edc9
+  metadata.gz: cd4857ae11dd7b1675fe6610783aec5f44f7a4bebf4c964d6eab993d9c95cf7acef20c8efcb9534120bc69e86c96b992d5679f75fa6514d22eff3c7f2e20a9e3
+  data.tar.gz: 40a89055c675a42aac6edd0f591785e0704d6c271b3ced718e27c817b5e45727d628dc31c201b301fa5cbf26335a62b1642d14878fb8b95608eb1e67f9bf2dc0

data/bin/kbsecret

@@ -120,7 +120,7 @@ def types_help
 end
 
 def conf(*_args)
-  abort("You need to set $EDITOR!") unless ENV["EDITOR"]
+  KBSecret::CLI.die "You need to set $EDITOR!" unless ENV["EDITOR"]
   Process.spawn("#{ENV["EDITOR"]} #{KBSecret::Config::CONFIG_FILE}")
 end
 

data/bin/kbsecret-dump-fields

@@ -27,18 +27,12 @@ opts = Slop.parse suppress_errors: true do |o|
   end
 end
 
-sess_name = opts[:session]
-
-unless KBSecret::Config.session? sess_name
-  abort "Fatal: Unknown session: '#{sess_name}'."
-end
-
-session = KBSecret::Session.new label: sess_name
+session = KBSecret::CLI.ensure_session opts[:session]
 
 label = opts.args.shift
 record = session.records.find { |r| r.label == label }
 
-abort("Fatal: No such record.") unless record
+KBSecret::CLI.die "No such record." unless record
 
 field_values = record.class.data_fields.map { |f| record.send f }
 field_pairs = record.class.data_fields.zip(field_values)

data/bin/kbsecret-env

@@ -31,13 +31,7 @@ opts = Slop.parse suppress_errors: true do |o|
   end
 end
 
-sess_name = opts[:session]
-
-unless KBSecret::Config.session? sess_name
-  abort "Fatal: Unknown session: '#{sess_name}'."
-end
-
-session = KBSecret::Session.new label: sess_name
+session = KBSecret::CLI.ensure_session opts[:session]
 
 env_records = session.records :environment
 

data/bin/kbsecret-list

@@ -27,13 +27,7 @@ opts = Slop.parse suppress_errors: true do |o|
   end
 end
 
-sess_name = opts[:session]
-
-unless KBSecret::Config.session? sess_name
-  abort "Fatal: Unknown session: '#{sess_name}'."
-end
-
-session = KBSecret::Session.new label: sess_name
+session = KBSecret::CLI.ensure_session opts[:session]
 
 records = session.records opts[:type]
 

data/bin/kbsecret-login

@@ -32,13 +32,7 @@ opts = Slop.parse suppress_errors: true do |o|
   end
 end
 
-sess_name = opts[:session]
-
-unless KBSecret::Config.session? sess_name
-  abort "Fatal: Unknown session: '#{sess_name}'."
-end
-
-session = KBSecret::Session.new label: sess_name
+session = KBSecret::CLI.ensure_session opts[:session]
 
 login_records = session.records :login
 
@@ -55,7 +49,7 @@ end
 
 selected_records.each do |record|
   if opts.terse?
-    fields = [:label, :username, :password].map { |m| record.send(m) }
+    fields = %i[label username password].map { |m| record.send(m) }
     puts fields.join(opts[:ifs])
   else
     puts <<~EOS

data/bin/kbsecret-new

@@ -39,26 +39,21 @@ opts = Slop.parse suppress_errors: true do |o|
   end
 end
 
-sess_name = opts[:session]
+session = KBSecret::CLI.ensure_session opts[:session]
 
-unless KBSecret::Config.session? sess_name
-  abort "Fatal: Unknown session: '#{sess_name}'."
-end
-
-abort "Fatal: Not enough arguments." if opts.args.size < 2
+KBSecret::CLI.die "Not enough arguments." if opts.args.size < 2
 
-session = KBSecret::Session.new label: sess_name
 type, label = opts.args.shift 2
 
-type = TYPE_ALIASES[type]
+resolved_type = TYPE_ALIASES[type]
 
 if session.record?(label) && !opts.force?
-  abort "Fatal: Refusing to overwrite an existing record without --force."
+  KBSecret::CLI.die "Refusing to overwrite an existing record without --force."
 end
 
-unless KBSecret::Record.type?(type)
-  abort <<~EOS
-    Fatal: Unknown record type: '#{type}'.
+unless KBSecret::Record.type?(resolved_type)
+  KBSecret::CLI.die <<~EOS
+    Unknown record type: '#{type}'.
     Known types are: #{KBSecret::Record.record_types.join(", ")}.
   EOS
 end
@@ -67,7 +62,7 @@ fields = []
 
 if opts.interactive?
   prompt = TTY::Prompt.new
-  klass = KBSecret::Record.class_for(type)
+  klass = KBSecret::Record.class_for(resolved_type)
   klass.data_fields.each do |field|
     fields << prompt.ask("#{field.capitalize}?", echo: opts.echo?)
   end
@@ -76,7 +71,7 @@ else
 end
 
 begin
-  session.add_record(type, label, *fields)
+  session.add_record(resolved_type, label, *fields)
 rescue => e
-  abort "Fatal: #{e}."
+  KBSecret::CLI.die "#{e}."
 end

data/bin/kbsecret-new-session

@@ -35,7 +35,7 @@ end
 session_label = opts[:label]
 
 if KBSecret::Config.session?(session_label) && !opts.force?
-  abort "Fatal: Refusing to overwrite an existing session without --force."
+  KBSecret::CLI.die "Refusing to overwrite an existing session without --force."
 end
 
 session_hash = {

data/bin/kbsecret-pass

@@ -31,18 +31,12 @@ opts = Slop.parse suppress_errors: true do |o|
   end
 end
 
-sess_name = opts[:session]
-
-unless KBSecret::Config.session? sess_name
-  abort "Fatal: Unknown session: '#{sess_name}'."
-end
-
-session = KBSecret::Session.new label: sess_name
-label = opts.args.shift
+session       = KBSecret::CLI.ensure_session opts[:session]
+label         = opts.args.shift
 login_records = session.records :login
-record = login_records.find { |r| r.label == label }
+record        = login_records.find { |r| r.label == label }
 
-abort("Fatal: No such login record.") unless record
+KBSecret::CLI.die "No such login record." unless record
 
 if opts.clipboard?
   Clipboard.copy record.password

data/bin/kbsecret-raw-edit

@@ -28,21 +28,11 @@ opts = Slop.parse suppress_errors: true do |o|
   end
 end
 
-sess_name = opts[:session]
+session = KBSecret::CLI.ensure_session opts[:session]
+label   = opts.args.shift
+record  = session.records.find { |r| r.label == label }
 
-abort "Fatal: $EDITOR is not set." unless ENV["EDITOR"]
+KBSecret::CLI.die "No such record." unless record
 
-unless KBSecret::Config.session? sess_name
-  abort "Fatal: Unknown session: '#{sess_name}'."
-end
-
-session = KBSecret::Session.new label: sess_name
-label = opts.args.shift
-record = session.records.find { |r| r.label == label }
-
-if record
-  Process.spawn("#{ENV["EDITOR"]} #{record.path}")
-  record.sync! # just to bump the timestamp
-else
-  abort "Fatal: No such record."
-end
+Process.spawn("#{ENV["EDITOR"]} #{record.path}")
+record.sync! # just to bump the timestamp

data/bin/kbsecret-rm

@@ -29,17 +29,11 @@ opts = Slop.parse suppress_errors: true do |o|
   end
 end
 
-sess_name = opts[:session]
-
-unless KBSecret::Config.session? sess_name
-  abort "Fatal: Unknown session: '#{sess_name}'."
-end
-
-session = KBSecret::Session.new label: sess_name
+session = KBSecret::CLI.ensure_session opts[:session]
 
 label = opts.args.shift
 
-abort "Fatal: I need the label of a record to delete." unless label
+KBSecret::CLI.die "I need the label of a record to delete." unless label
 
 tty = TTY::Prompt.new
 confirm = true

data/bin/kbsecret-rm-session

@@ -31,15 +31,9 @@ end
 
 label = opts.args.shift
 
-abort "Fatal: I need the label of a session to deconfigure." unless label
+KBSecret::CLI.die "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
+session = KBSecret::CLI.ensure_session label
+session.unlink! if opts.delete?
 
 KBSecret::Config.deconfigure_session label

data/bin/kbsecret-stash-file

@@ -29,23 +29,17 @@ opts = Slop.parse suppress_errors: true do |o|
   end
 end
 
-sess_name = opts[:session]
-
-unless KBSecret::Config.session? sess_name
-  abort "Fatal: Unknown session: '#{sess_name}'."
-end
-
-session = KBSecret::Session.new label: sess_name
+session         = KBSecret::CLI.ensure_session opts[:session]
 label, filename = opts.args.shift 2
 
-abort("Fatal: Missing a record label to create.") unless label
+KBSecret::CLI.die "Missing a record label to create." unless label
 
 contents = if filename.nil? || filename == "-"
              STDIN.read
            elsif File.file?(filename)
              File.read(filename)
            else
-             abort "Fatal: That file doesn't exist."
+             KBSecret::CLI.die "That file doesn't exist."
            end
 
 session.add_record(:unstructured, label, contents)

data/bin/kbsecret-todo

@@ -32,35 +32,29 @@ opts = Slop.parse suppress_errors: true do |o|
   end
 end
 
-sess_name = opts[:session]
-
-unless KBSecret::Config.session? sess_name
-  abort "Fatal: Unknown session: '#{sess_name}'."
-end
-
-session = KBSecret::Session.new label: sess_name
+session        = KBSecret::CLI.ensure_session opts[:session]
 command, label = opts.args.shift 2
 
-abort("Fatal: Missing subcommand.") unless command && label
+KBSecret::CLI.die "Missing subcommand." unless command && label
 
 todo_records = session.records :todo
 todo = todo_records.find { |r| r.label == label }
 
-abort("Fatal: No such todo record.") unless todo
+KBSecret::CLI.die("Fatal: No such todo record.") unless todo
 
 case command
 when "start"
-  abort("That task is already started!") if todo.started?
+  KBSecret::CLI.die "That task is already started!" if todo.started?
   todo.start!
   puts "#{todo.label}: '#{todo.todo}' marked as started at #{todo.start}"
 when "suspend"
-  abort("That task is already suspended!") if todo.suspended?
+  KBSecret::CLI.die "That task is already suspended!" if todo.suspended?
   todo.suspend!
   puts "#{todo.label}: '#{todo.todo}' marked as suspended at #{todo.stop}"
 when "complete"
-  abort("That task is already completed!") if todo.completed?
+  KBSecret::CLI.die "That task is already completed!" if todo.completed?
   todo.complete!
   puts "#{todo.label}: '#{todo.todo}' marked as completed at #{todo.stop}"
 else
-  abort("Fatal: Unknown action: #{command}.")
+  KBSecret::CLI.die "Unknown action: #{command}."
 end

data/lib/kbsecret/cli.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "pastel"
+
+module KBSecret
+  # An encapsulation of useful methods for kbsecret's CLI.
+  module CLI
+    class << self
+      # The pastel object used to generate colorful output.
+      PASTEL = Pastel.new
+
+      # Print an error message and terminate.
+      # @param msg [String] the message to print
+      # @return [void]
+      # @note This method does not return!
+      def die(msg)
+        pretty = "#{PASTEL.bright_red("Fatal")}: #{msg}"
+        abort pretty
+      end
+
+      # Instantiate a session if it exists, and terminate otherwise.
+      # @param sess_label [String, Symbol] the session label to instantiate
+      # @return [void]
+      # @note This method does not return if the given session is not configured!
+      def ensure_session(sess_label)
+        die "Unknown session: '#{sess_label}'." unless Config.session? sess_label
+
+        Session.new label: sess_label
+      end
+    end
+  end
+end

data/lib/kbsecret/config.rb

@@ -28,17 +28,17 @@ module KBSecret
     }.freeze
 
     # Retrieve a configured value.
-    # @param key [String]
+    # @param key [String] the configuration key to retrieve
     # @return [Object] the corresponding configuration
     def self.[](key)
       @config[key]
     end
 
     # Retrieve a session's configuration.
-    # @param sess [Symbol] the session's label
+    # @param sess [String, Symbol] the session's label
     # @return [Hash] the session configuration
     def self.session(sess)
-      @config[:sessions][sess]
+      @config[:sessions][sess.to_sym]
     end
 
     # @return [Array<Symbol>] all configured session labels
@@ -46,7 +46,7 @@ module KBSecret
       @config[:sessions].keys
     end
 
-    # @param sess [Symbol] the session label
+    # @param sess [String, Symbol] the session label
     # @return [Boolean] whether or not the given session is configured
     def self.session?(sess)
       session_labels.include?(sess.to_sym)

data/lib/kbsecret/record.rb

@@ -31,6 +31,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)
+      return false unless type
       record_types.include?(type.to_sym)
     end
 

data/lib/kbsecret.rb

@@ -6,11 +6,12 @@ require_relative "kbsecret/config"
 require_relative "kbsecret/exceptions"
 require_relative "kbsecret/record"
 require_relative "kbsecret/session"
+require_relative "kbsecret/cli"
 
 # The primary namespace for kbsecret.
 module KBSecret
   # kbsecret's current version
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 
   # fail very early if the user doesn't have keybase and KBFS running
   raise Keybase::KeybaseNotRunningError unless Keybase.running?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kbsecret
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - William Woodruff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-30 00:00:00.000000000 Z
+date: 2017-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: keybase-unofficial
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: pastel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: clipboard
   requirement: !ruby/object:Gem::Requirement
@@ -104,6 +118,7 @@ files:
 - bin/kbsecret-stash-file
 - bin/kbsecret-todo
 - lib/kbsecret.rb
+- lib/kbsecret/cli.rb
 - lib/kbsecret/config.rb
 - lib/kbsecret/exceptions.rb
 - lib/kbsecret/record.rb