freshbooks.rb 3.0.13

data/lib/freshbooks/estimate.rb

@@ -0,0 +1,15 @@
+module FreshBooks
+  class Estimate < FreshBooks::Base
+    define_schema do |s|
+      s.string :estimate_id, :status, :date, :notes, :terms, :first_name
+      s.string :last_name, :organization, :p_street1, :p_street2, :p_city
+      s.string :p_state, :p_country, :p_code
+      s.fixnum :client_id, :po_number
+      s.float :discount, :amount
+      s.array :lines
+      s.object :links, :read_only => true
+    end
+    
+    actions :list, :get, :create, :update, :delete, :send_by_email
+  end
+end

data/lib/freshbooks/expense.rb

@@ -0,0 +1,12 @@
+module FreshBooks
+  class Expense < FreshBooks::Base
+    define_schema do |s|
+      s.fixnum :expense_id, :staff_id, :category_id, :project_id, :client_id
+      s.float :amount, :tax1_amount, :tax1_percent, :tax2_amount, :tax2_percent
+      s.date :date
+      s.string :notes, :vendor, :status, :tax1_name, :tax2_name
+    end
+    
+    actions :list, :get, :create, :update, :delete
+  end
+end

data/lib/freshbooks/invoice.rb

@@ -0,0 +1,18 @@
+module FreshBooks
+  class Invoice < FreshBooks::Base
+    define_schema do |s|
+      s.fixnum :invoice_id, :client_id, :po_number
+      s.fixnum :recurring_id, :read_only => true
+      s.float :amount, :amount_outstanding, :discount, :paid
+      s.date :date
+      s.date_time :updated
+      s.array :lines
+      s.object :links, :read_only => true
+      s.string :number, :organization, :status, :notes, :terms, :first_name, :last_name
+      s.string :p_street1, :p_street2, :p_city, :p_state, :p_country, :p_code
+      s.string :return_uri
+    end
+    
+    actions :list, :get, :create, :update, :delete, :send_by_email, :send_by_snail_mail
+  end
+end

data/lib/freshbooks/item.rb

@@ -0,0 +1,11 @@
+module FreshBooks
+  class Item < FreshBooks::Base
+    define_schema do |s|
+      s.fixnum :item_id, :quantity, :inventory
+      s.float :unit_cost
+      s.string :name, :description
+    end
+  
+    actions :create, :update, :get, :delete, :list
+  end
+end

data/lib/freshbooks/line.rb

@@ -0,0 +1,10 @@
+module FreshBooks
+  class Line < FreshBooks::Base
+    define_schema do |s|
+      s.string :name, :description, :tax1_name, :tax2_name
+      s.float :unit_cost, :tax1_percent, :tax2_percent
+      s.float :amount, :read_only => true
+      s.fixnum :quantity
+    end
+  end
+end

data/lib/freshbooks/links.rb

@@ -0,0 +1,7 @@
+module FreshBooks
+  class Links < FreshBooks::Base
+    define_schema do |s|
+      s.string :client_view, :view, :edit, :read_only => true
+    end
+  end
+end

data/lib/freshbooks/list_proxy.rb

@@ -0,0 +1,80 @@
+module FreshBooks
+  class ListProxy
+    include Enumerable
+    
+    def initialize(list_page_proc)
+      @list_page_proc = list_page_proc
+      move_to_page(1)
+    end
+    
+    def each(&block)
+      move_to_page(1)
+      
+      begin
+        @array.each(&block)
+      end while @current_page.next_page? && next_page
+    end
+    
+    def [](position)
+      move_to_page(@current_page.page_number(position))
+      @array[@current_page.position_number(position)]
+    end
+    
+    def size
+      @current_page.total
+    end
+    
+  private
+    
+    def next_page
+      move_to_page(@current_page.page + 1)
+    end
+    
+    def move_to_page(page)
+      return true if @current_page && @current_page.page == page
+      @array, @current_page = @list_page_proc.call(page)
+    end
+  end
+  
+  class Page
+    attr_reader :page, :per_page, :total
+    
+    def initialize(page, per_page, total, total_in_array = total)
+      @page = page.to_i
+      @per_page = per_page.to_i
+      @total = total.to_i
+      
+      # Detect if response has pagination
+      if @per_page == 0 && @total == 0 && total_in_array != 0
+        # No pagination so fake it
+        @page = 1
+        @per_page = @total = total_in_array
+      end
+    end
+    
+    # Get the page number that this element is on given the number of elements per page
+    def page_number(position)
+      (position / per_page) + 1
+    end
+    
+    # Get the position number of this element based relative to the current page
+    def position_number(position)
+      position - ((page - 1) * per_page)
+    end
+    
+    def pages
+      return 0 if per_page == 0
+      
+      pages = total / per_page
+      
+      if (total % per_page) != 0
+        pages += 1
+      end
+      pages
+    end
+    
+    def next_page?
+      page < pages
+    end
+  end
+end

