kbsecret 0.7.0.pre.2 → 0.7.0.pre.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 880375c3b35cffd81cc94adba77037fb59fdbeaa
-  data.tar.gz: 05c2e322dfe48b7fa3b526b32c7233d6778c0651
+  metadata.gz: 8c5f8f62886813839cd84f823e1b3c5e1d0ef621
+  data.tar.gz: 7b8bfe9c9672bff900825568001362790b88a1db
 SHA512:
-  metadata.gz: 33a12d9bc5c28081e036a546ee05256dadfde708fe6dafd9ad211174cbf97f5efdd455e36f0b2d3a479a42aa4a46e920d88878c78bdab6bf461642032c8295d8
-  data.tar.gz: a068a60e73e107793ffee460cc86524f701a87dae2b4a987789f1d5f9c882a9a4284fd95b9dc532284f5c2769a15019b37cb5bb728fa640f9184252b72cbfe49
+  metadata.gz: c2f59a671138ea5867c2511e20bb15098ca1f578bf0389b91046d8a17bfa4441c2ad15d62a6bd57a1ea513106e561e8d576f325b54d40a168b44ca2f9e395b79
+  data.tar.gz: 04e18852305aba35410105cf6371ef76ca2ce8f3a4e6ba5849437e91345d22ead4144eb6de8bd4d911eef3746d24a4c9e578040e41fbf1425dcedbb952cbdaec

data/README.md

