zenhob-hcl 0.1.1

data/.gitignore

@@ -0,0 +1,2 @@
+*.sw[nop]
+pkg

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "ext/harvest"]
+	path = ext/harvest
+	url = git://github.com/aiaio/harvest.git

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2009 Zack Hobson <zack@opensourcery.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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,95 @@
+# hcl
+
+HCl is a command-line tool for interacting with Harvest time sheets using the
+[Harvest time tracking API][htt].
+
+[htt]: http://www.getharvest.com/api/time_tracking
+
+## Quick Start
+
+    $ gem install zenhob-hcl --source=http://gems.github.com
+    $ hcl show [date]
+
+### Prerequisites
+
+ * Ruby (tested with 1.8.7)
+ * Ruby OpenSSL support (in debian/ubuntu: apt-get install libopenssl-ruby)
+ * RubyGems
+ * 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
+
+NOTE that *add* and *rm* are not yet implemented.
+
+    hcl show [date]
+    hcl tasks
+    hcl set <key> <value ...>
+    hcl unset <key>
+    hcl start (<task_alias> | <project_id> <task_id>) [msg ...]
+    hcl note <msg ...>
+    hcl stop
+    hcl add (<task_alias> | <project_id> <task_id>) <duration> [msg ...]
+    hcl rm [entry_id]
+
+### Starting a Timer
+
+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. The first two numbers in each row are the project and task
+IDs. You need both values to start a timer:
+
+    $ hcl show
+    -------------
+    0:00    total
+    $ hcl tasks
+    1234 5678   ClientX Software Development
+    1234 9876   ClientX Admin
+    $ hcl start 1234 5678 adding a new feature
+
+### Task Aliases
+
+Since it's not practical to enter two long numbers every time you want to
+identify a task, HCl supports task aliases:
+
+    $ hcl set task.xdev 1234 5678
+    $ hcl start xdev adding a new feature
+
+### Adding Notes to a Running Task
+
+While a task is running you can append strings to the note for that task:
+
+    $ hcl note Found a good time
+    $ hcl note or not, whatever...
+
+### Stopping a Timer
+
+The following command will stop a running timer (currently only one timer at
+a time is supported):
+
+    $ hcl stop
+
+### 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:
+
+    $ hcl show yesterday
+    $ hcl show last friday
+    $ hcl show 2 days ago
+    $ hcl show 1 week ago
+
+[cd]: http://chronic.rubyforge.org/
+
+## Author
+
+[Zack Hobson][zgh], [OpenSourcery LLC][os]
+
+See LICENSE for copyright details.
+
+[zgh]: mailto:zack@opensourcery.com
+[os]: http://www.opensourcery.com/
+

data/Rakefile

@@ -0,0 +1,17 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "hcl"
+    gem.summary = "Harvest timesheets from the command-line"
+    gem.description = "HCl is a command-line client for manipulating Harvest time sheets."
+    gem.email = "zack@opensourcery.com"
+    gem.homepage = "http://github.com/zenhob/hcl"
+    gem.authors = ["Zack Hobson"]
+    gem.add_dependency "termios"
+    gem.add_dependency "trollop", ">= 1.10.2"
+    gem.add_dependency "chronic", ">= 0.2.3"
+    gem.add_dependency "highline", ">= 1.5.1"
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+---
+:major: 0
+:minor: 1
+:patch: 1

data/bin/hcl

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.dirname(__FILE__) + '/../lib'
+$:.unshift File.dirname(__FILE__) + '/../ext/harvest/lib'
+
+require 'hcl'
+
+HCl.command *ARGV
+

data/hcl.gemspec

