hcl 0.4.11 → 0.4.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2047a5b263411f1820b884a7360d462ce6eef539
-  data.tar.gz: df5dbbc4949e6b0da4e3909213d5d1da07a0c695
+  metadata.gz: 45c0652b8ee6e90814a451dc2287a45422998828
+  data.tar.gz: 73b419a165dc6e8c2d1b75a8a7bd31eb639bec8d
 SHA512:
-  metadata.gz: cf3b6fdd119d9120c3bcbc109c09aedb2e618bc7582d029279e5eab435e3c85a5a1d79314fe8d042552ac39ff01b74a6bc24fce86874ea7226eff0ed2de6bb0f
-  data.tar.gz: b50718f5a77b2e18f592ce3b63b9cfa3d9c7c080a67c7f5c2814baa40b7c6310afab635d376fad128541c748e67fb13fee17b353b62648bdc9551f889d2f0a81
+  metadata.gz: 5b505221e5543a832b272b175223cc5b22ca94aa60be13e0e44b60714efa3aed4ad326d7cbdb15a302de86899f296114d10e95793d347dff8e0362aa2908804b
+  data.tar.gz: d1f59e6eb45c915a2f2f9ed9d2d0fe666ad9472fe9c4f61c478bd990ad259e922a7c588314fb23191a651ce943c33c1c27cd332854ff0063b7e8f959d7356cb5

data/{CHANGELOG → CHANGELOG.markdown}

@@ -1,73 +1,82 @@
-= Recent Changes in HCl
+# Recent Changes in HCl
 
-== v0.4.11 2014-01-25
+## v0.4.12 2014-02-04
+
+* fixed crash when caching tasks for the first time, closes #56
+* fixed crash when stopping a timer the next day
+* added --changelog option
+* remove completion command, cache aliases in a file instead, closes #51
+* confirm timer deletion/cancellation, closes #47
+* added `status` command to query Harvest service status
+
+## v0.4.11 2014-01-25
 
 * more detailed gem dependencies, prevents unexpected failures
 * added a UNIX manual page for hcl(1)
 
-== v0.4.10 2014-01-06
+## v0.4.10 2014-01-06
 
 * added `config` command to display current credentials
 * added `console` command for exploring the Harvest API
 
-== v0.4.9 2013-12-21
+## v0.4.9 2013-12-21
 
 * MacOS X: store password in default keychain
 * abort log command when a timer is running
 
-== v0.4.8 2013-11-30
+## v0.4.8 2013-11-30
 
 * more fixes for 1.9.3
 
-== v0.4.7 2013-11-30
+## v0.4.7 2013-11-30
 
 * added --reauth option to refresh credentials
 * added support for retrying on API throttle
 * note command without args now displays all notes for a running timer
 * fixed a crash on ruby 1.9.3
 
-== v0.4.6 2013-11-21
+## v0.4.6 2013-11-21
 
 * automatically request credentials on auth-failure
 * fix user-entered credentials
 
-== v0.4.5 2013-11-21
+## v0.4.5 2013-11-21
 
 * allow filtering of tasks by project code
 * eliminate shoulda from development dependencies
 
-== v0.4.4 2013-11-20
+## v0.4.4 2013-11-20
 
 * added completion command to output a Bash auto-complete script, closes #34
 * removed jeweler dependency
 
-== v0.4.3 2013-11-19
+## v0.4.3 2013-11-19
 
 * 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 2013-11-19
+## v0.4.2 2013-11-19
 
 * resume command now accepts an optional task
 
-== v0.4.1 2013-11-18
+## v0.4.1 2013-11-18
 
 * update dependencies
 
-== v0.4.0 2013-11-18
+## v0.4.0 2013-11-18
 
 * start a timer or add a note without having to specify the sub-command
 * aliases can be specified with "@" anywhere on the command line
 * added alias and unalias to simplify setting task aliases
 
-== v0.3.2 2011-12-30
+## v0.3.2 2011-12-30
 
 * fixed support for modern Rubies
 * it's now possible to provide a message with the stop command
 
-== v0.3.1 2011-07-13
+## v0.3.1 2011-07-13
 
 * use STDERR instead of STDOUT for error reporting
 * sort tasks before viewing tasks (brian@madebyrocket.com)
@@ -75,46 +84,46 @@
 * show current time when on 'start', 'stop', and 'show' commands (scharfie@gmail.com)
 * include client name in tasks list (scharfie@gmail.com)
 
