hcl 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 852da2430771d5354f8fd2fca9bc55558e2248b7
-  data.tar.gz: 0f21a80c83c9e105829f872c47860e34975120e0
+  metadata.gz: aacea7a83e911178697ab35835691bab2827299a
+  data.tar.gz: b85493c73665fa37297841027ceb12c2ffbe8b90
 SHA512:
-  metadata.gz: 6a411682c2f8c9d049bfe3e13f436c9efd5c2cc3be9892d4ea9a3ed1b58008a60491d4f05530a9878af6a10ce6e9f7cd31b795caffce9727cbca0fddbb062e12
-  data.tar.gz: 7c1e0be48bbe9043a86265cc35d05feb3fb4bcc64b13c56fd4bbdcff9bce1e04c9b564702cfaabcca132ea8e9cad49993edd0a44be5d6b05bd0b720d881ea59a
+  metadata.gz: 40d2a72969d751827efe2cdfeb11e49522787dcc9bc089042bba3470e367c9e1f600599c05da241312be4050b328a67ea862ba43ee4737159d31697bb3f1e729
+  data.tar.gz: 9c9b1c0af9ea5cce5f48032c93584472f288b8ca01402eb4fc0cfd7d1b5884c961c9523bd543a00dc5eeeca78322ae5107e82f75c5bece8f47dfae5ca53b14ca

data/CHANGELOG

@@ -1,5 +1,16 @@
 = Recent Changes in HCl
 
+== v0.4.3
+
+* added cancel command to delete the last running timer, closes #13
+* properly unescape string from Harvest API, closes #24
+* stop command now checks for running timers from yesterday, closes #35
+* added log command to log time/notes without leaving a timer running, closes #30
+
+== v0.4.2
+
+* resume command now accepts an optional task
+
 == v0.4.1
 
 * update dependencies

data/README.markdown

@@ -17,27 +17,18 @@ or you can install from source using jeweler:
     $ gem install jeweler
     $ rake install
 
-### Prerequisites
-
- * Ruby (tested with 1.8.7)
- * Ruby OpenSSL support (in debian/ubuntu: apt-get install libopenssl-ruby)
- * Ruby extension building support (in debian/ubuntu: apt-get install ruby-dev)
- * RubyGems 1.3.3
- * Trollop option-parsing library (gem install trollop)
- * Chronic date-parsing library (gem install chronic)
- * HighLine console input library (gem install highline)
- * Jeweler packaging tool (needed to build the gem)
-
 ## Usage
 
-    hcl (@<task_alias> | <project_id> <task_id>) [+time] [message]
+    hcl [start] (@<task_alias> | <project_id> <task_id>) [+<time>] [<message>]
     hcl note <message>
     hcl stop [message]
     hcl resume [@<task_alias>]
+    hcl log (@<task_alias> | <project_id> <task_id>) [+<time>] [<message>]
     hcl show [date]
     hcl tasks
     hcl alias <task_alias> <project_id> <task_id>
     hcl aliases
+    hcl (cancel | nvm | oops)
 
 ### Available Projects and Tasks
 
@@ -52,8 +43,8 @@ available tasks.
 Since it's not practical to enter two long numbers every time you want to
 identify a task, HCl supports task aliases:
 
-    $ hcl alias xdev 1234 5678
-    $ hcl @xdev Adding a new feature!
+    $ hcl alias tacodev 1234 5678
+    $ hcl @tacodev Adding a new feature
 
 ### Starting a Timer with Initial Time
 
@@ -61,14 +52,14 @@ You can also provide an initial time when starting a new timer.
 This can be expressed in floating-point or HH:MM. The following two
 commands are equivalent:
 
-    $ hcl @xdev +0:15 Adding a new feature!
-    $ hcl +.25 @xdev Adding a new feature!
+    $ hcl @tacodev +0:15 Doing some stuff
+    $ hcl +.25 @tacodev Doing some stuff
 
 ### Adding Notes to a Running Task
 
 While a task is running you can append lines to the task notes:
 
-    $ hcl note Found a good time!
+    $ hcl note Then I did something else
 
 ### Stopping a Timer
 
@@ -76,7 +67,7 @@ The following command will stop a running timer (currently only one timer at
 a time is supported). You can provide a message when stopping a timer as
 well:
 
-    $ hcl stop All done!
+    $ hcl stop All done doing things
 
 ### Resuming a Timer
 
@@ -86,6 +77,25 @@ for that task:
     $ hcl resume
     $ hcl resume @xdev
 