@@ -0,0 +1,62 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{hcl}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Zack Hobson"]
+  s.date = %q{2009-07-24}
+  s.default_executable = %q{hcl}
+  s.description = %q{HCl is a command-line client for manipulating Harvest time sheets.}
+  s.email = %q{zack@opensourcery.com}
+  s.executables = ["hcl"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".gitignore",
+     ".gitmodules",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION.yml",
+     "bin/hcl",
+     "hcl.gemspec",
+     "hcl_conf.yml.example",
+     "lib/hcl.rb",
+     "lib/hcl/day_entry.rb",
+     "lib/hcl/project.rb",
+     "lib/hcl/task.rb",
+     "lib/hcl/timesheet_resource.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/zenhob/hcl}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Harvest timesheets from the command-line}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<termios>, [">= 0"])
+      s.add_runtime_dependency(%q<trollop>, [">= 1.10.2"])
+      s.add_runtime_dependency(%q<chronic>, [">= 0.2.3"])
+      s.add_runtime_dependency(%q<highline>, [">= 1.5.1"])
+    else
+      s.add_dependency(%q<termios>, [">= 0"])
+      s.add_dependency(%q<trollop>, [">= 1.10.2"])
+      s.add_dependency(%q<chronic>, [">= 0.2.3"])
+      s.add_dependency(%q<highline>, [">= 1.5.1"])
+    end
+  else
+    s.add_dependency(%q<termios>, [">= 0"])
+    s.add_dependency(%q<trollop>, [">= 1.10.2"])
+    s.add_dependency(%q<chronic>, [">= 0.2.3"])
+    s.add_dependency(%q<highline>, [">= 1.5.1"])
+  end
+end

data/hcl_conf.yml.example

@@ -0,0 +1,3 @@
+subdomain: mycompany
+login: me@mycompany.com
+password: secret

data/lib/hcl/day_entry.rb

@@ -0,0 +1,53 @@
+
+class HCl 
+  class DayEntry < TimesheetResource
+    # Get the time sheet entries for a given day. If no date is provided
+    # defaults to today.
+    def self.all date = nil
+      url = date.nil? ? 'daily' : "daily/#{date.strftime '%j/%Y'}"
+      from_xml get(url)
+    end
+
+    def to_s
+      "#{client} #{project} #{task} (#{hours})"
+    end
+
+    def self.from_xml xml
+      doc = REXML::Document.new xml
+      Task.cache_tasks doc
+      doc.root.elements.collect('*/day_entry') do |day|
+        new xml_to_hash(day)
+      end
+    end
+
+    # Append a string to the notes for this task.
+    def append_note new_notes
+      # If I don't include hours it gets reset.
+      # This doens't appear to be the case for task and project.
+      DayEntry.post("daily/update/#{id}", <<-EOD)
+      <request>
+        <notes>#{notes << " #{new_notes}"}</notes>
+        <hours>#{hours}</hours>
+      </request>
+      EOD
+    end
+
+    def self.with_timer
+      all.detect {|t| t.running? }
+    end
+
+    def running?
+      !@data[:timer_started_at].nil? && !@data[:timer_started_at].empty?
+    end
+
+    def initialize *args
+      super
+      # TODO cache client/project names and ids
+    end
+
+    def toggle
+      DayEntry.get("daily/timer/#{id}")
+      self
+    end
+  end
+end

data/lib/hcl/project.rb

@@ -0,0 +1,3 @@
+class HCl::Project < HCl::TimesheetResource
+end
+

data/lib/hcl/task.rb

@@ -0,0 +1,44 @@
+class HCl
+  class Task < TimesheetResource
+    def self.cache_tasks doc
+      tasks = []
+      doc.root.elements.collect('projects/project') do |project_elem|
+        project = Project.new xml_to_hash(project_elem)
+        tasks.concat(project_elem.elements.collect('tasks/task') do |task|
+          new xml_to_hash(task).merge(:project => project)
+        end)
+      end
+      File.open(File.join(ENV['HOME'],'.hcl_tasks'), 'w') do |f|
+        f.write tasks.uniq.to_yaml
+      end
+    end
+
+    def self.all
+      YAML.load File.read(File.join(ENV['HOME'],'.hcl_tasks'))
+    end
+
+    def self.find project_id, id
+      all.detect {|t| t.project.id == project_id && t.id == id }
+    end
+
+    def to_s
+      "#{project.name} #{name}"
+    end
+
+    def start *args
+      notes = args.join ' '
+      days = DayEntry.from_xml Task.post("daily/add", <<-EOT)
+      <request>
+        <notes>#{notes}</notes>
+        <hours></hours>
+        <project_id type="integer">#{project.id}</project_id>
+        <task_id type="integer">#{id}</task_id>
+        <spent_at type="date">#{Date.today}</spent_at>
+      </request>
+      EOT
+      days.first
+    end
+
+  end
+end
+

data/lib/hcl/timesheet_resource.rb

@@ -0,0 +1,72 @@
+class HCl
+  class TimesheetResource
+    def self.configure opts = nil
+      if opts
+        self.login = opts['login']
+        self.password = opts['password']
+        self.subdomain = opts['subdomain']
+      else
+        yield self
+      end
+    end
+  
+    # configuration accessors
+    %w[ login password subdomain ].each do |config_var|
+      class_eval <<-EOC
+        def self.#{config_var}= arg
+          @@#{config_var} = arg
+        end
+        def self.#{config_var}
+          @@#{config_var}
+        end
+      EOC
+    end
+  
+    def initialize params
+      @data = params
+    end
+  
+    def self.get action
+      https_do Net::HTTP::Get, action
+    end
+
+    def self.post action, data
+      https_do Net::HTTP::Post, action, data
+    end
+
+    def self.https_do method_class, action, data = nil
+      https   = Net::HTTP.new "#{subdomain}.harvestapp.com", 443
+      request = method_class.new "/#{action}"
+      https.use_ssl = true
+      request.basic_auth login, password
+      request.content_type = 'application/xml'
+      request['Accept']    = 'application/xml'
+      response = https.request request, data
+      return response.body
+      if response.kind_of? Net::HTTPSuccess
+        response.body
+      else
+        raise 'failure'
+      end
+    end
+
+    def id
+      @data[:id]
+    end
+
+    def method_missing method, *args
+      if @data.key? method.to_sym
+        @data[method]
+      else
+        super
+      end
+    end
+
+    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
+      end
+    end
+  end
+end

data/lib/hcl.rb

@@ -0,0 +1,219 @@
+require 'yaml'
+require 'rexml/document'
+require 'net/http'
+require 'net/https'
+
+require 'chronic'
+require 'trollop'
+require 'highline/import'
+
+require 'hcl/timesheet_resource'
+require 'hcl/project'
+require 'hcl/task'
+require 'hcl/day_entry'
+
+# 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
+
+class HCl
+  VERSION_FILE = File.dirname(__FILE__) + '/../VERSION.yml'
+  SETTINGS_FILE = "#{ENV['HOME']}/.hcl_settings"
+  CONFIG_FILE = "#{ENV['HOME']}/.hcl_config"
+
+  class UnknownCommand < StandardError; end
+
+  def self.command *args
+    hcl = new.process_args(*args).run
+  end
+
+  def run
+    if @command
+      if respond_to? @command
+        send @command, *@args
+      else
+        raise UnknownCommand, "unrecognized command `#{@command}'"
+      end
+    else
+      show
+    end
+  end
+
+  def initialize
+    @version = YAML::load(File.read(VERSION_FILE))
+    read_config
+    read_settings
+  end
+
+  def version
+    [:major, :minor, :patch].map { |v| @version[v] }.join('.')
+  end
+
+  def process_args *args
+    version_string = version
+    Trollop::options(args) do
+      version "HCl #{version_string}"
+      stop_on %w[ show tasks set unset note add rm start stop ]
+      banner <<-EOM
+HCl is a command-line client for manipulating Harvest time sheets.
+
+Commands:
+    hcl show [date]
+    hcl tasks
+    hcl set <key> <value ...>
+    hcl start <task> [msg]
+    hcl stop [msg]
+    hcl note <msg>
+    hcl add <task> <duration> [msg]
+    hcl rm [entry_id]
+
+Examples:
+    $ hcl tasks
+    $ hcl start 1234 4567 this is my log message
+    $ hcl set task.mytask 1234 4567
+    $ hcl start mytask this is my next log message
+    $ hcl show yesterday
+    $ hcl show last tuesday
+
+Options:
+EOM
+    end
+    @command = args.shift
+    @args = args
+    self
+  end
+
+  def tasks
+    Task.all.each do |task|
+      # TODO more information and formatting options
+      puts "#{task.project.id} #{task.id}\t#{task}"
+    end
+  end
+
+  def read_config
+    if File.exists? CONFIG_FILE
+      config = YAML::load File.read(CONFIG_FILE)
+      TimesheetResource.configure config
+    elsif File.exists? old_conf = File.dirname(__FILE__) + "/../hcl_conf.yml"
+      config = YAML::load File.read(old_conf)
+      TimesheetResource.configure config
+      write_config config
+    else
+      config = {}
+      puts "Please specify your Harvest credentials.\n"
+      config['login'] = ask("Email Address: ")
+      config['password'] = ask("Password: ") { |q| q.echo = false }
+      config['subdomain'] = ask("Subdomain: ")
+      TimesheetResource.configure config
+      write_config config
+    end
+  end
+
+  def write_config config
+    puts "Writing configuration to #{CONFIG_FILE}."
+    File.open(CONFIG_FILE, 'w') do |f|
+     f.write config.to_yaml
+    end
+  end
+
+  def read_settings
+    if File.exists? SETTINGS_FILE
+      @settings = YAML.load(File.read(SETTINGS_FILE))
+    else
+      @settings = {}
+    end
+  end
+
+  def write_settings
+    File.open(SETTINGS_FILE, 'w') do |f|
+     f.write @settings.to_yaml
+    end
+  end
+
+  def set key = nil, *args
+    if key.nil?
+      @settings.each do |k, v|
+        puts "#{k}: #{v}"
+      end
+    else
+      value = args.join(' ')
+      @settings ||= {}
+      @settings[key] = value
+      write_settings
+    end
+  end
+
+  def unset key
+    @settings.delete key
+    write_settings
+  end
+
+  def start *args
+    ident = args.shift
+    task = if @settings["task.#{ident}"]
+      Task.find *@settings["task.#{ident}"].split(/\s+/)
+    else
+      Task.find ident, args.shift
+    end
+    task.start(*args)
+    puts "Started timer for #{task}"
+  end
+
+  def stop
+    entry = DayEntry.with_timer
+    if entry
+      entry.toggle
+      puts "Stopped #{entry}"
+    else
+      puts "No running timers found."
+    end
+  end
+
+  def note *args
+    message = args.join ' '
+    entry = DayEntry.with_timer
+    if entry
+      entry.append_note message
+      puts "Added note '#{message}' to #{entry}."
+    else
+      puts "No running timers found."
+    end
+  end
+
+  def show *args
+    date = args.empty? ? nil : Chronic.parse(args.join(' '))
+    total_hours = 0.0
+    DayEntry.all(date).each do |day|
+      # TODO more information and formatting options
+      running = day.running? ? '(running) ' : ''
+      puts "\t#{as_hours day.hours}\t#{running}#{day.project} #{day.notes}"[0..78]
+      total_hours = total_hours + day.hours.to_f
+    end
+    puts "\t" + '-' * 13
+    puts "\t#{as_hours total_hours}\ttotal"
+  end
+
+  # Convert from decimal to a string of the form HH:MM.
+  def as_hours hours
+    minutes = hours.to_f * 60.0
+    sprintf "%d:%02d", (minutes / 60).to_i, (minutes % 60).to_i
+  end
+
+  def not_implemented *args
+    puts "not yet implemented"
+  end
+
+  # TODO implement the following commands
+  alias add not_implemented
+  alias rm not_implemented
+
+end
+

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: zenhob-hcl
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Zack Hobson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-24 00:00:00 -07:00
+default_executable: hcl
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: termios
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: trollop
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.10.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: chronic
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: highline
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.1
+    version: 
+description: HCl is a command-line client for manipulating Harvest time sheets.
+email: zack@opensourcery.com
+executables: 
+- hcl
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .gitignore
+- .gitmodules
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION.yml
+- bin/hcl
+- hcl.gemspec
+- hcl_conf.yml.example
+- lib/hcl.rb
+- lib/hcl/day_entry.rb
+- lib/hcl/project.rb
+- lib/hcl/task.rb
+- lib/hcl/timesheet_resource.rb
+has_rdoc: true
+homepage: http://github.com/zenhob/hcl
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Harvest timesheets from the command-line
+test_files: []
+