harvested 0.6.2 → 0.6.3

data/lib/harvest/base.rb

@@ -1,7 +1,7 @@
 module Harvest
   class Base
     attr_reader :request, :credentials
-    
+
     # @see Harvest.client
     # @see Harvest.hardy_client
     def initialize(subdomain, username, password, options = {})
@@ -9,7 +9,7 @@ module Harvest
       @credentials = Credentials.new(subdomain, username, password, options[:ssl])
       raise InvalidCredentials unless credentials.valid?
     end
-    
+
     # All API actions surrounding accounts
     #
     # == Examples
@@ -19,76 +19,76 @@ module Harvest
     def account
       @account ||= Harvest::API::Account.new(credentials)
     end
-    
+
     # All API Actions surrounding Clients
-    # 
+    #
     # == Examples
     #  harvest.clients.all() # Returns all clients in the system
-    #  
+    #
     #  harvest.clients.find(100) # Returns the client with id = 100
-    #  
+    #
     #  client = Harvest::Client.new(:name => 'SuprCorp')
     #  saved_client = harvest.clients.create(client) # returns a saved version of Harvest::Client
-    #  
+    #
     #  client = harvest.clients.find(205)
     #  client.name = 'SuprCorp LTD.'
     #  updated_client = harvest.clients.update(client) # returns an updated version of Harvest::Client
-    #  
+    #
     #  client = harvest.clients.find(205)
     #  harvest.clients.delete(client) # returns 205
-    #  
+    #
     #  client = harvest.clients.find(301)
     #  deactivated_client = harvest.clients.deactivate(client) # returns an updated deactivated client
     #  activated_client = harvest.clients.activate(client) # returns an updated activated client
-    # 
+    #
     # @see Harvest::Behavior::Crud
     # @see Harvest::Behavior::Activatable
     # @return [Harvest::API::Clients]
     def clients
       @clients ||= Harvest::API::Clients.new(credentials)
     end
-    
+
     # All API Actions surrounding Client Contacts
-    # 
+    #
     # == Examples
     #  harvest.contacts.all() # Returns all contacts in the system
     #  harvest.contacts.all(10) # Returns all contacts for the client id=10 in the system
-    #  
+    #
     #  harvest.contacts.find(100) # Returns the contact with id = 100
-    #  
+    #
     #  contact = Harvest::Contact.new(:first_name => 'Jane', :last_name => 'Doe', :client_id => 10)
     #  saved_contact = harvest.contacts.create(contact) # returns a saved version of Harvest::Contact
-    #  
+    #
     #  contact = harvest.contacts.find(205)
     #  contact.first_name = 'Jilly'
     #  updated_contact = harvest.contacts.update(contact) # returns an updated version of Harvest::Contact
-    #  
+    #
     #  contact = harvest.contacts.find(205)
     #  harvest.contacts.delete(contact) # returns 205
-    # 
+    #
     # @see Harvest::Behavior::Crud
     # @return [Harvest::API::Contacts]
     def contacts
       @contacts ||= Harvest::API::Contacts.new(credentials)
     end
-    
+
     # All API Actions surrounding Projects
-    # 
+    #
     # == Examples
     #  harvest.projects.all() # Returns all projects in the system
-    #  
+    #
     #  harvest.projects.find(100) # Returns the project with id = 100
-    #  
+    #
     #  project = Harvest::Project.new(:name => 'SuprGlu' :client_id => 10)
     #  saved_project = harvest.projects.create(project) # returns a saved version of Harvest::Project
-    #  
+    #
     #  project = harvest.projects.find(205)
     #  project.name = 'SuprSticky'
     #  updated_project = harvest.projects.update(project) # returns an updated version of Harvest::Project
-    #  
+    #
     #  project = harvest.project.find(205)
     #  harvest.projects.delete(project) # returns 205
-    #  
+    #
     #  project = harvest.projects.find(301)
     #  deactivated_project = harvest.projects.deactivate(project) # returns an updated deactivated project
     #  activated_project = harvest.projects.activate(project) # returns an updated activated project
@@ -102,67 +102,67 @@ module Harvest
     def projects
       @projects ||= Harvest::API::Projects.new(credentials)
     end
-    
+
     # All API Actions surrounding Tasks
