harvested 0.3.3 → 0.4.0

data/lib/harvested.rb

@@ -1,8 +1,15 @@
-require 'happymapper'
 require 'httparty'
 require 'base64'
-require 'builder'
 require 'delegate'
+require 'hashie'
+require 'json'
+require 'time'
+require 'csv'
+
+require 'ext/array'
+require 'ext/hash'
+require 'ext/date'
+require 'ext/time'
 
 require 'harvest/credentials'
 require 'harvest/errors'
@@ -12,11 +19,11 @@ require 'harvest/timezones'
 require 'harvest/base'
 
 %w(crud activatable).each {|a| require "harvest/behavior/#{a}"}
-%w(base_model client contact project task user rate_limit_status task_assignment user_assignment expense_category expense time_entry).each {|a| require "harvest/#{a}"}
-%w(base account clients contacts projects tasks users task_assignments user_assignments expense_categories expenses time reports).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).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}"}
 
 module Harvest
-  VERSION = "0.3.1".freeze
+  VERSION = File.read(File.expand_path(File.join(File.dirname(__FILE__), '..', 'VERSION'))).strip
   
   class << self
     

data/spec/functional/account_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe 'account information' do
+  it 'returns the rate limit when requested' do
+    cassette('account1') do
+      status = harvest.account.rate_limit_status
+      status.max_calls.should == 100
+    end
+  end
+  
+  it 'returns the result of whoami' do
+    cassette('account2') do
+      user = harvest.account.who_am_i
+      user.email.should == credentials["username"]
+    end
+  end
+end

data/spec/functional/clients_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe 'harvest clients' do
+  it 'allows adding, updating and removing clients' do
+    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.name = "Joe and Frank's Steam Cleaning"
+      client = harvest.clients.update(client)
+      client.name.should == "Joe and Frank's Steam Cleaning"
+
+      harvest.clients.delete(client)
+      harvest.clients.all.select {|p| p.name == "Joe and Frank's Steam Cleaning"}.should == []
+    end
+  end
+
+  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.should be_active
+
+      client = harvest.clients.deactivate(client)
+      client.should_not be_active
+
+      client = harvest.clients.activate(client)
+      client.should be_active
+    end
+  end
+
+  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"
+        )
+        contact        = harvest.contacts.create(
+          "client_id"  => client.id,
+          "email"      => "jane@doe.com",
+          "first_name" => "Jane",
+          "last_name"  => "Doe"
+        )
+        contact.client_id.should == client.id
+        contact.email.should == "jane@doe.com"
+
+        harvest.contacts.delete(contact)
+        harvest.contacts.all.select {|e| e.email == "jane@doe.com" }.should == []
+      end
+    end
+  end
+end

data/spec/functional/errors_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe 'harvest errors' do
+  before { WebMock.disable_net_connect! }
+  
+  it "wraps errors" do
+    stub_request(:get, /\/clients/).to_return({:status => ['400', 'Bad Request']}, {:body => "[]", :status => 200})
+    expect { harvest.clients.all }.to raise_error(Harvest::BadRequest)
+    
+    stub_request(:get, /\/clients/).to_return({:status => ['404', 'Not Found']}, {:body => "[]", :status => 200})
+    expect { harvest.clients.all }.to raise_error(Harvest::NotFound)
+    
+    stub_request(:get, /\/clients/).to_return({:status => ['500', 'Server Error']}, {:body => "[]", :status => 200})
+    expect { harvest.clients.all }.to raise_error(Harvest::ServerError)
+    
+    stub_request(:get, /\/clients/).to_return({:status => ['502', 'Bad Gateway']}, {:body => "[]", :status => 200})
+    expect { harvest.clients.all }.to raise_error(Harvest::Unavailable)
+    
+    stub_request(:get, /\/clients/).to_return({:status => ['503', 'Rate Limited']}, {:body => "[]", :status => 200})
+    expect { harvest.clients.all }.to raise_error(Harvest::RateLimited)
+  end
+end

