@@ -5,7 +5,9 @@ require 'activesupport' require File.dirname(__FILE__) + '/harvest_entry' class Harvest - VERSION = '0.1.0' + VERSION = '0.1.1' + @tasks = [] + @expenses = [] def initialize(domain, email, password) @domain = domain @@ -13,33 +15,64 @@ class Harvest @password = password end + # returns all the users created in this Harvest account + # see http://www.getharvest.com/api/people for data available def users(params={}) request("/people", params).users end + # returns all the projects created in this Harvest account + # see http://www.getharvest.com/api/projects for data available def projects request("/projects").projects end + # returns all tasks and expenses for a given project or person + # in the given time period. The expenses and entries are + # mixed in the same array returned. Use .expense? to determine + # what type it is. Reference http://www.getharvest.com/api/reporting + # to get data available for each type def report(from, to, project_and_or_person_id) entries = [] - if project_and_or_person_id.has_key?(:project_id) - entries += request("/projects/#{project_and_or_person_id[:project_id]}/entries?from=#{from.strftime("%Y%m%d")}&to=#{to.strftime("%Y%m%d")}").day_entries - end - if project_and_or_person_id.has_key?(:person_id) - entries += request("/people/#{project_and_or_person_id[:person_id]}/entries?from=#{from.strftime("%Y%m%d")}&to=#{to.strftime("%Y%m%d")}").day_entries - end + %w(entries expenses).each do |type| + if project_and_or_person_id.has_key?(:project_id) + t = request("/projects/#{project_and_or_person_id[:project_id]}/#{type}?from=#{from.strftime("%Y%m%d")}&to=#{to.strftime("%Y%m%d")}") + temp = (type == "entries" ? t.day_entries : t.expenses) + entries += temp.select {|entry| !(entries.any? {|match| match.id == entry.id })} + end + if project_and_or_person_id.has_key?(:person_id) + t = request("/people/#{project_and_or_person_id[:person_id]}/#{type}?from=#{from.strftime("%Y%m%d")}&to=#{to.strftime("%Y%m%d")}") + temp = (type == "entries" ? t.day_entries : t.expenses) + entries += temp.select {|entry| !(entries.any? {|match| match.id == entry.id })} + end + end entries end - def tasks(task_id=nil) - if task_id.nil? - request("/tasks").tasks - else - request("/tasks/#{task_id}") - end + # returns all tasks and caches the results + # see http://www.getharvest.com/api/tasks + def tasks + @tasks ||= request("/tasks").tasks + end + + # return a specific task + # see http://www.getharvest.com/api/tasks + def task(id) + self.tasks.find {|t| t.id.to_i == id.to_i} + end + + # returns all expense categories and caches the results + # see http://www.getharvest.com/api/expenses + def expense_categories + @expense_categories ||= request("/expense_categories").expense_categories + end + + # returns a specific expense_category + # see http://www.getharvest.com/api/expenses + def expense_category(id) + self.expense_categories.find {|e| e.id.to_i == id.to_i} end private @@ -50,6 +83,9 @@ private ret = nil Net::HTTP.new(@domain).start {|http| response = http.request(request) + if response.class == Net::HTTPServiceUnavailable + raise ArgumentError, "API Limit exceeded. Retry after #{response["Retry-After"].to_i/60} minutes." + end ret = HarvestEntry.new(XmlSimple.xml_in(response.body)) } ret lib/harvest.rb @@ -15,6 +15,15 @@ class HarvestEntry end end + def expense? + begin + self.expense_category_id + true + rescue + false + end + end + def method_missing(method, *args) method = method.to_s.gsub("_", "-").to_sym lib/harvest_entry.rb 5a5ef6d1f57704f4dec654dd2555c4e9ddf1cbd9 Brian Cooke bcooke@roobasoft.com http://github.com/bricooke/harvest-ruby/commit/afcce7c82561f7c1d9c385772aa2e11bea720259 afcce7c82561f7c1d9c385772aa2e11bea720259 2008-04-14T20:29:57-07:00 2008-04-14T20:29:57-07:00 0.1.1. minimal documentation. support for expense_categories. fix duplicates reported in report. support getting the Retry-After cfc0323dd4cc294fbe6dbc89fd1adb463d42306d Brian Cooke bcooke@roobasoft.com