hcl 0.4.6 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e1be76a382c48d42a98e4bad37a360bab90b728
-  data.tar.gz: 73afc8798c5cf88030394d3429db7c50e37c9ffa
+  metadata.gz: 37356337b2821522c84bd05569cbc5e6b00e8316
+  data.tar.gz: 506250a1481bce9b61c60c85170d838fc35afcd2
 SHA512:
-  metadata.gz: 10ecb6e3ac58681da880d0dffffff802efe12073f885bd6f66cdb3e42a4be44c32f51d15490db6b52ef708ce26686c0c196e15896e96721bb6985795b2710503
-  data.tar.gz: 831bcaac4c81408f66545380b3de4e76387f30a43592b0ab1210f0f14a1a758bd815ad6a4675b9a770698d9043e67ef56cdff232bc47211355cbc87f9cb87e46
+  metadata.gz: 088e3d191f620b7a5443fa3c6cfe74c18148b83fa592811a16b9e1019df5ea48879e03425638c43c7f2720c7168d2e2463dcb72734c49c98eae1f66f75414104
+  data.tar.gz: eac562669a54212360f07c93f3c31e8a84d8a1c64ddecd401186879a740c0c73e368c1ca0e36501ad2d51c27a444c287a699fe786cedaf27b099dbf4e45fe3e5

data/CHANGELOG

@@ -1,47 +1,54 @@
 = Recent Changes in HCl
 
-== v0.4.6
+== 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
 
 * automatically request credentials on auth-failure
 * fix user-entered credentials
 
-== v0.4.5
+== v0.4.5 2013-11-21
 
 * allow filtering of tasks by project code
 * eliminate shoulda from development dependencies
 
-== v0.4.4
+== v0.4.4 2013-11-20
 
 * added completion command to output a Bash auto-complete script, closes #34
 * removed jeweler dependency
 
-== v0.4.3
+== 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
+== v0.4.2 2013-11-19
 
 * resume command now accepts an optional task
 
-== v0.4.1
+== v0.4.1 2013-11-18
 
 * update dependencies
 
-== v0.4.0
+== 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
+== 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
+== v0.3.1 2011-07-13
 
 * use STDERR instead of STDOUT for error reporting
 * sort tasks before viewing tasks (brian@madebyrocket.com)
@@ -49,46 +56,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 Fri Apr 2 10:42:20 2010 -0700
+== v0.3.0 2010-04-02
 
 * added support for free accounts
 
-== v0.2.3 Sun Aug 23 21:39:34 2009 -0700
+== 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 Sun Aug 9 11:16:34 2009 -0700
+== 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 Thu Jul 30 14:02:23 2009 -0700
+== v0.2.1 2009-07-30
 
 * Fixed: Creating timers without starting them.
 
-== v0.2.0 Thu Jul 30 11:40:33 2009 -0700
+== 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 Tue Jul 28 09:19:53 2009 -0700
+== 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 Mon Jul 27 11:46:50 2009 -0700
+== v0.1.2 2009-07-27
 
 * Automatically include rubygems in bin/hcl.
 
-== v0.1.1 Fri Jul 24 19:32:32 2009 -0700
+== v0.1.1 2009-07-24
 
 * Mention gem in README, read version from file.
     
-== v0.1.0 Fri Jul 24 19:09:23 2009 -0700
+== v0.1.0 2009-07-24
 
 * Initial public release
 

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Zack Hobson <zack@opensourcery.com>, OpenSourcery LLC
+Copyright (c) 2009 Zack Hobson <zack@zackhobson.com>, OpenSourcery LLC
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.markdown

@@ -17,16 +17,16 @@ or you can install from source:
 
 ## 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
 
@@ -62,6 +62,12 @@ While a task is running you can append lines to the task notes:
 
     $ 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
+
 ### Stopping a Timer
 
 The following command will stop a running timer (currently only one timer at

data/Rakefile

@@ -1,6 +1,11 @@
 require 'rubygems/tasks'
 Gem::Tasks.new
 
+require 'fileutils'
+task :clean do
+  FileUtils.rm_rf %w[ pkg coverage doc ]
+end
+
 require 'rake/testtask'
 Rake::TestTask.new do |t|
   t.libs << 'test'

data/lib/hcl/app.rb

@@ -15,8 +15,8 @@ module HCl
     OLD_SETTINGS_FILE = "#{ENV['HOME']}/.hcl_settings"
     OLD_CONFIG_FILE = "#{ENV['HOME']}/.hcl_config"
 
-    def configure
-      FileUtils.mkdir_p(File.join(ENV['HOME'], ".hcl"))
+    def initialize
+      FileUtils.mkdir_p(HCL_DIR)
       read_config
       read_settings
       self
@@ -24,7 +24,7 @@ module HCl
 
     # Run the given command and arguments.
     def self.command *args
-      new.configure.process_args(*args).run
+      new.process_args(*args).run
     end
 
     # Return true if the string is a known command, false otherwise.
@@ -37,6 +37,7 @@ module HCl
 
     # Start the application.
     def run
+      request_config if @options[:reauth]
       begin
         if @command
           if command? @command
@@ -60,6 +61,10 @@ module HCl
       rescue SocketError => e
         STDERR.puts "Connection failed. (#{e.message})"
         exit 1
+      rescue TimesheetResource::ThrottleFailure => e
+        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}"
         request_config
