quickeebooks 0.1.2 → 0.1.3

data/lib/quickeebooks/common/online_line_item_model_methods.rb

@@ -0,0 +1,43 @@
+module OnlineLineItemModelMethods
+
+  def self.included base
+    base.send :include, InstanceMethods
+    base.extend ClassMethods
+  end
+
+  module InstanceMethods
+    def initialize
+      ensure_line_items_initialization
+    end
+
+    def valid_for_update?
+      errors.empty?
+    end
+
+    def to_xml_ns(options = {})
+      to_xml_inject_ns(self.class::XML_NODE, options)
+    end
+
+    def valid_for_deletion?
+      return false if(id.nil? || sync_token.nil?)
+      id.value.to_i > 0 && !sync_token.to_s.empty? && sync_token.to_i >= 0
+    end
+
+    private
+
+    def after_parse
+    end
+
+    def ensure_line_items_initialization
+      self.line_items ||= []
+    end
+  end
+
+  module ClassMethods
+    def resource_for_collection
+      "#{self::REST_RESOURCE}s"
+    end
+  end
+
+end
+

data/lib/quickeebooks/common/service_crud.rb

@@ -0,0 +1,56 @@
+module ServiceCRUD
+
+  def create(object)
+    raise InvalidModelException unless object.valid?
+    xml = object.to_xml_ns
+    response = do_http_post(url_for_resource(model.resource_for_singular), valid_xml_document(xml))
+    if response.code.to_i == 200
+      model.from_xml(response.body)
+    else
+      nil
+    end
+  end
+
+  def fetch_by_id(id)
+    url = "#{url_for_resource(model.resource_for_singular)}/#{id}"
+    response = do_http_get(url)
+    if response && response.code.to_i == 200
+      model.from_xml(response.body)
+    else
+      nil
+    end
+  end
+
+  def update(object)
+    raise InvalidModelException.new("Missing required parameters for update") unless object.valid_for_update?
+    url = action_url(object)
+    xml = object.to_xml_ns
+    response = do_http_post(url, valid_xml_document(xml))
+    if response.code.to_i == 200
+      model.from_xml(response.body)
+    else
+      nil
+    end
+  end
+
+  def delete(object)
+    raise InvalidModelException.new("Missing required parameters for delete") unless object.valid_for_deletion?
+    xml = valid_xml_document(object.to_xml_ns(:fields => ['Id', 'SyncToken']))
+    url = action_url(object)
+    response = do_http_post(url, xml, {:methodx => "delete"})
+    response.code.to_i == 200
+  end
+
+  def list(filters = [], page = 1, per_page = 20, sort = nil, options = {})
+    fetch_collection(model, filters, page, per_page, sort, options)
+  end
+
+  def model
+    self.class.to_s.sub(/::Service::/,'::Model::').constantize
+  end
+
+  def action_url(object)
+    url = "#{url_for_resource(model.resource_for_singular)}/#{object.id.value}"
+  end
+
+end

data/lib/quickeebooks/online/model/bill.rb

@@ -0,0 +1,26 @@
+# http://docs.developer.intuit.com/0025_Intuit_Anywhere/0050_Data_Services/v2/0400_QuickBooks_Online/Bill
+require 'quickeebooks/online/model/bill_header'
+require 'quickeebooks/online/model/bill_line_item'
+require 'quickeebooks/online/model/meta_data'
+require 'quickeebooks/common/online_line_item_model_methods'
+
+module Quickeebooks
+  module Online
+    module Model
+      class Bill < Quickeebooks::Online::Model::IntuitType
+        include ActiveModel::Validations
+        include OnlineLineItemModelMethods
+        XML_NODE = "Bill"
+        REST_RESOURCE = "bill"
+
+        xml_convention :camelcase
+        xml_accessor :id,         :from => 'Id',        :as => Quickeebooks::Online::Model::Id
+        xml_accessor :sync_token, :from => 'SyncToken', :as => Integer
+        xml_accessor :meta_data,  :from => 'MetaData',  :as => Quickeebooks::Online::Model::MetaData
+        xml_accessor :header,     :from => 'Header',    :as => Quickeebooks::Online::Model::BillHeader
+        xml_accessor :line_items, :from => 'Line',      :as => [Quickeebooks::Online::Model::BillLineItem]
+
+      end
+    end
+  end
+end

