kbsecret 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f468bb679d062bf75ce1d379e4cd76c4544c090f
-  data.tar.gz: d862b1c03920b88de8942fac32ad6f7b4fb89bd2
+  metadata.gz: a3a2b28b3170e4863d44f11502981d3089d632d9
+  data.tar.gz: fd5336473ba16c325225a4b91d66e59b3716d8a4
 SHA512:
-  metadata.gz: a9de681a6224e5f577deb31e8a72cafe288fa9d48c7de5e7438616c8887408a3705e813bd588fdfc328b84683e0f5b51540f58911163c81494cde918851306a4
-  data.tar.gz: 0fbe3224bc94a6a39eea6e1e0c578ab01fcd4755e92e827cd08441151086bd1cc2c65d00c2de8cfbefca0a32847001d53d7fc5496058de45bdf937cc7e3e64b7
+  metadata.gz: 6f3a41f94c383af499a7d5271c16ed24a3f2dda3e3ef12b7520766860015191acb9aad6765f3349b09518ce0187a9a67762f026a4c8ad487b791d46909900f87
+  data.tar.gz: 228a9ef975f89767c5addf46204387a9f51c2a5f1fa5c1d6464c36d4cd33fc6308b8b86bb961a6570a0caa6cbd25badc5d673a3e70fa8a92601c7da1c30d2f76

data/README.md

@@ -31,6 +31,8 @@ $ git clone git@github.com:woodruffw/kbsecret.git && cd kbsecret
 $ RUBYLIB=./lib PATH=./bin:${PATH} ./bin/kbsecret help
 ```
 
+Documentation is available on [RubyDoc](http://www.rubydoc.info/gems/kbsecret/).
+
 ### Usage
 
 ```bash

data/bin/kbsecret-new

@@ -2,6 +2,11 @@
 
 require "kbsecret"
 require "slop"
+require "abbrev"
+require "tty-prompt"
+
+# allows for abbreviated types (e.g., `kbsecret new env ...`)
+TYPE_ALIASES = Abbrev.abbrev(KBSecret::Record.record_types).freeze
 
 opts = Slop.parse suppress_errors: true do |o|
   o.banner = <<~EOS
@@ -9,14 +14,18 @@ opts = Slop.parse suppress_errors: true do |o|
 
     Usage:
       kbsecret new [--session <name>] [--force] <type> <label> <args ...>
+      kbsecret new [--session <name>] [--force] [--interactive] <type> <label>
 
     Examples:
       kbsecret new login gmail "foo@bar.com" "mytopsecretpassword"
       kbsecret new environment API_KEY "abcdef-0123456789"
+      kbsecret new --interactive login netflix
   EOS
 
   o.string "-s", "--session", "the session name", default: :default
   o.bool "-f", "--force", "force creation (ignore overwrites, etc.)"
+  o.bool "-i", "--interactive", "input record fields interactively"
+  o.bool "-e", "--echo", "echo input to tty (only effects --interactive)"
 
   o.on "-h", "--help" do
     puts o
@@ -35,6 +44,8 @@ abort "Fatal: Not enough arguments." if opts.args.size < 2
 session = KBSecret::Session.new label: sess_name
 type, label = opts.args.shift 2
 
+type = TYPE_ALIASES[type]
+
 if session.record?(label) && !opts.force?
   abort "Fatal: Refusing to overwrite an existing record without --force."
 end
@@ -46,8 +57,21 @@ unless KBSecret::Record.type?(type)
   EOS
 end
 
+fields = []
+
+if opts.interactive?
+  prompt = TTY::Prompt.new
+  klass = KBSecret::Record.class_for(type)
+  klass.data_fields.each do |field|
+    fields << prompt.ask("#{field.capitalize}?", echo: opts.echo?)
+  end
+else
+  fields = opts.args
+end
+
+
 begin
-  session.add_record(type, label, *opts.args)
+  session.add_record(type, label, *fields)
 rescue => e
   abort "Fatal: #{e.to_s}."
 end

data/bin/kbsecret-new-session

@@ -37,4 +37,4 @@ session_hash = {
   root: opts[:root],
 }
 
-KBSecret::Config.add_session(session_label, session_hash)
+KBSecret::Config.configure_session(session_label, session_hash)