@@ -71,7 +76,7 @@ module HCl
     end
 
     def process_args *args
-      Trollop::options(args) do
+      @options = Trollop::options(args) do
         stop_on Commands.instance_methods
         version "HCl version #{VERSION}"
         banner <<-EOM
@@ -119,6 +124,7 @@ Examples:
 
 Options:
 EOM
+        opt :reauth, "Force refresh of auth details"
       end
       @command = args.shift
       @args = args

data/lib/hcl/commands.rb

@@ -108,11 +108,14 @@ module HCl
     end
 
     def note *args
-      message = args.join ' '
       entry = DayEntry.with_timer
       if entry
-        entry.append_note message
-        "Added note to #{entry}."
+        if args.empty?
+          return entry.notes
+        else
+          entry.append_note args.join(' ')
+          "Added note to #{entry}."
+        end
       else
         puts "No running timers found."
         exit 1

data/lib/hcl/task.rb

@@ -24,7 +24,7 @@ module HCl
     end
 
     def self.cache_dir
-      File.join(ENV['HOME'],'.hcl/cache')
+      File.join(HCl::App::HCL_DIR, 'cache')
     end
 
     def self.all

data/lib/hcl/timesheet_resource.rb

@@ -1,22 +1,18 @@
 require 'net/http'
 require 'net/https'
-
-# Workaround for annoying SSL warning:
-#  >> warning: peer certificate won't be verified in this SSL session
-# http://www.5dollarwhitebox.org/drupal/node/64
-class Net::HTTP
-  alias_method :old_initialize, :initialize
-  def initialize(*args)
-    old_initialize(*args)
-    @ssl_context = OpenSSL::SSL::SSLContext.new
-    @ssl_context.verify_mode = OpenSSL::SSL::VERIFY_NONE
-  end
-end
+require 'cgi'
 
 module HCl
   class TimesheetResource
     class Failure < StandardError; end
     class AuthFailure < StandardError; end
+    class ThrottleFailure < StandardError
+      attr_reader :retry_after
+      def initialize response
+        @retry_after = response.headers['Retry-After'].to_i
+        super "Too many requests! Try again in #{@retry_after} seconds."
+      end
+    end
 
     def self.configure opts = nil
       if opts
@@ -24,8 +20,6 @@ module HCl
         self.password = opts['password']
         self.subdomain = opts['subdomain']
         self.ssl = opts['ssl']
-      else
-        yield self
       end
     end
 
@@ -57,10 +51,16 @@ module HCl
       http_do Net::HTTP::Delete, action
     end
 
+    def self.connect
+      Net::HTTP.new("#{subdomain}.harvestapp.com", (ssl ? 443 : 80)).tap do |https|
+        https.use_ssl = ssl
+        https.verify_mode = OpenSSL::SSL::VERIFY_NONE if ssl
+      end
+    end
+
     def self.http_do method_class, action, data = nil
-      https   = Net::HTTP.new "#{subdomain}.harvestapp.com", (ssl ? 443 : 80)
+      https = connect
       request = method_class.new "/#{action}"
-      https.use_ssl = ssl
       request.basic_auth login, password
       request.content_type = 'application/xml'
       request['Accept']    = 'application/xml'
@@ -70,6 +70,8 @@ module HCl
         response.body
       when Net::HTTPFound
         raise Failure, "Redirected! Perhaps your ssl configuration variable is set incorrectly?"
+      when Net::HTTPServiceUnavailable
+        raise ThrottleFailure, response
       when Net::HTTPUnauthorized
         raise AuthFailure, "Login failed."
       else
@@ -82,11 +84,11 @@ module HCl
     end
 
     def method_missing method, *args
-      if @data.key? method.to_sym
-        @data[method]
-      else
-        super
-      end
+      @data.key?(method.to_sym) ? @data[method] : super
+    end
+
+    def respond_to? method
+      (@data && @data.key?(method.to_sym)) || super
     end
 
     def self.xml_to_hash elem

data/lib/hcl/version.rb

@@ -1,3 +1,3 @@
 module HCl
-  VERSION = '0.4.6'
+  VERSION = '0.4.7'
 end

data/test/app_test.rb

@@ -1,17 +1,47 @@
 require 'test_helper'
 class AppTest < Test::Unit::TestCase
 
+  def setup
+    # touch config to avoid triggering manual config
+    FileUtils.mkdir_p HCl::App::HCL_DIR
+    FileUtils.touch File.join(HCl::App::HCL_DIR, "config.yml")
+  end
+
   def test_commands
     app = HCl::App.new
     assert HCl::Commands.instance_methods.all? { |c| app.command? c  }, 'all methods are commands'
   end
 
   def test_command_show
