kbsecret 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f2ba5bfa023b12c86f64fd86b7bada8daf6f219
-  data.tar.gz: c403e756af14fe31813700aefa67c46a05dceb04
+  metadata.gz: 726c2a148f51589eeef719b170d7f5102532b0f1
+  data.tar.gz: 2500fec63f6f4a1f843197fc2e5e69be64232723
 SHA512:
-  metadata.gz: 7cc451a8a3f419514238d52994aae8c7c91dc044195b2e9562131dcd5976425f362e202fda6d914c00a84742f019149c618097d17a6412201dd6bd4d70ab9c8a
-  data.tar.gz: fa75fb703cb27f820b8e154ad22372d2dce821240ea3f7575808e5a5a349fe8cae9289ec068d836cefa586261a0fe95bbdf060dc8683b8c11fc5aea38d94f4b5
+  metadata.gz: cec6a334486cf1286c2a11e4192b834a477c4472535192a1ecaf136dc54068fd64d3bae22e90340e5463580d2202a5a4fb2a9d5cff103a21165a9bba015673d1
+  data.tar.gz: 0acfe368d0e5891a58d905917885980449cd38f9c9d87b0c634d16f2b4b019140d63d152c5f22a052aebbe0837b86c19c3f49c5924ec90869460649ef428edc9

data/bin/kbsecret

@@ -1,14 +1,9 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "kbsecret"
 
-BUILTIN_CMDS = [
-  "help",
-  "version",
-  "commands",
-  "types",
-  "conf",
-].freeze
+BUILTIN_CMDS = %w[help version commands types conf].freeze
 
 EXT_PATHS = ENV["PATH"].split(File::PATH_SEPARATOR).map do |path|
   Dir[File.join(path, "kbsecret-*")]
@@ -18,13 +13,24 @@ EXT_CMDS = EXT_PATHS.map do |c|
   File.basename(c, File.extname(c)).sub!("kbsecret-", "")
 end.freeze
 
-ALIASES = Hash.new { |_, k| k }.update({
+ALIASES = Hash.new { |_, k| k }.update(
   "--help" => "help",
-  "-h" => "help",
-}).freeze
+  "-h" => "help"
+).freeze
 
 ALL_CMDS = (ALIASES.keys + BUILTIN_CMDS + EXT_CMDS).freeze
 
+KBSECRET_HELP = <<~EOS
+  Usage:
+    kbsecret <command> <args ...>
+
+  Available commands:
+    #{ALL_CMDS.join(", ")}
+
+  More more information about a particular command, try:
+    kbsecret help <command>
+EOS
+
 def external?(cmd)
   EXT_CMDS.include?(cmd)
 end
@@ -49,24 +55,13 @@ end
 def help(*args)
   command = normalize args.shift
   if command.nil?
-    puts <<~EOS
-      Usage:
-        kbsecret <command> <args ...>
-
-      Available commands:
-        #{ALL_CMDS.join(", ")}
-
-      More more information about a particular command, try:
-        kbsecret help <command>
-    EOS
+    puts KBSECRET_HELP
+  elsif builtin? command
+    send "#{command}_help"
   else
-    if builtin? command
-      send "#{command}_help"
-    else
-      # XXX: this probably doesn't make sense, since not every user command
-      # will implement --help.
-      system expand(command), "--help"
-    end
+    # XXX: this probably doesn't make sense, since not every user command
+    # will implement --help.
+    system expand(command), "--help"
   end
 end
 
@@ -83,7 +78,7 @@ def help_help
   EOS
 end
 
-def version(*args)
+def version(*_args)
   puts <<~EOS
     kbsecret version #{KBSecret::VERSION}.
   EOS
@@ -98,7 +93,7 @@ def version_help
   EOS
 end
 
-def commands
+def commands(*_args)
   puts ALL_CMDS.join("\n")
 end
 
@@ -111,7 +106,7 @@ def commands_help
   EOS
 end
 
