harvest-ruby 0.1.1

data/History.txt

@@ -0,0 +1,6 @@
+=== 0.1.1 / 2008-04-15
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,7 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/harvest.rb
+lib/harvest_entry.rb
+spec/harvest_spec.rb

data/README.txt

@@ -0,0 +1,75 @@
+= harvest-ruby
+
+http://github.com/bricooke/harvest-ruby
+
+== DESCRIPTION:
+
+Ruby wrapper around the Harvest API 
+http://www.getharvest.com/api
+
+== SYNOPSIS:
+
+harvest = Harvest.new("company.harvestapp.com", "email@example.com", "password")
+
+harvest.users[0].last_name
+=> "email@example.com"
+
+harvest.users[0].created_at
+=> "Fri May 11 15:00:08 EDT 2007"
+
+harvest.projects[0].name
+=> "Best Project Ever"
+
+harvest.tasks[0].name
+=> "Project Management"
+
+harvest.tasks(59273).name
+=> "Project Management"
+
+Fetch all entries and expenses for a project:
+harvest.report(5.years.ago, Time.now, :project_id => 6)
+
+or to filter on person:
+harvest.report(5.years.ago, Time.now, :person_id => 555)
+
+or to filter on both:
+harvest.report(5.years.ago, Time.now, :person_id => 555, :project_id => 6)
+
+
+== REQUIREMENTS:
+
+activesupport xml-simple
+
+== INSTALL:
+
+sudo gem install harvest-ruby
+
+== TODO:
+
+* Specs
+* Document the public API for rdocs
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Brian Cooke
+
+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/Rakefile

@@ -0,0 +1,22 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/harvest.rb'
+require 'spec/rake/spectask'
+
+
+Hoe.new('harvest-ruby', Harvest::VERSION) do |p|
+  p.rubyforge_name = 'harvest-ruby' # if different than lowercase project name
+  p.developer('Brian Cooke', 'bcooke@roobasoft.com')
+end
+
+
+desc "Run specifications"
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_opts = ["--format", "specdoc", "--colour"]
+  t.spec_files = './spec/**/*_spec.rb'
+end
+
+
+# vim: syntax=Ruby

data/lib/harvest.rb

@@ -0,0 +1,93 @@
+require 'rubygems'
+require 'net/http'
+require 'xmlsimple'
+require 'activesupport'
+require File.dirname(__FILE__) + '/harvest_entry'
+
+class Harvest
+  VERSION = '0.1.1'
+  @tasks = []
+  @expenses = []
+  
+  def initialize(domain, email, password)
+    @domain = domain
+    @email = email
+    @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 = []
+    
+    %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
+  
+  # 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
+  def request(path, params={})
+    request = Net::HTTP::Get.new(path, { "Accept" => "application/xml"})
+    request.basic_auth(@email, @password)
+    request.content_type = "application/xml"
+    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
+  end
+end

data/lib/harvest_entry.rb

@@ -0,0 +1,46 @@
+class HarvestEntry
+  def initialize(parsed)
+    @hash = parsed
+  end
+  
+  def id
+    self.method_missing(:id)
+  end
+  
+  def empty?
+    if @hash["type"] == "array" && @hash["content"] == "\n"
+      true
+    else
+      false 
+    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
+    
+    if @hash.has_key?(method.to_s.singularize)
+      entry = @hash[method.to_s.singularize]
+      if method.to_s.pluralize == method.to_s && entry.class == Array
+        return entry.collect {|e| HarvestEntry.new(e)}
+      else
+        return entry[0] unless entry[0].class == Hash && entry[0].has_key?("content")
+        return entry[0]["content"]
+      end
+    elsif @hash.has_key?(method.to_s)
+      entry = @hash[method.to_s]
+      return entry[0] unless entry[0].class == Hash && entry[0].has_key?("content")
+      return entry[0]["content"]
+    else
+      super 
+    end
+  end
+end

data/spec/harvest_spec.rb

@@ -0,0 +1,6 @@
+require './lib/harvest'
+
+describe "Harvest" do
+  it "should do some things"
+end
+

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: harvest-ruby
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Brian Cooke
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-04-15 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.1
+    version: 
+description: Ruby wrapper around the Harvest API  http://www.getharvest.com/api
+email: 
+- bcooke@roobasoft.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/harvest.rb
+- lib/harvest_entry.rb
+- spec/harvest_spec.rb
+has_rdoc: true
+homepage: http://github.com/bricooke/harvest-ruby
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+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: harvest-ruby
+rubygems_version: 1.1.1
+signing_key: 
+specification_version: 2
+summary: Ruby wrapper around the Harvest API  http://www.getharvest.com/api
+test_files: []
+