kbsecret 0.4.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aafa31104e34d5e24baa546e26a05fd9cd695054
-  data.tar.gz: 860ddcb29cdc1d2e0a053d8910af5dd0b7e7cc1a
+  metadata.gz: 40118cac4e5abfe1a536fefb044f62266df790b8
+  data.tar.gz: 52f20d03e5855f7609c41e51787e530fa01e7f38
 SHA512:
-  metadata.gz: 0d58a6e350bd3972be81081ac70b3832e92b51ebb59d0fbe9a50c3bd36720c2e5e4051dd49c3666122fd6598e96b0ad38a4e911e80cd71a5f899217a8f1a78f2
-  data.tar.gz: b5222b237f8ad4caff0869f431a090e7522ffd882cf600e0731d074c981fed2761709ec47bb9bd6a0969bc26d4f3f4e7f18c4a64c3b3207380c31f879e731c3d
+  metadata.gz: 1b920a36a162c11b7b94b925ce495f6246a4645711b987ff5c9629845e881934918fc179cbfdd6d2452d858fc800dedbe220edd4b0723c42271f88c3faeb69b5
+  data.tar.gz: 3102a1a4481fdd75a8dfebd4e56543a6fe079b95f5e4405800ff6b3532e0d2e4efb6b151d3c325b55f6edd4d4d1421713452337fe932b617f6a6bf42d12caf8e

data/README.md

@@ -40,7 +40,9 @@ Documentation is available on [RubyDoc](http://www.rubydoc.info/gems/kbsecret/).
 
 ```bash
 # create a new login record under the default session
-$ kbsecret new login gmail "foo@example.com" "barbazquux"
+$ kbsecret new login gmail
+Username?
+Password?
 
 # list all records under the default session
 $ kbsecret list

data/bin/kbsecret-dump-fields

@@ -19,7 +19,7 @@ end
 session = KBSecret::CLI.ensure_session opts[:session]
 
 label = opts.args.shift
-record = session.records.find { |r| r.label == label }
+record = session[label]
 
 KBSecret::CLI.die "No such record." unless record
 

data/bin/kbsecret-env

@@ -22,18 +22,15 @@ end
 
 session = KBSecret::CLI.ensure_session opts[:session]
 
-env_records = session.records :environment
-
-if opts.all?
-  selected_records = env_records
-else
-  selected_labels = opts.args.uniq
-
-  # instead of complaining about nonexistent records, just ignore them
-  selected_records = selected_labels.map do |l|
-    env_records.find { |r| r.label == l }
-  end.compact
-end
+records = session.records :environment
+
+selected_records = if opts.all?
+                     records
+                   else
+                     records.select do |record|
+                       opts.args.include? record.label
+                     end
+                   end
 
 selected_records.each do |record|
   if opts.value_only?

data/bin/kbsecret-login

@@ -23,18 +23,14 @@ end
 
 session = KBSecret::CLI.ensure_session opts[:session]
 
-login_records = session.records :login
-
-if opts.all?
-  selected_records = login_records
-else
-  selected_labels = opts.args.uniq
-
-  # instead of complaining about nonexistent records, just ignore them
-  selected_records = selected_labels.map do |l|
-    login_records.find { |r| r.label == l }
-  end.compact
-end
+records = session.records :login
+selected_records = if opts.all?
+                     records
+                   else
+                     records.select do |record|
+                       opts.args.include? record.label
+                     end
+                   end
 
 selected_records.each do |record|
   if opts.terse?

data/bin/kbsecret-pass

@@ -20,12 +20,12 @@ opts = KBSecret::CLI.slop do |o|
   o.bool "-c", "--clipboard", "dump the password in the clipboard"
 end
 
-session       = KBSecret::CLI.ensure_session opts[:session]
-label         = opts.args.shift
-login_records = session.records :login
-record        = login_records.find { |r| r.label == label }
+session = KBSecret::CLI.ensure_session opts[:session]
+label   = opts.args.shift
+record  = session[label]
 
-KBSecret::CLI.die "No such login record." unless record
+KBSecret::CLI.die "No such record." unless record
+KBSecret::CLI.die "'#{record}' is not a login record." unless record.type == :login
 
 if opts.clipboard?
   Clipboard.copy record.password

data/bin/kbsecret-raw-edit

@@ -19,7 +19,7 @@ end
 
 session = KBSecret::CLI.ensure_session opts[:session]
 label   = opts.args.shift
-record  = session.records.find { |r| r.label == label }
+record  = session[label]
 
 KBSecret::CLI.die "No such record." unless record
 

data/bin/kbsecret-todo

@@ -24,10 +24,10 @@ command, label = opts.args.shift 2
 
 KBSecret::CLI.die "Missing subcommand." unless command && label
 
-todo_records = session.records :todo
-todo = todo_records.find { |r| r.label == label }
+todo = session[label]
 
-KBSecret::CLI.die("Fatal: No such todo record.") unless todo
+KBSecret::CLI.die "No such record." unless todo
+KBSecret::CLI.die "'#{todo}' is not a todo record." unless todo.type == :todo
 
 case command
 when "start"

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.4.3"
+  VERSION = "0.4.4"
 
   # fail very early if the user doesn't have keybase and KBFS running
   raise Keybase::KeybaseNotRunningError unless Keybase.running?

data/lib/kbsecret/record/abstract.rb

@@ -14,7 +14,7 @@ module KBSecret
       # @return [Integer] the UNIX timestamp marking the record's last modification
       attr_reader :timestamp
 
-      # @return [Symbol] the record's label
+      # @return [String] the record's label
       attr_reader :label
 
       # @return [Symbol] the record's type
@@ -86,12 +86,12 @@ module KBSecret
 
       # Create a brand new record, associated with a session.
       # @param session [Session] the session to associate with
-      # @param label [Symbol] the new record's label
+      # @param label [String, Symbol] the new record's label
       # @note Creation does *not* sync the new record; see {#sync!} for that.
       def initialize(session, label)
         @session   = session
         @timestamp = Time.now.to_i
-        @label     = label
+        @label     = label.to_s
         @type      = self.class.type
         @data      = {}
         @path      = File.join(session.directory, "#{label}.json")
@@ -109,6 +109,12 @@ module KBSecret
         @path      = File.join(session.directory, "#{label}.json")
       end
 
+      # Create a string representation of the current record.
+      # @return [String] the string representation
+      def to_s
+        @label
+      end
+
       # Create a hash-representation of the current record.
       # @return [Hash] the hash-representation
       def to_h

data/lib/kbsecret/session.rb

@@ -28,6 +28,13 @@ module KBSecret
       @records   = load_records!
     end
 
+    # @param label [String, Symbol] the label of the record to fetch
+    # @return [Record::Abstract, nil] the record with the requested label, if extant
+    def [](label)
+      @records.find { |r| r.label == label.to_s }
+    end
+
+    # All records (of a given type) in the session.
     # @param type [String, Symbol] the type of the records to return (or `nil` for all)
     # @return [Array<Record::Abstract>] records associated with the session
     def records(type = nil)
@@ -38,16 +45,16 @@ module KBSecret
       end
     end
 
-    # @return [Array<Symbol>] the labels of all records known to the session
+    # @return [Array<String>] the labels of all records known to the session
     # @example
-    #  session.record_labels # => [:website1, :apikey1, :website2]
+    #  session.record_labels # => ["website1", "apikey1", "website2"]
     def record_labels
       records.map(&:label)
     end
 
     # Add a record to the session.
     # @param type [String, Symbol] the type of record (see {Record.record_types})
-    # @param label [Symbol] the new record's label
+    # @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
@@ -61,27 +68,28 @@ module KBSecret
       arity = klass.instance_method(:initialize).arity - 2
       raise RecordCreationArityError.new(arity, args.size) unless arity == args.size
 
-      record = klass.new(self, label, *args)
+      record = klass.new(self, label.to_s, *args)
       records << record
       record.sync!
     end
 
     # Delete a record from the session, if it exists. Does nothing if
     # no such record can be found.
-    # @param rec_label [Symbol] the label of the record to delete
+    # @param label [String, Symbol] the label of the record to delete
     # @return [void]
-    def delete_record(rec_label)
-      record = records.find { |r| r.label == rec_label }
+    def delete_record(label)
+      record = records.find { |r| r.label == label.to_s }
       return unless record
 
       File.delete(record.path)
       records.delete(record)
     end
 
+    # @param label [String, Symbol] the label to test for
     # @return [Boolean] whether or not the session contains a record with the
     #  given label
     def record?(label)
-      record_labels.include?(label)
+      record_labels.include?(label.to_s)
     end
 
     # Delete the entire session.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kbsecret
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors:
 - William Woodruff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-15 00:00:00.000000000 Z
+date: 2017-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clipboard