mirror42-freshbooks.rb 3.0.25

data/lib/freshbooks/client.rb

@@ -0,0 +1,23 @@
+module FreshBooks
+  class Client < FreshBooks::Base
+    define_schema do |s|
+      s.string :first_name, :last_name, :organization, :email
+      s.string :username, :password, :work_phone, :home_phone
+      s.string :mobile, :fax, :notes, :p_street1, :p_street2, :p_city
+      s.string :p_state, :p_country, :p_code, :s_street1, :s_street2
+      s.string :s_city, :s_state, :s_country, :s_code
+      s.string :vat_name, :vat_number
+      s.float :credit, :read_only => true
+      s.date_time :updated, :read_only => true
+      s.fixnum :client_id
+      s.object :links, :read_only => true
+    end
+    
+    actions :list, :get, :create, :update, :delete
+    
+    def invoices(options = {})
+      options.merge!('client_id' => self.client_id)
+      Invoice::list(options)
+    end
+  end
+end

data/lib/freshbooks/connection.rb

@@ -0,0 +1,162 @@
+require 'net/https'
+require 'rexml/document'
+require 'logger'
+
+module FreshBooks
+  class Connection
+    attr_reader :account_url, :auth_token, :utc_offset, :request_headers
+    
+    @@logger = Logger.new(STDOUT)
+    def logger
+      @@logger
+    end
+
+    def logger=(value)
+      @@logger = value
+    end
+
+    def self.log_level=(level)
+      @@logger.level = level
+    end
+    self.log_level = Logger::WARN
+    
+    def initialize(account_url, auth_token, request_headers = {}, options = {})
+      raise InvalidAccountUrlError.new unless account_url =~ /^[0-9a-zA-Z\-_]+\.freshbooks\.com$/
+      
+      @account_url = account_url
+      @auth_token = auth_token
+      @request_headers = request_headers
+      @utc_offset = options[:utc_offset] || -4
+      @start_session_count = 0
+    end
+    
+    def call_api(method, elements = [])
+      request = create_request(method, elements)
+      result = post(request)
+      Response.new(result)
+    end
+    
+    def direct_post(xml)
+      result = post(xml)
+      Response.new(result)
+    end
+    
+    def start_session(&block)
+      @connection = obtain_connection if @start_session_count == 0
+      @start_session_count = @start_session_count + 1
+      
+      begin
+        block.call(@connection)
+      ensure
+        @start_session_count = @start_session_count - 1
+        close if @start_session_count == 0
+      end
+    end
+    
+  protected
+    
+    def create_request(method, elements = [])
+      doc = REXML::Document.new '<?xml version="1.0" encoding="UTF-8"?>'
+      request = doc.add_element('request')
+      request.attributes['method'] = method
+      
+      elements.each do |element|
+        if element.kind_of?(Hash)
+          element = element.to_a
+        end
+        key = element.first
+        value = element.last
+        
+        if value.kind_of?(Base)
+          request.add_element(REXML::Document.new(value.to_xml))
+        else
+          request.add_element(REXML::Element.new(key.to_s)).text = value.to_s
+        end
+      end
+      
+      doc.to_s
+    end
+    
+    def obtain_connection(force = false)
+      return @connection if @connection && !force
+      
+      @connection = Net::HTTP.new(@account_url, 443)
+      @connection.use_ssl = true
+      @connection.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      @connection.start
+    end
+    
+    def reconnect
+      close
+      obtain_connection(true)
+    end
+    
+    def close
+      begin
+        @connection.finish if @connection
+      rescue => e
+        logger.error("Error closing connection: " + e.message)
+      end
+      @connection = nil
+    end
+    
+    def post(request_body)
+      result = nil
+      request = Net::HTTP::Post.new(FreshBooks::SERVICE_URL)
+      request.basic_auth @auth_token, 'X'
+      request.body = request_body
+      request.content_type = 'application/xml'
+      @request_headers.each_pair do |name, value|
+        request[name.to_s] = value
+      end
+      
+      result = post_request(request)
+      
+      if logger.debug?
+        logger.debug "Request:"
+        logger.debug request_body
+        logger.debug "Response:"
+        logger.debug result.body
+      end
+      
+      check_for_api_error(result)
+    end
+    
+    # For connections that take a long time, we catch EOFError's and reconnect seamlessly
+    def post_request(request)
+      response = nil
+      has_reconnected = false
+      start_session do |connection|
+        begin
+          response = connection.request(request)
+        rescue EOFError => e
+          raise e if has_reconnected
+          
+          has_reconnected = true
+          connection = reconnect
+          retry
+        end
+      end
+      response
+    end
+    
+    def check_for_api_error(result)
+      return result.body if result.kind_of?(Net::HTTPSuccess)
+      
+      case result
+      when Net::HTTPRedirection
+        if result["location"] =~ /loginSearch/
+          raise UnknownSystemError.new("Account does not exist")
+        elsif result["location"] =~ /deactivated/
+          raise AccountDeactivatedError.new("Account is deactivated")
+        end
+      when Net::HTTPUnauthorized
+        raise AuthenticationError.new("Invalid API key.")
+      when Net::HTTPBadRequest
+        raise ApiAccessNotEnabledError.new("API not enabled.")
+      end
+      
+      raise InternalError.new("Invalid HTTP code: #{result.class}")
+    end
+  end
+end

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, :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,22 @@
+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, :discount
+      s.float :amount_outstanding, :paid, :read_only => true
+      s.date :date
+      s.date_time :updated, :read_only => true
+      s.array :lines
+      s.object :links, :read_only => true
+      s.string :number, :organization, :status, :notes, :terms, :first_name, :last_name, :currency_code
+      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,11 @@
+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.float :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, :read_only => true
+      s.string :type, :notes
+    end
+    
+    actions :list, :get, :create, :update, :delete
+  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,16 @@
+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, :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
+      s.string :return_uri
+    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 = ActiveSupport::OrderedHash.new
+      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