supaspoida-harvest 0.8.2

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,84 @@
+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
+  end
+  
+end

data/test/unit/resources/client_test.rb

@@ -0,0 +1,82 @@
+require File.join(File.dirname(__FILE__), "..", "..", "test_helper")
+
+class ClientTest < Test::Unit::TestCase
+  
+  def setup_resources
+    @client  =  {:id => 1, :name => "Widgets&Co"}.to_xml(:root => "client")
+    @clients = [{:id => 1, :name => "Widgets&Co"}].to_xml(:root => "clients") 
+  end
+  
+  def mock_client_responses
+    ActiveResource::HttpMock.respond_to do |mock|
+      mock.get    "/clients.xml",          {}, @clients
+      mock.get    "/clients/1.xml",        {}, @client
+      mock.post   "/clients.xml",          {}, @client, 201, "Location" => "/clients/5.xml"
+      mock.put    "/clients/1.xml",        {}, nil,     200
+      mock.delete "/clients/1.xml",        {}, nil,     200
+      mock.put    "/clients/1/toggle.xml", {}, nil, 200
+    end
+  end
+  
+  context "Client actions" do 
+    setup do 
+      setup_resources
+      mock_client_responses
+    end
+    
+    should "get index" do 
+      Harvest::Resources::Client.find(:all)
+      expected_request = ActiveResource::Request.new(:get, "/clients.xml")
+      assert ActiveResource::HttpMock.requests.include?(expected_request)
+    end
+    
+    should "get a single client" do 
+      Harvest::Resources::Client.find(1)
+      expected_request = ActiveResource::Request.new(:get, "/clients/1.xml")
+      assert ActiveResource::HttpMock.requests.include?(expected_request)
+    end
+    
+    should "create a new client" do 
+      client = Harvest::Resources::Client.new(:name => "Widgets&Co")
+      client.save
+      expected_request = ActiveResource::Request.new(:post, "/clients.xml")
+      assert ActiveResource::HttpMock.requests.include?(expected_request)
+    end
+    
+    should "update an existing client" do 
+      client = Harvest::Resources::Client.find(1)
+      client.name = "Sprockets & Co"
+      client.save
+      expected_request = ActiveResource::Request.new(:put, "/clients/1.xml")
+      assert ActiveResource::HttpMock.requests.include?(expected_request)
+    end
+    
+    should "delete an existing client" do 
+      Harvest::Resources::Client.delete(1)
+      expected_request = ActiveResource::Request.new(:delete, "/clients/1.xml")
+      assert ActiveResource::HttpMock.requests.include?(expected_request)
+    end
+    
+  end
+    
+  context "Toggling active/inactive status" do 
+    setup do 
+      setup_resources
+      mock_client_responses
+    end
+    
+    should "hit the toggle method" do
+      client = Harvest::Resources::Client.find(1)
+      client.toggle
+      expected_request = ActiveResource::Request.new(:put, "/clients/1/toggle.xml")
+      assert ActiveResource::HttpMock.requests.include?(expected_request)
+    end
+    
+    should "return 200 Success toggle method" do
+      client = Harvest::Resources::Client.find(1)
+      assert client.toggle.code == 200
+    end
+        
+  end
+  
+end

data/test/unit/resources/expense_category_test.rb

@@ -0,0 +1,49 @@
+require File.join(File.dirname(__FILE__), "..", "..", "test_helper")
+
+class ExpenseCategoryTest < Test::Unit::TestCase
+  
+  def setup_resources
+    @expense_category   =  {:id => 1, :name => "Mileage"}.to_xml(:root => "expense_category")
+    @expense_categories = [{:id => 1, :name => "Mileage"}].to_xml(:root => "expense_categories") 
+  end
+  
+  def mock_responses
+    ActiveResource::HttpMock.respond_to do |mock|
+      mock.get    "/expense_categories.xml",          {}, @expense_categories
+      mock.post   "/expense_categories.xml",          {}, @expence_categories, 201, "Location" => "/expense_categories/5.xml"
+      mock.put    "/expense_categories/1.xml",        {}, nil,     200
+      mock.delete "/expense_categories/1.xml",        {}, nil,     200
+    end
+  end
+  
+  context "expense_category actions" do 
+    setup do 
+      setup_resources
+      mock_responses
+    end
+    
+    # Note: The api technically supports updates; however, it doesn't support a show and
+    # therefore doesn't work well with activeresource.
+    
+    should "get index" do 
+      Harvest::Resources::ExpenseCategory.find(:all)
+      expected_request = ActiveResource::Request.new(:get, "/expense_categories.xml")
+      assert ActiveResource::HttpMock.requests.include?(expected_request)
+    end
+  
+    should "create a new expense_category" do 
+      expense_category = Harvest::Resources::ExpenseCategory.new(:name => "Widgets&Co")
+      expense_category.save
+      expected_request = ActiveResource::Request.new(:post, "/expense_categories.xml")
+      assert ActiveResource::HttpMock.requests.include?(expected_request)
+    end
+    
+    should "delete an existing expense_category" do 
+      Harvest::Resources::ExpenseCategory.delete(1)
+      expected_request = ActiveResource::Request.new(:delete, "/expense_categories/1.xml")
+      assert ActiveResource::HttpMock.requests.include?(expected_request)
+    end
+    
+  end
+      
+end

data/test/unit/resources/expense_test.rb

@@ -0,0 +1,14 @@
+require File.join(File.dirname(__FILE__), "..", "..", "test_helper")
+
+class ExpenseAssignmentTest < Test::Unit::TestCase
+
+  context "ExpenseAssignment class" do 
+    
+    should "adjust the site setting when the person_id is set" do 
+      expense_class = Harvest::Resources::Expense.clone
+      expense_class.person_id = 5
+      assert_equal "http://example.com/people/5", expense_class.site.to_s
+    end
+    
+  end
+end

data/test/unit/resources/person_test.rb

