harvest 0.8.2

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

data/lib/harvest/resources/expense_category.rb

@@ -0,0 +1,7 @@
+module Harvest
+  module Resources
+    class ExpenseCategory < Harvest::HarvestResource
+      
+    end
+  end
+end

data/lib/harvest/resources/person.rb

@@ -0,0 +1,44 @@
+module Harvest
+  module Resources
+    class Person < Harvest::HarvestResource
+      include Harvest::Plugins::Toggleable
+      
+      # Find all entries for the given person;
+      # options[:from] and options[:to] are required;
+      # include options[:user_id] to limit by a specific project.
+      def entries(options={})
+        validate_options(options)
+        entry_class = Harvest::Resources::Entry.clone
+        entry_class.person_id = self.id
+        entry_class.find :all, :params => format_params(options)
+      end
+      
+      def expenses(options={})
+        validate_options(options)
+        expense_class = Harvest::Resources::Expense.clone
+        expense_class.person_id = self.id
+        expense_class.find :all, :params => format_params(options)
+      end
+      
+      private
+      
+        def validate_options(options)
+          if [:from, :to].any? {|key| !options[key].respond_to?(:strftime) }
+            raise ArgumentError, "Must specify :from and :to as dates."
+          end
+          
+          if options[:from] > options[:to]
+            raise ArgumentError, ":start must precede :end."
+          end
+        
+        end
+        def format_params(options)
+          ops = { :from => options[:from].strftime("%Y%m%d"),
+                  :to   => options[:to].strftime("%Y%m%d")}
+          ops[:project_id] = options[:project_id] if options[:project_id]
+          return ops
+        end
+      
+    end
+  end
+end

data/lib/harvest/resources/project.rb

@@ -0,0 +1,51 @@
+module Harvest
+  module Resources
+    # Supports the following:
+    class Project < Harvest::HarvestResource
+      include Harvest::Plugins::Toggleable
+      
+      def users
+        user_class = Harvest::Resources::UserAssignment.clone
+        user_class.project_id = self.id
+        user_class
+      end
+      
+      def tasks
+        task_class = Harvest::Resources::TaskAssignment.clone
+        task_class.project_id = self.id
+        task_class
+      end
+      
+      # Find all entries for the given project;
+      # options[:from] and options[:to] are required;
+      # include options[:user_id] to limit by a specific user.
+      #   
+      def entries(options={})
+        validate_entries_options(options)
+        entry_class = Harvest::Resources::Entry.clone
+        entry_class.project_id = self.id
+        entry_class.find :all, :params => format_params(options)
+      end
+      
+      private
+      
+        def validate_entries_options(options)
+          if [:from, :to].any? {|key| !options[key].respond_to?(:strftime) }
+            raise ArgumentError, "Must specify :from and :to as dates."
+          end
+          
+          if options[:from] > options[:to]
+            raise ArgumentError, ":start must precede :end."
+          end
+        end
+        
+        def format_params(options)
+          ops = { :from => options[:from].strftime("%Y%m%d"),
+                  :to   => options[:to].strftime("%Y%m%d")}
+          ops[:user_id] = options[:user_id] if options[:user_id]
+          return ops
+        end
+          
+    end
+  end
+end

data/lib/harvest/resources/task.rb

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

data/lib/harvest/resources/task_assignment.rb

@@ -0,0 +1,27 @@
+# This class is accessed by an instance of Project.
+module Harvest
+  module Resources
+    class TaskAssignment < Harvest::HarvestResource
+            
+      self.element_name = "task_assignment"
+      
+      class << self
+        
+        def project_id=(id)
+          @project_id = id
+          set_site
+        end
+        
+        def project_id
+          @project_id
+        end
+        
+        def set_site
+          self.site = self.site + "/projects/#{self.project_id}"
+        end
+        
+      end
+      
+    end
+  end
+end

data/lib/harvest/resources/user_assignment.rb

@@ -0,0 +1,27 @@
+# This class is accessed by an instance of Project.
+module Harvest
+  module Resources
+    class UserAssignment < Harvest::HarvestResource
+            
+      self.element_name = "user_assignment"
+      
+      class << self
+        
+        def project_id=(id)
+          @project_id = id
+          set_site
+        end
+        
+        def project_id
+          @project_id
+        end
+        
+        def set_site
+          self.site = self.site + "/projects/#{self.project_id}"
+        end
+        
+      end
+      
+    end
+  end
+end

data/test/integration/client_integration.rb

@@ -0,0 +1,17 @@
+class ClientIntegration < Test::Unit::TestCase
+
+  def test_should_create_and_update_a_new_client 
+    # create
+    client = $harvest.clients.new
+    client.name    = "HarvestGem, INC"
+    client.details = "New York, NY"
+    client.save
+    $test_client = $harvest.clients.find(:all).detect {|c| c.name == "HarvestGem, INC"}
+    
+    #update
+    client.details = "San Francisco, CA"
+    client.save
+    assert_equal "San Francisco, CA", $harvest.clients.find($test_client.id).details
+  end
+  
+end

data/test/integration/client_teardown.rb

