kbsecret 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd4688af12e409cc9c13577ff5e2471773504790
-  data.tar.gz: d72010806cfb3e8f132b3aeae87f53664e34235a
+  metadata.gz: 123474c33b029cd6b8934c0e19aaed74979e097c
+  data.tar.gz: f5c40ef2c8e2fba8973c4ff3034998e8c89080a3
 SHA512:
-  metadata.gz: c520121a121d1a83583391546502e7491a831d090cfb3edc968ec1a6205639f82cc954e0a9793f6b33764c7e5ee61d94c5d85ef3edab634e43efcaa3953d943e
-  data.tar.gz: 0bbbabee51ef4a1e2676b5251d25bce45157be2d3f69e9c4e34ba82c3cddba779a6b9c247a5f3576444711d8333ba824bacaffc49d1c5b603aa4db521082c7e9
+  metadata.gz: 3b1fbd12a21eb016fbe174d72433ffc501284fc0edb43d8c47914f38ae76804927a449b696bb05205e203e795cdc2fe9c870ac1ffe5eab305d12c0c4c398bc3a
+  data.tar.gz: '0168fee1a6e9baf4b875b7883f351f5d9378733074e6d165309e69339f52da479ed8244774451067e4eeeade851b3602363e835ff2174302f7714043ca9fcb5b'

data/README.md