@@ -24,6 +24,10 @@ kbsecret is available via [RubyGems](https://rubygems.org/gems/kbsecret):
 
 ```bash
 $ gem install kbsecret
+
+# or, install the prerelease:
+
+$ gem install --pre kbsecret
 ```
 
 For hacking:

data/bin/kbsecret-new

@@ -53,7 +53,7 @@ end
 fields = if $stdin.tty? && !cmd.opts.args?
            prompt = TTY::Prompt.new
            klass = Record.class_for(resolved_type)
-           klass.data_fields.map do |field|
+           klass.external_fields.map do |field|
              if cmd.opts.generate? && klass.sensitive?(field)
                generator.secret
              else

data/lib/kbsecret/record/abstract.rb

@@ -33,13 +33,16 @@ module KBSecret
         # 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)
+        # @param internal [Boolean] whether the field should be populated by the user
         # @return [void]
-        def data_field(field, sensitive: true)
+        def data_field(field, sensitive: true, internal: false)
           @fields    ||= []
           @sensitive ||= {}
+          @internal  ||= {}
 
           @fields << field
           @sensitive[field] = sensitive
+          @internal[field]  = internal
 
           gen_methods field
         end
@@ -67,11 +70,27 @@ module KBSecret
           !!@sensitive[field]
         end
 
+        # @param field [Symbol] the field's name
+        # @return [Boolean] whether the field is internal
+        # @note Fields that are marked as "internal" should *not* be presented to the user
+        #  for population. Instead, it is up to the record type itself to define a reasonable
+        #  default (and subsequent values) for these fields.
+        def internal?(field)
+          !!@internal[field]
+        end
+
         # @return [Array<Symbol>] all data fields for the record class
+        # @note This includes internal fields, which are generated. See {external_fields}
+        #  for the list of exclusively external fields.
         def data_fields
           @fields
         end
 
+        # @return [Array<Symbol>] all external data fields for the record class
+        def external_fields
+          @fields.reject { |f| internal? f }
+        end
+
         # @return [Symbol] the record's type
         # @example
         #  KBSecret::Record::Abstract.type # => :abstract
@@ -100,13 +119,14 @@ module KBSecret
       # Create a brand new record, associated with a session.
       # @param session [Session] the session to associate with
       # @param label [String, Symbol] the new record's label
+      # @param body [Hash<Symbol, String>] a mapping of the record's data fields
       # @note Creation does *not* sync the new record; see {#sync!} for that.
-      def initialize(session, label)
+      def initialize(session, label, **body)
         @session   = session
         @timestamp = Time.now.to_i
         @label     = label.to_s
         @type      = self.class.type
-        @data      = {}
+        @data      = { @type => body }
         @path      = File.join(session.directory, "#{label}.json")
       end
 
@@ -124,9 +144,13 @@ module KBSecret
 
       # @!method data_fields
       #  @return (see KBSecret::Record::Abstract.data_fields)
+      # @!method external_fields
+      #  @return (see KBSecret::Record::Abstract.external_fields)
       # @!method sensitive?
       #  @return (see KBSecret::Record::Abstract.sensitive?)
-      def_delegators :"self.class", :data_fields, :sensitive?
+      # @!method internal?
+      #  @return (see KBSecret::Record::Abstract.internal?)
+      def_delegators :"self.class", :data_fields, :external_fields, :sensitive?, :internal?
 
       # Create a string representation of the current record.
       # @return [String] the string representation

data/lib/kbsecret/record/environment.rb

@@ -14,14 +14,7 @@ module KBSecret
       # @param variable [String] the new record's variable
       # @param value [String] the new record's value
       def initialize(session, label, variable, value)
-        super(session, label)
-
-        @data = {
-          environment: {
-            variable: variable.shellescape,
-            value: value.shellescape,
-          },
-        }
+        super(session, label, variable: variable.shellescape, value: value.shellescape)
       end
 
       # @return [String] a sh-style environment assignment

data/lib/kbsecret/record/login.rb

@@ -12,14 +12,7 @@ module KBSecret
       # @param user [String] the new record's username
       # @param pass [String] the new record's password
       def initialize(session, label, user, pass)
-        super(session, label)
-
-        @data = {
-          login: {
-            username: user,
-            password: pass,
-          },
-        }
+        super(session, label, username: user, password: pass)
       end
     end
   end

data/lib/kbsecret/record/snippet.rb

@@ -12,14 +12,7 @@ module KBSecret
       # @param code [String] the code
       # @param description [String] a description of the code
       def initialize(session, label, code, description)
-        super(session, label)
-
-        @data = {
-          snippet: {
-            code: code,
-            description: description,
-          },
-        }
+        super(session, label, code: code, description: description)
       end
     end
   end

data/lib/kbsecret/record/todo.rb

@@ -17,24 +17,15 @@ module KBSecret
     # last suspended via {#suspend!} *or* finished via {#complete!}.
     class Todo < Abstract
       data_field :todo, sensitive: false
-      data_field :status, sensitive: false
-      data_field :start, sensitive: false
-      data_field :stop, sensitive: false
+      data_field :status, sensitive: false, internal: true
+      data_field :start, sensitive: false, internal: true
+      data_field :stop, sensitive: false, internal: true
 
       # @param session [Session] the session to associate with
       # @param label [Symbol] the new record's label
       # @param todo [String] the to do item
       def initialize(session, label, todo)
-        super(session, label)
-
-        @data = {
-          todo: {
-            todo: todo,
-            status: "suspended",
-            start: nil,
-            stop: nil,
-          },
-        }
+        super(session, label, todo: todo, status: "suspended", start: nil, stop: nil)
       end
 
       # @return [Boolean] whether or not the item is marked as started

data/lib/kbsecret/record/unstructured.rb

@@ -10,13 +10,7 @@ module KBSecret
       # @param label [Symbol] the new record's label
       # @param text [String] the new record's unstructured text
       def initialize(session, label, text)
-        super(session, label)
-
-        @data = {
-          unstructured: {
-            text: text,
-          },
-        }
+        super(session, label, text: text)
       end
     end
   end

data/lib/kbsecret/session.rb

@@ -63,8 +63,8 @@ module KBSecret
     #  arguments does not match the record type's constructor
     def add_record(type, label, *args)
       klass = Record.class_for(type.to_sym)
-
       arity = klass.instance_method(:initialize).arity - 2
+
       raise RecordCreationArityError.new(arity, args.size) unless arity == args.size
 
       record = klass.new(self, label.to_s, *args)

data/lib/version.rb

@@ -2,5 +2,5 @@
 
 module KBSecret
   # kbsecret's current version
-  VERSION = "0.7.0.pre.2"
+  VERSION = "0.7.0.pre.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kbsecret
 version: !ruby/object:Gem::Version
-  version: 0.7.0.pre.2
+  version: 0.7.0.pre.3
 platform: ruby
 authors:
 - William Woodruff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-12 00:00:00.000000000 Z
+date: 2017-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fpm
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.2.1
 - !ruby/object:Gem::Dependency
   name: keybase-unofficial
   requirement: !ruby/object:Gem::Requirement