quickeebooks 0.0.3 → 0.0.4

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

@@ -12,9 +12,12 @@ module Quickeebooks
 
         XML_COLLECTION_NODE = 'Items'
         XML_NODE = 'Item'
+        
+        # https://services.intuit.com/sb/item/v2/<realmID>
+        REST_RESOURCE = "item"
 
         xml_name 'Item'
-        xml_accessor :id, :from => 'Id'
+        xml_accessor :id, :from => 'Id', :as => Quickeebooks::Windows::Model::Id
         xml_accessor :sync_token, :from => 'SyncToken', :as => Integer
         xml_accessor :external_key, :from => 'ExternalKey'
         xml_accessor :synchronized, :from => 'Synchronized'
@@ -22,7 +25,7 @@ module Quickeebooks
         xml_accessor :custom_fields, :from => 'CustomField', :as => [Quickeebooks::Windows::Model::CustomField]
         xml_accessor :draft
         xml_accessor :object_state, :from => 'ObjectState'
-        xml_accessor :item_parent_id, :from => 'ItemParentId'
+        xml_accessor :item_parent_id, :from => 'ItemParentId', :as => Quickeebooks::Windows::Model::Id
         xml_accessor :item_parent_name, :from => 'ItemParentName'
         xml_accessor :name, :from => 'Name'
         xml_accessor :desc, :from => 'Desc'
@@ -31,7 +34,7 @@ module Quickeebooks
         xml_accessor :active
         xml_accessor :rate_percent, :from => 'RatePercent'
         xml_accessor :type, :from => 'Type'
-        xml_accessor :uomid, :from => 'UOMId'
+        xml_accessor :uomid, :from => 'UOMId', :as => Quickeebooks::Windows::Model::Id
         xml_accessor :uomabbrv, :from => 'UOMAbbrv'
         xml_accessor :account_reference, :from => 'IncomeAccountRef', :as => Quickeebooks::Windows::Model::AccountReference
         xml_accessor :purchase_desc, :from => 'PurchaseDesc'

data/lib/quickeebooks/windows/model/object_ref.rb

@@ -0,0 +1,14 @@
+module Quickeebooks
+  module Windows
+    module Model
+      class ObjectRef < Quickeebooks::Windows::Model::IntuitType
+        
+        xml_convention :camelcase
+        xml_accessor :id, :as => Quickeebooks::Windows::Model::Id
+        xml_accessor :sync_token, :as => Integer
+        xml_accessor :last_updated_time, :as => Time
+        
+      end
+    end
+  end
+end

data/lib/quickeebooks/windows/model/other_name.rb

@@ -0,0 +1,16 @@
+require "quickeebooks"
+require 'quickeebooks/windows/model/other_name_id'
+
+module Quickeebooks
+  module Windows
+    module Model
+      class OtherName < Quickeebooks::Windows::Model::IntuitType
+        
+        xml_convention :camelcase
+        xml_accessor :other_name_id, :from => 'OtherNameId', :as => Quickeebooks::Windows::Model::OtherNameId
+        xml_accessor :other_name_name
+
+      end
+    end
+  end
+end

data/lib/quickeebooks/windows/model/other_name_id.rb

@@ -0,0 +1,21 @@
+require "quickeebooks"
+
+module Quickeebooks
+  module Windows
+    module Model
+      class OtherNameId < Quickeebooks::Windows::Model::IntuitType
+        
+        DOMAIN = "QB"
+        
+        xml_convention :camelcase
+        xml_accessor :idDomain, :from => '@idDomain' # Attribute with name 'idDomain'
+        xml_accessor :value, :from => :content
+        
+        def initialize(value = nil)
+          self.idDomain = DOMAIN
+          self.value = value
+        end
+      end
+    end
+  end
+end

data/lib/quickeebooks/windows/model/rest_response.rb

@@ -0,0 +1,34 @@
+require "quickeebooks/windows/model/success"
+require "quickeebooks/windows/model/error"
+
+module Quickeebooks
+  module Windows
+    module Model
+      class RestResponse < Quickeebooks::Windows::Model::IntuitType
+        
+        xml_convention :camelcase
+        xml_accessor :success, :as => Quickeebooks::Windows::Model::Success
+        xml_accessor :error, :as => Quickeebooks::Windows::Model::Error
+        
+        def success?
+          success != nil
+        end
+        
+        def error?
+          error != nil
+        end
+        
+        def to_s
+          s = "#<RestResponse>: "
+          if success?
+            s += "Success[#{success.request_name}] @ #{success.processed_time} - "
+          else
+            s += "Error[#{error.request_name}] @ #{error.processed_time} - "
+            s += "Code: #{error.code}, Desc: #{error.desc}"
+          end
+        end
+        
+      end
+    end
+  end
+end