data/lib/freshbooks/payment.rb

@@ -0,0 +1,13 @@
+module FreshBooks
+  class Payment < FreshBooks::Base
+    define_schema do |s|
+      s.fixnum :client_id, :invoice_id, :payment_id
+      s.float :amount
+      s.date :date
+      s.date_time :updated
+      s.string :type, :notes
+    end
+    
+    actions :list, :get, :create, :update
+  end
+end

data/lib/freshbooks/project.rb

@@ -0,0 +1,12 @@
+module FreshBooks
+  class Project < FreshBooks::Base
+    define_schema do |s|
+      s.string :name, :bill_method, :description
+      s.fixnum :project_id, :client_id
+      s.float :rate
+      s.array :tasks
+    end
+    
+    actions :list, :get, :create, :update, :delete
+  end
+end

data/lib/freshbooks/recurring.rb

@@ -0,0 +1,15 @@
+module FreshBooks
+  class Recurring < FreshBooks::Base
+    define_schema do |s|
+      s.string :first_name, :last_name, :organization, :p_street1, :p_street2, :p_city
+      s.string :p_state, :p_country, :p_code, :lines, :status, :notes, :terms, :frequency
+      s.date :date
+      s.fixnum :recurring_id, :client_id, :po_number, :occurrences
+      s.float :discount, :amount
+      s.array :lines
+      s.boolean :stopped, :send_email, :send_snail_mail
+    end
+    
+    actions :list, :get, :create, :update, :delete
+  end
+end

data/lib/freshbooks/response.rb

@@ -0,0 +1,25 @@
+module FreshBooks
+  class Response
+    attr_accessor :doc
+    
+    def initialize(xml_raw)
+      @doc = REXML::Document.new(xml_raw)
+    end
+    
+    def elements
+      @doc.root.elements
+    end
+    
+    def success?
+      @doc.root.attributes['status'] == 'ok'
+    end
+    
+    def fail?
+      !success?
+    end
+    
+    def error_msg
+      return @doc.root.elements['error'].text
+    end
+  end
+end

data/lib/freshbooks/schema/definition.rb

@@ -0,0 +1,20 @@
+module FreshBooks
+  module Schema
+    class Definition
+      attr_reader :members
+      
+      def initialize
+        @members = {}
+      end
+      
+      def method_missing(method, *attributes)
+        options = attributes.extract_options!
+        options[:read_only] ||= false
+        
+        attributes.each do |attribute|
+          @members[attribute.to_s] = options.merge({ :type => method.to_sym })
+        end
+      end
+    end
+  end
+end

data/lib/freshbooks/schema/mixin.rb

@@ -0,0 +1,40 @@
+require File.dirname(__FILE__) + '/definition'
+
+module FreshBooks
+  module Schema
+    module Mixin
+      def self.included(base)
+        base.extend ClassMethods
+      end
+    
+      module ClassMethods
+        def define_schema
+          # Create the class method accessor for the schema definition
+          cattr_accessor :schema_definition
+          self.schema_definition ||= FreshBooks::Schema::Definition.new
+          
+          # Yield to the block for the user to define the schema
+          yield self.schema_definition
+          
+          # Process the schema additions
+          schema_definition.members.each do |member|
+            process_schema_member(member)
+          end
+        end
+        
+        def process_schema_member(member)
+          member_name = member.first
+          member_options = member.last
+          
+          # Create accessor
+          attr_accessor member_name
+          
+          # Protect write if read only
+          if member_options[:read_only]
+            protected "#{member_name}="
+          end
+        end
+      end
+    end
+  end
+end

data/lib/freshbooks/staff.rb

@@ -0,0 +1,13 @@
+module FreshBooks
+  class Staff < FreshBooks::Base
+    define_schema do |s|
+      s.fixnum :staff_id, :number_of_logins
+      s.string :username, :first_name, :last_name, :email, :business_phone, :mobile_phone
+      s.string :street1, :street2, :city, :state, :country, :code
+      s.float :rate
+      s.date_time :last_login, :signup_date
+    end
+    
+    actions :list, :get
+  end
+end