data/lib/quickeebooks/online/model/bill_header.rb

@@ -0,0 +1,21 @@
+require 'time'
+
+module Quickeebooks
+  module Online
+    module Model
+      class BillHeader < Quickeebooks::Online::Model::IntuitType
+        xml_name 'Header'
+        xml_accessor :doc_number,            :from => 'DocNumber'
+        xml_accessor :txn_date,              :from => 'TxnDate',            :as => Time
+        xml_accessor :msg,                   :from => 'Msg'
+        xml_accessor :note,                  :from => 'Note'
+        xml_accessor :status,                :from => 'Status'
+        xml_accessor :vendor_id,             :from => 'VendorId',           :as => Quickeebooks::Online::Model::Id
+        xml_accessor :total_amount,          :from => 'TotalAmt',           :as => Float
+        xml_accessor :sales_term_id,         :from => 'SalesTermId',        :as => Quickeebooks::Online::Model::Id
+        xml_accessor :due_date,              :from => 'DueDate',            :as => Time
+        xml_accessor :balance,               :from => 'Balance',            :as => Float
+      end
+    end
+  end
+end

data/lib/quickeebooks/online/model/bill_line_item.rb

@@ -0,0 +1,22 @@
+require 'quickeebooks/online/model/bill_reimbursable'
+
+module Quickeebooks 
+  module Online 
+    module Model
+      class BillLineItem < Quickeebooks::Online::Model::IntuitType
+        xml_name 'Line'
+        xml_accessor :id,                         :from => 'Id',                      :as => Integer
+        xml_accessor :desc,                       :from => 'Desc'
+        xml_accessor :amount,                     :from => 'Amount',                  :as => Float
+        xml_accessor :class_id,                   :from => 'ClassId',                 :as => Quickeebooks::Online::Model::Id
+        xml_accessor :billable_status,            :from => 'BillableStatus'
+        xml_accessor :item_id,                    :from => 'ItemId',                  :as => Quickeebooks::Online::Model::Id
+        xml_accessor :unit_price,                 :from => 'UnitPrice',               :as => Float
+        xml_accessor :quantity,                   :from => 'Qty',                     :as => Float
+        xml_accessor :override_item_account_id,   :from => 'OverrideItemAccountId',   :as => Quickeebooks::Online::Model::Id
+        xml_accessor :account_id,                 :from => 'AccountId',               :as => Quickeebooks::Online::Model::Id
+        xml_accessor :reimbursable,               :from => 'ReimbursableInfo',        :as => Quickeebooks::Online::Model::ReimbursableInfo
+      end
+    end
+  end
+end

data/lib/quickeebooks/online/model/bill_reimbursable.rb

@@ -0,0 +1,11 @@
+module Quickeebooks
+  module Online
+    module Model
+      class ReimbursableInfo < Quickeebooks::Online::Model::IntuitType
+        xml_name     'ReimbursableInfo'
+        xml_accessor :customer_id,                :from => 'CustomerId',              :as => Quickeebooks::Online::Model::Id
+        xml_accessor :customer_name,              :from => 'CustomerName'
+      end
+    end
+  end
+end

data/lib/quickeebooks/online/model/invoice.rb

@@ -5,6 +5,7 @@ require 'quickeebooks/online/model/invoice_header'
 require 'quickeebooks/online/model/invoice_line_item'
 require 'quickeebooks/online/model/address'
 require 'quickeebooks/online/model/meta_data'
+require 'quickeebooks/common/online_line_item_model_methods'
 
 
 module Quickeebooks
@@ -12,6 +13,7 @@ module Quickeebooks
     module Model
       class Invoice < Quickeebooks::Online::Model::IntuitType
         include ActiveModel::Validations
+        include OnlineLineItemModelMethods
         
         XML_NODE = "Invoice"
         REST_RESOURCE = "invoice"