data/bin/kbsecret-rm

@@ -11,7 +11,7 @@ opts = Slop.parse suppress_errors: true do |o|
     Delete a record.
 
     Usage:
-      kbsecret rm [--session <name>] <label>
+      kbsecret rm [--session <name>] [--interactive] <label>
   EOS
 
   o.string "-s", "--session", "the session name", default: :default

data/bin/kbsecret-sessions

@@ -20,7 +20,7 @@ opts = Slop.parse suppress_errors: true do |o|
   end
 end
 
-KBSecret::Config.session_names.each do |sess_name|
+KBSecret::Config.session_labels.each do |sess_name|
   session_hash = KBSecret::Config.session(sess_name)
   session = KBSecret::Session.new label: sess_name
   line = "#{sess_name}\n"

data/lib/kbsecret/config.rb

@@ -40,22 +40,20 @@ module KBSecret
     end
 
     # @return [Array<Symbol>] all configured session labels
-    # @todo This should be session_labels.
-    def self.session_names
+    def self.session_labels
       @@config[:sessions].keys
     end
 
     # @param sess [Symbol] the session label
     # @return [Boolean] whether or not the given session is configured
     def self.session?(sess)
-      session_names.include?(sess.to_sym)
+      session_labels.include?(sess.to_sym)
     end
 
     # Configure a session.
     # @param label [Symbol] the session label
     # @param hsh [Hash] the session configuration
-    # @todo This should be configure_session.
-    def self.add_session(label, hsh)
+    def self.configure_session(label, hsh)
       @@config[:sessions][label.to_sym] = hsh
       File.open(CONFIG_FILE, "w") { |io| io.write @@config.to_yaml }
     end

data/lib/kbsecret/record/abstract.rb

@@ -12,24 +12,46 @@ module KBSecret
       attr_reader :type
       attr_reader :data
 
-      # @return [String] the record's type
-      # @example
-      #  KBSecret::Record::Abstract.type # => "abstract"
-      def self.type
-        name.split("::").last.downcase
-      end
+      class << self
+        def data_field(field)
+          @fields ||= []
+          @fields << field
 
-      # Load the given hash-representation into a record.
-      # @param session [Session] the session to associate with
-      # @param hsh [Hash] the record's hash-representation
-      # @return [Record::AbstractRecord] the created record
-      # @api private
-      def self.load!(session, hsh)
-        instance = allocate
-        instance.session = session
-        instance.initialize_from_hash(hsh)
+          class_eval %[
+            def #{field}
+              @data[self.class.type.to_sym]["#{field}".to_sym]
+            end
+
+            def #{field}=(val)
+              @data[self.class.type.to_sym]["#{field}".to_sym] = val
+              sync!
+            end
+          ]
+        end
+
+        def data_fields
+          @fields
+        end
+
+        # @return [String] the record's type
+        # @example
+        #  KBSecret::Record::Abstract.type # => "abstract"
+        def type
+          name.split("::").last.downcase
+        end
+
+        # Load the given hash-representation into a record.
+        # @param session [Session] the session to associate with
+        # @param hsh [Hash] the record's hash-representation
+        # @return [Record::AbstractRecord] the created record
+        # @api private
+        def load!(session, hsh)
+          instance = allocate
+          instance.session = session
+          instance.initialize_from_hash(hsh)
 
-        instance
+          instance
+        end
       end
 
       # Create a brand new record, associated with a session.

data/lib/kbsecret/record/environment.rb

@@ -4,6 +4,9 @@ module KBSecret
   module Record
     # Represents a record containing an environment variable and value.
     class Environment < Abstract
+      data_field :variable
+      data_field :value
+
       # @param session [Session] the session to associate with
       # @param label [Symbol] the new record's label
       # @param variable [String] the new record's variable
@@ -22,32 +25,6 @@ module KBSecret
         }
       end
 
