kbsecret 0.3.6 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 84a1ecab08084cc71d8fb221a3a66984ca666e4b
-  data.tar.gz: cb5712d9720862406333252f437cf690b56f3f59
+  metadata.gz: b92602206f1d3a9d5e7a6229c92de8483b90bc78
+  data.tar.gz: d8677ddd153af6bd8b045bb952035e6e3a2747cb
 SHA512:
-  metadata.gz: 710f4ed51abb06d69d8287fd496b2e18545ca36c895d388bdba991faa87ffb57a511a6f582ea06ed0d5230e16ce5d8dfc18a4d4b4563a18c3f79ea701a3676ad
-  data.tar.gz: 71e11b76e2f36dce94006e4b31bd421d712aa2101f6ec721030b32390feec0afb157be25194050bd2befecd48d4cfc61560cc483a95c18ace30ae0d0213b7bfb
+  metadata.gz: dd25e6557b8d4c087ba0768114a76db07bdfad421f90adbfbf17abb7a665131f2febae4e5767c7447512a5762533279b452841c93f0f0a2b89383acfa4966b61
+  data.tar.gz: df41aa140028171ebc7f10745af3e735390304b13fce9a7b249162fe32be6a29156e14e5a5f4894fda840ac63bb7c34e5068ed91aec7790a2b67e81bd82977d2

data/README.md

@@ -60,11 +60,11 @@ default
 dev-team
 
 # add an environment record to the dev-team session
-$ kbsecret new environment API_KEY 0xBADBEEF -s dev-team
+$ kbsecret new environment api-key API_KEY 0xBADBEEF -s dev-team
 
 # list all records under the dev-team session
 $ kbsecret list -s dev-team
-API_KEY
+api-key
 
 # get all environment records in dev-team in an easy-to-source format
 $ kbsecret env -s dev-team --all
@@ -102,4 +102,3 @@ Please feel free to contribute completion scripts for other shells!
 ### TODO
 
 * zsh/fish completions
-* a TODO record type?

data/lib/kbsecret.rb

@@ -11,7 +11,7 @@ require_relative "kbsecret/cli"
 # The primary namespace for kbsecret.
 module KBSecret
   # kbsecret's current version
-  VERSION = "0.3.6"
+  VERSION = "0.4.0"
 
   # fail very early if the user doesn't have keybase and KBFS running
   raise Keybase::KeybaseNotRunningError unless Keybase.running?

data/lib/kbsecret/config.rb

@@ -18,11 +18,11 @@ module KBSecret
     # @api private
     DEFAULT_CONFIG = {
       mount: "/keybase",
-
+      session_root: "kbsecret",
       sessions: {
         default: {
           users: [Keybase.current_user],
-          root: "kbsecret",
+          root: "default",
         },
       },
     }.freeze
@@ -81,5 +81,6 @@ module KBSecret
     end
 
     @config = DEFAULT_CONFIG.merge(user_config)
+    FileUtils.mkdir_p @config[:session_root]
   end
 end

data/lib/kbsecret/record/abstract.rb

@@ -8,12 +8,24 @@ module KBSecret
     # more useful records.
     # @abstract
     class Abstract
+      # @return [Session] the session associated with the record
       attr_accessor :session
+
+      # @return [Integer] the UNIX timestamp marking the record's last modification
       attr_reader :timestamp
+
+      # @return [Symbol] the record's label
       attr_reader :label
+
+      # @return [Symbol] the record's type
       attr_reader :type
+
+      # @return [Hash] the record's data
       attr_reader :data
 
+      # @return [String] the fully qualified path to the record in KBFS
+      attr_reader :path
+
       class << self
         # Add a field to the record's data.
         # @param field [Symbol] the new field's name
@@ -82,6 +94,7 @@ module KBSecret
         @label     = label
         @type      = self.class.type
         @data      = {}
+        @path      = File.join(session.directory, "#{label}.json")
       end
 
       # Fill in instance fields from a record's hash-representation.
@@ -93,14 +106,7 @@ module KBSecret
         @label     = hsh[:label]
         @type      = hsh[:type].to_sym
         @data      = hsh[:data]
-      end
-
-      # The fully qualified path to the record's file.
-      # @return [String] the path
-      # @note If the record hasn't been synced to disk, this path may not
-      #  exist yet.
-      def path
-        File.join(session.directory, "#{label}.json")
+        @path      = File.join(session.directory, "#{label}.json")
       end
 
       # Create a hash-representation of the current record.

data/lib/kbsecret/session.rb

@@ -90,21 +90,31 @@ module KBSecret
       FileUtils.rm_rf(directory)
     end
 
-    private
-
+    # @return [Array<String>] the fully qualified paths of all records in the session
+    # @api private
     def record_paths
       Dir[File.join(directory, "*.json")]
     end
 
+    # Load all records associated with the session.
+    # @return [Array<Record::Abstract>] all records in the session
+    # @api private
     def load_records!
       record_paths.map do |path|
         Record.load_record! self, path
       end
     end
 
+    # @param rel [String, Symbol] the "root" of the session
+    # @param mkdir [Boolean] whether or not to make the session directory
+    # @return [String] the fully qualified path to the session
+    # @api private
     def rel_path(rel, mkdir: false)
+      # /keybase/private/[username]/kbsecret/[session]
       path = File.join(Config[:mount], "private",
-                       Keybase::U[config[:users]], rel)
+                       Keybase::U[config[:users]],
+                       Config[:session_root],
+                       rel)
 
       FileUtils.mkdir_p path if mkdir
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kbsecret
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.4.0
 platform: ruby
 authors:
 - William Woodruff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-06 00:00:00.000000000 Z
+date: 2017-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: keybase-unofficial