kbsecret 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fbc13cb4e4be9699119df9e1a40229636c033c24
-  data.tar.gz: bfd30dd12815a1ef6b5e7ad7ced9b0a94e9523da
+  metadata.gz: a5b1955e05178ea6bd3da7538fc4d756de0bcef4
+  data.tar.gz: f33e38c1524dc6c3a7d8b5524e1e4640c5911402
 SHA512:
-  metadata.gz: 75b37e82e7b7f798a149b458d94575bce3c2708dcede2ede334d75d11fe251a517ab35a619f352a0bb3c1b0b81265e7319e8e7a6739beb21253bf42accbb5066
-  data.tar.gz: 87526553d6e2b39798df1923e775c54d6e7860610bd342153f9dab3b8eabbdd38194fe91cb1bbc880dad65160d037ed09a11223a985b8d12131ef7865460168c
+  metadata.gz: 95d789fa03e62389714673915f277876d4ae795f5d079920577d8ca87145a79c4fa40fec86dbebd6105e4da423e33f658bb696f2129ec61b8db983e483d67c04
+  data.tar.gz: 895de053efda4a7a314f9f3cbb2a4b64804175387aef51839e3606f9debb635802b50b336b2d45726b6f3babfd7567dfb2be2a6c4c284cd1de7e3164101e0e2f

data/README.md

@@ -89,3 +89,4 @@ Please feel free to contribute completion scripts for other shells!
 ### TODO
 
 * zsh/fish completions
+* a TODO record type?

data/bin/kbsecret-pass

@@ -41,12 +41,10 @@ label = opts.args.shift
 login_records = session.records.select { |r| r.type == "login" }
 record = login_records.find { |r| r.label == label }
 
-if record
-  if opts.clipboard?
-    Clipboard.copy record.password
-  else
-    puts record.password
-  end
+abort("Fatal: No such login record.") unless record
+
+if opts.clipboard?
+  Clipboard.copy record.password
 else
-  abort "Fatal: No such record."
+  puts record.password
 end

data/bin/kbsecret-raw-edit

@@ -42,7 +42,7 @@ label = opts.args.shift
 record = session.records.find { |r| r.label == label}
 
 if record
-  `#{ENV["EDITOR"]} #{record.path}`
+  Process.spawn("#{ENV["EDITOR"]} #{record.path}")
 else
   abort "Fatal: No such record."
 end

data/bin/kbsecret-todo

@@ -0,0 +1,65 @@
+#!/usr/bin/env ruby
+
+require "kbsecret"
+require "slop"
+
+opts = Slop.parse suppress_errors: true do |o|
+  o.banner = <<~EOS
+    Manage 'to do' records.
+
+    Usage:
+      kbsecret todo <start|suspend|complete> <label>
+
+    Examples:
+      kbsecret todo start unit-tests
+      kbsecret todo suspend laundry
+      kbsecret todo complete shopping
+  EOS
+
+  o.string "-s", "--session", "the session name", default: :default
+
+  o.on "-h", "--help" do
+    puts o
+    exit
+  end
+
+  o.on "--introspect-flags" do
+    subcmds = ["start", "suspend", "complete"]
+    comp = o.options.flat_map { |o| o.flags } + subcmds
+    puts comp.join "\n"
+    exit
+  end
+end
+
+sess_name = opts[:session]
+
+unless KBSecret::Config.session? sess_name
+  abort "Fatal: Unknown session: '#{sess_name}'."
+end
+
+session = KBSecret::Session.new label: sess_name
+command, label = opts.args.shift 2
+
+abort("Fatal: Missing subcommand.") unless command && label
+
+todo_records = session.records.select { |r| r.type == "todo" }
+todo = todo_records.find { |r| r.label == label }
+
+abort("Fatal: No such todo record.") unless todo
+
+case command
+when "start"
+  abort("That task is already started!") if todo.started?
+  todo.start!
+  puts "#{todo.label}: '#{todo.todo}' marked as started at #{todo.start}"
+when "suspend"
+  abort("That task is already suspended!") if todo.suspended?
+  todo.suspend!
+  puts "#{todo.label}: '#{todo.todo}' marked as suspended at #{todo.stop}"
+when "complete"
+  abort("That task is already completed!") if todo.completed?
+  todo.complete!
+  puts "#{todo.label}: '#{todo.todo}' marked as completed at #{todo.stop}"
+else
+  abort("Fatal: Unknown action: #{command}.")
+end