data/lib/freshbooks/task.rb

@@ -0,0 +1,12 @@
+module FreshBooks
+  class Task < FreshBooks::Base
+    define_schema do |s|
+      s.fixnum :task_id
+      s.string :name, :description
+      s.float :rate
+      s.boolean :billable
+    end
+    
+    actions :list, :get, :create, :update, :delete
+  end
+end

data/lib/freshbooks/time_entry.rb

@@ -0,0 +1,12 @@
+module FreshBooks
+  class TimeEntry < FreshBooks::Base
+    define_schema do |s|
+      s.fixnum :time_entry_id, :project_id, :task_id, :staff_id
+      s.float :hours
+      s.date :date
+      s.string :notes
+    end
+    
+    actions :list, :get, :create, :update, :delete
+  end
+end

data/lib/freshbooks/xml_serializer.rb

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) + '/xml_serializer/serializers'
+
+module FreshBooks
+  module XmlSerializer
+    def self.to_value(node, type)
+      create_serializer(type).to_value(node)
+    end
+    
+    def self.to_node(member_name, value, type)
+      create_serializer(type).to_node(member_name, value)
+    end
+    
+    def self.create_serializer(type)
+      "FreshBooks::XmlSerializer::#{type.to_s.classify}Serializer".constantize
+    end
+  end
+end

data/lib/freshbooks/xml_serializer/serializers.rb

@@ -0,0 +1,109 @@
+module FreshBooks
+  module XmlSerializer
+    class FixnumSerializer
+      def self.to_node(member_name, value)
+        element = REXML::Element.new(member_name)
+        element.text = value.to_s
+        element
+      end
+      
+      def self.to_value(xml_val)
+        xml_val.text.to_i
+      end
+    end
+    
+    class FloatSerializer
+      def self.to_node(member_name, value)
+        element = REXML::Element.new(member_name)
+        element.text = value.to_s
+        element
+      end
+      
+      def self.to_value(xml_val)
+        xml_val.text.to_f 
+      end
+    end
+    
+    class DateSerializer
+      def self.to_node(member_name, value)
+        element = REXML::Element.new(member_name)
+        element.text = value.to_s
+        element
+      end
+      
+      def self.to_value(xml_val)
+        begin
+          Date.parse(xml_val.text.to_s) 
+        rescue ArgumentError => e
+          # Sometimes freshbooks gives dates that look like this 0000-00-00 00:00:00
+          # just default to todays date, you have any other suggestions?
+          Date.new
+        end
+      end
+    end
+    
+    class StringSerializer
+      def self.to_node(member_name, value)
+        element = REXML::Element.new(member_name)
+        element.text = value.to_s
+        element
+      end
+      
+      def self.to_value(xml_val)
+        xml_val.text.to_s
+      end
+    end
+    
+    class BooleanSerializer
+      def self.to_node(member_name, value)
+        element = REXML::Element.new(member_name)
+        element.text = value ? '1' : '0'
+        element
+      end
+      
+      def self.to_value(xml_val)
+        xml_val.text.to_s == "1" 
+      end
+    end
+    
+    class ObjectSerializer
+      def self.to_node(member_name, value)
+        REXML::Document.new(value.to_xml(member_name))
+      end
+      
+      def self.to_value(xml_val)
+        FreshBooks::const_get(xml_val.name.camelize)::new_from_xml(xml_val) 
+      end
+    end
+    
+    class ArraySerializer
+      def self.to_node(member_name, value)
+        element = REXML::Element.new(member_name)
+        value.each { |array_elem|
+          element.add_element(REXML::Document.new(array_elem.to_xml))
+        }
+        element
+      end
+      
+      def self.to_value(xml_val)
+        xml_val.elements.map { |elem|
+          FreshBooks::const_get(elem.name.camelize)::new_from_xml(elem)
+        }
+      end
+    end
+    
+    # FreshBooks datetimes are specified in gmt-4. This library assumes utc and
+    # will convert to the appropriate timezone.
+    class DateTimeSerializer
+      def self.to_node(member_name, value)
+        element = REXML::Element.new(member_name)
+        element.text = (value.utc - 4.hours).to_s(:db) # hack to convert to gmt-4, any better way?
+        element
+      end
+      
+      def self.to_value(xml_val)
+        DateTime.parse(xml_val.text.to_s + " -04:00").utc # hack to convert from gmt-4 to utc
+      end
+    end
+  end
+end