@@ -0,0 +1,11 @@
+class ClientTeardown < Test::Unit::TestCase
+
+  def test_should_destroy_the_client
+    client = $harvest.clients.find($test_client.id)
+    client.destroy
+    assert_raise ActiveResource::ResourceNotFound do 
+      $harvest.clients.find($test_client)
+    end
+  end
+        
+end

data/test/integration/expense_category_integration.rb

@@ -0,0 +1,16 @@
+class ExpenseCategoryIntegration < Test::Unit::TestCase
+
+  def test_should_create_and_update_a_new_expense_category 
+    # create
+    expense_category = $harvest.expense_categories.new
+    expense_category.name    = "GemEntertainmentBeforeUpdate"
+    expense_category.save
+    $test_expense_category = $harvest.expense_categories.find(:all).detect {|c| c.name == "GemEntertainmentBeforeUpdate"}
+    
+    #update
+    expense_category.name = "GemEntertainment"
+    expense_category.save
+    assert_equal "GemEntertainment", $harvest.expense_categories.find(:all).detect {|c| c.name == "GemEntertainment"}.name
+  end
+  
+end

data/test/integration/expense_category_teardown.rb

@@ -0,0 +1,12 @@
+class ExpenseCategoryTeardown < Test::Unit::TestCase
+  
+  def test_should_destroy_the_expense_category
+    expense_category = $harvest.expense_categories.find(:all).detect {|c| c.name == "GemEntertainment"}
+    expense_category.destroy
+    assert_raise ActiveResource::ResourceNotFound do 
+      $harvest.expense_categories.find($test_expense_category)
+    end
+  end
+  
+end
+  

data/test/integration/harvest_integration_test.rb

@@ -0,0 +1,47 @@
+$:.unshift File.dirname(__FILE__)
+$test_mode = :integration
+
+require File.join(File.dirname(__FILE__), "..", "test_helper")
+require "test/unit/testsuite"
+require "test/unit/ui/console/testrunner"
+
+require "client_integration"
+require "client_teardown"
+require "expense_category_integration"
+require "expense_category_teardown"
+require "project_integration"
+require "project_teardown"
+require "task_integration"
+require "task_teardown"
+
+
+# Make sure that credentials have been specified:
+if [:email, :password, :sub_domain].any? { |k| $integration_credentials[k].nil? }
+  raise ArgumentError, "Integration test cannot be run without login credentials; Please specify in test/test_helper.rb"
+end
+
+# Initialize a harvest object with credentials.
+$harvest = Harvest($integration_credentials)
+
+# Global variables to hold resources
+# for later reference.
+$test_client  = nil
+$test_project = nil
+$test_person  = nil
+   
+class HarvestIntegration
+  def self.suite
+    suite = Test::Unit::TestSuite.new
+    suite << ExpenseCategoryIntegration.suite
+    suite << TaskIntegration.suite
+    suite << ClientIntegration.suite
+    suite << ProjectIntegration.suite
+    suite << ProjectTeardown.suite
+    suite << ClientTeardown.suite
+    suite << TaskTeardown.suite
+    suite << ExpenseCategoryTeardown.suite
+    return suite
+  end
+end
+
+Test::Unit::UI::Console::TestRunner.run(HarvestIntegration)

data/test/integration/project_integration.rb

@@ -0,0 +1,19 @@
+class ProjectIntegration < Test::Unit::TestCase
+  
+  def test_should_create_and_update_a_new_project
+    # create
+    project = $harvest.projects.new
+    project.name    = "HarvestGem Project"
+    project.active  = false
+    project.bill_by = "None"
+    project.client_id = $test_client.id
+    project.save
+    
+    # update
+    $test_project = $harvest.projects.find(:all).detect {|c| c.name == "HarvestGem Project"}
+    project.active = true
+    project.save
+    assert $harvest.projects.find($test_project.id).active?
+  end
+
+end

data/test/integration/project_teardown.rb

@@ -0,0 +1,12 @@
+class ProjectTeardown < Test::Unit::TestCase
+  
+  def test_should_destroy_the_project
+    project = $harvest.projects.find($test_project.id)
+    project.destroy
+    assert_raise ActiveResource::ResourceNotFound do 
+      $harvest.projects.find($test_project)
+    end
+  end
+  
+end
+  

data/test/integration/task_integration.rb

@@ -0,0 +1,19 @@
+class TaskIntegration < Test::Unit::TestCase
+  
+  def test_should_create_and_update_a_new_task
+    # create
+    task = $harvest.tasks.new
+    task.billable_by_default  = false
+    task.default_hourly_rate  = 100
+    task.is_default           = false
+    task.name                 = "GemIntegration"
+    task.save
+    
+    # update
+    $test_task = $harvest.tasks.find(:all).detect {|t| t.name == "GemIntegration"}
+    task.name = "GemIntegrationUpdated"
+    task.save
+    assert_equal "GemIntegrationUpdated", $harvest.tasks.find($test_task.id).name
+  end
+
+end

data/test/integration/task_teardown.rb