-def types
+def types(*_args)
   puts KBSecret::Record.record_types.join("\n")
 end
 
@@ -124,7 +119,7 @@ def types_help
   EOS
 end
 
-def conf
+def conf(*_args)
   abort("You need to set $EDITOR!") unless ENV["EDITOR"]
   Process.spawn("#{ENV["EDITOR"]} #{KBSecret::Config::CONFIG_FILE}")
 end

data/bin/kbsecret-dump-fields

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "kbsecret"
 require "slop"
@@ -12,6 +13,8 @@ opts = Slop.parse suppress_errors: true do |o|
   EOS
 
   o.string "-s", "--session", "the session name", default: :default
+  o.bool "-x", "--terse", "output in field:value format"
+  o.bool "-i", "--ifs", "separate terse pairs with this string", default: ":"
 
   o.on "-h", "--help" do
     puts o
@@ -19,7 +22,7 @@ opts = Slop.parse suppress_errors: true do |o|
   end
 
   o.on "--introspect-flags" do
-    puts o.options.flat_map { |o| o.flags }.join "\n"
+    puts o.options.flat_map(&:flags).join "\n"
     exit
   end
 end
@@ -40,4 +43,8 @@ abort("Fatal: 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)
 
-puts field_pairs.map { |f, v| "#{f}: #{v}" }.join "\n"
+if opts.terse?
+  puts field_pairs.map { |f, v| "#{f}#{opts[:ifs]}#{v}" }.join "\n"
+else
+  puts field_pairs.map { |f, v| "#{f}: #{v}" }.join "\n"
+end

data/bin/kbsecret-env

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "kbsecret"
 require "slop"
@@ -25,7 +26,7 @@ opts = Slop.parse suppress_errors: true do |o|
   end
 
   o.on "--introspect-flags" do
-    puts o.options.flat_map { |o| o.flags }.join "\n"
+    puts o.options.flat_map(&:flags).join "\n"
     exit
   end
 end

data/bin/kbsecret-list

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "kbsecret"
 require "slop"
@@ -21,7 +22,7 @@ opts = Slop.parse suppress_errors: true do |o|
   end
 
   o.on "--introspect-flags" do
-    puts o.options.flat_map { |o| o.flags }.join "\n"
+    puts o.options.flat_map(&:flags).join "\n"
     exit
   end
 end
@@ -46,4 +47,3 @@ records.each do |record|
 
   puts line
 end
-

data/bin/kbsecret-login

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "kbsecret"
 require "slop"
@@ -16,7 +17,7 @@ opts = Slop.parse suppress_errors: true do |o|
   EOS
 
   o.bool "-a", "--all", "retrieve all login records, not just listed ones"
-  o.bool "-t", "--terse", "output in label:username:password format"
+  o.bool "-x", "--terse", "output in label:username:password format"
   o.string "-i", "--ifs", "separate terse fields with this string", default: ":"
   o.string "-s", "--session", "the session name", default: :default
 
@@ -26,7 +27,7 @@ opts = Slop.parse suppress_errors: true do |o|
   end
 
   o.on "--introspect-flags" do
-    puts o.options.flat_map { |o| o.flags }.join "\n"
+    puts o.options.flat_map(&:flags).join "\n"
     exit
   end
 end

data/bin/kbsecret-new

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "kbsecret"
 require "slop"
@@ -33,7 +34,7 @@ opts = Slop.parse suppress_errors: true do |o|
   end
 
   o.on "--introspect-flags" do
-    puts o.options.flat_map { |o| o.flags }.join "\n"
+    puts o.options.flat_map(&:flags).join "\n"
     exit
   end
 end
@@ -74,9 +75,8 @@ else
   fields = opts.args
 end
 
-
 begin
   session.add_record(type, label, *fields)
 rescue => e
-  abort "Fatal: #{e.to_s}."
+  abort "Fatal: #{e}."
 end

data/bin/kbsecret-new-session

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "keybase"
 require "kbsecret"
@@ -26,7 +27,7 @@ opts = Slop.parse suppress_errors: true do |o|
   end
 
   o.on "--introspect-flags" do
-    puts o.options.flat_map { |o| o.flags }.join "\n"
+    puts o.options.flat_map(&:flags).join "\n"
     exit
   end
 end

data/bin/kbsecret-pass

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "kbsecret"
 require "slop"
@@ -25,7 +26,7 @@ opts = Slop.parse suppress_errors: true do |o|
   end
 
   o.on "--introspect-flags" do
-    puts o.options.flat_map { |o| o.flags }.join "\n"
+    puts o.options.flat_map(&:flags).join "\n"
     exit
   end
 end

data/bin/kbsecret-raw-edit

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "kbsecret"
 require "slop"
@@ -22,16 +23,14 @@ opts = Slop.parse suppress_errors: true do |o|
   end
 
   o.on "--introspect-flags" do
-    puts o.options.flat_map { |o| o.flags }.join "\n"
+    puts o.options.flat_map(&:flags).join "\n"
     exit
   end
 end
 
 sess_name = opts[:session]
 
-unless ENV["EDITOR"]
-  abort "Fatal: $EDITOR is not set."
-end
+abort "Fatal: $EDITOR is not set." unless ENV["EDITOR"]
 
 unless KBSecret::Config.session? sess_name
   abort "Fatal: Unknown session: '#{sess_name}'."
@@ -39,7 +38,7 @@ end
 
 session = KBSecret::Session.new label: sess_name
 label = opts.args.shift
-record = session.records.find { |r| r.label == label}
+record = session.records.find { |r| r.label == label }
 
 if record
   Process.spawn("#{ENV["EDITOR"]} #{record.path}")

data/bin/kbsecret-rm

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "kbsecret"
 require "slop"
@@ -23,7 +24,7 @@ opts = Slop.parse suppress_errors: true do |o|
   end
 
   o.on "--introspect-flags" do
-    puts o.options.flat_map { |o| o.flags }.join "\n"
+    puts o.options.flat_map(&:flags).join "\n"
     exit
   end
 end

data/bin/kbsecret-rm-session

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "kbsecret"
 require "slop"
@@ -23,7 +24,7 @@ opts = Slop.parse suppress_errors: true do |o|
   end
 
   o.on "--introspect-flags" do
-    puts o.options.flat_map { |o| o.flags }.join "\n"
+    puts o.options.flat_map(&:flags).join "\n"
     exit
   end
 end

data/bin/kbsecret-sessions

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "kbsecret"
 require "slop"
@@ -20,7 +21,7 @@ opts = Slop.parse suppress_errors: true do |o|
   end
 
   o.on "--introspect-flags" do
-    puts o.options.flat_map { |o| o.flags }.join "\n"
+    puts o.options.flat_map(&:flags).join "\n"
     exit
   end
 end

data/bin/kbsecret-stash-file

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "kbsecret"
 require "slop"
@@ -23,7 +24,7 @@ opts = Slop.parse suppress_errors: true do |o|
   end
 
   o.on "--introspect-flags" do
-    puts o.options.flat_map { |o| o.flags }.join "\n"
+    puts o.options.flat_map(&:flags).join "\n"
     exit
   end
 end

data/bin/kbsecret-todo

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "kbsecret"
 require "slop"
@@ -24,8 +25,8 @@ opts = Slop.parse suppress_errors: true do |o|
   end
 
   o.on "--introspect-flags" do
-    subcmds = ["start", "suspend", "complete"]
-    comp = o.options.flat_map { |o| o.flags } + subcmds
+    subcmds = %w[start suspend complete]
+    comp = o.options.flat_map(&:flags) + subcmds
     puts comp.join "\n"
     exit
   end

data/lib/kbsecret/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "yaml"
 require "fileutils"
 
@@ -21,27 +23,27 @@ module KBSecret
         default: {
           users: [Keybase.current_user],
           root: "kbsecret",
-        }
-      }
+        },
+      },
     }.freeze
 
     # Retrieve a configured value.
     # @param key [String]
     # @return [Object] the corresponding configuration
     def self.[](key)
