kbsecret 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6dc4f0b34abfe1a2039f9b657525efc5e5d678b
-  data.tar.gz: ec05f73bc4d7da3d6dfba1fe3add2fd58db90bc8
+  metadata.gz: 3f807d04b3f3365845cb00d88dc4c117815f8338
+  data.tar.gz: d5aa5f00590f7660391758f9408eb567b8ff9258
 SHA512:
-  metadata.gz: 1807d92771a23c68cbc9a1568d4e64d6798bd8390c5c9e624b78b39a576428e81dcd8292ae89039f7d5d026e744873f024e1dd84fc56328832220a301cb6aef3
-  data.tar.gz: c7898dab3eec671c45a6817c8ad9404cd7e5281d1ea0389a29c7dcf306125b8a3fa6a5846ca269db1aaf72332d45ae427887a0792007c02933e98190484834cb
+  metadata.gz: ffb8f5e6d8658c48911ee49b7f2f9cc4127bbb3c92aea221a9b06b9727d15bde4f283170def0f9f9337b40186baa970434b89994ea6050aeace0f31f7c45cd10
+  data.tar.gz: 3a0656fc05c14ae990ceea61619476edf8c67ceb7b21f88e4b092e7894466f69600926f62620f2e1b786832d73c31b239c48f5fc959c3a31d08e97cdd362d84a

data/bin/kbsecret-env

@@ -38,7 +38,7 @@ end
 
 session = KBSecret::Session.new label: sess_name
 
-env_records = session.records.select { |r| r.type == "environment" }
+env_records = session.records :environment
 
 if opts.all?
   selected_records = env_records

data/bin/kbsecret-list

@@ -12,7 +12,7 @@ opts = Slop.parse suppress_errors: true do |o|
   EOS
 
   o.string "-s", "--session", "the session name", default: :default
-  o.string "-t", "--type", "the type of secrets to list", default: :all
+  o.string "-t", "--type", "the type of secrets to list", default: nil
   o.bool "-a", "--show-all", "show everything in each secret (i.e. metadata)"
 
   o.on "-h", "--help" do
@@ -34,11 +34,7 @@ end
 
 session = KBSecret::Session.new label: sess_name
 
-if opts[:type] != :all
-  records = session.records.select { |r| r.type == opts[:type] }
-else
-  records = session.records
-end
+records = session.records opts[:type]
 
 records.each do |record|
   line = "#{record.label}\n"

data/bin/kbsecret-login

@@ -37,7 +37,7 @@ end
 
 session = KBSecret::Session.new label: sess_name
 
-login_records = session.records.select { |r| r.type == "login" }
+login_records = session.records :login
 
 if opts.all?
   selected_records = login_records

data/bin/kbsecret-pass

@@ -38,7 +38,7 @@ end
 
 session = KBSecret::Session.new label: sess_name
 label = opts.args.shift
-login_records = session.records.select { |r| r.type == "login" }
+login_records = session.records :login
 record = login_records.find { |r| r.label == label }
 
 abort("Fatal: No such login record.") unless record

data/bin/kbsecret-todo

@@ -42,7 +42,7 @@ command, label = opts.args.shift 2
 
 abort("Fatal: Missing subcommand.") unless command && label
 
-todo_records = session.records.select { |r| r.type == "todo" }
+todo_records = session.records :todo
 todo = todo_records.find { |r| r.label == label }
 
 abort("Fatal: No such todo record.") unless todo

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

data/lib/kbsecret/record.rb

@@ -15,21 +15,21 @@ module KBSecret
       klasses
     end
 
-    # @return [Array<String>] the types of all records
+    # @return [Array<Symbol>] the types of all records
     def self.record_types
       record_classes.map(&:type)
     end
 
-    # @param type [String] the record type
+    # @param type [String, Symbol] 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 }
+      record_classes.find { |c| c.type == type.to_sym }
     end
 
-    # @param type [String] the record type
+    # @param type [String, Symbol] the record type
     # @return [Boolean] whether a record class exists of the given type
     def self.type?(type)
-      record_types.include?(type)
+      record_types.include?(type.to_sym)
     end
 
     # Load a record by path into the given session.
@@ -39,7 +39,7 @@ module KBSecret
     # @api private
     def self.load_record!(session, path)
       hsh = JSON.parse(File.read(path), symbolize_names: true)
-      klass = record_classes.find { |c| c.type == hsh[:type] }
+      klass = record_classes.find { |c| c.type == hsh[:type].to_sym }
       klass.load!(session, hsh) if klass
     end
   end

data/lib/kbsecret/record/abstract.rb

@@ -38,11 +38,11 @@ module KBSecret
           @fields
         end
 
-        # @return [String] the record's type
+        # @return [Symbol] the record's type
         # @example
-        #  KBSecret::Record::Abstract.type # => "abstract"
+        #  KBSecret::Record::Abstract.type # => :abstract
         def type
-          name.split("::").last.downcase
+          name.split("::").last.downcase.to_sym
         end
 
         # Load the given hash-representation into a record.
@@ -78,7 +78,7 @@ module KBSecret
       def initialize_from_hash(hsh)
         @timestamp = hsh[:timestamp]
         @label = hsh[:label]
-        @type = hsh[:type]
+        @type = hsh[:type].to_sym
         @data = hsh[:data]
       end
 

data/lib/kbsecret/session.rb

@@ -8,8 +8,9 @@ module KBSecret
     # @return [Hash] the session-specific configuration, from
     #  {Config::CONFIG_FILE}
     attr_reader :config
+
+    # @return [String] the fully-qualified path of the session
     attr_reader :directory
-    attr_reader :records
 
     # @param label [Symbol] the label of the session to initialize
     # @note This does not *create* a new session, but loads one already
@@ -23,6 +24,16 @@ module KBSecret
       @records = load_records!
     end
 
+    # @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)
+      if type
+        @records.select { |r| r.type == type.to_sym }
+      else
+        @records
+      end
+    end
+
     # @return [Array<Symbol>] the labels of all records known to the session
     # @example
     #  session.record_labels # => [:website1, :apikey1, :website2]
@@ -31,14 +42,14 @@ module KBSecret
     end
 
     # Add a record to the session.
-    # @param type [String] the type of record (see {Record.record_types})
+    # @param type [String, Symbol] the type of record (see {Record.record_types})
     # @param label [Symbol] the new record's label
     # @param args [Array<String>] the record-type specific arguments
     # @return [void]
     # @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.record_classes.find { |k| k.type == type }
+      klass = Record.record_classes.find { |k| k.type == type.to_sym }
       arity = klass.instance_method(:initialize).arity - 2
 
       unless arity == args.size

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kbsecret
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - William Woodruff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-17 00:00:00.000000000 Z
+date: 2017-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: keybase-unofficial
@@ -130,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: kbsecret - A KBFS (Keybase) backed secret manager.