@@ -0,0 +1,12 @@
+class TaskTeardown < Test::Unit::TestCase
+  
+  def test_should_destroy_the_task
+    task = $harvest.tasks.find($test_task.id)
+    task.destroy
+    assert_raise ActiveResource::ResourceNotFound do 
+      $harvest.tasks.find($test_task)
+    end
+  end
+  
+end
+  

data/test/test_helper.rb

@@ -0,0 +1,51 @@
+require "rubygems"
+require "active_resource"
+require "active_resource_throttle"
+require "test/unit"
+require "shoulda"
+require "mocha"
+
+# The integration test will not run by default.
+# To run it, type:
+#   rake test:integration
+#
+# If running the integration test, login credentials
+# must be specified here. The integration test verifies
+# that various resources in a Harvest account can be created, 
+# deleted, updated, destroyed, etc.
+#
+# It's best to run this test on a trial account, where no 
+# sensitive data can be manipulated.
+#
+# Leave these values nil if not running the integration test.
+$integration_credentials = {:email      => nil,
+                            :password   => nil,
+                            :sub_domain => nil}
+
+require File.join(File.dirname(__FILE__), "..", "lib", "harvest.rb")
+
+# Disengage throttling if in unit test mode (Integration test needs throttling).
+if ($test_mode ||= :unit) == :unit
+  require "active_resource/http_mock"
+  Harvest::HarvestResource.throttle(:interval => 0, :requests => 0)
+  Harvest::HarvestResource.site = "http://example.com/"
+end
+
+# Load all available resources.
+ResourcesPath = File.join(File.dirname(__FILE__), "..", "lib", "harvest", "resources")
+Harvest.load_all_ruby_files_from_path(ResourcesPath)
+
+# Custom assert_raise to test exception message in addition to the exception itself.
+class Test::Unit::TestCase
+  def assert_raise_plus(exception_class, exception_message, message=nil, &block)
+    begin
+      yield
+    rescue => e
+      error_message = build_message(message, '<?>, <?> expected but was <?>, <?>', exception_class, exception_message, e.class, e.message)
+      assert_block(error_message) { e.class == exception_class && e.message == exception_message }
+    else
+      error_message = build_message(nil, '<?>, <?> expected but raised nothing.', exception_class, exception_message)
+      assert_block(error_message) { false }
+    end
+  end
+end

data/test/unit/base_test.rb

@@ -0,0 +1,88 @@
+require File.join(File.dirname(__FILE__), "..", "test_helper")
+
+class BaseTest < Test::Unit::TestCase
+    
+  context "A Harvest object" do 
+    setup do 
+      @password   = "secret"
+      @email      = "james@example.com"
+      @sub_domain = "bond"
+      @headers    = {"User-Agent" => "HarvestGemTest"}
+      @harvest    = Harvest::Base.new(:email      => @email, 
+                                      :password   => @password, 
+                                      :sub_domain => @sub_domain,
+                                      :headers    => @headers)
+    end
+    
+    should "initialize the resource base class" do
+      assert_equal "http://bond.harvestapp.com", Harvest::HarvestResource.site.to_s
+      assert_equal @password, Harvest::HarvestResource.password
+      assert_equal @email,    Harvest::HarvestResource.user
+    end
+        
+    should "raise an error if sub_domain is missing" do
+      assert_raise_plus ArgumentError, "Missing required option(s): sub_domain" do
+        Harvest(:email => "joe@example.com", :password => "secret")
+      end
+    end
+    
+    should "raise an error if password is missing" do
+      assert_raise_plus ArgumentError, "Missing required option(s): password" do
+        Harvest(:email => "joe@example.com", :sub_domain => "time")
+      end
+    end
+    
+    should "raise an error if email is missing" do
+      assert_raise_plus ArgumentError, "Missing required option(s): email" do
+        Harvest(:password => "secret", :sub_domain => "time")
+      end
+    end
+    
+    should "set the headers" do
+      assert_equal @headers, Harvest::HarvestResource.headers
+    end
+    
+    should "return the Client class" do
+      assert_equal Harvest::Resources::Client, @harvest.clients
+    end
+    
+    should "return the Expense class" do
+      assert_equal Harvest::Resources::Expense, @harvest.expenses
+    end
+    
+    should "return the ExpenseCategory class" do
+      assert_equal Harvest::Resources::ExpenseCategory, @harvest.expense_categories
+    end
+    
+    should "return the Person class" do
+      assert_equal Harvest::Resources::Project, @harvest.projects
+    end
+    
+    should "return the Project class" do
+      assert_equal Harvest::Resources::Project, @harvest.projects
+    end
+    
+    should "return the Task class" do
+      assert_equal Harvest::Resources::Task, @harvest.tasks
+    end
+    
+    context "with SSL enabled" do
+      setup do
+        @harvest = Harvest::Base.new(:email      => @email,
+                                     :password   => @password,
+                                     :sub_domain => @sub_domain,
+                                     :headers    => @headers,
+                                     :ssl        => true)
+      end
+
+      should "have https in URL" do
+        assert_equal "https://bond.harvestapp.com", Harvest::HarvestResource.site.to_s
+      end
+    end
+    
+    context "who_am_i" do
+      @person = @harvest.who_am_i
+    end
+  end
+  
+end