data/lib/kbsecret/record/todo.rb

@@ -0,0 +1,82 @@
+module KBSecret
+  module Record
+    # Represents a record containing a 'to do' item and its status.
+    #
+    # Apart from the text of the item itself, each record contains three
+    # relevant fields: the item's status, a start time, and a stop time.
+    #
+    # The status is one of `"started"`, `"suspended"`, or `"complete"`, each
+    # of which should be self-explanatory.
+    #
+    # The start time is the date and time at which the item was started via
+    # {#start!}.
+    #
+    # The stop top is the date and time at which the item was *either*
+    # last suspended via {#suspend!} *or* finished via {#complete!}.
+    class ToDo < Abstract
+      data_field :todo
+      data_field :status
+      data_field :start
+      data_field :stop
+
+      # @param session [Session] the session to associate with
+      # @param label [Symbol] the new record's label
+      # @param todo [String] the to do item
+      def initialize(session, label, todo)
+        super(session, label)
+
+        @data = {
+          todo: {
+            todo: todo,
+            status: "suspended",
+            start: nil,
+            stop: nil,
+          },
+        }
+      end
+
+      # @return [Boolean] whether or not the item is marked as started
+      def started?
+        status == "started"
+      end
+
+      # @return [Boolean] whether or not the item is marked as suspended
+      def suspended?
+        status == "suspended"
+      end
+
+      # @return [Boolean] whether or not the item is marked as completed
+      def completed?
+        !(started? || suspended?)
+      end
+
+      # Start the to do item.
+      # @return [void]
+      # @note Does nothing if the item is already started.
+      def start!
+        return if started?
+
+        self.status = "started"
+        self.start = Time.now.to_s
+      end
+
+      # Suspend the to do item.
+      # @return [void]
+      # @note Does nothing if the item is already suspended.
+      def suspend!
+        return if suspended?
+        self.status = "suspended"
+        self.stop = Time.now.to_s
+      end
+
+      # Complete the to do item.
+      # @return [void]
+      # @note Does nothing if the item is already completed.
+      def complete!
+        return if completed?
+        self.status = "complete"
+        self.stop = Time.now.to_s
+      end
+    end
+  end
+end

data/lib/kbsecret/record.rb

@@ -40,7 +40,7 @@ module KBSecret
     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.load!(session, hsh)
+      klass.load!(session, hsh) if klass
     end
   end
 end

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.10".freeze
+  VERSION = "0.0.11".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.10
+  version: 0.0.11
 platform: ruby
 authors:
 - William Woodruff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-12 00:00:00.000000000 Z
+date: 2017-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: keybase-unofficial
@@ -74,6 +74,7 @@ executables:
 - kbsecret-rm
 - kbsecret-login
 - kbsecret-raw-edit
+- kbsecret-todo
 - kbsecret-new
 - kbsecret-env
 - kbsecret-new-session
@@ -95,6 +96,7 @@ files:
 - bin/kbsecret-raw-edit
 - bin/kbsecret-rm
 - bin/kbsecret-sessions
+- bin/kbsecret-todo
 - lib/kbsecret.rb
 - lib/kbsecret/config.rb
 - lib/kbsecret/exceptions.rb
@@ -103,6 +105,7 @@ files:
 - lib/kbsecret/record/environment.rb
 - lib/kbsecret/record/login.rb
 - lib/kbsecret/record/snippet.rb
+- lib/kbsecret/record/todo.rb
 - lib/kbsecret/record/unstructured.rb
 - lib/kbsecret/session.rb
 homepage: https://github.com/woodruffw/kbsecret