data/spec/functional/expenses_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+describe 'harvest expenses' do
+  context 'categories' do
+    it 'allows adding, updating and removing categories' do
+      cassette("expense_category1") do
+        category       = harvest.expense_categories.create(
+          "name"       => "Mileage",
+          "unit_price" => 100,
+          "unit_name"  => "mile"
+        )
+        category.name.should == "Mileage"
+
+        category.name = "Travel"
+        category = harvest.expense_categories.update(category)
+        category.name.should == "Travel"
+
+        harvest.expense_categories.delete(category)
+        harvest.expense_categories.all.select{|e| e.name == "Travel" }.should == []
+      end
+    end
+  end
+  
+  
+  it "allows adding, updating, and removing expenses" do
+    cassette("expenses2") do
+      category       = harvest.expense_categories.create(
+        "name"       => "Something Deductible",
+        "unit_price" => 100,
+        "unit_name"  => "deduction"
+      )
+
+      client      = harvest.clients.create(
+        "name"    => "Tom's Butcher",
+        "details" => "Building API Widgets across the country"
+      )
+
+      project       = harvest.projects.create(
+        "name"      => "Expensing Project",
+        "active"    => true,
+        "notes"     => "project to test the api",
+        "client_id" => client.id
+      )
+      
+      expense                 = harvest.expenses.create(
+        "notes"               => "Drive to Chicago",
+        "total_cost"          => 75.0,
+        "spent_at"            => Time.utc(2009, 12, 28),
+        "expense_category_id" => category.id,
+        "project_id"          => project.id
+      )
+      expense.notes.should == "Drive to Chicago"
+      
+      expense.notes = "Off to Chicago"
+      expense = harvest.expenses.update(expense)
+      expense.notes.should == "Off to Chicago"
+      
+      harvest.expenses.delete(expense)
+      harvest.expenses.all(Time.utc(2009, 12, 28)).select {|e| e.notes == "Off to Chicago"}.should == []
+    end
+  end
+end
+
+# Copied from feature
+# @wip
+# Scenario: Attaching a receipt to an Expense
+#   Given I am using the credentials from "./support/harvest_credentials.yml"
+#   When I create an expense category with the following:
+#   | name       | Mileage |
+#   | unit_name  | Miles   |
+#   | unit_price | 0.485   |
+#   Then there should be an expense category "Mileage"
+#   When I create a client with the following:
+#   | name | Expense Client |
+#   When I create a project for the client "Expense Client" with the following:
+#   | name | Test Project |
+#   When I create an expense for the project "Test Project" with the category "Mileage" with the following:
+#   | notes      | Drive to Chicago |
+#   | total_cost | 75.00            |
+#   | spent_at   | 12/28/2009       |
+#   Then there should be an expense "Drive to Chicago" on "12/28/2009"
+#   When I attach the receipt "./support/fixtures/receipt.png" to the expense "Drive to Chicago" on "12/28/2009"
+#   Then there should be a receipt "./support/fixtures/receipt.png" attached to the expense "Drive to Chicago" on "12/28/2009"
+

data/spec/functional/hardy_client_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe 'harvest hardy client' do
+  before do 
+    WebMock.disable_net_connect!
+    @time = Time.now
+  end
+  
+  it "waits the alloted time out when over rate limit" do
+    stub_request(:get, /\/clients/).to_return({:status => ['503', 'Rate Limited'], :headers => {"Retry-After" => "5"}}, {:body => "[]", :status => 200})
+    hardy_harvest.clients.all
+    Time.now.should be_within(10).of(@time)
+  end
+  
+  it "waits a default time when over the rate limit" do
+    stub_request(:get, /\/clients/).to_return({:status => ['503', 'Rate Limited']}, {:body => "[]", :status => 200})
+    hardy_harvest.clients.all
+    Time.now.should be_within(20).of(@time)
+  end
+  
+  it "retries after known errors" do
+    stub_request(:get, /\/rate_limit_status/).to_return({:body => '{"lockout_seconds":2,"last_access_at":"2011-06-18T17:13:22+00:00","max_calls":100,"count":1,"timeframe_limit":15}'})
+    
+    stub_request(:get, /\/clients/).to_return({:status => ['502', 'Bad Gateway']}).times(2).then.to_return({:body => "[]", :status => 200})
+    hardy_harvest.clients.all.should == []
+    
+    stub_request(:get, /\/clients/).to_raise(Net::HTTPError.new("custom error", "")).times(2).then.to_return({:body => "[]", :status => 200})
+    hardy_harvest.clients.all.should == []
+    
+    stub_request(:get, /\/clients/).to_return({:status => ['502', 'Bad Gateway']}).times(6).then.to_return({:body => "[]", :status => 200})
+    expect { hardy_harvest.clients.all }.to raise_error(Harvest::Unavailable)
+  end
+end

data/spec/functional/invoice_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe 'harvest invoices' do
+  it 'allows adding, updating and removing categories' 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(
+      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")]
+      )
+      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
+  
+      harvest.invoices.delete(invoice)
+      harvest.invoices.all.select {|p| p.number == "1000"}.should == []
+    end
+  end
+end

data/spec/functional/project_spec.rb

@@ -0,0 +1,50 @@
+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"
+      )
+
+      project       = harvest.projects.create(
+        "name"      => "Test Project",
+        "active"    => true,
+        "notes"     => "project to test the api",
+        "client_id" => client.id
+      )
+      project.name.should == "Test Project"
+
+      project.name = "Updated Project"
+      project = harvest.projects.update(project)
+      project.name.should == "Updated Project"
+
+      harvest.projects.delete(project)
+      harvest.projects.all.select {|p| p.name == "Updated Project"}.should == []
+    end
+  end
+
+  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"
+      )
+
+      project       = harvest.projects.create(
+        "name"      => "Test Project",
+        "active"    => true,
+        "notes"     => "project to test the api",
+        "client_id" => client.id
+      )
+      project.should be_active
+
+      project = harvest.projects.deactivate(project)
+      project.should_not be_active
+
+      project = harvest.projects.activate(project)
+      project.should be_active
+    end
+  end
+end