@@ -34,37 +36,6 @@ module Quickeebooks
 
         validates_length_of :line_items, :minimum => 1
 
-        def initialize
-          ensure_line_items_initialization
-        end
-
-        def valid_for_update?
-          errors.empty?
-        end        
-
-        def valid_for_deletion?
-          return false if(id.nil? || sync_token.nil?)
-          id.to_i > 0 && !sync_token.to_s.empty? && sync_token.to_i >= 0
-        end
-        
-        def to_xml_ns(options = {})
-          to_xml_inject_ns(XML_NODE, options)
-        end
-        
-        #== Class methods
-        def self.resource_for_collection
-          "#{self::REST_RESOURCE}s"
-        end
-        
-        private
-
-        def after_parse
-        end
-
-        def ensure_line_items_initialization
-          self.line_items ||= []
-        end
-
       end
     end
   end

data/lib/quickeebooks/online/model/payment.rb

@@ -5,15 +5,18 @@ require 'quickeebooks/online/model/credit_card'
 require 'quickeebooks/online/model/credit_charge_info'
 require 'quickeebooks/online/model/credit_charge_response'
 require 'quickeebooks/online/model/meta_data'
+require 'quickeebooks/common/online_line_item_model_methods'
 
 module Quickeebooks
   module Online
     module Model
       class Payment  < Quickeebooks::Online::Model::IntuitType
+        include ActiveModel::Validations
+        include OnlineLineItemModelMethods
+
         XML_NODE = "Payment"
         REST_RESOURCE = "payment"
 
-        include ActiveModel::Validations
         xml_convention :camelcase
         xml_accessor :id,         :from => 'Id',        :as => Quickeebooks::Online::Model::Id
         xml_accessor :sync_token, :from => 'SyncToken', :as => Integer
@@ -21,38 +24,7 @@ module Quickeebooks
         xml_accessor :header,     :from => 'Header',    :as => Quickeebooks::Online::Model::PaymentHeader
         xml_accessor :line_items, :from => 'Line',      :as => [Quickeebooks::Online::Model::PaymentLineItem]
 
-        def initialize
-          ensure_line_items_initialization
-        end
-
-        def valid_for_update?
-          errors.empty?
-        end        
-
-        def to_xml_ns(options = {})
-          to_xml_inject_ns(XML_NODE, options)
-        end
-
-        def valid_for_deletion?
-          return false if(id.nil? || sync_token.nil?)
-          id.to_i > 0 && !sync_token.to_s.empty? && sync_token.to_i >= 0
-        end
-        
-        #== Class methods
-        def self.resource_for_collection
-          "#{self::REST_RESOURCE}s"
-        end
-
-        private
-
-        def after_parse
-        end
-
-        def ensure_line_items_initialization
-          self.line_items ||= []
-        end
-
       end
     end
   end
-end
+end

data/lib/quickeebooks/online/service/bill.rb

@@ -0,0 +1,17 @@
+require 'quickeebooks/online/service/service_base'
+require 'quickeebooks/online/model/bill'
+require 'quickeebooks/online/model/bill_header'
+require 'quickeebooks/online/model/bill_line_item'
+require 'quickeebooks/common/service_crud'
+require 'nokogiri'
+
+module Quickeebooks
+  module Online
+    module Service
+      class Bill < ServiceBase
+        include ServiceCRUD
+      end
+    end
+  end
+end
+

data/lib/quickeebooks/online/service/customer.rb

@@ -1,57 +1,13 @@
 require 'quickeebooks/online/service/service_base'
+require 'quickeebooks/common/service_crud'
 require 'nokogiri'
 
 module Quickeebooks
   module Online
     module Service
       class Customer < ServiceBase
