kbsecret 0.5.6 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f988059d109942e54868a06c593c2f20f62972c6
-  data.tar.gz: a6d1d9b5b52fcb4f136eab7ead9d404111855fc9
+  metadata.gz: 04bf388d61371a29a5f721a4a39a03037fbd674c
+  data.tar.gz: 4bc34dd530c79ecb34816c0013a36c47ecb969e4
 SHA512:
-  metadata.gz: e627e140303c2966e2f824e751edd7bdd9e48bb999160b1ba9b498b8f1c14ceebc128ac331c20d0a5729665810033851f575ce200803c11a0ef179f90ca4698e
-  data.tar.gz: 9700504918200ff1dd434a65466cecf666575205bcae655cac6208f12f942a8aa12e8a6348560b99f28c4f084baa51ee35c197d589ec342e3cb2ba5817036f80
+  metadata.gz: 6933f6c00c8ced6ebec24956790109f0238324e69194637fe7cabbb8be7cdac21e5de9732eba3c043f8cbc92d93def83195682013c1d019aca497423a04ff44a
+  data.tar.gz: 3fbd02c35aaf1531b0365e7475ab3047c6b07ac442bd83f195d656b613fae4d1a3f8e4d450ce1d770312c59a61fc4518f4e3e084f60ac425c0105ce02f071ed4

data/bin/kbsecret-new

@@ -53,7 +53,8 @@ fields = if $stdin.tty? && !cmd.opts.args?
            prompt = TTY::Prompt.new
            klass = Record.class_for(resolved_type)
            klass.data_fields.map do |field|
-             prompt.ask("#{field.capitalize}?", echo: cmd.opts.echo?)
+             prompt.ask "#{field.capitalize}?",
+                        echo: !klass.sensitive?(field) || cmd.opts.echo?
            end
          else
            cmd.args[:fields]

data/lib/kbsecret/record/abstract.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "json"
+require "forwardable"
 
 module KBSecret
   module Record
@@ -8,6 +9,8 @@ module KBSecret
     # more useful records.
     # @abstract
     class Abstract
+      extend Forwardable
+
       # @return [Session] the session associated with the record
       attr_accessor :session
 
@@ -29,10 +32,14 @@ module KBSecret
       class << self
         # Add a field to the record's data.
         # @param field [Symbol] the new field's name
+        # @param sensitive [Boolean] whether the field is sensitive (e.g., a password)
         # @return [void]
-        def data_field(field)
-          @fields ||= []
+        def data_field(field, sensitive: true)
+          @fields    ||= []
+          @sensitive ||= {}
+
           @fields << field
+          @sensitive[field] = sensitive
 
           gen_methods field
         end
@@ -54,6 +61,12 @@ module KBSecret
           ]
         end
 
+        # @param field [Symbol] the field's name
+        # @return [Boolean] whether the field is sensitive
+        def sensitive?(field)
+          !!@sensitive[field]
+        end
+
         # @return [Array<Symbol>] all data fields for the record class
         def data_fields
           @fields
@@ -63,11 +76,11 @@ module KBSecret
         # @example
         #  KBSecret::Record::Abstract.type # => :abstract
         def type
-          name.split("::")                       # ["Foo", "BarBaz"]
-              .last                              # "BarBaz"
-              .gsub(/([^A-Z])([A-Z]+)/, '\1_\2') # "Bar_Baz"
-              .downcase                          # "bar_baz"
-              .to_sym                            # :bar_baz
+          name.split("::")
+              .last
+              .gsub(/([^A-Z])([A-Z]+)/, '\1_\2')
+              .downcase
+              .to_sym
         end
 
         # Load the given hash-representation into a record.
@@ -109,6 +122,12 @@ module KBSecret
         @path      = File.join(session.directory, "#{label}.json")
       end
 
+      # @!method data_fields
+      #  @return (see KBSecret::Record::Abstract.data_fields)
+      # @!method sensitive?
+      #  @return (see KBSecret::Record::Abstract.sensitive?)
+      def_delegators :"self.class", :data_fields, :sensitive?
+
       # Create a string representation of the current record.
       # @return [String] the string representation
       def to_s

data/lib/kbsecret/record/environment.rb

@@ -6,7 +6,7 @@ module KBSecret
   module Record
     # Represents a record containing an environment variable and value.
     class Environment < Abstract
-      data_field :variable
+      data_field :variable, sensitive: false
       data_field :value
 
       # @param session [Session] the session to associate with

data/lib/kbsecret/record/login.rb

@@ -4,7 +4,7 @@ module KBSecret
   module Record
     # Represents a record containing a login (username, password) pair.
     class Login < Abstract
-      data_field :username
+      data_field :username, sensitive: false
       data_field :password
 
       # @param session [Session] the session to associate with

data/lib/kbsecret/record/snippet.rb

@@ -4,8 +4,8 @@ module KBSecret
   module Record
     # Represents a record containing a code snippet and its description.
     class Snippet < Abstract
-      data_field :code
-      data_field :description
+      data_field :code, sensitive: false
+      data_field :description, sensitive: false
 
       # @param session [Session] the session to associate with
       # @param label [Symbol] the new record's label

data/lib/kbsecret/record/todo.rb

@@ -14,10 +14,10 @@ module KBSecret
     # 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
-      data_field :todo
-      data_field :status
-      data_field :start
-      data_field :stop
+      data_field :todo, sensitive: false
+      data_field :status, sensitive: false
+      data_field :start, sensitive: false
+      data_field :stop, sensitive: false
 
       # @param session [Session] the session to associate with
       # @param label [Symbol] the new record's label

data/lib/kbsecret/record/unstructured.rb

@@ -4,7 +4,7 @@ module KBSecret
   module Record
     # Represents a record containing unstructured text.
     class Unstructured < Abstract
-      data_field :text
+      data_field :text, sensitive: false
 
       # @param session [Session] the session to associate with
       # @param label [Symbol] the new record's label

data/lib/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kbsecret
 version: !ruby/object:Gem::Version
-  version: 0.5.6
+  version: 0.6.0
 platform: ruby
 authors:
 - William Woodruff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-30 00:00:00.000000000 Z
+date: 2017-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fpm
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.6
+        version: 0.0.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.6
+        version: 0.0.7
 - !ruby/object:Gem::Dependency
   name: keybase-unofficial
   requirement: !ruby/object:Gem::Requirement