hcl 0.4.8 → 0.4.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ffeab4df3c125edae4368f304a145fa7d76bb0f
-  data.tar.gz: 8f362f3aa3e7010d9a871212818fa247165cea49
+  metadata.gz: 1ea82cda49c0d4f4aa43038029ae70b5e22b9e18
+  data.tar.gz: 3bf6719883563294afd3545ce02213abe468e7a5
 SHA512:
-  metadata.gz: 75031b9762f7ecc905d2b11fbe8c16b8708b459677a58de1750bca4cb9185699f25dd006626ea85841624e0b0130324ae43eef03922ffe8459b2411cf5b95817
-  data.tar.gz: 3a3b1bfce1f9f88da3a8bebb206c5bab6c6d6b71c81d6a8914a50ee4f74ecf216e904f03386bd95ed60b97cfb5b6eb37f706327bf22dd482d5db183f810fbf9c
+  metadata.gz: f0994f4ee68ce6b5adabb2de5cec31a8db29091fc02eba53929461015e639b152805ba5b42707c693a1bcf1efb200e0918f07c3b6e4522e33beb46187cda9aa8
+  data.tar.gz: 1749a65a4eaaaa8c580573e5dab944ae026fb057bdaa33a3ae225569f1033d9cccada2c5efd77a7c0d1e5785d38fb154ef23d8943e70db48728c3ef0ad54b41f

data/CHANGELOG

@@ -1,5 +1,10 @@
 = Recent Changes in HCl
 
+== 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
 
 * more fixes for 1.9.3

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+gemspec
+# XXX this is dumb but it's crazy hard to get platform specfic deps into a gemspec
+gem 'rubysl-abbrev', platform:'rbx'
+gem 'rubysl-singleton', platform:'rbx'
+gem 'rubysl-rexml', platform:'rbx'
+gem 'rubysl-coverage', platform:'rbx', group:'test'
+gem 'rubinius-coverage', platform:'rbx', group:'test'
+gem 'yajl-ruby', platform:'rbx', group:'test'

data/HACKING.markdown

@@ -8,6 +8,10 @@ Use Bundler to install dependencies before you run the tests:
     bundle
     rake test
 
+Coverage is tested automatically. To view the test coverage report:
+
+    open coverage/index.html
+
 ## Running HCl during development
 
 To run HCl in place (e.g. for testing out local changes) you can use bundle exec:

data/README.markdown

@@ -5,28 +5,31 @@ HCl is a command-line tool for interacting with Harvest time sheets using the
 
 [htt]: http://www.getharvest.com/api/time_tracking
 