data/spec/functional/reporting_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+describe 'harvest reporting' do  
+  it 'allows project and people entry reporting' do
+    cassette("reports1") do
+      user = harvest.users.create(
+        "email"      => "jane@example.com",
+        "first_name" => "Jane",
+        "last_name"  => "Doe",
+        "password"   => "secure"
+      )
+      client   = harvest.clients.create("name" => "Tim's Dry Cleaning")
+      project1 = harvest.projects.create("name" => "Reporting Project1", "client_id" => client.id)
+      project2 = harvest.projects.create("name" => "Reporting Project2", "client_id" => client.id)
+      task1     = harvest.tasks.create("name" => "A billable task", "default_hourly_rate" => 120, "billable_by_default" => true)
+      task2     = harvest.tasks.create("name" => "A non billable task", "billable_by_default" => false)
+
+      harvest.task_assignments.create("project" => project1, "task" => task1)
+      harvest.task_assignments.create("project" => project2, "task" => task2)
+      harvest.user_assignments.create("project" => project1, "user" => user)
+      harvest.user_assignments.create("project" => project2, "user" => user)
+
+      entry1 = harvest.time.create("notes" => "billable entry1", "hours" => 3, "spent_at" => "12/28/2009", "task_id" => task1.id, "project_id" => project1.id, "of_user" => user.id)
+      entry2 = harvest.time.create("notes" => "non billable entry2", "hours" => 6, "spent_at" => "12/28/2009", "task_id" => task2.id, "project_id" => project2.id, "of_user" => user.id)
+
+      harvest.reports.time_by_project(project1, Time.utc(2009, 12, 20), Time.utc(2009,12,30)).first.should == entry1
+
+      harvest.reports.time_by_project(project1, Time.utc(2009, 12, 20), Time.utc(2009,12,30), :user => user).first.should == entry1
+
+      harvest.reports.time_by_project(project2, Time.utc(2009, 12, 20), Time.utc(2009,12,30), :user => user).first.should == entry2
+
+      harvest.reports.time_by_project(project2, Time.utc(2009, 12, 20), Time.utc(2009,12,30), :billable => true).should == []
+      harvest.reports.time_by_project(project2, Time.utc(2009, 12, 20), Time.utc(2009,12,30), :billable => false).first.should == entry2
+
+      harvest.reports.time_by_user(user, Time.utc(2009, 12, 20), Time.utc(2009,12,30)).map(&:id).should == [entry1, entry2].map(&:id)
+
+      harvest.reports.time_by_user(user, Time.utc(2009, 12, 20), Time.utc(2009,12,30), :project => project1).first.should == entry1
+
+      harvest.reports.time_by_user(user, Time.utc(2009, 12, 20), Time.utc(2009,12,30), :project => project2).first.should == entry2
+
+      harvest.reports.time_by_user(user, Time.utc(2009, 12, 20), Time.utc(2009,12,30), :billable => true).first.should == entry1
+      harvest.reports.time_by_user(user, Time.utc(2009, 12, 20), Time.utc(2009,12,30), :billable => false).first.should == entry2
+      
+      client2 = harvest.clients.create("name" => "Phil's Sandwich Shop")
+      harvest.reports.projects_by_client(client).map(&:id).to_set.should == [project1, project2].map(&:id).to_set
+      harvest.reports.projects_by_client(client2).should == []
+    end
+  end
+
+  it 'allows expense reporting' do
+    cassette("reports2") do
+      user = harvest.users.create(
+        "email"      => "simon@example.com",
+        "first_name" => "Simon",
+        "last_name"  => "Stir",
+        "password"   => "secure"
+      )
+
+      category = harvest.expense_categories.create("name" => "Reporting category", "unit_price" => 100, "unit_name"  => "deduction")
+      client  = harvest.clients.create("name" => "Philip's Butcher")
+      project = harvest.projects.create("name" => "Expense Reporting Project", "client_id" => client.id)
+      harvest.user_assignments.create("project" => project, "user" => user)
+
+      expense                 = harvest.expenses.create(
+        "notes"               => "Drive to Chicago",
+        "total_cost"          => 75.0,
+        "spent_at"            => Time.utc(2009, 12, 28),
+        "expense_category_id" => category.id,
+        "project_id"          => project.id,
+        "user_id"             => user.id
+      )
+      
+      harvest.reports.expenses_by_user(user, Time.utc(2009, 12, 20), Time.utc(2009,12,30)).first.should == expense
+      
+      my_user = harvest.users.all.detect {|u| u.email == credentials["username"]}
+      my_user.should_not be_nil
+      harvest.reports.expenses_by_user(my_user, Time.utc(2009, 12, 20), Time.utc(2009,12,30)).should == []
+    end
+  end
+end