-
-        def create(customer)
-          raise InvalidModelException unless customer.valid?
-          xml = customer.to_xml_ns
-          response = do_http_post(url_for_resource(Quickeebooks::Online::Model::Customer.resource_for_singular), valid_xml_document(xml))
-          if response.code.to_i == 200
-            Quickeebooks::Online::Model::Customer.from_xml(response.body)
-          else
-            nil
-          end
-        end
-
-        def fetch_by_id(id)
-          url = "#{url_for_resource(Quickeebooks::Online::Model::Customer.resource_for_singular)}/#{id}"
-          response = do_http_get(url)
-          if response && response.code.to_i == 200
-            Quickeebooks::Online::Model::Customer.from_xml(response.body)
-          else
-            nil
-          end
-        end
-
-        def update(customer)
-          raise InvalidModelException.new("Missing required parameters for update") unless customer.valid_for_update?
-          url = "#{url_for_resource(Quickeebooks::Online::Model::Customer.resource_for_singular)}/#{customer.id.value}"
-          xml = customer.to_xml_ns
-          response = do_http_post(url, valid_xml_document(xml))
-          if response.code.to_i == 200
-            Quickeebooks::Online::Model::Customer.from_xml(response.body)
-          else
-            nil
-          end
-        end
-
-        def delete(customer)
-          raise InvalidModelException.new("Missing required parameters for delete") unless customer.valid_for_deletion?
-          xml = valid_xml_document(customer.to_xml_ns(:fields => ['Id', 'SyncToken']))
-          url = "#{url_for_resource(Quickeebooks::Online::Model::Customer.resource_for_singular)}/#{customer.id.value}"
-          response = do_http_post(url, xml, {:methodx => "delete"})
-          response.code.to_i == 200
-        end
-
-        def list(filters = [], page = 1, per_page = 20, sort = nil, options = {})
-          fetch_collection(Quickeebooks::Online::Model::Customer, filters, page, per_page, sort, options)
-        end
-
+        include ServiceCRUD
       end
     end
   end
-end
+end

data/lib/quickeebooks/online/service/invoice.rb

@@ -29,7 +29,7 @@ module Quickeebooks
 
         def update(invoice)
           raise InvalidModelException.new("Missing required parameters for update") unless invoice.valid_for_update?
-          url = "#{url_for_resource(Quickeebooks::Online::Model::Invoice.resource_for_singular)}/#{invoice.id}"
+          url = "#{url_for_resource(Quickeebooks::Online::Model::Invoice.resource_for_singular)}/#{invoice.id.value}"
           xml = invoice.to_xml_ns
           response = do_http_post(url, valid_xml_document(xml))
           if response.code.to_i == 200

data/lib/quickeebooks/online/service/payment.rb

@@ -6,58 +6,15 @@ require 'quickeebooks/online/model/payment_detail'
 require 'quickeebooks/online/model/credit_card'
 require 'quickeebooks/online/model/credit_charge_info'
 require 'quickeebooks/online/model/credit_charge_response'
+require 'quickeebooks/common/service_crud'
 require 'nokogiri'
 
 module Quickeebooks
   module Online
     module Service
       class Payment < ServiceBase
-
-        def create(payment)
-          raise InvalidModelException unless payment.valid?
-          xml = payment.to_xml_ns
-          response = do_http_post(url_for_resource(Quickeebooks::Online::Model::Payment.resource_for_singular), valid_xml_document(xml))
-          if response.code.to_i == 200
-            Quickeebooks::Online::Model::Payment.from_xml(response.body)
-          else
-            nil
-          end
-        end
-
-        def fetch_by_id(id)
-          url = "#{url_for_resource(Quickeebooks::Online::Model::Payment.resource_for_singular)}/#{id}"
-          response = do_http_get(url)
-          if response && response.code.to_i == 200
-            Quickeebooks::Online::Model::Payment.from_xml(response.body)
-          else
-            nil
-          end
-        end
-
-        def update(payment)
-          raise InvalidModelException.new("Missing required parameters for update") unless payment.valid_for_update?
-          url = "#{url_for_resource(Quickeebooks::Online::Model::Payment.resource_for_singular)}/#{payment.id}"
-          xml = payment.to_xml_ns
-          response = do_http_post(url, valid_xml_document(xml))
-          if response.code.to_i == 200
-            Quickeebooks::Online::Model::Payment.from_xml(response.body)
-          else
-            nil
-          end
-        end
-
-        def list(filters = [], page = 1, per_page = 20, sort = nil, options = {})
-          fetch_collection(Quickeebooks::Online::Model::Payment, filters, page, per_page, sort, options)
-        end
-        
-        def delete(payment)
-          raise InvalidModelException.new("Missing required parameters for delete") unless payment.valid_for_deletion?
-          xml = valid_xml_document(payment.to_xml_ns(:fields => ['Id', 'SyncToken']))
-          url = "#{url_for_resource(Quickeebooks::Online::Model::Payment.resource_for_singular)}/#{payment.id}"
-          response = do_http_post(url, xml, {:methodx => "delete"})
-          response.code.to_i == 200
-        end
+        include ServiceCRUD
       end
     end
   end