+[![Build Status](https://travis-ci.org/zenhob/hcl.png?branch=master)](https://travis-ci.org/zenhob/hcl)
+[![Gem Version](https://badge.fury.io/rb/hcl.png)](http://badge.fury.io/rb/hcl)
+
 ## Quick Start
 
 You can install hcl directly from rubygems.org:
 
-    $ gem install hcl
+    gem install hcl
 
 or you can install from source:
 
-    $ rake install
+    rake install
 
 ## Usage
 
-    $ hcl [start] @<task_alias> [+<time>] [<message>]
-    $ hcl note <message>
-    $ hcl stop [<message>]
-    $ hcl resume [@<task_alias>]
-    $ hcl log @<task_alias> [+<time>] [<message>]
-    $ hcl show [<date>]
-    $ hcl tasks [<project_code>]
-    $ hcl alias <task_alias> <project_id> <task_id>
-    $ hcl aliases
-    $ hcl (cancel | nvm | oops)
+    hcl [start] @<task_alias> [+<time>] [<message>]
+    hcl note <message>
+    hcl stop [<message>]
+    hcl resume [@<task_alias>]
+    hcl log @<task_alias> [+<time>] [<message>]
+    hcl show [<date>]
+    hcl tasks [<project_code>]
+    hcl alias <task_alias> <project_id> <task_id>
+    hcl aliases
+    hcl (cancel | nvm | oops)
 
 ### Available Projects and Tasks
 
@@ -34,7 +37,7 @@ 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.
 
-    $ hcl tasks
+    hcl tasks
 
 You can also pass a project code (this is the short optional code associated
 with each project) to list only the tasks for that project.
@@ -44,8 +47,8 @@ with each project) to list only the tasks for that project.
 Since it's not practical to enter two long numbers every time you want to
 identify a task, HCl supports task aliases:
 
-    $ hcl alias tacodev 1234 5678
-    $ hcl @tacodev Adding a new feature
+    hcl alias tacodev 1234 5678
+    hcl @tacodev Adding a new feature
 
 ### Starting a Timer with Initial Time
 
@@ -53,20 +56,20 @@ 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 @tacodev +0:15 Doing some stuff
-    $ hcl +.25 @tacodev Doing some stuff
+    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 Then I did something else
+    hcl note Then I did something else
 
 **Note** that `show` only displays the last line of the timer notes.
 You can list all the notes for a running timer by issuing the note
 command without any arguments:
 
-    $ hcl note
+    hcl note
 
 ### Stopping a Timer
 
@@ -74,22 +77,22 @@ 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 doing things
+    hcl stop All done doing things
 
 ### Resuming a Timer
 
 You can resume a stopped timer. Specify a task to resume the last timer
 for that task:
 
-    $ hcl resume
-    $ hcl resume @xdev
+    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
+    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`.
@@ -99,26 +102,42 @@ running. You can also use `nvm` or `oops` instead of `cancel`.
 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.
+    hcl log @xdev +1 Worked for an hour.
 
 The above starts and immediately stops a one-hour timer with the given note.
 
+## Advanced Usage
+
 ### Bash Auto-completion of Task Aliases
 
-You can enable auto-completion of task aliases by adding this to your bashrc:
+You can enable auto-completion of task aliases by adding this to your shell
+configuration:
 
     eval `hcl completion`
 
+### Configuration Profiles
+
+You can specify an alternate configuration directory in the environment as
+`HCL_DIR`. This can be used to easily interact with multiple harvest accounts.
+Here is a shell alias `myhcl` with a separate configuration from the
+main `hcl` command, including alias completion:
+
+    alias myhcl="env HCL_DIR=~/.myhcl hcl"
+    eval `myhcl completion myhcl`
+
+When using `myhcl` you can use different credentials and aliases, while
+`hcl` will continue to function with your original configuration.
+
 ### Date Formats
 
 Dates can be expressed in a variety of ways. See the [Chronic documentation][cd]
 for more information about available date input formats. The following
-commands show the timesheet for the specified day:
+commands show the time sheet for the specified day:
 
-    $ hcl show yesterday
-    $ hcl show last friday
-    $ hcl show 2 days ago
-    $ hcl show 1 week ago
+    hcl show yesterday
+    hcl show last friday
+    hcl show 2 days ago
+    hcl show 1 week ago
 
 [cd]: http://chronic.rubyforge.org/
 

data/lib/hcl/app.rb

@@ -55,22 +55,25 @@ module HCl
         else
           puts show
         end
+      rescue CommandError => e
+        $stderr.puts e
+        exit 1
       rescue RuntimeError => e
-        STDERR.puts "Error: #{e}"
+        $stderr.puts "Error: #{e}"
         exit 1
       rescue SocketError => e
-        STDERR.puts "Connection failed. (#{e.message})"
+        $stderr.puts "Connection failed. (#{e.message})"
         exit 1
       rescue TimesheetResource::ThrottleFailure => e
-        STDERR.puts "Too many requests, retrying in #{e.retry_after+5} seconds..."
+        $stderr.puts "Too many requests, retrying in #{e.retry_after+5} seconds..."
         sleep e.retry_after+5
         run
       rescue TimesheetResource::AuthFailure => e
-        STDERR.puts "Unable to authenticate: #{e}"
+        $stderr.puts "Unable to authenticate: #{e}"
         request_config
         run
       rescue TimesheetResource::Failure => e
-        STDERR.puts "API failure: #{e}"
+        $stderr.puts "API failure: #{e}"
         exit 1
       end
     end
@@ -133,9 +136,12 @@ EOM
 
     private
 
-    def read_config force=false
+    def read_config
       if File.exists? CONFIG_FILE
-        config = YAML::load File.read(CONFIG_FILE)
+        config = YAML::load(File.read(CONFIG_FILE)) || {}
+        if has_security_command?
+          load_password config
+        end
         TimesheetResource.configure config
       elsif File.exists? OLD_CONFIG_FILE
         config = YAML::load File.read(OLD_CONFIG_FILE)
@@ -159,10 +165,13 @@ EOM
 
     def write_config config
       puts "Writing configuration to #{CONFIG_FILE}."
+      if has_security_command?
+        save_password config
+      end
       File.open(CONFIG_FILE, 'w') do |f|
        f.write config.to_yaml
       end
-      FileUtils.chmod 0400, CONFIG_FILE
+      FileUtils.chmod 0600, CONFIG_FILE
     end
 
     def read_settings
@@ -182,6 +191,32 @@ EOM
       end
       nil
     end
+
+    def has_security_command?
+      if @has_security.nil? 
+        @has_security = File.exists?('/usr/bin/security') &&
+          (`/usr/bin/security error 1` =~ /CSSM_ERRCODE_INTERNAL_ERROR/)
+      else
+        @has_security
+      end
+    end
+
+    def load_password config
+      cmd = "security find-internet-password -l hcl -a '%s' -s '%s.harvestapp.com' -w" % [
+        config['login'],
+        config['subdomain'],
+      ]
+      password = `#{cmd}`
+      config.update('password'=>password.chomp) if $?.success?
+    end
+
+    def save_password config
+      if system("security add-internet-password -U -l hcl -a '%s' -s '%s.harvestapp.com' -w '%s'" % [
+        config['login'],
+        config['subdomain'],
+        config['password'],
+      ]) then config.delete('password') end
+    end
   end
 end
 

data/lib/hcl/commands.rb

@@ -3,6 +3,8 @@ require 'highline'
 
 module HCl
   module Commands
+    class Error < StandardError; end
+
     def tasks project_code=nil
       tasks = Task.all
       if tasks.empty? # cache tasks
@@ -11,8 +13,7 @@ module HCl
       end
       tasks.select! {|t| t.project.code == project_code } if project_code
       if tasks.empty?
-        puts "No matching tasks."
-        exit 1
+        fail "No matching tasks."
       end
       tasks.map { |task| "#{task.project.id} #{task.id}\t#{task}" }.join("\n")
     end
@@ -37,12 +38,10 @@ module HCl
         if entry.cancel
           "Deleted entry #{entry}."
         else
-          puts "Failed to delete #{entry}!"
-          exit 1
+          fail "Failed to delete #{entry}!"
         end
       else
-        puts 'Nothing to cancel.'
-        exit 1
+        fail 'Nothing to cancel.'
       end
     end
     alias_method :oops, :cancel
@@ -64,13 +63,12 @@ module HCl
         set "task.#{task_name}", *value
         "Added alias @#{task_name} for #{task}."
       else
-        puts "Unrecognized project and task ID: #{value.inspect}"
-        exit 1
+        fail "Unrecognized project and task ID: #{value.inspect}"
       end
     end
 
-    def completion
-      %[complete -W "#{aliases.join ' '}" hcl]
+    def completion command=$PROGRAM_NAME
+      %[complete -W "#{aliases.join ' '}" #{command}]
     end
 
     def aliases
@@ -81,8 +79,7 @@ module HCl
       starting_time = get_starting_time args
       task = get_task args
       if task.nil?
-        puts "Unknown task alias, try one of the following: ", aliases.join(', ')
-        exit 1
+        fail "Unknown task alias, try one of the following: ", aliases.join(', ')
       end
       timer = task.start \
         :starting_time => starting_time,
@@ -91,6 +88,7 @@ module HCl
     end
 
     def log *args
+      fail "There is already a timer running." if DayEntry.with_timer
       start *args
       stop
     end
@@ -102,8 +100,7 @@ module HCl
         entry.toggle
         "Stopped #{entry} (at #{current_time})"
       else
-        puts "No running timers found."
-        exit 1
+        fail "No running timers found."
       end
     end
 
@@ -117,8 +114,7 @@ module HCl
           "Added note to #{entry}."
         end
       else
-        puts "No running timers found."
-        exit 1
+        fail "No running timers found."
       end
     end
 
@@ -128,7 +124,7 @@ module HCl
       result = ''
       DayEntry.all(date).each do |day|
         running = day.running? ? '(running) ' : ''
-        columns = HighLine::SystemExtensions.terminal_size[0]
+        columns = HighLine::SystemExtensions.terminal_size[0] rescue 80
         result << "\t#{day.formatted_hours}\t#{running}#{day.project}: #{day.notes.lines.to_a.last}\n"[0..columns-1]
         total_hours = total_hours + day.hours.to_f
       end
@@ -147,8 +143,7 @@ module HCl
       if entry
         entry.toggle
       else
-        puts "No matching timer found."
-        exit 1
+        fail "No matching timer found."
       end
     end
 

data/lib/hcl/utility.rb

@@ -1,5 +1,10 @@
 module HCl
+  class CommandError < StandardError; end
   module Utility
+    def fail *message
+      raise CommandError, message.join(' ')
+    end
+
     def get_task_ids ident, args
       if @settings.key? "task.#{ident}"
         @settings["task.#{ident}"].split(/\s+/)

data/lib/hcl/version.rb

@@ -1,3 +1,3 @@
 module HCl
-  VERSION = '0.4.8'
+  VERSION = '0.4.9'
 end

data/test/app_test.rb

@@ -1,5 +1,5 @@
 require 'test_helper'
-class AppTest < Test::Unit::TestCase
+class AppTest < HCl::TestCase
 
   def setup
     # touch config to avoid triggering manual config
@@ -30,18 +30,38 @@ class AppTest < Test::Unit::TestCase
     app.process_args('show').run
   end
 
-  def test_report_generic_failure
+  def test_generic_failure
     app = HCl::App.new
     app.expects(:show).raises(RuntimeError)
     app.expects(:exit).with(1)
     app.process_args('show').run
   end
 
-  def test_report_socket_error
+  def test_socket_error
     app = HCl::App.new
     app.expects(:show).raises(SocketError)
     app.expects(:exit).with(1)
     app.process_args('show').run
+    assert_match /connection failed/i, error_output
+  end
+
+  def test_configure_on_auth_failure
+    app = HCl::App.new
+    configured = states('configured').starts_as(false)
+    app.expects(:show).raises(HCl::TimesheetResource::AuthFailure).when(configured.is(false))
+    app.expects(:ask).returns('xxx').times(4).when(configured.is(false))
+    app.expects(:write_config).then(configured.is(true))
+    app.expects(:show).when(configured.is(true))
+    app.process_args('show').run
+    assert_match /unable to authenticate/i, error_output
+  end
+
+  def test_api_failure
+    app = HCl::App.new
+    app.expects(:show).raises(HCl::TimesheetResource::Failure)
+    app.expects(:exit).with(1)
+    app.process_args('show').run
+    assert_match /API failure/i, error_output
   end
 
 end

data/test/command_test.rb

@@ -1,5 +1,5 @@
 require 'test_helper'
-class CommandTest < Test::Unit::TestCase
+class CommandTest < HCl::TestCase
   include HCl::Commands
   include HCl::Utility
 
@@ -18,6 +18,11 @@ class CommandTest < Test::Unit::TestCase
     @settings
   end
 
+  def test_log_failure
+    HCl::DayEntry.expects(:with_timer).returns(stub)
+    assert_raises(HCl::CommandError) { log "stuff" }
+  end
+
   def test_tasks
     HCl::Task.expects(:all).returns([HCl::Task.new(
       id:123,

data/test/day_entry_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class DayEntryTest < Test::Unit::TestCase
+class DayEntryTest < HCl::TestCase
   def test_from_xml
     entries = HCl::DayEntry.from_xml(<<-EOD)
 <daily>

data/test/ext/capture_output.rb

@@ -0,0 +1,23 @@
+module CaptureOutput
+  def before_setup
+    super
+    $stderr = @stderr = StringIO.new
+    $stdout = @stdout = StringIO.new
+  end
+  def after_teardown
+    super
+    $stderr = STDERR
+    $stdout = STDOUT
+  end
+  def error_output
+    @stderr.string
+  end
+  def standard_output
+    @stdout.string
+  end
+end
+class MiniTest::Unit::TestCase
+  include CaptureOutput
+end
+
+

data/test/task_test.rb

@@ -1,5 +1,5 @@
 
-class Task < Test::Unit::TestCase
+class Task < HCl::TestCase
   def test_cache_file
     assert_equal "#{HCl::App::HCL_DIR}/cache/tasks.yml", HCl::Task.cache_file
   end

data/test/test_helper.rb

@@ -1,20 +1,35 @@
 require 'bundler'
-require 'simplecov'
-SimpleCov.start do
-  add_filter '/test/'
-  add_filter do |source_file|
-    source_file.lines.count < 15
+
+begin
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter '/test/'
+    add_filter '/vendor/' # for travis-ci
+    add_filter do |source_file|
+      source_file.lines.count < 15
+    end
+    # source: https://travis-ci.org/zenhob/hcl
+    minimum_coverage case RUBY_ENGINE
+      when "rbx" then 84
+      when "jruby" then 73
+      else 78
+    end
   end
+rescue LoadError => e
+  $stderr.puts 'No test coverage tools found, skipping coverage check.'
 end
 
-require 'test/unit'
-require 'mocha/setup'
-require 'fileutils'
-require 'fakeweb'
-
 # override the default hcl dir
 ENV['HCL_DIR'] = File.dirname(__FILE__)+"/dot_hcl"
 
 require 'hcl'
+require 'minitest/autorun'
+require 'mocha/setup'
+require 'fileutils'
+require 'fakeweb'
+
+# require test extensions/helpers
+Dir[File.dirname(__FILE__) + '/ext/*.rb'].each { |ext| require ext }
 
+class HCl::TestCase < MiniTest::Unit::TestCase; end
 

data/test/timesheet_resource_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class TimesheetResourceTest < Test::Unit::TestCase
+class TimesheetResourceTest < HCl::TestCase
 
   def setup
     FakeWeb.allow_net_connect = false

data/test/utility_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class UtilityTest < Test::Unit::TestCase
+class UtilityTest < HCl::TestCase
   include HCl::Utility
 
   def test_time2float_decimal

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hcl
 version: !ruby/object:Gem::Version
-  version: 0.4.8
+  version: 0.4.9
 platform: ruby
 authors:
 - Zack Hobson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-30 00:00:00.000000000 Z
+date: 2013-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop
@@ -52,6 +52,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubygems-tasks
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +136,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: HCl is a command-line client for manipulating Harvest time sheets.
 email: zack@zackhobson.com
 executables:
@@ -132,6 +160,7 @@ files:
 - CHANGELOG
 - LICENSE
 - Rakefile
+- Gemfile
 - HACKING.markdown
 - README.markdown
 - bin/hcl
@@ -147,6 +176,7 @@ files:
 - test/app_test.rb
 - test/command_test.rb
 - test/day_entry_test.rb
+- test/ext/capture_output.rb
 - test/task_test.rb
 - test/test_helper.rb
 - test/timesheet_resource_test.rb