-    HCl::DayEntry.expects(:all).returns([HCl::DayEntry.new({
-      hours:'2.06',
-      notes: 'hi world',
-      project: 'App'
-    })])
+    HCl::DayEntry.expects(:all).returns [HCl::DayEntry.new(
+      hours:'2.06', notes:'hi world', project:'App'
+    )]
     HCl::App.command 'show'
   end
+
+  def test_command_retry_on_throttle
+    app = HCl::App.new
+    throttled = states('throttled').starts_as(false)
+    app.expects(:show).
+      raises(HCl::TimesheetResource::ThrottleFailure, stub(headers:{'Retry-After' => 42})).
+      then(throttled.is(true))
+    app.expects(:sleep).with(47).when(throttled.is(true))
+    app.expects(:show).when(throttled.is(true))
+    app.process_args('show').run
+  end
+
+  def test_report_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
+    app = HCl::App.new
+    app.expects(:show).raises(SocketError)
+    app.expects(:exit).with(1)
+    app.process_args('show').run
+  end
+
 end

data/test/command_test.rb

@@ -82,6 +82,14 @@ class CommandTest < Test::Unit::TestCase
     resume
   end
 
+  def test_resume_with_task_alias
+    entry = stub
+    expects(:get_task_ids).with('mytask',[]).returns(%w[ 456 789 ])
+    HCl::DayEntry.expects(:last_by_task).with('456', '789').returns(entry)
+    entry.expects(:toggle)
+    resume 'mytask'
+  end
+
   def test_cancel
     entry = stub
     HCl::DayEntry.expects(:with_timer).returns(entry)
@@ -96,4 +104,10 @@ class CommandTest < Test::Unit::TestCase
     note 'hi world'
   end
 
+  def test_note_display
+    entry = stub(notes:"your face")
+    HCl::DayEntry.expects(:with_timer).returns(entry)
+    assert_equal "your face", note
+  end
+
 end

data/test/task_test.rb

@@ -1,5 +1,9 @@
 
 class Task < Test::Unit::TestCase
+  def test_cache_file
+    assert_equal "#{HCl::App::HCL_DIR}/cache/tasks.yml", HCl::Task.cache_file
+  end
+
   def test_cache_tasks
     HCl::Task.cache_tasks(REXML::Document.new(<<-EOD))
 <daily>

data/test/test_helper.rb

@@ -10,9 +10,9 @@ end
 require 'test/unit'
 require 'mocha/setup'
 require 'fileutils'
+require 'fakeweb'
 
 # override the default hcl dir
-FileUtils.mkdir_p __dir__+"/dot_hcl"
 ENV['HCL_DIR'] = __dir__+"/dot_hcl"
 
 require 'hcl'

data/test/timesheet_resource_test.rb

@@ -0,0 +1,38 @@
+require 'test_helper'
+
+class TimesheetResourceTest < Test::Unit::TestCase
+
+  def setup
+    FakeWeb.allow_net_connect = false
+    HCl::TimesheetResource.configure \
+      'login' => 'bob',
+      'password' => 'secret',
+      'subdomain' => 'bobclock',
+      'ssl' => true
+  end
+
+  def test_configure
+    assert_equal 'bob', HCl::TimesheetResource.login
+    assert_equal 'secret', HCl::TimesheetResource.password
+    assert_equal 'bobclock', HCl::TimesheetResource.subdomain
+    assert_equal true, HCl::TimesheetResource.ssl
+  end
+
+  def test_http_get
+    FakeWeb.register_uri(:get, "https://bob:secret@bobclock.harvestapp.com/foo", :body => 'gotten!')
+    body = HCl::TimesheetResource.get 'foo'
+    assert_equal 'gotten!', body
+  end
+
+  def test_http_post
+    FakeWeb.register_uri(:post, "https://bob:secret@bobclock.harvestapp.com/foo", :body => 'posted!')
+    body = HCl::TimesheetResource.post 'foo', {pizza:'taco'}
+    assert_equal 'posted!', body
+  end
+
+  def test_http_delete
+    FakeWeb.register_uri(:delete, "https://bob:secret@bobclock.harvestapp.com/foo", :body => 'wiped!')
+    body = HCl::TimesheetResource.delete 'foo'
+    assert_equal 'wiped!', body
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hcl
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.4.7
 platform: ruby
 authors:
 - Zack Hobson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-21 00:00:00.000000000 Z
+date: 2013-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop
@@ -108,6 +108,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  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:
@@ -135,6 +149,7 @@ files:
 - test/day_entry_test.rb
 - test/task_test.rb
 - test/test_helper.rb
+- test/timesheet_resource_test.rb
 - test/utility_test.rb
 homepage: http://zackhobson.com/hcl/
 licenses: