harvested 0.6.2 → 0.6.3

data/lib/harvested.rb

@@ -19,14 +19,14 @@ require 'harvest/timezones'
 require 'harvest/base'
 
 %w(crud activatable).each {|a| require "harvest/behavior/#{a}"}
-%w(model client contact project task user rate_limit_status task_assignment user_assignment expense_category expense time_entry invoice_category line_item invoice).each {|a| require "harvest/#{a}"}
-%w(base account clients contacts projects tasks users task_assignments user_assignments expense_categories expenses time reports invoice_categories invoices).each {|a| require "harvest/api/#{a}"}
+%w(model client contact project task user rate_limit_status task_assignment user_assignment expense_category expense time_entry invoice_category line_item invoice invoice_payment).each {|a| require "harvest/#{a}"}
+%w(base account clients contacts projects tasks users task_assignments user_assignments expense_categories expenses time reports invoice_categories invoices invoice_payments).each {|a| require "harvest/api/#{a}"}
 
 module Harvest
   VERSION = File.read(File.expand_path(File.join(File.dirname(__FILE__), '..', 'VERSION'))).strip
-  
+
   class << self
-    
+
     # Creates a standard client that will raise all errors it encounters
     #
     # == Options
@@ -38,7 +38,7 @@ module Harvest
     def client(subdomain, username, password, options = {})
       Harvest::Base.new(subdomain, username, password, options)
     end
-    
+
     # Creates a hardy client that will retry common HTTP errors it encounters and sleep() if it determines it is over your rate limit
     #
     # == Options
@@ -66,4 +66,4 @@ module Harvest
       Harvest::HardyClient.new(client(subdomain, username, password, options), (retries || 5))
     end
   end
-end
+end

data/spec/factories.rb

@@ -0,0 +1,57 @@
+FactoryGirl.define do
+  sequence :name do |n|
+    "Joe's Steam Cleaning #{n}"
+  end
+
+  sequence :description do |n|
+    "Item #{n}"
+  end
+
+  sequence :project_name do |n|
+    "Joe's Steam Cleaning Project #{n}"
+  end
+
+  factory :client, class: Harvest::Client do
+    name
+    details "Steam Cleaning across the country"
+  end
+
+  factory :invoice, class: Harvest::Invoice do
+    subject "Invoice for Joe's Stream Cleaning"
+    client_id nil
+    issued_at "2011-03-31"
+    due_at "2011-03-31"
+    due_at_human_format "upon receipt"
+
+    currency "United States Dollars - USD"
+    sequence(:number)
+    notes "Some notes go here"
+    period_end "2011-03-31"
+    period_start "2011-02-26"
+    kind "free_form"
+    state "draft"
+    purchase_order nil
+    tax nil
+    tax2 nil
+    import_hours "no"
+    import_expenses "no"
+    line_items { [FactoryGirl.build(:line_item)] }
+  end
+
+  factory :line_item, class: Harvest::LineItem do
+    kind "Service"
+    description
+    quantity 200
+    unit_price "12.00"
+  end
+
+  factory :invoice_payment, class: Harvest::InvoicePayment do
+    paid_at Time.now
+    amount "0.00"
+    notes "Payment received"
+  end
+
+  factory :project, class: Harvest::Project do
+    name { generate(:project_name) }
+  end
+end

data/spec/functional/clients_spec.rb

@@ -2,12 +2,11 @@ require 'spec_helper'
 
 describe 'harvest clients' do
   it 'allows adding, updating and removing clients' do
+    client_attributes = FactoryGirl.attributes_for(:client)
+
     cassette("client") do
-      client      = harvest.clients.create(
-        "name"    => "Joe's Steam Cleaning",
-        "details" => "Building API Widgets across the country"
-      )
-      client.name.should == "Joe's Steam Cleaning"
+      client = harvest.clients.create(client_attributes)
+      client.name.should == client_attributes[:name]
 
       client.name = "Joe and Frank's Steam Cleaning"
       client = harvest.clients.update(client)
@@ -20,10 +19,7 @@ describe 'harvest clients' do
 
   it 'allows activating and deactivating clients' do
     cassette("client2") do
-      client      = harvest.clients.create(
-        "name"    => "Joe's Steam Cleaning",
-        "details" => "Building API Widgets across the country"
-      )
+      client = harvest.clients.create(FactoryGirl.attributes_for(:client))
       client.should be_active
 
       client = harvest.clients.deactivate(client)
@@ -37,21 +33,19 @@ describe 'harvest clients' do
   context "contacts" do
     it "allows adding, updating, and removing contacts" do
       cassette("client3") do
-        client      = harvest.clients.create(
-          "name"    => "Joe's Steam Cleaning",
-          "details" => "Building API Widgets across the country"
-        )
+        client = harvest.clients.create(FactoryGirl.attributes_for(:client))
+
         contact        = harvest.contacts.create(
           "client_id"  => client.id,
-          "email"      => "jane@doe.com",
+          "email"      => "jane@example.com",
           "first_name" => "Jane",
           "last_name"  => "Doe"
         )
         contact.client_id.should == client.id
-        contact.email.should == "jane@doe.com"
+        contact.email.should == "jane@example.com"
 
         harvest.contacts.delete(contact)
-        harvest.contacts.all.select {|e| e.email == "jane@doe.com" }.should == []
+        harvest.contacts.all.select {|e| e.email == "jane@example.com" }.should == []
       end
     end
   end

data/spec/functional/invoice_payments_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe 'harvest invoice payments' do
+  it 'allows retrieving existing invoice payments' do
+    cassette('invoice_payment1') do
+      client  = harvest.clients.create(FactoryGirl.attributes_for(:client))
+      invoice = harvest.invoices.create(FactoryGirl.attributes_for(:invoice, :client_id => client.id))
+
+      payment       = Harvest::InvoicePayment.new(FactoryGirl.attributes_for(:invoice_payment, :invoice_id => invoice.id, :amount => invoice.amount))
+      payment_saved = harvest.invoice_payments.create(payment)
+
+      payment_found = harvest.invoice_payments.find(invoice, payment_saved)
+
+      payment_found.should == payment_saved
+    end
+  end
+
+  it 'allows adding, and removing invoice payments' do
+    cassette('invoice_payment2') do
+      client  = harvest.clients.create(FactoryGirl.attributes_for(:client))
+      invoice = harvest.invoices.create(FactoryGirl.attributes_for(:invoice, :client_id => client.id))
+
+      half_amount = (invoice.amount.to_f / 2)
+
+      payment1 = Harvest::InvoicePayment.new(FactoryGirl.attributes_for(:invoice_payment, :invoice_id => invoice.id, :amount => half_amount))
+      payment1 = harvest.invoice_payments.create(payment1)
+
+      invoice = harvest.invoices.find(invoice.id)
+      invoice.state.should == 'partial'
+
+      payment2 = Harvest::InvoicePayment.new(FactoryGirl.attributes_for(:invoice_payment, :invoice_id => invoice.id, :amount => half_amount))
+      payment2 = harvest.invoice_payments.create(payment2)
+
+      invoice = harvest.invoices.find(invoice.id)
+      invoice.state.should == 'paid'
+
+      harvest.invoice_payments.all(invoice).each { |ip| harvest.invoice_payments.delete(ip) }
+      harvest.invoice_payments.all(invoice).should be_empty
+
+      invoice = harvest.invoices.find(invoice.id)
+      invoice.state.should == 'open'
+    end
+  end
+end

data/spec/functional/invoice_spec.rb

@@ -5,61 +5,109 @@ describe 'harvest invoices' do
     cassette('invoice1') do
       cat = harvest.invoice_categories.create("name" => "New Category")
       cat.name.should == "New Category"
-      
+
       cat.name = "Updated Category"
       cat = harvest.invoice_categories.update(cat)
       cat.name.should == "Updated Category"
-      
+
       harvest.invoice_categories.delete(cat)
       harvest.invoice_categories.all.select {|c| c.name == "Updated Category" }.should == []
     end
   end
-  
+
   it 'allows adding, updating and removing invoices' do
-    pending "having trouble following the API docs at http://www.getharvest.com/api/invoices"
-    
     cassette('invoice2') do
-      client  = harvest.clients.create("name" => "Frannie's Factory")
-      project = harvest.projects.create("name" => "Invoiced Project1", "client_id" => client.id)
-      
-      # invoice        = harvest.invoices.create(
+      client  = harvest.clients.create(FactoryGirl.attributes_for(:client))
+
+      invoice = Harvest::Invoice.new(FactoryGirl.attributes_for(:invoice, :client_id => client.id))
+      invoice = harvest.invoices.create(invoice)
+
+      invoice.subject.should == "Invoice for Joe's Stream Cleaning"
+      invoice.amount.should == "2400.0"
+      invoice.line_items.size.should == 1
+
+      invoice.subject    = "Updated Invoice for Joe"
+      invoice.line_items << FactoryGirl.build(:line_item)
+
+      invoice = harvest.invoices.update(invoice)
+      invoice.subject.should == "Updated Invoice for Joe"
+      invoice.amount.should == "4800.0"
+      invoice.line_items.size.should == 2
+
+      harvest.invoices.delete(invoice)
+      harvest.invoices.all.select {|p| p.number == "1000"}.should == []
+    end
+  end
+
+  it 'allows finding one invoice or all invoices with parameters' do
+    cassette('invoice3') do
+      client = harvest.clients.create(FactoryGirl.attributes_for(:client))
+
+      project_attributes = FactoryGirl.attributes_for(:project)
+      project_attributes[:client_id] = client.id
+
+      project = harvest.projects.create(project_attributes)
+      project.name.should == project_attributes[:name]
+
+      # Delete any existing invoices.
+      harvest.invoices.all.each {|i| harvest.invoices.delete(i.id)}
+
       invoice = Harvest::Invoice.new(
-        "subject"    => "Invoice for Frannie's Widgets",
-        "client_id"  => client.id,
-        "issued_at" => "2011-03-31",
-        "due_at" => "2011-03-31",
-        "due_at_human_format" => "upon receipt",
-        
-        "currency" => "United States Dollars - USD",
-        "number"     => 1000,
-        "notes" => "Some notes go here",
-        "period_end" => "2011-03-31",
-        "period_start" => "2011-02-26",
-        "kind" => "free_form"
-        # "state" => "draft",
-        # "purchase_order" => nil,
-        # "tax" => nil,
-        # "tax2" => nil,
-        # "kind" => "free_form",
-        # "import_hours" => "no",
-        # "import_expenses" => "no"
-        # "line_items" => [Harvest::LineItem.new("kind" => "Service", "description" => "One item", "quantity" => 200, "unit_price" => "12.00")]
+        "subject"              => "Invoice for Frannie's Widgets",
+        "client_id"            => client.id,
+        "issued_at"            => "2011-03-31",
+        "due_at"               => "2011-05-31",
+        "currency"             => "United States Dollars - USD",
+        "number"               => 1000,
+        "notes"                => "Some notes go here",
+        "period_end"           => "2011-03-31",
+        "period_start"         => "2011-02-26",
+        "kind"                 => "free_form",
+        "state"                => "draft",
+        "purchase_order"       => nil,
+        "tax"                  => nil,
+        "tax2"                 => nil,
+        "kind"                 => "free_form",
+        "import_hours"         => "no",
+        "import_expenses"      => "no",
+        "line_items"           => [Harvest::LineItem.new("kind" => "Service", "description" => "One item", "quantity" => 200, "unit_price" => "12.00")]
       )
-      p invoice.to_json
       invoice = harvest.invoices.create(invoice)
-      
+
       invoice.subject.should == "Invoice for Frannie's Widgets"
       invoice.amount.should == "2400.0"
       invoice.line_items.size.should == 1
-      
-      invoice.subject    = "Updated Invoice for Frannie"
-      invoice.line_items << Harvest::LineItem.new("kind" => "Service", "description" => "Two item", "quantity" => 10, "unit_price" => "2.00", "amount" => "20.0")
-      
-      invoice = harvest.invoices.update(invoice)
-      invoice.subject.should == "Updated Invoice for Frannie"
-      invoice.amount.should == "2420.0"
-      invoice.line_items.size.should == 2
-  
+      invoice.due_at.should == "2011-05-31"
+
+      invoice = harvest.invoices.find(invoice.id)
+      invoice.subject.should == "Invoice for Frannie's Widgets"
+      invoice.amount.should == "2400.0"
+      invoice.line_items.size.should == 1
+
+      invoices = harvest.invoices.all
+      invoices.count.should == 1
+
+      invoices = harvest.invoices.all(:status => 'draft')
+      invoices.count.should == 1
+
+      invoices = harvest.invoices.all(:status => 'closed')
+      invoices.count.should == 0
+
+      invoices = harvest.invoices.all(:status => 'draft', :page => 1)
+      invoices.count.should == 1
+
+      invoices = harvest.invoices.all(:timeframe => {:from => Date.today, :to => Date.today})
+      invoices.count.should == 1
+
+      invoices = harvest.invoices.all(:timeframe => {:from => '19690101', :to => '19690101'})
+      invoices.count.should == 0
+
+      invoices = harvest.invoices.all(:updated_since => Date.today)
+      invoices.count.should == 1
+
+      invoices = harvest.invoices.all(:updated_since => '21121231')
+      invoices.count.should == 0
+
       harvest.invoices.delete(invoice)
       harvest.invoices.all.select {|p| p.number == "1000"}.should == []
     end

data/spec/functional/project_spec.rb

@@ -3,10 +3,7 @@ require 'spec_helper'
 describe 'harvest projects' do
   it 'allows adding, updating and removing projects' do
     cassette('project1') do
-      client      = harvest.clients.create(
-        "name"    => "Joe's Steam Cleaning",
-        "details" => "Building API Widgets across the country"
-      )
+      client = harvest.clients.create(FactoryGirl.attributes_for(:client))
 
       project       = harvest.projects.create(
         "name"      => "Test Project",
@@ -27,10 +24,7 @@ describe 'harvest projects' do
 
   it 'allows activating and deactivating clients' do
     cassette('project2') do
-      client      = harvest.clients.create(
-        "name"    => "Joe's Steam Cleaning",
-        "details" => "Building API Widgets across the country"
-      )
+      client = harvest.clients.create(FactoryGirl.attributes_for(:client))
 
       project       = harvest.projects.create(
         "name"      => "Test Project",

data/spec/functional/tasks_spec.rb

@@ -22,10 +22,7 @@ describe 'harvest tasks' do
   context "task assignments" do
     it "allows adding, updating, and removing tasks from projects" do
       cassette('tasks2') do
-        client      = harvest.clients.create(
-          "name"    => "Joe's Steam Cleaning",
-          "details" => "Building API Widgets across the country"
-        )
+        client = harvest.clients.create(FactoryGirl.attributes_for(:client))
 
         project       = harvest.projects.create(
           "name"      => "Test Project2",
@@ -66,10 +63,7 @@ describe 'harvest tasks' do
 
     it "allows creating and assigning the task at the same time" do
       cassette('tasks3') do
-        client      = harvest.clients.create(
-          "name"    => "Joe's Steam Cleaning 2",
-          "details" => "Building API Widgets across the country"
-        )
+        client = harvest.clients.create(FactoryGirl.attributes_for(:client))
 
         project       = harvest.projects.create(
           "name"      => "Test Project3",

data/spec/harvest/expense_spec.rb

@@ -7,12 +7,12 @@ describe Harvest::Expense do
     it "should parse strings" do
       date = RUBY_VERSION =~ /1.8/ ? "12/01/2009" : "01/12/2009"
       expense = Harvest::Expense.new(:spent_at => date)
-      expense.spent_at.should == Time.parse(date)
+      expense.spent_at.should == Date.parse(date)
     end
     
     it "should accept times" do
       expense = Harvest::Expense.new(:spent_at => Time.utc(2009, 12, 1))
-      expense.spent_at.should == Time.utc(2009, 12, 1)
+      expense.spent_at.should == Date.new(2009, 12, 1)
     end
   end
 end

data/spec/harvest/invoice_payment_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Harvest::InvoicePayment do
+  it_behaves_like 'a json sanitizer', %w(cache_version)
+end

data/spec/harvest/invoice_spec.rb

@@ -6,42 +6,41 @@ describe Harvest::Invoice do
       invoice = Harvest::Invoice.new(:line_items => "kind,description,quantity,unit_price,amount,taxed,taxed2,project_id\nService,Abc,200,12.00,2400.0,false,false,100\nService,def,1.00,20.00,20.0,false,false,101\n")
       invoice.line_items.count.should == 2
       line_item = invoice.line_items.first
-      
+
       line_item.kind.should == "Service"
       line_item.project_id.should == "100"
     end
-    
+
     it 'parses csv into objects w/o projects' do
       invoice = Harvest::Invoice.new(:line_items => "kind,description,quantity,unit_price,amount,taxed,taxed2,project_id\nService,Abc,200,12.00,2400.0,false,false,\nService,def,1.00,20.00,20.0,false,false,\n")
       invoice.line_items.count.should == 2
       line_item = invoice.line_items.first
-      
+
       line_item.kind.should == "Service"
       line_item.description.should == "Abc"
     end
-    
+
     it 'parses empty strings' do
       invoice = Harvest::Invoice.new(:line_items => "")
       invoice.line_items.should == []
     end
-    
+
     it 'accepts rich objects' do
       Harvest::Invoice.new(:line_items => [Harvest::LineItem.new(:kind => "Service")]).line_items.count.should == 1
       Harvest::Invoice.new(:line_items => Harvest::LineItem.new(:kind => "Service")).line_items.count.should == 1
     end
-    
+
     it 'accepts nil' do
       Harvest::Invoice.new(:line_items => nil).line_items.should == []
     end
   end
-  
+
   context "as_json" do
     it 'encodes line items csv' do
       invoice = Harvest::Invoice.new(:line_items => "kind,description,quantity,unit_price,amount,taxed,taxed2,project_id\nService,Abc,200,12.00,2400.0,false,false,\nService,def,1.00,20.00,20.0,false,false,\n")
       invoice.line_items.count.should == 2
       invoice.line_items.first.kind.should == "Service"
-      
-      invoice.as_json["doc"]["csv_line_items"].should == "kind,description,quantity,unit_price,amount,taxed,taxed2,project_id\nService,Abc,200,12.00,2400.0,false,false,\nService,def,1.00,20.00,20.0,false,false,\n"
+      invoice.as_json["invoice"]["csv_line_items"].should == "kind,description,quantity,unit_price,amount,taxed,taxed2,project_id\nService,Abc,200,12.00,2400.0,false,false,\nService,def,1.00,20.00,20.0,false,false,\n"
     end
   end
-end
+end