-== v0.3.0 2010-04-02
+## v0.3.0 2010-04-02
 
 * added support for free accounts
 
-== v0.2.3 2009-08-23
+## v0.2.3 2009-08-23
 
 * Allow decimal time offset without a dot, closes #29.
 * Reverted and re-fixed: Adding note fails when task is started without notes, #26.
 * Reinstate the --version option
 
-== v0.2.2 2009-08-09
+## v0.2.2 2009-08-09
 
 * Support installation via rip, closes #27.
 * Fixed: Adding note fails when task is started without notes, closes #26.
 * Avoid stack trace on missing XML root node, closes #25.
 
-== v0.2.1 2009-07-30
+## v0.2.1 2009-07-30
 
 * Fixed: Creating timers without starting them.
 
-== v0.2.0 2009-07-30
+## v0.2.0 2009-07-30
 
 * Allow an initial time to be specified when starting a timer, closes #9.
 * Always display hours as HH:MM, closes #22.
 * Do not write empty task cache, closes #23.
 
-== v0.1.3 2009-07-28
+## v0.1.3 2009-07-28
 
 * Add a note about ruby-dev for debian/ubuntu users, closes #20.
 * Friendlier error message on unrecognized task, closes #18, #21.
 
-== v0.1.2 2009-07-27
+## v0.1.2 2009-07-27
 
 * Automatically include rubygems in bin/hcl.
 
-== v0.1.1 2009-07-24
+## v0.1.1 2009-07-24
 
 * Mention gem in README, read version from file.
     
-== v0.1.0 2009-07-24
+## v0.1.0 2009-07-24
 
 * Initial public release
 

data/README.markdown

@@ -11,7 +11,7 @@ HCl is a command-line tool for interacting with Harvest time sheets using the
 [htt]: http://www.getharvest.com/api/time_tracking
 [rdoc]: http://rdoc.info/github/zenhob/hcl/file/README.markdown
 
-## Quick Start
+## GETTING STARTED
 
 You can install hcl directly from rubygems.org:
 
@@ -21,7 +21,7 @@ or you can install from source:
 
     rake install
 
-## Usage
+## SYNOPSIS
 
     hcl [start] @<task_alias> [+<time>] [<message>]
     hcl note <message>
@@ -31,9 +31,13 @@ or you can install from source:
     hcl show [<date>]
     hcl tasks [<project_code>]
     hcl alias <task_alias> <project_id> <task_id>
+    hcl unalias <task_alias>
     hcl aliases
     hcl (cancel | nvm | oops)
     hcl config
+    hcl status
+
+## DESCRIPTION
 
 ### Available Projects and Tasks
 
@@ -115,9 +119,12 @@ The above starts and immediately stops a one-hour timer with the given note.
 ### Bash Auto-completion of Task Aliases
 
 You can enable auto-completion of task aliases by adding this to your shell
-configuration:
+configuration (note the backticks inside the double quotes):
+
+    complete -W "`cat ~/.hcl/aliases`" hcl
 
-    eval `hcl completion`
+Warning: You will need to have run `hcl` at least once to create the aliases
+file. Without it, this command will fail with an error.
 
 ### Configuration Profiles
 
@@ -131,7 +138,7 @@ Here is a shell alias `myhcl` with a separate configuration from the
 main `hcl` command, and another command to configure alias completion:
 
     alias myhcl="env HCL_DIR=~/.myhcl hcl"
-    eval `myhcl completion myhcl`
+    complete -W "`cat ~/.myhcl/aliases`" myhcl
 
 Adding something like the above to your bashrc will enable a new command,
 `myhcl`. When using `myhcl` you can use different credentials and aliases,
@@ -171,7 +178,15 @@ commands show the time sheet for the specified day:
 
 [cd]: http://chronic.rubyforge.org/
 
-## Author
+### Harvest service status
+
+Harvest provides a [status API], which you can query using the
+`hcl status` command. This will tell you whether Harvest itself is up and the
+current response time, along with a timestamp of when it was last tested.
+
+[status API]: http://harveststatus.com/status_api
+
+## AUTHOR
 
 HCl was designed and implemented by [Zack Hobson][zgh].
 

data/Rakefile

@@ -1,3 +1,6 @@
+require 'rubygems/tasks'
+Gem::Tasks.new
+
 require 'fileutils'
 task :clean do
   FileUtils.rm_rf %w[ pkg coverage doc man/hcl.1 ]
@@ -10,15 +13,27 @@ Rake::TestTask.new do |t|
 end
 task :default => :test
 