@@ -1,11 +1,11 @@
-kbsecret
+KBSsecret
 ========
 
 [![Gem Version](https://badge.fury.io/rb/kbsecret.svg)](https://badge.fury.io/rb/kbsecret)
 
 *Note*: This is still a work in process. Use it with caution.
 
-kbsecret is a combined library/utility that provides a secret management
+KBSecret is a combined library/utility that provides a secret management
 interface for [KBFS](https://keybase.io/docs/kbfs) and
 [Keybase](https://keybase.io/).
 
@@ -20,12 +20,12 @@ interface for [KBFS](https://keybase.io/docs/kbfs) and
 
 ### Installation
 
-kbsecret is available via [RubyGems](https://rubygems.org/gems/kbsecret):
+KBSecret is available via [RubyGems](https://rubygems.org/gems/kbsecret):
 
 ```bash
 $ gem install kbsecret
 
-# or, install the prerelease:
+# or, install the latest prerelease:
 
 $ gem install --pre kbsecret
 ```
@@ -91,7 +91,7 @@ export BRAND_NEW_API='0xBADBEEF'
 
 ### Manual Pages
 
-kbsecret's manual pages can be found online
+KBSecret's manual pages can be found online
 [here](https://yossarian.net/docs/kbsecret-man/kbsecret.1).
 
 If you'd like to generate the roff versions for `man(1)`, you'll need `ronn(1)`:
@@ -103,7 +103,7 @@ $ cp man/*.1 ${YOUR_MAN_DIR}
 
 ### Shell Completion
 
-kbsecret provides shell completion functions for bash.
+KBSecret provides shell completion functions for bash.
 
 To generate them:
 

data/bin/kbsecret-new-session

@@ -17,9 +17,15 @@ cmd = CLI.create do |c|
     o.array "-u", "--users", "the keybase users", default: [Keybase.current_user]
     o.string "-r", "--root", "the secret root directory"
     o.bool "-f", "--force", "force creation (ignore overwrites, etc.)"
+    o.bool "-n", "--no-notify", "do not send a notification to session members"
   end
 end
 
+unless cmd.opts[:users].include? Keybase.current_user
+  cmd.warn "You didn't include yourself in the user list, but I'll add you."
+  cmd.opts[:users] << Keybase.current_user
+end
+
 session_label = cmd.opts[:label]
 
 if Config.session?(session_label) && !cmd.opts.force?
@@ -32,3 +38,23 @@ session_hash = {
 }
 
 Config.configure_session(session_label, session_hash)
+
+unless cmd.opts.no_notify? && cmd.opts[:users] != [Keybase.current_user]
+  users = cmd.opts[:users].join(",")
+
+  Keybase::Chat.send_message cmd.opts[:users], <<~EOM
+    You've been added to a KBSecret session!
+
+    To access this session, please run the following:
+
+    ```
+      $ kbsecret new-session -l '<your label>' -r '#{cmd.opts[:root]}' -u #{users}
+    ```
+
+    If you don't have KBSecret installed, you can install it from `gem`:
+
+    ```
+      $ gem install kbsecret
+    ```
+  EOM
+end

data/lib/kbsecret/config.rb

@@ -47,10 +47,6 @@ module KBSecret
     # configuration defaults
     # @api private
     DEFAULT_CONFIG = {
-      session_root: File.join("/keybase/private/",
-                              Keybase.current_user,
-                              "kbsecret"),
-
       mount: "/keybase",
       sessions: DEFAULT_SESSION,
       generators: DEFAULT_GENERATOR,
@@ -149,7 +145,6 @@ module KBSecret
     @config[:sessions].merge!(DEFAULT_SESSION)
     @config[:generators].merge!(DEFAULT_GENERATOR)
 
-    FileUtils.mkdir_p @config[:session_root]
     sync!
   end
 end

data/lib/kbsecret/exceptions.rb

@@ -27,6 +27,13 @@ module KBSecret
     end
   end
 
+  # Raised during session load if an error occurs.
+  class SessionLoadError < KBSecretError
+    def initialize(msg)
+      super "Session loading failure: #{msg}"
+    end
+  end
+
   # Raised during session lookup if an unknown session is requested.
   class SessionUnknownError < KBSecretError
     def initialize(sess)

data/lib/kbsecret/record/environment.rb

@@ -6,6 +6,10 @@ module KBSecret
   module Record
     # Represents a record containing an environment variable and value.
     class Environment < Abstract
+      # @!attribute variable
+      #  @return [String] the environment variable
+      # @!attribute value
+      #  @return [String] the value of the environment value
       data_field :variable, sensitive: false
       data_field :value
 

data/lib/kbsecret/record/login.rb

@@ -4,6 +4,10 @@ module KBSecret
   module Record
     # Represents a record containing a login (username, password) pair.
     class Login < Abstract
+      # @!attribute username
+      #  @return [String] the username
+      # @!attribute password
+      #  @return [String] the password
       data_field :username, sensitive: false
       data_field :password
     end

data/lib/kbsecret/record/snippet.rb

@@ -4,6 +4,10 @@ module KBSecret
   module Record
     # Represents a record containing a code snippet and its description.
     class Snippet < Abstract
+      # @!attribute code
+      #  @return [String] the code snippet
+      # @!attribute description
+      #  @return [String] the description of the code snippet
       data_field :code, sensitive: false
       data_field :description, sensitive: false
     end

data/lib/kbsecret/record/todo.rb

@@ -16,6 +16,17 @@ 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
+      # @!attribute todo
+      #  @return [String] the todo message
+      # @!attribute status
+      #  @return [String] the todo record's status (one of "started", "suspended", or "complete")
+      #  @note This is an internal field.
+      # @!attribute start
+      #  @return [String] a string representation of the record's (last) start time
+      #  @note This is an internal field.
+      # @!attribute stop
+      #  @return [String] a string representation of the record's (last) stop time
+      #  @note This is an internal field.
       data_field :todo, sensitive: false
       data_field :status, sensitive: false, internal: true
       data_field :start, sensitive: false, internal: true

data/lib/kbsecret/record/unstructured.rb

@@ -4,6 +4,8 @@ module KBSecret
   module Record
     # Represents a record containing unstructured text.
     class Unstructured < Abstract
+      # @!attribute text
+      #  @return [String] the unstructured text of the record
       data_field :text, sensitive: false
     end
   end

data/lib/kbsecret/session.rb

@@ -17,6 +17,7 @@ module KBSecret
     attr_reader :directory
 
     # @param label [String, Symbol] the label of the session to initialize
+    # @raise [SessionLoadError] if the session has no users or any invalid Keybase users
     # @note This does not *create* a new session, but loads one already
     #  specified in {Config::CONFIG_FILE}. To *create* a new session,
     #  see {Config.configure_session}.
@@ -24,7 +25,13 @@ module KBSecret
       @label     = label.to_sym
       @config    = Config.session(@label)
 
-      @directory = rel_path config[:root], mkdir: true
+      raise SessionLoadError, "no users in session" if @config[:users].empty?
+
+      @config[:users].each do |user|
+        raise SessionLoadError, "unknown Keybase user: '#{user}'" unless Keybase::API.user? user
+      end
+
+      @directory = rel_path mkdir: true
       @records   = load_records!
     end
 
@@ -57,9 +64,9 @@ module KBSecret
     # @param label [String, Symbol] the new record's label
     # @param args [Array<String>] the record-type specific arguments
     # @return [void]
-    # @raise UnknownRecordTypeError if the requested type does not exist
+    # @raise [UnknownRecordTypeError] if the requested type does not exist
     #  in {Record.record_types}
-    # @raise RecordCreationArityError if the number of specified record
+    # @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.class_for(type.to_sym)
@@ -116,13 +123,14 @@ module KBSecret
       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[:session_root], rel)
+    def rel_path(mkdir: false)
+      # /keybase/private/[u1,u2,...,uN]/kbsecret/[session]
+      path = File.join(Config[:mount], "private",
+                       Keybase::U[@config[:users]],
+                       "kbsecret", @config[:root])
 
       FileUtils.mkdir_p path if mkdir
 

data/lib/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kbsecret
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - William Woodruff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-15 00:00:00.000000000 Z
+date: 2017-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fpm
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.8
+        version: 0.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.8
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: slop
   requirement: !ruby/object:Gem::Requirement