hcl 0.4.5 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db61484751f4f46ad0e78d1221bd7c6291812ed8
-  data.tar.gz: 835db00cb847562bb1bfdd32156ce14bae753d36
+  metadata.gz: 1e1be76a382c48d42a98e4bad37a360bab90b728
+  data.tar.gz: 73afc8798c5cf88030394d3429db7c50e37c9ffa
 SHA512:
-  metadata.gz: 842e229a4dc43d0931f2fed478ec12e78576ad073095994ca71ff9fb9d79c24af4f592af479c0a8d01ae360e69a0a81c4e8084ee30c3d0ad694fe011345c14c8
-  data.tar.gz: 298c413ac8be9f93bd0910ca7da08bb8a7d006ec86078ed1e30317e672d9f7cb13598a87e47caa10f61d1783feef16219bcec5300faa0733598df0e8a1cd84d8
+  metadata.gz: 10ecb6e3ac58681da880d0dffffff802efe12073f885bd6f66cdb3e42a4be44c32f51d15490db6b52ef708ce26686c0c196e15896e96721bb6985795b2710503
+  data.tar.gz: 831bcaac4c81408f66545380b3de4e76387f30a43592b0ab1210f0f14a1a758bd815ad6a4675b9a770698d9043e67ef56cdff232bc47211355cbc87f9cb87e46

data/CHANGELOG

@@ -1,5 +1,10 @@
 = Recent Changes in HCl
 
+== v0.4.6
+
+* automatically request credentials on auth-failure
+* fix user-entered credentials
+
 == v0.4.5
 
 * allow filtering of tasks by project code

data/HACKING.markdown

@@ -14,3 +14,9 @@ To run HCl in place (e.g. for testing out local changes) you can use bundle exec
 
     bundle exec bin/hcl
 
+## Generating API documentation
+
+To generate and view the API documentation:
+
+    rake doc
+    open doc/index.html

data/README.markdown

@@ -30,9 +30,9 @@ or you can install from source:
 
 ### Available Projects and Tasks
 
-To start a new timer you need to identify the project and task. After you've
-used the show command you can use the tasks command to view a cached list of
-available 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.
 
     $ hcl tasks
 

data/Rakefile

@@ -9,7 +9,6 @@ end
 task :default => :test
 
 require 'yard'
-YARD::Rake::YardocTask.new do |t|
-  t.options = %w[--files CHANGELOG]
-end
+YARD::Rake::YardocTask.new
+task :doc => :yard
 

data/lib/hcl/app.rb

@@ -2,14 +2,13 @@ require 'yaml'
 require 'fileutils'
 
 require 'trollop'
-require 'highline'
+require 'highline/import'
 
 module HCl
   class App
     include HCl::Utility
     include HCl::Commands
 
-
     HCL_DIR = ENV['HCL_DIR'] || "#{ENV['HOME']}/.hcl"
     SETTINGS_FILE = "#{HCL_DIR}/settings.yml"
     CONFIG_FILE = "#{HCL_DIR}/config.yml"
@@ -61,6 +60,10 @@ module HCl
       rescue SocketError => e
         STDERR.puts "Connection failed. (#{e.message})"
         exit 1
+      rescue TimesheetResource::AuthFailure => e
+        STDERR.puts "Unable to authenticate: #{e}"
+        request_config
+        run
       rescue TimesheetResource::Failure => e
         STDERR.puts "API failure: #{e}"
         exit 1
@@ -87,12 +90,15 @@ Commands:
     # start a task using an alias
     hcl [start] @<task_alias> [+<time>] [<message>]
 
-    # add a line to your running timer
+    # add a line to a running timer
     hcl note <message>
 
     # stop a running timer
     hcl stop [<message>]
 
+    # log a task and time without leaving a timer running
+    hcl log @<task_alias> [+<time>] [<message>]
+
     # resume the last stopped timer or a specific task
     hcl resume [@<task_alias>]
 
@@ -119,9 +125,9 @@ EOM
       self
     end
 
-    protected
+    private
 
-    def read_config
+    def read_config force=false
       if File.exists? CONFIG_FILE
         config = YAML::load File.read(CONFIG_FILE)
         TimesheetResource.configure config
@@ -130,17 +136,21 @@ EOM
         TimesheetResource.configure config
         write_config config
       else
-        config = {}
-        puts "Please specify your Harvest credentials.\n"
-        config['login'] = ask("Email Address: ").to_s
-        config['password'] = ask("Password: ") { |q| q.echo = false }.to_s
-        config['subdomain'] = ask("Subdomain: ").to_s
-        config['ssl'] = %w(y yes).include?(ask("Use SSL? (y/n): ").downcase)
-        TimesheetResource.configure config
-        write_config config
+        request_config
       end
     end
 
+    def request_config
+      config = {}
+      puts "Please specify your Harvest credentials.\n"
+      config['login'] = ask("Email Address: ").to_s
+      config['password'] = ask("Password: ") { |q| q.echo = false }.to_s
+      config['subdomain'] = ask("Subdomain: ").to_s
+      config['ssl'] = %w(y yes).include?(ask("Use SSL? (y/n): ").downcase)
+      TimesheetResource.configure config
+      write_config config
+    end
+
     def write_config config
       puts "Writing configuration to #{CONFIG_FILE}."
       File.open(CONFIG_FILE, 'w') do |f|

data/lib/hcl/timesheet_resource.rb

@@ -16,6 +16,7 @@ end
 module HCl
   class TimesheetResource
     class Failure < StandardError; end
+    class AuthFailure < StandardError; end
 
     def self.configure opts = nil
       if opts
@@ -64,12 +65,15 @@ module HCl
       request.content_type = 'application/xml'
       request['Accept']    = 'application/xml'
       response = https.request request, data
-      if response.kind_of? Net::HTTPSuccess
+      case response
+      when Net::HTTPSuccess
         response.body
-      elsif response.kind_of? Net::HTTPFound
-        raise Failure, "Redirected in the request. Perhaps your ssl configuration variable is set incorrectly?"
+      when Net::HTTPFound
+        raise Failure, "Redirected! Perhaps your ssl configuration variable is set incorrectly?"
+      when Net::HTTPUnauthorized
+        raise AuthFailure, "Login failed."
       else
-        raise Failure, "Unexpected response from the upstream API"
+        raise Failure, "Unexpected response from the upstream API."
       end
     end
 

data/lib/hcl/version.rb

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

metadata

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