-    # 
+    #
     # == Examples
     #  harvest.tasks.all() # Returns all tasks in the system
-    #  
+    #
     #  harvest.tasks.find(100) # Returns the task with id = 100
-    #  
+    #
     #  task = Harvest::Task.new(:name => 'Server Administration' :default => true)
     #  saved_task = harvest.tasks.create(task) # returns a saved version of Harvest::Task
-    #  
+    #
     #  task = harvest.tasks.find(205)
     #  task.name = 'Server Administration'
     #  updated_task = harvest.tasks.update(task) # returns an updated version of Harvest::Task
-    #  
+    #
     #  task = harvest.task.find(205)
     #  harvest.tasks.delete(task) # returns 205
-    #   
+    #
     # @see Harvest::Behavior::Crud
     # @return [Harvest::API::Tasks]
     def tasks
       @tasks ||= Harvest::API::Tasks.new(credentials)
     end
-    
+
     # All API Actions surrounding Users
-    # 
+    #
     # == Examples
     #  harvest.users.all() # Returns all users in the system
-    #  
+    #
     #  harvest.users.find(100) # Returns the user with id = 100
-    #  
+    #
     #  user = Harvest::User.new(:first_name => 'Edgar', :last_name => 'Ruth', :email => 'edgar@ruth.com', :password => 'mypassword', :timezone => :cst, :admin => false, :telephone => '444-4444')
     #  saved_user = harvest.users.create(user) # returns a saved version of Harvest::User
-    #  
+    #
     #  user = harvest.users.find(205)
     #  user.email = 'edgar@ruth.com'
     #  updated_user = harvest.users.update(user) # returns an updated version of Harvest::User
-    #  
+    #
     #  user = harvest.users.find(205)
     #  harvest.users.delete(user) # returns 205
-    #  
+    #
     #  user = harvest.users.find(301)
     #  deactivated_user = harvest.users.deactivate(user) # returns an updated deactivated user
     #  activated_user = harvest.users.activate(user) # returns an updated activated user
-    #  
+    #
     #  user = harvest.users.find(401)
     #  harvest.users.reset_password(user) # will trigger the reset password feature of harvest and shoot the user an email
-    #   
+    #
     # @see Harvest::Behavior::Crud
     # @see Harvest::Behavior::Activatable
     # @return [Harvest::API::Users]
     def users
       @users ||= Harvest::API::Users.new(credentials)
     end
-    
+
     # All API Actions surrounding assigning tasks to projects
-    # 
+    #
     # == Examples
     #  project = harvest.projects.find(101)
     #  harvest.task_assignments.all(project) # returns all tasks assigned to the project  (as Harvest::TaskAssignment)
-    #  
+    #
     #  project = harvest.projects.find(201)
     #  harvest.task_assignments.find(project, 5) # returns the task assignment with ID 5 that is assigned to the project
     #
@@ -184,13 +184,13 @@ module Harvest
     def task_assignments
       @task_assignments ||= Harvest::API::TaskAssignments.new(credentials)
     end
-    
+
     # All API Actions surrounding assigning users to projects
-    # 
+    #
     # == Examples
     #  project = harvest.projects.find(101)
     #  harvest.user_assignments.all(project) # returns all users assigned to the project  (as Harvest::UserAssignment)
-    #  
+    #
     #  project = harvest.projects.find(201)
     #  harvest.user_assignments.find(project, 5) # returns the user assignment with ID 5 that is assigned to the project
     #
@@ -212,21 +212,21 @@ module Harvest
     def user_assignments
       @user_assignments ||= Harvest::API::UserAssignments.new(credentials)
     end
-    
+
     # All API Actions surrounding managing expense categories
     #
     # == Examples
     #  harvest.expense_categories.all() # Returns all expense categories in the system
-    #  
+    #
     #  harvest.expense_categories.find(100) # Returns the expense category with id = 100
-    #  
+    #
     #  category = Harvest::ExpenseCategory.new(:name => 'Mileage', :unit_price => 0.485)
     #  saved_category = harvest.expense_categories.create(category) # returns a saved version of Harvest::ExpenseCategory
-    #  
+    #
     #  category = harvest.clients.find(205)
     #  category.name = 'Travel'
     #  updated_category = harvest.expense_categories.update(category) # returns an updated version of Harvest::ExpenseCategory
-    #  
+    #
     #  category = harvest.expense_categories.find(205)
     #  harvest.expense_categories.delete(category) # returns 205
     #
@@ -235,22 +235,22 @@ module Harvest
     def expense_categories
       @expense_categories ||= Harvest::API::ExpenseCategories.new(credentials)
     end
-    
+
     # All API Actions surrounding expenses
     #
     # == Examples
     #  harvest.expenses.all() # Returns all expenses for the current week
     #  harvest.expenses.all(Time.parse('11/12/2009')) # returns all expenses for the week of 11/12/2009
-    #  
+    #
     #  harvest.expenses.find(100) # Returns the expense with id = 100
     def expenses
       @expenses ||= Harvest::API::Expenses.new(credentials)
     end
-    
+
     def time
       @time ||= Harvest::API::Time.new(credentials)
     end
-    
+
     def reports
       @reports ||= Harvest::API::Reports.new(credentials)
     end
@@ -262,5 +262,27 @@ module Harvest
     def invoices
       @invoices ||= Harvest::API::Invoices.new(credentials)
     end
+
+    # All API Actions surrounding invoice payments
+    #
+    # == Examples
+    #  invoice = harvest.invoices.find(100)
+    #  harvest.invoice_payments.all(invoice) # returns all payments for the invoice  (as Harvest::InvoicePayment)
+    #
+    #  invoice = harvest.invoices.find(100)
+    #  harvest.invoice_payments.find(invoice, 5) # returns the payment with ID 5 that is assigned to the invoice
+    #
+    #  invoice = harvest.invoices.find(100)
+    #  payment = Harvest::InvoicePayment.new(:invoice_id => invoice.id)
+    #  saved_payment = harvest.invoice_payments.create(payment) # returns a saved version of the payment
+    #
+    #  invoice = harvest.invoices.find(100)
+    #  payment = harvest.invoice_payments.find(invoice, 5)
+    #  harvest.invoice_payments.delete(payment) # returns 5
+    #
+    # @return [Harvest::API::InvoicePayments]
+    def invoice_payments
+      @invoice_payments ||= Harvest::API::InvoicePayments.new(credentials)
+    end
   end
-end
+end

data/lib/harvest/behavior/crud.rb

@@ -19,6 +19,7 @@ module Harvest
       #
       # @return [Harvest::BaseModel] the model depends on where you're calling it from (e.g. Harvest::Client from Harvest::Base#clients)
       def find(id, user = nil)
+        raise "id required" unless id
         response = request(:get, credentials, "#{api_model.api_path}/#{id}", :query => of_user_query(user))
         api_model.parse(response.parsed_response).first
       end
@@ -57,4 +58,4 @@ module Harvest
       end
     end
   end
-end
+end

data/lib/harvest/expense.rb

@@ -13,12 +13,12 @@ module Harvest
     end
 
     def spent_at=(date)
-      self["spent_at"] = (String === date ? Time.parse(date) : date)
+      self["spent_at"] = Date.parse(date.to_s)
     end
 
     def as_json(args = {})
       super(args).to_hash.stringify_keys.tap do |hash|
-        hash[json_root].update("spent_at" => (spent_at.nil? ? nil : spent_at.to_time.xmlschema))
+        hash[json_root].update("spent_at" => (spent_at.nil? ? nil : spent_at.xmlschema))
         hash[json_root].delete("has_receipt")
         hash[json_root].delete("receipt_url")
       end

data/lib/harvest/invoice.rb

@@ -1,4 +1,41 @@
 module Harvest