+### Canceling a Timer
+
+If you accidentally started a timer that you didn't mean to, you can cancel
+it:
+
+    $ hcl cancel
+
+This will delete the running timer, or the last-updated timer if one isn't
+running. You can also use `nvm` or `oops` instead of `cancel`.
+
+### Logging without Starting a Timer
+
+You can log time and notes without leaving a timer running. It takes
+the same arguments as start:
+
+    $ hcl log @xdev +1 Worked for an hour.
+
+The above starts and immediately stops a one-hour timer with the given note.
+
 ### Date Formats
 
 Dates can be expressed in a variety of ways. See the [Chronic documentation][cd]
@@ -114,3 +124,5 @@ See LICENSE for copyright details.
 [bricooke]: http://github.com/bricooke
 [scharfie]: http://github.com/scharfie
 
+
+

data/VERSION

@@ -1 +1 @@
-0.4.2
+0.4.3

data/hcl.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "hcl"
-  s.version = "0.4.2"
+  s.version = "0.4.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Zack Hobson"]

data/lib/hcl/app.rb

@@ -31,7 +31,7 @@ class Net::HTTP
 end
 
 module HCl
-  VERSION = "0.4.2"
+  VERSION = "0.4.3"
 
   class App
     include HCl::Utility
@@ -103,31 +103,34 @@ Commands:
     # show all available tasks
     hcl tasks
 
-    # set a task alias
-    hcl alias <task> <project_id> <task_id>
+    # create a task alias
+    hcl alias <task_alias> <project_id> <task_id>
 
     # list task aliases
     hcl aliases
 
     # start a task using an alias
-    hcl @<task> [+time] [message]
+    hcl [start] @<task_alias> [+<time>] [<message>]
 
-    # display the daily timesheet
-    hcl show [date]
+    # add a line to your running timer
+    hcl note <message>
 
     # stop a running timer
-    hcl stop [message]
+    hcl stop [<message>]
 
-    # resume the last stopped timer
-    hcl resume
+    # resume the last stopped timer or a specific task
+    hcl resume [@<task_alias>]
 
-    # add a line to your running timer
-    hcl note <message>
+    # delete the current or last running timer
+    hcl (cancel | oops | nvm)
+
+    # display the daily timesheet
+    hcl [show [<date>]]
 
 Examples:
     hcl alias mytask 1234 4567
     hcl @mytask +:15 Doing a thing that I started 15 minutes ago.
-    hcl Adding a note to my running task.
+    hcl note Adding a note to my running task.
     hcl stop That's enough for now.
     hcl resume
     hcl show yesterday

data/lib/hcl/commands.rb

@@ -24,6 +24,23 @@ module HCl
       nil
     end
 
+    def cancel
+      entry = DayEntry.with_timer || DayEntry.last
+      if entry
+        if entry.cancel
+          puts "Deleted entry #{entry}."
+        else
+          puts "Failed to delete #{entry}!"
+          exit 1
+        end
+      else
+        puts 'Nothing to cancel.'
+        exit 1
+      end
+    end
+    alias_method :oops, :cancel
+    alias_method :nvm, :cancel
+
     def unset key
       @settings.delete key
       write_settings
@@ -62,8 +79,13 @@ module HCl
       puts "Started timer for #{timer} (at #{current_time})"
     end
 
+    def log *args
+      start *args
+      stop
+    end
+
     def stop *args
-      entry = DayEntry.with_timer
+      entry = DayEntry.with_timer || DayEntry.with_timer(DateTime.yesterday)
       if entry
         entry.append_note(args.join(' ')) if args.any?
         entry.toggle

data/lib/hcl/day_entry.rb

@@ -23,6 +23,15 @@ module HCl
       end
     end
 
+    def cancel
+      begin
+        DayEntry.delete("daily/delete/#{id}")
+      rescue TimesheetResource::Failure
+        return false
+      end
+      true
+    end
+
     def notes
       super || @data[:notes] = ''
     end
@@ -36,8 +45,8 @@ module HCl
         %{<request><notes>#{notes}</notes><hours>#{hours}</hours></request>}
     end
 
-    def self.with_timer
-      all.detect {|t| t.running? }
+    def self.with_timer date=nil
+      all(date).detect {|t| t.running? }
     end
 
     def self.last_by_task project_id, task_id

data/lib/hcl/timesheet_resource.rb

@@ -37,6 +37,10 @@ module HCl
       http_do Net::HTTP::Post, action, data
     end
 
+    def self.delete action
+      http_do Net::HTTP::Delete, action
+    end
+
     def self.http_do method_class, action, data = nil
       https   = Net::HTTP.new "#{subdomain}.harvestapp.com", (ssl ? 443 : 80)
       request = method_class.new "/#{action}"
@@ -68,7 +72,7 @@ module HCl
 
     def self.xml_to_hash elem
       elem.elements.map { |e| e.name }.inject({}) do |a, f|
-        a[f.to_sym] = elem.elements[f].text if elem.elements[f]
+        a[f.to_sym] = CGI.unescape_html(elem.elements[f].text || '') if elem.elements[f]
         a
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hcl
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Zack Hobson