-      @@config[key]
+      @config[key]
     end
 
     # Retrieve a session's configuration.
     # @param sess [Symbol] the session's label
     # @return [Hash] the session configuration
     def self.session(sess)
-      @@config[:sessions][sess]
+      @config[:sessions][sess]
     end
 
     # @return [Array<Symbol>] all configured session labels
     def self.session_labels
-      @@config[:sessions].keys
+      @config[:sessions].keys
     end
 
     # @param sess [Symbol] the session label
@@ -55,8 +57,8 @@ module KBSecret
     # @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 }
+      @config[:sessions][label.to_sym] = hsh
+      File.open(CONFIG_FILE, "w") { |io| io.write @config.to_yaml }
     end
 
     # Deconfigure a session.
@@ -66,8 +68,8 @@ module KBSecret
     #  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 }
+      @config[:sessions].delete(label.to_sym)
+      File.open(CONFIG_FILE, "w") { |io| io.write @config.to_yaml }
     end
 
     if File.exist?(CONFIG_FILE)
@@ -78,6 +80,6 @@ module KBSecret
       File.open(CONFIG_FILE, "w") { |io| io.write DEFAULT_CONFIG.to_yaml }
     end
 
-    @@config = DEFAULT_CONFIG.merge(user_config)
+    @config = DEFAULT_CONFIG.merge(user_config)
   end
 end