+
+  # == Fields
+  # [+due_at+] when the invoice is due
+  # [+due_at_human_format+] when the invoice is due in human representation (e.g., due upon receipt) overrides +due_at+
+  # [+client_id+] (REQUIRED) the client id of the invoice
+  # [+currency+] the invoice currency
+  # [+issued_at+] when the invoice was issued
+  # [+subject+] subject line for the invoice
+  # [+notes+] notes on the invoice
+  # [+number+] invoice number
+  # [+kind+] (REQUIRED) the type of the invoice +free_form|project|task|people|detailed+
+  # [+projects_to_invoice+] comma separated project ids to gather data from
+  # [+import_hours+] import hours from +project|task|people|detailed+ one of +yes|no+
+  # [+import_expenses+] import expenses from +project|task|people|detailed+ one of +yes|no+
+  # [+period_start+] start of the invoice period
+  # [+period_end+] end of the invoice period
+  # [+expense_period_start+] start of the invoice expense period
+  # [+expense_period_end+] end of the invoice expense period
+  # [+csv_line_items+] csv formatted line items for the invoice +kind,description,quantity,unit_price,amount,taxed,taxed2,project_id+
+  # [+created_at+] (READONLY) when the invoice was created
+  # [+updated_at+] (READONLY) when the invoice was updated
+  # [+id+] (READONLY) the id of the invoice
+  # [+amount+] (READONLY) the amount of the invoice
+  # [+due_amount+] (READONLY) the amount due on the invoice
+  # [+created_by_id+] who created the invoice
+  # [+purchase_order+] purchase order number/text
+  # [+client_key+] unique client key
+  # [+state+] (READONLY) state of the invoice
+  # [+tax+] applied tax percentage
+  # [+tax2+] applied tax 2 percentage
+  # [+tax_amount+] amount to tax
+  # [+tax_amount2+] amount to tax 2
+  # [+discount_amount+] discount amount to apply to invoice
+  # [+discount_type+] discount type
+  # [+recurring_invoice_id+] the id of the original invoice
+  # [+estimate_id+] id of the related estimate
+  # [+retainer_id+] id of the related retainer
   class Invoice < Hashie::Mash
     include Harvest::Model
 
@@ -6,14 +43,24 @@ module Harvest
 
     attr_reader :line_items
 
-    def self.json_root; "doc"; end
-    # skip_json_root true
+    def self.parse(json)
+      parsed   = String === json ? JSON.parse(json) : json
+      invoices = Array.wrap(parsed).map {|attrs| new(attrs["invoices"])}
+      invoice  = Array.wrap(parsed).map {|attrs| new(attrs["invoice"])}
+      if invoices.first && invoices.first.length > 0
+        invoices
+      else
+        invoice
+      end
+    end
 
     def initialize(args = {}, _ = nil)
-      @line_items = []
-      args            = args.to_hash.stringify_keys
-      self.line_items = args.delete("csv_line_items")
-      self.line_items = args.delete("line_items")
+      if args
+        args            = args.to_hash.stringify_keys
+        self.line_items = args.delete("csv_line_items")
+        self.line_items = args.delete("line_items")
+        self.line_items = [] if self.line_items.nil?
+      end
       super
     end
 
@@ -48,21 +95,10 @@ module Harvest
         else
           header = %w(kind description quantity unit_price amount taxed taxed2 project_id)
 
-          # writing this in stdlib so we don't force 1.8 users to install FasterCSV and make gem dependencies wierd
-          if RUBY_VERSION =~ /1.8/
-            csv_data = ""
-            CSV.generate_row(header, header.size, csv_data)
+          CSV.generate do |csv|
+            csv << header
             line_items.each do |item|
-              row_data = header.inject([]) {|row, attr| row << item[attr] }
-              CSV.generate_row(row_data, row_data.size, csv_data)
-            end
-            csv_data
-          else
-            CSV.generate do |csv|
-              csv << header
-              line_items.each do |item|
-                csv << header.inject([]) {|row, attr| row << item[attr] }
-              end
+              csv << header.inject([]) {|row, attr| row << item[attr] }
             end
           end
         end

data/lib/harvest/invoice_payment.rb

@@ -0,0 +1,8 @@
+module Harvest
+  class InvoicePayment < Hashie::Mash
+    include Harvest::Model
+
+    api_path '/payments'
+    def self.json_root; 'payment'; end
+  end
+end

data/lib/harvest/time_entry.rb

@@ -13,12 +13,12 @@ module Harvest
     end
 
     def spent_at=(date)
-      self["spent_at"] = (String === date ? Time.parse(date) : date)
+      self["spent_at"] = Date.parse(date.to_s)
     end
 
     def as_json(args = {})
       super(args).to_hash.stringify_keys.tap do |hash|
-        hash.update("spent_at" => (spent_at.nil? ? nil : spent_at.to_time.xmlschema))
+        hash.update("spent_at" => (spent_at.nil? ? nil : spent_at.xmlschema))
       end
     end
   end