@@ -0,0 +1,150 @@
+require File.join(File.dirname(__FILE__), "..", "..", "test_helper")
+
+class PersonTest < Test::Unit::TestCase
+  
+  def setup_resources
+    @person_xml  =  {:id => 1, :name => "Joe Coder"}.to_xml(:root => "person")
+    @people      = [{:id => 1, :name => "Joe Coder"}].to_xml(:root => "people")
+    @entry       = [{:id => 2, :project_id => 50}].to_xml(:root => "day-entries")
+    @entries     = [{:id => 1, :project_id => "25"}, 
+                    {:id => 2, :project_id => 50}  ].to_xml(:root => "day-entries")
+    @expenses    = [{:id => 1, :project_id => "25"}, 
+                    {:id => 2, :project_id => 50}  ].to_xml(:root => "expenses")
+  end
+  
+  def mock_responses
+    ActiveResource::HttpMock.respond_to do |mock|
+      mock.get    "/people.xml",           {}, @people
+      mock.get    "/people/1.xml",         {}, @person_xml
+      mock.post   "/people.xml",           {}, @person_xml, 201, "Location" => "/people/5.xml"
+      mock.put    "/people/1.xml",         {}, nil,     200
+      mock.delete "/people/1.xml",         {}, nil,     200
+      mock.put    "/people/1/toggle.xml",  {}, nil, 200
+      mock.get    "/people/1/entries.xml?from=20080101&to=20080131", {}, @entries
+      mock.get    "/people/1/entries.xml?from=20080101&project_id=3&to=20080131", {}, @entry
+      mock.get    "/people/1/expenses.xml?from=20080101&to=20080131", {}, @expenses
+    end
+  end
+  
+  context "People CRUD actions -- " do 
+    setup do 
+      setup_resources
+      mock_responses
+    end
+    
+    should "get index" do 
+      Harvest::Resources::Person.find(:all)
+      expected_request = ActiveResource::Request.new(:get, "/people.xml")
+      assert ActiveResource::HttpMock.requests.include?(expected_request)
+    end
+    
+    should "get a single project" do 
+      Harvest::Resources::Person.find(1)
+      expected_request = ActiveResource::Request.new(:get, "/people/1.xml")
+      assert ActiveResource::HttpMock.requests.include?(expected_request)
+    end
+    
+    should "create a new project" do 
+      project = Harvest::Resources::Person.new(:name => "Widgets&Co")
+      project.save
+      expected_request = ActiveResource::Request.new(:post, "/people.xml")
+      assert ActiveResource::HttpMock.requests.include?(expected_request)
+    end
+    
+    should "update an existing project" do 
+      project = Harvest::Resources::Person.find(1)
+      project.name = "Joe Coder"
+      project.save
+      expected_request = ActiveResource::Request.new(:put, "/people/1.xml")
+      assert ActiveResource::HttpMock.requests.include?(expected_request)
+    end
+    
+    should "delete an existing project" do 
+      Harvest::Resources::Person.delete(1)
+      expected_request = ActiveResource::Request.new(:delete, "/people/1.xml")
+      assert ActiveResource::HttpMock.requests.include?(expected_request)
+    end
+    
+  end
+  
+    
+  context "Toggling active/inactive status" do 
+    setup do 
+      setup_resources
+      mock_responses
+    end
+    
+    should "hit the toggle method" do
+      person = Harvest::Resources::Person.find(1)
+      person.toggle
+      expected_request = ActiveResource::Request.new(:put, "/people/1/toggle.xml")
+      assert ActiveResource::HttpMock.requests.include?(expected_request)
+    end
+    
+    should "return 200 Success toggle method" do
+      person = Harvest::Resources::Person.find(1)
+      assert person.toggle.code == 200
+    end
+        
+  end
+  
+  context "Getting entries" do 
+    setup do 
+      setup_resources
+      mock_responses
+      @person = Harvest::Resources::Person.find(1)
+    end
+    
+    should "raise an error if start and end are not included" do 
+      assert_raises ArgumentError, "Must specify :start and :end as dates." do  
+        @person.entries
+      end
+    end
+    
+    should "raise an error if end date precedes start date" do 
+      assert_raises ArgumentError, "Must specify :start and :end as dates." do  
+        @person.entries(:from => Time.utc(2007, 1, 1), :to => Time.utc(2006, 1, 1))
+      end
+    end
+    
+    should "return the project site prefix" do
+      entry_class = Harvest::Resources::Entry.clone
+      entry_class.person_id = @person.id
+      assert_equal "http://example.com/people/1", entry_class.site.to_s
+    end
+    
+  end
+  
+  context "Reports -- " do   
+    setup do
+      setup_resources 
+      mock_responses
+      @from    = Time.utc(2008, 1, 1)
+      @to      = Time.utc(2008, 1, 31)
+      @person = Harvest::Resources::Person.find(1)
+      @request_path = "/people/1/entries.xml?from=20080101&to=20080131"
+      @expense_path = "/people/1/expenses.xml?from=20080101&to=20080131"
+    end
+      
+    should "get all entries for a given date range" do
+      @person.entries(:from => @from, :to => @to)
+      expected_request = ActiveResource::Request.new(:get, @request_path)
+      assert ActiveResource::HttpMock.requests.include?(expected_request)
+    end
+    
+    should "get all entries for the given date range and user" do 
+      path = "/people/1/entries.xml?from=20080101&project_id=3&to=20080131"
+      @person.entries(:from => @from, :to => @to, :project_id => 3)
+      expected_request = ActiveResource::Request.new(:get, path)
+      assert ActiveResource::HttpMock.requests.include?(expected_request)
+    end
+    
+    should "return all expense entries logged by the given user" do
+      @person.expenses(:from => @from, :to => @to)
+      expected_request = ActiveResource::Request.new(:get, @expense_path)
+      assert ActiveResource::HttpMock.requests.include?(expected_request)
+    end
+       
+  end
+      
+end