+# process the README into a manual page using ronn
+require 'ronn'
 task :man do
-  system 'ronn -r man/hcl.1.ronn'
+  print "Writing manual page..."
+  head, content = File.read('README.markdown').split("## SYNOPSIS\n")
+  content.prepend <<-END
+hcl(1) -- Track time with Harvest time sheets
+=============================================
+
+## SYNOPSIS
+  END
+  FileUtils.mkdir_p('man')
+  File.write('man/hcl.1.ronn', content)
+  File.open('man/hcl.1','w').tap do |man|
+    man.write Ronn::Document.new('man/hcl.1.ronn').to_roff
+  end
+  puts "done."
 end
-task 'build:gem' => [:man]
+task "pkg/hcl-#{HCl::VERSION}.gem" => :man
 
 require 'yard'
 YARD::Rake::YardocTask.new
 task :doc => [:yard, :man]
 
-require 'rubygems/tasks'
-Gem::Tasks.new
-

data/lib/hcl/app.rb

@@ -11,6 +11,7 @@ module HCl
 
     HCL_DIR = (ENV['HCL_DIR'] || "#{ENV['HOME']}/.hcl").freeze
     SETTINGS_FILE = "#{HCL_DIR}/settings.yml".freeze
+    ALIAS_LIST = "#{HCL_DIR}/aliases".freeze
     CONFIG_FILE = "#{HCL_DIR}/config.yml".freeze
 
     attr_reader :http
@@ -38,6 +39,10 @@ module HCl
     # Start the application.
     def run
       request_config if @options[:reauth]
+      if @options[:changelog]
+        system %[ more "#{File.join(File.dirname(__FILE__), '../../CHANGELOG.markdown')}" ]
+        exit
+      end
       begin
         if @command
           if command? @command
@@ -92,6 +97,9 @@ Commands:
     # create a task alias
     hcl alias <task_alias> <project_id> <task_id>
 
+    # remove a task alias
+    hcl unalias <task_alias>
+
     # list task aliases
     hcl aliases
 
@@ -116,6 +124,12 @@ Commands:
     # display the daily timesheet
     hcl [show [<date>]]
 
+    # show your current credentials
+    hcl config
+
+    # display Harvest service status
+    hcl status
+
 Examples:
     hcl alias mytask 1234 4567
     hcl @mytask +:15 Doing a thing that I started 15 minutes ago.
@@ -128,6 +142,7 @@ Examples:
 Options:
 EOM
         opt :reauth, "Force refresh of auth details"
+        opt :changelog, "Review the HCl changelog"
       end
       @command = args.shift
       @args = args
@@ -172,16 +187,24 @@ EOM
 
     def read_settings
       if File.exists? SETTINGS_FILE
-        @settings = YAML.load(File.read(SETTINGS_FILE))
+        @settings = YAML.load(File.read(SETTINGS_FILE)) || {}
       else
         @settings = {}
       end
+      cache_aliases
+    end
+
+    def cache_aliases
+      File.open(ALIAS_LIST, 'w') do |f|
+        f.write aliases.join(' ')
+      end
     end
 
     def write_settings
       File.open(SETTINGS_FILE, 'w') do |f|
        f.write @settings.to_yaml
       end
+      cache_aliases
       nil
     end
 

data/lib/hcl/commands.rb

@@ -10,6 +10,16 @@ module HCl
       http.config_hash.merge(password:'***').map {|k,v| "#{k}: #{v}" }.join("\n")
     end
 
+    # Show the network status of the Harvest service.
+    def status
+      result = Faraday.new("http://harveststatus.com/") do |f|
+        f.use :harvest, '', ''
+        f.adapter Faraday.default_adapter
+      end.get('status.json').body
+      date = Time.at(result[:last_check_time].to_i)
+      "Harvest is #{result[:status]}, response time: #{result[:last_response_time]}ms. [#{date}]"
+    end
+
     def console
       Console.new(self)
       nil
@@ -18,7 +28,7 @@ module HCl
     def tasks project_code=nil
       tasks = Task.all
       if tasks.empty? # cache tasks
-        DayEntry.today
+        DayEntry.today(http)
         tasks = Task.all
       end
       tasks.select! {|t| t.project.code == project_code } if project_code
@@ -45,6 +55,9 @@ module HCl
     def cancel
       entry = DayEntry.with_timer(http) || DayEntry.last(http)
       if entry