-end
+end

data/lib/quickeebooks/online/service/service_base.rb

@@ -134,9 +134,10 @@ module Quickeebooks
             headers.merge!({'Content-Type' => 'application/xml'})
           end
           # puts "METHOD = #{method}"
-          # puts "URL = #{url}"
-          # puts "BODY = #{body == nil ? "<NIL>" : body}"
+          # puts "RESOURCE = #{resource}"
+          # puts "BODY(#{body.class}) = #{body == nil ? "<NIL>" : body.inspect}"
           # puts "HEADERS = #{headers.inspect}"
+
           response = @oauth.request(method, resource, body, headers)
           check_response(response)
         end

data/lib/quickeebooks/online/service/sort.rb

@@ -1,18 +1,7 @@
 module Quickeebooks
   module Online
     module Service
-      class Sort
-        attr_accessor :field, :how
-
-        def initialize(field, how)
-          @field = field
-          @how = how
-        end
-
-        def to_s
-          "#{field} #{how}"
-        end
-
+      class Sort < Quickeebooks::Shared::Service::Sort
       end
     end
   end

data/lib/quickeebooks/shared/service/filter.rb

@@ -39,6 +39,17 @@ module Quickeebooks
           end
         end
 
+        def to_xml
+          case @type.to_sym
+          when :text
+            text_to_xml
+          when :boolean
+            boolean_to_xml
+          else
+            raise ArgumentError, "Don't know how to generate a Filter for type #{@type}"
+          end
+        end
+
         private
 
         def number_to_s
@@ -77,10 +88,18 @@ module Quickeebooks
           "#{@field} :EQUALS: #{@value}"
         end
 
+        def text_to_xml
+          "<#{@field}>#{CGI::escapeHTML(@value.to_s)}</#{@field}>"
+        end
+
         def boolean_to_s
           "#{@field} :EQUALS: #{@value}"
         end
 
+        def boolean_to_xml
+          "<#{@field}>#{CGI::escapeHTML(@value.to_s)}</#{@field}>"
+        end
+
         def formatted_time(time)
           if time.is_a?(Date)
             time.strftime(DATE_FORMAT)
@@ -88,8 +107,6 @@ module Quickeebooks
             time.strftime(DATE_TIME_FORMAT)
           end
         end
-
-
       end
     end
   end

data/lib/quickeebooks/shared/service/sort.rb

@@ -0,0 +1,22 @@
+module Quickeebooks
+  module Shared
+    module Service
+      class Sort
+        attr_accessor :field, :how
+
+        def initialize(field, how)
+          @field = field
+          @how = how
+        end
+
+        def to_s
+          "#{field} #{how}"
+        end
+
+        def to_xml
+          "<SortByColumn sortOrder=\"#{how}\">#{field}</SortByColumn>"
+        end
+      end
+    end
+  end
+end

data/lib/quickeebooks/version.rb

@@ -1,5 +1,5 @@
 module Quickeebooks
 
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 
 end

data/lib/quickeebooks/windows/service/clazz.rb

@@ -7,11 +7,7 @@ module Quickeebooks
       class Clazz < Quickeebooks::Windows::Service::ServiceBase
 
         def list(filters = [], page = 1, per_page = 20, sort = nil, options = {})
