aiaio-harvest 0.8

data/HISTORY

@@ -0,0 +1,3 @@
+0.8 (December 10, 2008)
+  First version
+

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2008, Kyle Banker, Alexander Interactive, Inc.
+
+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.
+
+Except as contained in this notice, the name(s) of the above copyright holders 
+shall not be used in advertising or otherwise to promote the sale, use or other 
+dealings in this Software without prior written authorization.
+
+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.rdoc

@@ -0,0 +1,146 @@
+= harvest
+
+A ruby library wrapping (most of) the Harvest Api.
+
+== DESCRIPTION:
+
+This library uses ActiveResource and activeresource_throttle to provide simple, reliable access to the Harvest Api.  Good for building reporting scripts and simple apps.
+
+Note that this library does not support the complete Harvest Api at this time. See Features/Issues below for details.
+
+== USAGE:
+
+=== Creating a new harvest object:
+
+All calls to the Harvest API will originate from a Harvest object. Initialize it like so:
+
+  @harvest = Harvest(:email      => "joe@example.com", 
+                     :password   => "secret", 
+                     :sub_domain => "joeandcompany",
+                     :headers    => {"User-Agent" => "MyCompany"})
+                     
+The _headers_ argument is optional.
+                       
+=== Clients
+
+Index
+  @harvest.clients.find(:all)
+Show
+  @harvest.clients.find(43235)
+Create
+  @client = @harvest.clients.new
+  @client.attributes = {:name => "Company, LLC", :details => "New York, NY"}
+  @client.save
+Update
+  @client.first_name = "Smith"
+  @client.save
+Destroy
+  @client.destroy
+
+Toggle (Active/Inactive)
+  @client.toggle
+  
+=== Tasks
+
+Index
+  @harvest.tasks.find(:all)
+Show
+  @harvest.tasks.find(123)
+Create
+  @task = @harvest.tasks.new
+  @task.attributes = {:name => "Meeting",   :billable_by_default => false,
+                      :is_default => false, :default_hourly_rate => 100}
+  @task.save
+Update
+  @task.name = "Client Meeting"
+  @task.save
+Destroy
+  @task.destroy
+  
+=== People
+
+Index
+  @harvest.people.find(:all)
+Show
+  @harvest.people.find(123)
+  
+=== Projects
+
+Index
+  @harvest.projects.find(:all)
+Show
+  @harvest.projects.find(123)
+Create
+  @project = @harvest.projects.new
+  @project.attributes = {:name => "Refactor", :active => true, 
+                         :bill_by => "None", :client_id => @client.id, }
+  @project.save
+Update
+  @project.name = "Mega-Refactor"
+  @project.save
+Destroy
+  @project.destroy
+
+Toggle (Active/Inactive)
+  @project.toggle
+    
+==== User and Task Assignments
+
+  @project.users.find(:all)
+  @project.users.find(:first)
+  
+  @project.tasks.find(:all)
+  @project.tasks.find(:first)
+  
+=== Reports
+
+  @project.entries(:from => Time.now, :to => Time.now)
+  @project.entries(:from => Time.now, :to => Time.now, :user_id => @person.id)
+  
+  @person.entries(:from => Time.now, :to => Time.now)
+  @person.expenses(:from => Time.now, :to => Time.now)
+  
+== FEATURES/PROBLEMS:
+
+Supports most of the Harvest Api (http://www.getharvest.com/api).
+
+Though RESTful, the Harvest Api does not entirely follow ActiveResource conventions. In order to support the complete API, certain customizations will be required. <b>We welcome any contributions/modifications to help complete this Api.</b>
+
+The following Api features are incomplete due to incompatibilities with ActiveResource conventions (CRUD actions in parentheses):
+
+1. People (CUD)
+2. User & Task Assignments (CUD)
+3. Expenses (CUD)
+
+In addition, the following have not been implemented at all due to time constraints:
+
+1. Time Tracking Api
+2. Invoices, Invoice Payments, Invoice Categories, and Invoice Messages 
+
+Expect a more complete library in the near future. Again, contributions are welcome.
+
+== TEST SUITE
+
+This library includes a fairly thorough set of unit and integration tests. The unit tests can be run with the "rake" command.
+
+The integration tests require a Harvest account. It is best to use a trial account when running these tests.
+
+The credentials may be entered in test/test_helper.rb. To run the integration suite:
+
+  rake test:integration
+  
+Note that the integration test structure is somewhat unorthodox, as it requires tests to run in a particular order. The main test file is test/integration/harvest_integration_test.rb. Examine this to see how the integration suite works.
+  
+== REQUIREMENTS:
+
+Requires active_resource >= 2.1 and activeresource_throttle >= 1.0.
+
+active_resource_throttle should install automaticallt, but just in case you need to install manually:
+
+  gem sources -a http://gems.github.com
+  sudo gem install aiaio-active_resource_throttle 
+
+== INSTALL:
+  
+  gem sources -a http://gems.github.com
+  gem install aiaio-harvest

data/Rakefile

@@ -0,0 +1,44 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require './lib/harvest.rb'
+
+desc 'Default: run all tests.'
+task :default => :test_all
+
+namespace :test do
+
+  Rake::TestTask.new(:resources) do |t|
+    t.libs << 'lib'
+    t.pattern = 'test/unit/resources/*_test.rb'
+    t.verbose = false
+  end
+  
+  Rake::TestTask.new(:base) do |t|
+    t.libs << 'lib'
+    t.pattern = 'test/unit/*_test.rb'
+    t.verbose = false
+  end
+  
+  Rake::TestTask.new(:integration) do |t|
+    t.libs << 'lib'
+    t.pattern = 'test/integration/*_test.rb'
+    t.verbose = false
+  end
+
+end
+
+desc "Test everything."
+task :test_all do
+  errors = %w(test:resources test:base).collect do |task|
+    begin
+      Rake::Task[task].invoke
+      nil
+    rescue => e
+      task
+    end
+  end.compact
+  abort "Errors running #{errors.to_sentence}!" if errors.any?
+end

data/lib/harvest.rb

@@ -0,0 +1,36 @@
+module Harvest
+  VERSION   = "0.8"
+  ApiDomain = "harvestapp.com"
+  
+  # Class method to load all ruby files from a given path.
+  def self.load_all_ruby_files_from_path(path)
+    Dir.foreach(path) do |file|
+      require File.join(path, file) if file =~ /\.rb/
+    end
+  end
+  
+end
+
+# Gems
+require "rubygems"
+require "activeresource"
+require "active_resource_throttle"
+
+# Plugins
+PluginPath = File.join(File.dirname(__FILE__), "harvest", "plugins")
+Harvest.load_all_ruby_files_from_path(PluginPath)
+
+# Base
+require File.join(File.dirname(__FILE__), "harvest", "base")
+require File.join(File.dirname(__FILE__), "harvest", "harvest_resource")
+
+# Shortcut for Harvest::Base.new
+#
+# Example:
+# Harvest(:email      => "jack@exampe.com", 
+#         :password   => "secret", 
+#         :sub_domain => "frenchie",
+#         :headers    => {"User-Agent => "Harvest Rubygem"})
+def Harvest(options={})
+  Harvest::Base.new(options)
+end

data/lib/harvest/base.rb

@@ -0,0 +1,71 @@
+module Harvest
+  class Base
+   
+    # Requires a sub_domain, email, and password.
+    # Specifying headers is optional, but useful for setting a user agent.
+    def initialize(options={})
+      options.assert_valid_keys(:email, :password, :sub_domain, :headers)
+      options.assert_required_keys(:email, :password, :sub_domain)
+      @email        = options[:email]
+      @password     = options[:password]
+      @sub_domain   = options[:sub_domain]
+      @headers      = options[:headers]
+      configure_base_resource
+    end
+    
+    # Below is a series of proxies allowing for easy
+    # access to the various resources.
+    
+    # Clients
+    def clients
+      Harvest::Resources::Client
+    end
+    
+    # Expenses.
+    def expenses
+      Harvest::Resources::Expense
+    end
+    
+    # Expense categories.
+    def expense_categories
+      Harvest::Resources::ExpenseCategory
+    end
+    
+    # People.
+    # Also provides access to time entries.
+    def people
+      Harvest::Resources::Person
+    end
+    
+    # Projects.
+    # Provides access to the assigned users and tasks
+    # along with reports for entries on the project.
+    def projects
+      Harvest::Resources::Project
+    end
+    
+    # Tasks.
+    def tasks
+      Harvest::Resources::Task
+    end
+
+    private
+    
+      # Configure resource base class so that 
+      # inherited classes can access the api.
+      def configure_base_resource
+        HarvestResource.site     = "http://#{@sub_domain}.#{Harvest::ApiDomain}"
+        HarvestResource.user     = @email
+        HarvestResource.password = @password
+        HarvestResource.headers.update(@headers) if @headers.is_a?(Hash)
+        load_resources
+      end
+      
+      # Load the classes representing the various resources.
+      def load_resources
+        resource_path = File.join(File.dirname(__FILE__), "resources")
+        Harvest.load_all_ruby_files_from_path(resource_path)
+      end
+                
+  end
+end

data/lib/harvest/harvest_resource.rb

@@ -0,0 +1,15 @@
+module Harvest
+  # This is the base class from which all resource
+  # classes inherit. Site and authentication params
+  # are loaded into this class when a Harvest::Base
+  # object is initialized.
+  class HarvestResource < ActiveResource::Base
+    include ActiveResourceThrottle
+    include Harvest::Plugins::ActiveResourceInheritableHeaders
+    
+    # The harvest api will block requests in excess
+    # of 40 / 15 seconds. Adds a throttle (with cautious settings). 
+    # Throttle feature provided by activeresource_throttle gem.
+    self.throttle(:requests => 30, :interval => 15, :sleep_interval => 60)
+  end
+end

data/lib/harvest/plugins/active_resource_inheritable_headers.rb

@@ -0,0 +1,36 @@
+# Allows headers in an ActiveResource::Base class
+# to be inherited by subclasses.  Useful for setting
+# a User-Agent used by all resources.
+module Harvest
+  module Plugins
+    module ActiveResourceInheritableHeaders
+        
+      module ClassMethods
+        
+        # If headers are not defined in a
+        # given subclass, then obtain headers
+        # from the superclass.
+        def inheritable_headers
+          if defined?(@headers)
+            @headers
+          elsif superclass != Object && superclass.headers
+            superclass.headers
+          else
+            @headers ||= {}
+          end
+        end
+        
+      end
+      
+      def self.included(klass)
+        klass.instance_eval do
+          klass.extend ClassMethods
+          class << self
+            alias_method :headers, :inheritable_headers
+          end
+        end
+      end
+    
+    end
+  end
+end

data/lib/harvest/plugins/toggleable.rb

@@ -0,0 +1,12 @@
+# Adds toggability to a harvest resource.
+module Harvest
+  module Plugins
+    module Toggleable
+        
+      def toggle
+        put(:toggle)
+      end
+    
+    end
+  end
+end

data/lib/harvest/resources/client.rb

@@ -0,0 +1,8 @@
+module Harvest
+  module Resources
+    class Client < Harvest::HarvestResource
+      include Harvest::Plugins::Toggleable
+                  
+    end
+  end
+end

data/lib/harvest/resources/entry.rb

@@ -0,0 +1,34 @@
+# The entry resource is never accessed directly;
+# rather, it is manipulated through an instance
+# of Project or Person.
+module Harvest
+  module Resources
+    class Entry < Harvest::HarvestResource
+      
+      self.element_name = "entry"
+
+      class << self
+        
+        def project_id=(id)
+          @project_id = id
+          self.site = self.site + "/projects/#{@project_id}"
+        end
+        
+        def project_id
+          @project_id
+        end
+        
+        def person_id=(id)
+          @person_id = id
+          self.site = self.site + "/people/#{@person_id}"
+        end
+        
+        def person_id
+          @person_id
+        end
+        
+      end
+                  
+    end
+  end
+end

data/lib/harvest/resources/expense.rb

@@ -0,0 +1,22 @@
+module Harvest
+  module Resources
+    class Expense < Harvest::HarvestResource
+      
+      self.element_name = "expense"
+      
+      class << self
+      
+        def person_id=(id)
+          @person_id = id
+          self.site = self.site + "/people/#{@person_id}"
+        end
+        
+        def person_id
+          @person_id
+        end
+        
+      end
+                  
+    end
+  end
+end