+        confirmed = /^y/.match(ask("#{entry}\nDelete this entry? (y/n): ").downcase)
+        return unless confirmed
+
         if entry.cancel http
           "Deleted entry #{entry}."
         else
@@ -79,6 +92,9 @@ module HCl
 
     def completion command=nil
       command ||= $PROGRAM_NAME.split('/').last
+      $stderr.puts \
+        "The hcl completion command is deprecated (and slow!), instead use something like:",
+        "> complete -W "`cat #{HCl::App::ALIAS_LIST}`" #{command}"
       %[complete -W "#{aliases.join ' '}" #{command}]
     end
 
@@ -105,7 +121,7 @@ module HCl
     end
 
     def stop *args
-      entry = DayEntry.with_timer(http) || DayEntry.with_timer(http, DateTime.yesterday)
+      entry = DayEntry.with_timer(http) || DayEntry.with_timer(http, Date.today - 1)
       if entry
         entry.append_note(http, args.join(' ')) if args.any?
         entry.toggle http

data/lib/hcl/version.rb

@@ -1,3 +1,3 @@
 module HCl
-  VERSION = '0.4.11'
+  VERSION = '0.4.12'
 end

data/man/hcl.1

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "HCL" "1" "January 2014" "" ""
+.TH "HCL" "1" "February 2014" "" ""
 .
 .SH "NAME"
 \fBhcl\fR \- Track time with Harvest time sheets
@@ -18,14 +18,15 @@ hcl log @<task_alias> [+<time>] [<message>]
 hcl show [<date>]
 hcl tasks [<project_code>]
 hcl alias <task_alias> <project_id> <task_id>
+hcl unalias <task_alias>
 hcl aliases
 hcl (cancel | nvm | oops)
 hcl config
+hcl status
 .
 .fi
 .
 .SH "DESCRIPTION"
-HCl is a command\-line tool for interacting with Harvest time sheets using the Harvest time tracking API\.
 .
 .SS "Available Projects and Tasks"
 To start a new timer you need to identify the project and task\. The tasks command displays a list of available tasks with their project and task IDs\.
@@ -156,21 +157,24 @@ hcl log @xdev +1 Worked for an hour\.
 .P
 The above starts and immediately stops a one\-hour timer with the given note\.
 .
-.SH "ADVANCED USAGE"
+.SH "Advanced Usage"
 .
 .SS "Bash Auto\-completion of Task Aliases"
-You can enable auto\-completion of task aliases by adding this to your shell configuration:
+You can enable auto\-completion of task aliases by adding this to your shell configuration (note the backticks inside the double quotes):
 .
 .IP "" 4
 .
 .nf
 
-eval `hcl completion`
+complete \-W "`cat ~/\.hcl/aliases`" hcl
 .
 .fi
 .
 .IP "" 0
 .
+.P
+Warning: You will need to have run \fBhcl\fR at least once to create the aliases file\. Without it, this command will fail with an error\.
+.
 .SS "Configuration Profiles"
 You can modify your credentials with the \fB\-\-reauth\fR option, and review them with \fBhcl config\fR\. If you\'d rather store multiple configurations at once, specify an alternate configuration directory in the environment as \fBHCL_DIR\fR\. This can be used to interact with multiple harvest accounts at once\.
 .
@@ -182,7 +186,7 @@ Here is a shell alias \fBmyhcl\fR with a separate configuration from the main \f
 .nf
 
 alias myhcl="env HCL_DIR=~/\.myhcl hcl"
-eval `myhcl completion myhcl`
+complete \-W "`cat ~/\.myhcl/aliases`" myhcl
 .
 .fi
 .
@@ -230,17 +234,22 @@ hcl show 1 week ago
 .
 .IP "" 0
 .
+.SS "Harvest service status"
+Harvest provides a status API \fIhttp://harveststatus\.com/status_api\fR, which you can query using the \fBhcl status\fR command\. This will tell you whether Harvest itself is up and the current response time, along with a timestamp of when it was last tested\.
+.
 .SH "AUTHOR"
-HCl was designed and implemented by Zack Hobson\.
+HCl was designed and implemented by Zack Hobson \fIhttp://github\.com/zenhob\fR\.
 .
 .IP "\(bu" 4
-Non\-SSL support by Michael Bleigh\.
+Non\-SSL support by Michael Bleigh \fIhttp://github\.com/mbleigh\fR\.
 .
 .IP "\(bu" 4
-Resume command by Brian Cooke\.
+Resume command by Brian Cooke \fIhttp://github\.com/bricooke\fR\.
 .
 .IP "\(bu" 4
-UI improvements by Chris Scharf\.
+UI improvements by Chris Scharf \fIhttp://github\.com/scharfie\fR\.
 .
 .IP "" 0
-
+.
+.P
+See LICENSE for copyright details\.

data/test/command_test.rb

@@ -25,13 +25,13 @@ class CommandTest < HCl::TestCase
   end
 
   def test_tasks
-    HCl::Task.expects(:all).returns([HCl::Task.new(
-      id:123,
-      name: 'Dev',
-      project: HCl::Project.new(id:456, name:'App', client:'Bob', code:'b')
-    )])
+    FileUtils.rm_rf ENV['HCL_DIR']+"/cache"
+    register_uri(:get, '/daily', {:day_entries=>[], :projects=> [{
+      :name=>"Harvest Command Line", :code=>"hcl", :id=>"123", :client=>"zenhob",
+      :tasks=> [{:name=>"Development", :id=>"456"} ]
+    }]})
     result = tasks
-    assert_equal "456 123\tBob - [b] App - Dev", result
+    assert_equal "123 456\tzenhob - [hcl] Harvest Command Line - Development", result
   end
 
   def test_show
@@ -81,6 +81,16 @@ class CommandTest < HCl::TestCase
     stop 'all done'
   end
 
+  def test_stop_yesterday
+    entry = stub
+    yesterday = (DateTime.now - 1).strftime("%3j")
+    register_uri(:get, '/daily', {day_entries:[]})
+    register_uri(:get, "/daily/#{yesterday}/2014", {day_entries:[{id:321,notes:'',hours:1,client:nil,project:nil,timer_started_at:DateTime.now}]})
+    register_uri(:post, '/daily/update/321', {day_entry:{notes:'all done next day'}})
+    register_uri(:get, '/daily/timer/321')
+    stop 'all done next day'
+  end
+
   def test_resume
     entry = stub
     HCl::DayEntry.expects(:last).returns(entry)
@@ -100,6 +110,14 @@ class CommandTest < HCl::TestCase
     entry = stub
     HCl::DayEntry.expects(:with_timer).with(http).returns(entry)
     entry.expects(:cancel).with(http).returns(true)
+    expects(:ask).returns('y')
+    cancel
+  end
+
+  def test_cancel_no
+    entry = stub
+    HCl::DayEntry.expects(:with_timer).with(http).returns(entry)
+    expects(:ask).returns('n')
     cancel
   end
 

data/test/ext/capture_output.rb

@@ -18,7 +18,7 @@ module CaptureOutput
     @stdout.string
   end
 end
-class MiniTest::Unit::TestCase
+class MiniTest::Test
   include CaptureOutput
 end
 

data/test/test_helper.rb

@@ -9,7 +9,7 @@ begin
       source_file.lines.count < 15
     end
     # source: https://travis-ci.org/zenhob/hcl
-    minimum_coverage 84
+    minimum_coverage 80
   end
 rescue LoadError => e
   $stderr.puts 'No test coverage tools found, skipping coverage check.'
@@ -23,11 +23,12 @@ require 'minitest/autorun'
 require 'mocha/setup'
 require 'fileutils'
 require 'fakeweb'
+require 'debugger' if ENV['DEBUG']
 
 # require test extensions/helpers
 Dir[File.dirname(__FILE__) + '/ext/*.rb'].each { |ext| require ext }
 
-class HCl::TestCase < MiniTest::Unit::TestCase
+class HCl::TestCase < MiniTest::Test
   attr_reader :http
   def setup
     FakeWeb.allow_net_connect = false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hcl
 version: !ruby/object:Gem::Version
-  version: 0.4.11
+  version: 0.4.12
 platform: ruby
 authors:
 - Zack Hobson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-25 00:00:00.000000000 Z
+date: 2014-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop
@@ -213,13 +213,14 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG
 - LICENSE
 - Rakefile
 - Gemfile
+- bin/hcl
+- man/hcl.1
+- CHANGELOG.markdown
 - HACKING.markdown
 - README.markdown
-- bin/hcl
 - lib/hcl/app.rb
 - lib/hcl/commands.rb
 - lib/hcl/console.rb
@@ -240,7 +241,6 @@ files:
 - test/task_test.rb
 - test/test_helper.rb
 - test/utility_test.rb
-- man/hcl.1
 homepage: http://zackhobson.com/hcl/
 licenses:
 - MIT