data/lib/kbsecret/exceptions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KBSecret
   # A generic error in kbsecret.
   class KBSecretError < RuntimeError

data/lib/kbsecret/record/abstract.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "json"
 
 module KBSecret
@@ -20,6 +22,13 @@ module KBSecret
           @fields ||= []
           @fields << field
 
+          gen_methods field
+        end
+
+        # Generate the methods used to access a given field.
+        # @param field [Symbol] the new field's name
+        # @return [void]
+        def gen_methods(field)
           class_eval %[
             def #{field}
               @data[self.class.type.to_sym]["#{field}".to_sym]
@@ -42,7 +51,11 @@ module KBSecret
         # @example
         #  KBSecret::Record::Abstract.type # => :abstract
         def type
-          name.split("::").last.downcase.to_sym
+          name.split("::")                       # ["Foo", "BarBaz"]
+              .last                              # "BarBaz"
+              .gsub(/([^A-Z])([A-Z]+)/, '\1_\2') # "Bar_Baz"
+              .downcase                          # "bar_baz"
+              .to_sym                            # :bar_baz
         end
 
         # Load the given hash-representation into a record.
@@ -51,7 +64,7 @@ module KBSecret
         # @return [Record::AbstractRecord] the created record
         # @api private
         def load!(session, hsh)
-          instance = allocate
+          instance         = allocate
           instance.session = session
           instance.initialize_from_hash(hsh)
 
@@ -64,11 +77,11 @@ module KBSecret
       # @param label [Symbol] the new record's label
       # @note Creation does *not* sync the new record; see {#sync!} for that.
       def initialize(session, label)
-        @session = session
+        @session   = session
         @timestamp = Time.now.to_i
-        @label = label
-        @type = self.class.type
-        @data = {}
+        @label     = label
+        @type      = self.class.type
+        @data      = {}
       end
 
       # Fill in instance fields from a record's hash-representation.
@@ -77,9 +90,9 @@ module KBSecret
       # @api private
       def initialize_from_hash(hsh)
         @timestamp = hsh[:timestamp]
-        @label = hsh[:label]
-        @type = hsh[:type].to_sym
-        @data = hsh[:data]
+        @label     = hsh[:label]
+        @type      = hsh[:type].to_sym
+        @data      = hsh[:data]
       end
 
       # The fully qualified path to the record's file.

data/lib/kbsecret/record/environment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "shellwords"
 
 module KBSecret

data/lib/kbsecret/record/login.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KBSecret
   module Record
     # Represents a record containing a login (username, password) pair.

data/lib/kbsecret/record/snippet.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KBSecret
   module Record
     # Represents a record containing a code snippet and its description.

data/lib/kbsecret/record/todo.rb

@@ -11,9 +11,9 @@ module KBSecret
     # The start time is the date and time at which the item was started via
     # {#start!}.
     #
-    # The stop top is the date and time at which the item was *either*
+    # The stop time is the date and time at which the item was *either*
     # last suspended via {#suspend!} *or* finished via {#complete!}.
-    class ToDo < Abstract
+    class Todo < Abstract
       data_field :todo
       data_field :status
       data_field :start
@@ -57,7 +57,7 @@ module KBSecret
         return if started?
 
         self.status = "started"
-        self.start = Time.now.to_s
+        self.start  = Time.now.to_s
       end
 
       # Suspend the to do item.
@@ -66,7 +66,7 @@ module KBSecret
       def suspend!
         return if suspended?
         self.status = "suspended"
-        self.stop = Time.now.to_s
+        self.stop   = Time.now.to_s
       end
 
       # Complete the to do item.
@@ -75,7 +75,7 @@ module KBSecret
       def complete!
         return if completed?
         self.status = "complete"
-        self.stop = Time.now.to_s
+        self.stop   = Time.now.to_s
       end
     end
   end

data/lib/kbsecret/record/unstructured.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module KBSecret
   module Record
     # Represents a record containing unstructured text.
@@ -13,7 +15,7 @@ module KBSecret
         @data = {
           unstructured: {
             text: text,
-          }
+          },
         }
       end
     end