data/lib/quickeebooks/windows/model/sales_rep.rb

@@ -0,0 +1,40 @@
+require 'quickeebooks'
+require 'quickeebooks/windows/model/id'
+require 'quickeebooks/windows/model/vendor'
+require 'quickeebooks/windows/model/other_name'
+require 'quickeebooks/windows/model/external_key'
+require 'quickeebooks/windows/model/meta_data'
+
+module Quickeebooks
+  module Windows
+    module Model
+      class SalesRep < Quickeebooks::Windows::Model::IntuitType
+
+        XML_COLLECTION_NODE = 'SalesReps'
+        XML_NODE = 'SalesRep'
+        
+        # https://services.intuit.com/sb/salesrep/v2/<realmID>
+        REST_RESOURCE = "salesrep"
+        
+        xml_convention :camelcase
+        xml_accessor :id, :as => Quickeebooks::Windows::Model::Id
+        xml_accessor :meta_data, :from => 'MetaData', :as => Quickeebooks::Windows::Model::MetaData
+        xml_accessor :external_key, :as => Quickeebooks::Windows::Model::ExternalKey
+        xml_accessor :synchronized
+        xml_accessor :name_of, :from => 'NameOf'
+        xml_accessor :vendor, :as => Quickeebooks::Windows::Model::Vendor
+        xml_accessor :other_name, :as => Quickeebooks::Windows::Model::OtherName
+        xml_accessor :initials
+        
+        def vendor?
+          vendor != nil
+        end
+        
+        def other_name?
+          other_name != nil
+        end
+
+      end
+    end
+  end
+end

data/lib/quickeebooks/windows/model/sales_tax.rb

@@ -0,0 +1,33 @@
+require 'quickeebooks'
+require 'quickeebooks/windows/model/id'
+require 'quickeebooks/windows/model/external_key'
+require 'quickeebooks/windows/model/custom_field'
+require 'quickeebooks/windows/model/meta_data'
+
+module Quickeebooks
+  module Windows
+    module Model
+      class SalesTax < Quickeebooks::Windows::Model::IntuitType
+
+        XML_COLLECTION_NODE = 'SalesTaxes'
+        XML_NODE = 'SalesTax'
+        
+        # https://services.intuit.com/sb/salestax/v2/<realmID>
+        REST_RESOURCE = "salestax"
+        
+        xml_convention :camelcase
+        xml_accessor :id, :as => Quickeebooks::Windows::Model::Id
+        xml_accessor :sync_token
+        xml_accessor :meta_data, :from => 'MetaData', :as => Quickeebooks::Windows::Model::MetaData
+        xml_accessor :external_key, :as => Quickeebooks::Windows::Model::ExternalKey
+        xml_accessor :synchronized
+        xml_accessor :custom_fields, :as => [Quickeebooks::Windows::Model::CustomField]
+        xml_accessor :name
+        xml_accessor :desc
+        xml_accessor :tax_rate, :as => Float
+        
+
+      end
+    end
+  end
+end

data/lib/quickeebooks/windows/model/ship_method.rb

@@ -0,0 +1,31 @@
+require 'quickeebooks'
+require 'quickeebooks/windows/model/id'
+require 'quickeebooks/windows/model/external_key'
+require 'quickeebooks/windows/model/custom_field'
+require 'quickeebooks/windows/model/meta_data'
+
+module Quickeebooks
+  module Windows
+    module Model
+      class ShipMethod < Quickeebooks::Windows::Model::IntuitType
+
+        XML_COLLECTION_NODE = 'ShipMethods'
+        XML_NODE = 'ShipMethod'
+        
+        # https://services.intuit.com/sb/shipmethod/v2/<realmID>
+        REST_RESOURCE = "shipmethod"
+        
+        xml_convention :camelcase
+        xml_accessor :id, :as => Quickeebooks::Windows::Model::Id
+        xml_accessor :sync_token
+        xml_accessor :meta_data, :from => 'MetaData', :as => Quickeebooks::Windows::Model::MetaData
+        xml_accessor :external_key, :as => Quickeebooks::Windows::Model::ExternalKey
+        xml_accessor :synchronized
+        xml_accessor :custom_fields, :as => [Quickeebooks::Windows::Model::CustomField]
+        xml_accessor :name
+        xml_accessor :active
+
+      end
+    end
+  end
+end

data/lib/quickeebooks/windows/model/success.rb

@@ -0,0 +1,17 @@
+require "quickeebooks/windows/model/object_ref"
+module Quickeebooks
+  module Windows
+    module Model
+      class Success < Quickeebooks::Windows::Model::IntuitType
+        
+        xml_convention :camelcase
+        
+        xml_accessor :request_id, :from => '@RequestId'
+        xml_accessor :object_ref, :as => Quickeebooks::Windows::Model::ObjectRef
+        xml_accessor :request_name
+        xml_accessor :processed_time, :as => Time
+        
+      end
+    end
+  end
+end

data/lib/quickeebooks/windows/model/vendor.rb

@@ -0,0 +1,16 @@
+require "quickeebooks"
+require 'quickeebooks/windows/model/vendor_id'
+
+module Quickeebooks
+  module Windows
+    module Model
+      class Vendor < Quickeebooks::Windows::Model::IntuitType
+        
+        xml_convention :camelcase
+        xml_accessor :vendor_id, :from => 'VendorId', :as => Quickeebooks::Windows::Model::VendorId
+        xml_accessor :vendor_name
+
+      end
+    end
+  end
+end

data/lib/quickeebooks/windows/model/vendor_id.rb

@@ -0,0 +1,21 @@
+require "quickeebooks"
+
+module Quickeebooks
+  module Windows
+    module Model
+      class VendorId < Quickeebooks::Windows::Model::IntuitType
+        
+        DOMAIN = "QB"
+        
+        xml_convention :camelcase
+        xml_accessor :idDomain, :from => '@idDomain' # Attribute with name 'idDomain'
+        xml_accessor :value, :from => :content
+        
+        def initialize(value = nil)
+          self.idDomain = DOMAIN
+          self.value = value
+        end
+      end
+    end
+  end
+end

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

@@ -11,7 +11,7 @@ module Quickeebooks
           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("customer", "Customer", Quickeebooks::Windows::Model::Customer, custom_field_query.strip, filters, page, per_page, sort, options)
+          fetch_collection(Quickeebooks::Windows::Model::Customer, custom_field_query.strip, filters, page, per_page, sort, options)
         end
 
       end

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

@@ -0,0 +1,15 @@
+require 'quickeebooks/windows/service/service_base'
+
+module Quickeebooks
+  module Windows
+    module Service
+      class CustomerMsg < Quickeebooks::Windows::Service::ServiceBase
+
+        def list(filters = [], page = 1, per_page = 20, sort = nil, options = {})
+          fetch_collection(Quickeebooks::Windows::Model::CustomerMsg, nil, filters, page, per_page, sort, options)
+        end
+        
+      end
+    end
+  end
+end

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

@@ -18,7 +18,25 @@ module Quickeebooks
         # sort: +Sort+ object
         # options: +Hash+ extra arguments
         def list(filters = [], page = 1, per_page = 20, sort = nil, options = {})
-          fetch_collection("invoices", "Invoice", Quickeebooks::Windows::Model::Invoice, nil, filters, page, per_page, sort, options)
+          fetch_collection(Quickeebooks::Windows::Model::Invoice, nil, filters, page, per_page, sort, options)
+        end
+        
+        def invoice_as_pdf(invoice_id, destination_file_name)
+          raise NoMethodError, 'invoice_as_pdf is not implemented in Quickeebooks for Windows, only available in the Online adapter.'
+        end
+        
+        def create(invoice)
+          # XML is a wrapped 'object' where the type is specified as an attribute
+          #    <Object xsi:type="Invoice">
+          xml_node = invoice.to_xml(:name => 'Object')
+          xml_node.set_attribute('xsi:type', 'Invoice')
+          xml = <<-XML
+          <Add xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" RequestId="#{guid}" xmlns="http://www.intuit.com/sb/cdm/v2">
+          <ExternalRealmId>#{self.realm_id}</ExternalRealmId>
+          #{xml_node}
+          </Add>
+          XML
+          perform_write(Quickeebooks::Windows::Model::Invoice, xml)
         end
 
       end

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

@@ -11,7 +11,7 @@ module Quickeebooks
           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>'
-          fetch_collection("item", "Item", Quickeebooks::Windows::Model::Item, custom_field_query.strip, filters, page, per_page, sort, options)
+          fetch_collection(Quickeebooks::Windows::Model::Item, custom_field_query.strip, filters, page, per_page, sort, options)
         end
 
       end

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