-      # @return [String] the record's variable
-      def variable
-        @data[:environment][:variable]
-      end
-
-      # @param var [String] the new variable to insert into the record
-      # @return [void]
-      # @note Triggers a record sync; see {Abstract#sync!}.
-      def variable=(var)
-        @data[:environment][:variable] = var
-        sync!
-      end
-
-      # @return [String] the record's value
-      def value
-        @data[:environment][:value]
-      end
-
-      # @param val [String] the new value to insert into the record
-      # @return [void]
-      # @note Triggers a record sync; see {Abstract#sync!}.
-      def value=(val)
-        @data[:environment][:value] = val
-        sync!
-      end
-
       # @return [String] a sh-style environment assignment
       def to_assignment
         "#{variable}=#{value}"

data/lib/kbsecret/record/login.rb

@@ -2,6 +2,9 @@ module KBSecret
   module Record
     # Represents a record containing a login (username, password) pair.
     class Login < Abstract
+      data_field :username
+      data_field :password
+
       # @param session [Session] the session to associate with
       # @param label [Symbol] the new record's label
       # @param user [String] the new record's username
@@ -16,32 +19,6 @@ module KBSecret
           },
         }
       end
-
-      # @return [String] the record's username
-      def username
-        @data[:login][:username]
-      end
-
-      # @param user [String] the new username to insert into the record
-      # @return [void]
-      # @note Triggers a record sync; see {Abstract#sync!}.
-      def username=(user)
-        @data[:login][:username] = user
-        sync!
-      end
-
-      # @return [String] the record's password
-      def password
-        @data[:login][:password]
-      end
-
-      # @param pass [String] the new password to insert into the record
-      # @return [void]
-      # @note Triggers a record sync; see {Abstract#sync!}.
-      def password=(pass)
-        @data[:login][:password] = pass
-        sync!
-      end
     end
   end
 end

data/lib/kbsecret/record/unstructured.rb

@@ -2,6 +2,8 @@ module KBSecret
   module Record
     # Represents a record containing unstructured text.
     class Unstructured < Abstract
+      data_field :text
+
       # @param session [Session] the session to associate with
       # @param label [Symbol] the new record's label
       # @param text [String] the new record's unstructured text
@@ -12,19 +14,6 @@ module KBSecret
           text: text
         }
       end
-
-      # @return [String] the record's unstructured text
-      def text
-        @data[:text]
-      end
-
-      # @param new_text [String] the new text to insert into the record
-      # @return [void]
-      # @note Triggers a record sync; see {Abstract#sync!}.
-      def text=(new_text)
-        @data[:text] = new_text
-        sync!
-      end
     end
   end
 end

data/lib/kbsecret/record.rb

@@ -20,6 +20,13 @@ module KBSecret
       record_classes.map(&:type)
     end
 
+    # @param type [String] the record type
+    # @return [Class, nil] the record class corresponding to the given type
+    def self.class_for(type)
+      record_classes.find { |c| c.type == type }
+    end
+
+    # @param type [String] the record type
     # @return [Boolean] whether a record class exists of the given type
     def self.type?(type)
       record_types.include?(type)

data/lib/kbsecret/session.rb

@@ -14,7 +14,7 @@ module KBSecret
     # @param label [Symbol] the label of the session to initialize
     # @note This does not *create* a new session, but loads one already
     #  specified in {Config::CONFIG_FILE}. To *create* a new session,
-    #  see {Config.add_session}.
+    #  see {Config.configure_session}.
     def initialize(label: :default)
       @label = label
       @config = Config.session(label.to_sym)

data/lib/kbsecret.rb

@@ -8,7 +8,7 @@ require_relative "kbsecret/session"
 # The primary namespace for kbsecret.
 module KBSecret
   # kbsecret's current version
-  VERSION = "0.0.2".freeze
+  VERSION = "0.0.3".freeze
 
   # 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.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - William Woodruff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-03 00:00:00.000000000 Z
+date: 2017-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: keybase-unofficial
@@ -55,14 +55,14 @@ dependencies:
 description: Manages your passwords, environment, and more via KBFS.
 email: william@tuffbizz.com
 executables:
-- kbsecret-sessions
-- kbsecret-new-session
-- kbsecret-new
+- kbsecret
 - kbsecret-rm
-- kbsecret-list
 - kbsecret-login
+- kbsecret-new
 - kbsecret-env
-- kbsecret
+- kbsecret-new-session
+- kbsecret-list
+- kbsecret-sessions
 extensions: []
 extra_rdoc_files: []
 files: