Merge branch 'master' into create-bank-account-resource

Author: murraysum

.gitignore

@@ -1 +1,2 @@
-example.rb
+example.rb
+resource_list

lib/freeagent.rb

@@ -8,6 +8,14 @@ module FreeAgent
   require_relative 'freeagent/timeline_item'
   require_relative 'freeagent/attachment'
 
+  require_relative 'freeagent/contact'
+  require_relative 'freeagent/project'
+  require_relative 'freeagent/task'
+  require_relative 'freeagent/timeslip'
+  require_relative 'freeagent/note'
+  require_relative 'freeagent/recurring_invoice'
+  require_relative 'freeagent/invoice'
+
   class << self
     attr_accessor :environment
     attr_accessor :debug

lib/freeagent/contact.rb

@@ -0,0 +1,49 @@
+module FreeAgent
+  class Contact < Resource
+    resource :contact
+
+    resource_methods :default
+
+    attr_accessor :first_name, :last_name, :contact_name_on_invoice, :country, :locale, :sales_tax_registration_number, :uses_contact_invoice_sequence
+
+    attr_accessor :organisation_name, :email, :phone_number
+
+    attr_accessor :address1, :town, :region, :postcode, :address2, :address3, :country
+
+    date_accessor :created_at, :updated_at
+
+    decimal_accessor :account_balance
+
+    def self.active
+      Contact.filter(:view => 'active')
+    end
+
+    def self.clients
+      Contact.filter(:view => 'clients')
+    end
+
+    def self.suppliers
+      Contact.filter(:view => 'suppliers')
+    end
+
+    def self.active_projects
+      Contact.filter(:view => 'active_projects')
+    end
+
+    def self.completed_projects
+      Contact.filter(:view => 'completed_projects')
+    end
+
+    def self.open_clients
+      Contact.filter(:view => 'open_clients')
+    end
+
+    def self.open_suppliers
+      Contact.filter(:view => 'open_suppliers')
+    end
+
+    def self.hidden
+      Contact.filter(:view => 'hidden')
+    end
+  end
+end

lib/freeagent/errors.rb

@@ -34,4 +34,20 @@ def inspect
       # TODO
     end
   end
+
+  class NotImplemented < StandardError
+    attr_reader :message
+
+    def initialize(message)
+      @message = message
+    end
+
+    def to_s
+      message
+    end
+
+    def inspect
+      "#<#{self.class}: message: #{message} >"
+    end
+  end
 end

lib/freeagent/invoice.rb

@@ -0,0 +1,78 @@
+module FreeAgent
+  class Invoice < Resource
+    resource :invoice
+
+    resource_methods :default
+
+    attr_accessor :contact, :reference, :currency, :status, :omit_header, :payment_terms_in_days, :ec_status, :invoice_items
+
+    attr_accessor :project, :discount_percent, :written_off_date
+
+    decimal_accessor :exchange_rate, :net_value, :sales_tax_value
+
+    date_accessor :dated_on, :due_on
+
+    # TODO FIXME Need to rename this better
+    def self.all_with_nested_items
+      Invoice.filter(:nested_invoice_items => true)
+    end
+
+    def self.recent_open_or_overdue
+      Invoice.filter(:view => 'recent_open_or_overdue')
+    end
+
+    def self.open_or_overdue
+      Invoice.filter(:view => 'recent_open_or_overdue')
+    end
+
+    def self.draft
+      Invoice.filter(:view => 'recent_open_or_overdue')
+    end
+
+    def self.scheduled_to_email
+      Invoice.filter(:view => 'recent_open_or_overdue')
+    end
+
+    def self.thank_you_emails
+      Invoice.filter(:view => 'recent_open_or_overdue')
+    end
+
+    def self.reminder_emails
+      Invoice.filter(:view => 'recent_open_or_overdue')
+    end
+
+    def self.last_month(n)
+      Invoice.filter(:view => 'recent_open_or_overdue')
+    end
+
+    def self.find_all_by_contact(contact)
+      Invoice.filter(:contact => contact)
+    end
+
+    def self.find_all_by_project(project)
+      Invoice.filter(:project => project)
+    end
+    
+    # FIXME Need to figure out the format of the json.
+    #def send_email(email)
+    #  FreeAgent.client.post("invoices/#{id}/send_email", email)
+    #end
+
+    def mark_as_sent
+      FreeAgent.client.put("invoices/#{id}/transitions/mark_as_sent", nil)
+    end
+
+    def mark_as_draft
+      FreeAgent.client.put("invoices/#{id}/transitions/mark_as_draft", nil)
+    end
+
+    def mark_as_cancelled
+      FreeAgent.client.put("invoices/#{id}/transitions/mark_as_cancelled", nil)
+    end
+
+    # TODO Write invoice timeline wrapper
+    #def timeline
+    #
+    #end
+  end
+end