-          custom_field_query = '<?xml version="1.0" encoding="utf-8"?>'
-          custom_field_query += '<ClassQuery xmlns="http://www.intuit.com/sb/cdm/v2">'
-          custom_field_query += "<StartPage>#{page}</StartPage><ChunkSize>#{per_page}</ChunkSize>"
-          custom_field_query += '</ClassQuery>'
-          fetch_collection(Quickeebooks::Windows::Model::Clazz, custom_field_query.strip, filters, page, per_page, sort, options)
+          fetch_collection(Quickeebooks::Windows::Model::Clazz, nil, filters, page, per_page, sort, options)
         end
 
       end

data/lib/quickeebooks/windows/service/customer.rb

@@ -6,21 +6,17 @@ module Quickeebooks
       class Customer < Quickeebooks::Windows::Service::ServiceBase
 
         def list(filters = [], page = 1, per_page = 20, sort = nil, options = {})
-          custom_field_query = '<?xml version="1.0" encoding="utf-8"?>'
-          custom_field_query += '<CustomerQuery xmlns="http://www.intuit.com/sb/cdm/v2">'
-          custom_field_query += "<StartPage>#{page}</StartPage><ChunkSize>#{per_page}</ChunkSize>"
-          custom_field_query += '</CustomerQuery>'
-          fetch_collection(Quickeebooks::Windows::Model::Customer, custom_field_query.strip, filters, page, per_page, sort, options)
+          fetch_collection(Quickeebooks::Windows::Model::Customer, nil, filters, page, per_page, sort, options)
         end
-        
+
         def fetch_by_id(id, idDomain = 'QB', options = {})
           url = "#{url_for_resource(Quickeebooks::Windows::Model::Customer::REST_RESOURCE)}/#{id}"
           fetch_object(Quickeebooks::Windows::Model::Customer, url, {:idDomain => idDomain})
         end
-        
+
         def create(customer)
           raise InvalidModelException unless customer.valid_for_create?
-          
+
           # XML is a wrapped 'object' where the type is specified as an attribute
           #    <Object xsi:type="Invoice">
           xml_node = customer.to_xml(:name => 'Object')
@@ -33,11 +29,11 @@ module Quickeebooks
           XML
           perform_write(Quickeebooks::Windows::Model::Customer, xml)
         end
-        
+
         def update(customer)
           # XML is a wrapped 'object' where the type is specified as an attribute
           #    <Object xsi:type="Invoice">
-          
+
           # Intuit requires that some fields are unset / do not exist.
           customer.meta_data = nil
           customer.external_key = nil
@@ -49,15 +45,15 @@ module Quickeebooks
           if customer.email
             customer.email.id = nil
           end
-          
+
           if customer.phones
             customer.phones.each {|phone| phone.id = nil }
           end
-          
+
           if customer.web_site
             customer.web_site.id = nil
           end
-          
+
           xml_node = customer.to_xml(:name => 'Object')
           xml_node.set_attribute('xsi:type', 'Customer')
           xml = <<-XML

data/lib/quickeebooks/windows/service/item.rb

@@ -7,10 +7,7 @@ module Quickeebooks
       class Item < Quickeebooks::Windows::Service::ServiceBase
 
         def list(filters = [], page = 1, per_page = 20, sort = nil, options = {})
-          custom_field_query = '<?xml version="1.0" encoding="utf-8"?>'
-          custom_field_query += '<ItemQuery xmlns="http://www.intuit.com/sb/cdm/v2">'
-          custom_field_query += "<StartPage>#{page}</StartPage><ChunkSize>#{per_page}</ChunkSize>"
-          custom_field_query += '<CustomFieldEnable>true</CustomFieldEnable></ItemQuery>'
+          custom_field_query = '<CustomFieldEnable>true</CustomFieldEnable>'
           fetch_collection(Quickeebooks::Windows::Model::Item, custom_field_query.strip, filters, page, per_page, sort, options)
         end
 
@@ -30,6 +27,6 @@ module Quickeebooks
 
       end
     end
-    
+
   end
 end