data/lib/kbsecret/record.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "json"
 
 # we have to require abstract first because ruby's module resolution is bad
@@ -38,9 +40,9 @@ module KBSecret
     # @return [Record::AbstractRecord] the loaded record
     # @api private
     def self.load_record!(session, path)
-      hsh = JSON.parse(File.read(path), symbolize_names: true)
+      hsh   = JSON.parse(File.read(path), symbolize_names: true)
       klass = record_classes.find { |c| c.type == hsh[:type].to_sym }
-      klass.load!(session, hsh) if klass
+      klass&.load!(session, hsh)
     end
   end
 end

data/lib/kbsecret/session.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "fileutils"
 
 module KBSecret
@@ -19,11 +21,11 @@ module KBSecret
     #  specified in {Config::CONFIG_FILE}. To *create* a new session,
     #  see {Config.configure_session}.
     def initialize(label: :default)
-      @label = label.to_sym
-      @config = Config.session(@label)
+      @label     = label.to_sym
+      @config    = Config.session(@label)
 
       @directory = rel_path config[:root], mkdir: true
-      @records = load_records!
+      @records   = load_records!
     end
 
     # @param type [String, Symbol] the type of the records to return (or `nil` for all)
@@ -51,12 +53,10 @@ module KBSecret
     # @raise RecordCreationArityError if the number of specified record
     #  arguments does not match the record type's constructor
     def add_record(type, label, *args)
-      klass = Record.record_classes.find { |k| k.type == type.to_sym }
+      klass = Record.class_for(type.to_sym)
       arity = klass.instance_method(:initialize).arity - 2
 
-      unless arity == args.size
-        raise RecordCreationArityError.new(arity, args.size)
-      end
+      raise RecordCreationArityError.new(arity, args.size) unless arity == args.size
 
       record = klass.new(self, label, *args)
       records << record

data/lib/kbsecret.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "keybase"
 
 require_relative "kbsecret/config"
@@ -8,7 +10,7 @@ require_relative "kbsecret/session"
 # The primary namespace for kbsecret.
 module KBSecret
   # kbsecret's current version
-  VERSION = "0.2.2".freeze
+  VERSION = "0.3.0"
 
   # 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.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - William Woodruff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-27 00:00:00.000000000 Z
+date: 2017-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: keybase-unofficial