lib/freeagent/note.rb

@@ -0,0 +1,24 @@
+module FreeAgent
+  class Note < Resource
+    resource :note
+
+    resource_methods :find, :filter, :update, :delete
+
+    attr_accessor :note, :parent_url, :author
+
+    date_accessor :created_at, :updated_at
+
+    # FIXME Need to change POST to allow query strings to be passed to it
+    def self.create(attributes)
+      raise FreeAgent::NotImplemented.new("FIXME Need to change POST to allow query strings to be passed to it")
+    end
+
+    def self.find_all_by_contact(contact)
+      Note.filter(:contact => contact)
+    end
+
+    def self.find_all_by_project(project)
+      Note.filter(:project => project)
+    end
+  end
+end

lib/freeagent/project.rb

@@ -0,0 +1,30 @@
+module FreeAgent
+  class Project < Resource
+    resource :project
+
+    resource_methods :default
+
+    attr_accessor :name, :contact, :is_ir35, :status, :budget_units, :uses_project_invoice_sequence,
+                  :currency, :billing_period, :contract_po_reference
+
+    decimal_accessor :budget, :normal_billing_rate, :hours_per_day
+
+    date_accessor :starts_on, :ends_on, :created_at, :updated_at
+
+    def self.active
+      Project.filter(:view => 'active')
+    end
+
+    def self.completed
+      Project.filter(:view => 'completed')
+    end
+
+    def self.cancelled
+      Project.filter(:view => 'cancelled')
+    end
+
+    def self.hidden
+      Project.filter(:view => 'hidden')
+    end
+  end
+end

lib/freeagent/recurring_invoice.rb

@@ -0,0 +1,29 @@
+module FreeAgent
+  class RecurringInvoice < Resource
+    resource :recurring_invoice
+
+    resource_methods :all, :filter, :find
+
+    attr_accessor :contact, :frequency, :recurring_status, :reference, :currency, :omit_header, :payment_terms_in_days, :invoice_items
+
+    decimal_accessor :exchange_rate, :net_value, :sales_tax_value, :total_value
+
+    date_accessor :dated_on
+
+    def self.draft
+      RecurringInvoice.filter(:view => 'draft')
+    end
+
+    def self.active
+      RecurringInvoice.filter(:view => 'active')
+    end
+
+    def self.inactive
+      RecurringInvoice.filter(:view => 'inactive')
+    end
+
+    def self.find_all_by_contact(contact)
+      RecurringInvoice.filter(:contact => contact)
+    end
+  end
+end

lib/freeagent/resource.rb

@@ -113,7 +113,7 @@ def self.define_all
     def self.define_filter
       self.define_singleton_method(:filter) do |params|
         response = FreeAgent.client.get("#{endpoint[:plural]}/", params)
-        response[:endpoint[:plural]].collect{ |r| self.new(r) }
+        response[endpoint[:plural]].collect{ |r| self.new(r) }
       end
     end
 
@@ -123,6 +123,7 @@ def self.define_find
           response = FreeAgent.client.get("#{endpoint[:plural]}/#{id}")
           self.new(response[endpoint[:single]])
         rescue FreeAgent::ApiError => error
+          raise error if FreeAgent.debug 
           nil
         end
       end

lib/freeagent/task.rb

@@ -0,0 +1,24 @@
+module FreeAgent
+  class Task < Resource
+    resource :task
+
+    resource_methods :find, :filter, :update, :delete
+
+    attr_accessor :project, :name, :is_billable, :billing_period, :status
+
+    decimal_accessor :billing_rate
+
+    decimal_accessor :created_at, :updated_at
+
+    # FIXME the create action on the Task resource does a POST to
+    # https://api.freeagent.com/v2/tasks?project=:project which is
+    # inconsistent with the rest of the API. 
+    def self.create(attributes = {})
+      raise FreeAgent::NotImplemented.new("Opps creating tasks not implemented - see source for details")
+    end
+
+    def self.find_by_project(project)
+      Task.filter(:project => project)
+    end
+  end
+end