@@ -0,0 +1,16 @@
+require 'quickeebooks/windows/model/sales_rep'
+require 'quickeebooks/windows/service/service_base'
+
+module Quickeebooks
+  module Windows
+    module Service
+      class SalesRep < Quickeebooks::Windows::Service::ServiceBase
+
+        def list(filters = [], page = 1, per_page = 20, sort = nil, options = {})
+          fetch_collection(Quickeebooks::Windows::Model::SalesRep, nil, filters, page, per_page, sort, options)
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+require 'quickeebooks/windows/service/service_base'
+
+module Quickeebooks
+  module Windows
+    module Service
+      class SalesTax < Quickeebooks::Windows::Service::ServiceBase
+
+        def list(filters = [], page = 1, per_page = 20, sort = nil, options = {})
+          fetch_collection(Quickeebooks::Windows::Model::SalesTax, nil, filters, page, per_page, sort, options)
+        end
+        
+      end
+    end
+  end
+end

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

@@ -1,6 +1,7 @@
 require 'rexml/document'
 require 'uri'
 require 'cgi'
+require 'uuidtools'
 
 class IntuitRequestException < Exception
   attr_accessor :code, :cause
@@ -23,9 +24,24 @@ module Quickeebooks
 
         XML_NS = %{xmlns:ns2="http://www.intuit.com/sb/cdm/qbo" xmlns="http://www.intuit.com/sb/cdm/v2" xmlns:ns3="http://www.intuit.com/sb/cdm"}
 
-        def initialize(oauth_access_token, realm_id)
+        def initialize(oauth_access_token = nil, realm_id = nil)
           @base_uri = 'https://services.intuit.com/sb'
-          @oauth = oauth_access_token
+          
+          if !oauth_access_token.nil? && !realm_id.nil?
+            msg = "Quickeebooks::Windows::ServiceBase - "
+            msg += "This version of the constructor is deprecated. "
+            msg += "Use the no-arg constructor and set the AccessToken and the RealmID using the accessors."
+            warn(msg)
+            access_token = oauth_access_token
+            realm_id = realm_id
+          end
+        end
+        
+        def access_token=(token)
+          @oauth = token
+        end
+        
+        def realm_id=(realm_id)
           @realm_id = realm_id
         end
 
@@ -36,6 +52,10 @@ module Quickeebooks
         def url_for_base(raw)
           "#{@base_uri}/#{raw}/v2/#{@realm_id}"
         end
+        
+        def guid
+          UUIDTools::UUID.random_create.to_s.gsub('-', '')
+        end
 
         private
 
@@ -52,15 +72,13 @@ module Quickeebooks
           %Q{<?xml version="1.0" encoding="utf-8"?>\n#{xml.strip}}
         end
 
-        def fetch_collection(resource, container, model, custom_field_query = nil, filters = [], page = 1, per_page = 20, sort = nil, options ={})
-          raise ArgumentError, "missing resource to fetch" if resource.nil?
-          raise ArgumentError, "missing result container" if container.nil?
+        def fetch_collection(model, custom_field_query = nil, filters = [], page = 1, per_page = 20, sort = nil, options ={})
           raise ArgumentError, "missing model to instantiate" if model.nil?
 
           if custom_field_query != nil
-            response = do_http_post(url_for_resource(resource), custom_field_query, {}, {'Content-Type' => 'text/xml'})
+            response = do_http_post(url_for_resource(model::REST_RESOURCE), custom_field_query, {}, {'Content-Type' => 'text/xml'})
           else
-            response = do_http_get(url_for_resource(resource), {}, {'Content-Type' => 'text/html'})
+            response = do_http_get(url_for_resource(model::REST_RESOURCE), {}, {'Content-Type' => 'text/html'})
           end
           if response
             collection = Quickeebooks::Collection.new
@@ -78,7 +96,7 @@ module Quickeebooks
               collection.entries = results
               collection.current_page = 1 # TODO: fix this
             rescue => ex
-              log("Error parsing XML: #{ex.message}")
+              #log("Error parsing XML: #{ex.message}")
               raise IntuitRequestException.new("Error parsing XML: #{ex.message}")
             end
             collection
@@ -86,6 +104,27 @@ module Quickeebooks
             nil
           end
         end
+        
+        def perform_write(model, body = "", params = {}, headers = {})
+          url = url_for_resource(model::REST_RESOURCE)
+          unless headers.has_key?('Content-Type')
+            headers['Content-Type'] = 'text/xml'
+          end
+          response = do_http_post(url, body.strip, params, headers)
+          
+          result = nil
+          if response
+            case response.code.to_i
+            when 200
+              result = Quickeebooks::Windows::Model::RestResponse.from_xml(response.body)
+            when 401
+              raise IntuitRequestException.new("Authorization failure: token timed out?")
+            when 404
+              raise IntuitRequestException.new("Resource Not Found: Check URL and try again")
+            end
+          end
+          result
+        end
 
         def do_http_post(url, body = "", params = {}, headers = {}) # throws IntuitRequestException
           url = add_query_string_to_url(url, params)