quickeebooks 0.0.3 → 0.0.4

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

@@ -17,34 +17,42 @@ module Quickeebooks
       class ServiceBase
         attr_accessor :realm_id
         attr_accessor :oauth
-        attr_reader :base_uri
+        attr_accessor :base_uri
 
         QB_BASE_URI = "https://qbo.intuit.com/qbo1/rest/user/v2"
         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_consumer_token, realm_id, base_url = nil)
-          @oauth = oauth_consumer_token
-          @realm_id = realm_id
-          if base_url.nil?
-            determine_base_url
-          else
-            uri = URI.parse(base_url)
-            if uri.host.nil?
-              raise ArgumentError, "#{base_url} doesn't appear to be a valid host name!"
-            end
-            @base_uri = base_url
+        def initialize(oauth_access_token = nil, realm_id = nil)
+          if !oauth_access_token.nil? && !realm_id.nil?
+            msg = "Quickeebooks::Online::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
+          determine_base_url
+        end
+        
+        def base_url=(uri)
+          @base_uri = uri
+        end
+
         # Given a realm ID we need to determine the real Base URL
         # to use for all subsequenet REST operations
         # See: https://ipp.developer.intuit.com/0010_Intuit_Partner_Platform/0050_Data_Services/0400_QuickBooks_Online/0100_Calling_Data_Services/0010_Getting_the_Base_URL
         def determine_base_url
-          response = @oauth.request(:get, qb_base_uri_with_realm_id)
-          if response
-            if response.code == "200"
-              doc = parse_xml(response.body)
-              element = doc.xpath("//qbo:QboUser/qbo:CurrentCompany/qbo:BaseURI")[0]
+          if service_response
+            if service_response.code == "200"
+              element = base_doc.xpath("//qbo:QboUser/qbo:CurrentCompany/qbo:BaseURI")[0]
               if element
                 @base_uri = element.text
               end
@@ -67,7 +75,29 @@ module Quickeebooks
           "#{QB_BASE_URI}/#{@realm_id}"
         end
 
+        # store service base response
+        # so it can be accessed by other methods
+        def service_response
+          @service_response ||= @oauth.request(:get, qb_base_uri_with_realm_id)
+        end
+
+        # allows for reuse of service base's xml doc
+        # rather than loading it each time we need it
+        def base_doc
+          @base_doc ||= parse_xml(service_response.body)
+        end
+        
+        # gives us the qbo user's LoginName
+        # useful for verifying email address against
+        def login_name
+          @login_name ||= base_doc.xpath("//qbo:QboUser/qbo:LoginName")[0].text
+        end
+
         private
+        
+        def determined_base_url?
+          @base_uri != nil
+        end
 
         def parse_xml(xml)
           Nokogiri::XML(xml)
@@ -77,10 +107,10 @@ module Quickeebooks
           %Q{<?xml version="1.0" encoding="utf-8"?>\n#{xml.strip}}
         end
 
-        def fetch_collection(resource, container, model, 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, filters = [], page = 1, per_page = 20, sort = nil, options ={})
           raise ArgumentError, "missing model to instantiate" if model.nil?
+          
+          determine_base_url unless determined_base_url?
 
           post_body_lines = []
 
@@ -97,7 +127,7 @@ module Quickeebooks
           end
 
           body = post_body_lines.join("&")
-          response = do_http_post(url_for_resource(resource), body, {}, {'Content-Type' => 'application/x-www-form-urlencoded'})
+          response = do_http_post(url_for_resource(model.resource_for_collection), body, {}, {'Content-Type' => 'application/x-www-form-urlencoded'})
           if response
             collection = Quickeebooks::Collection.new
             xml = parse_xml(response.body)
@@ -105,14 +135,14 @@ module Quickeebooks
               results = []
               collection.count = xml.xpath("//qbo:SearchResults/qbo:Count")[0].text.to_i
               if collection.count > 0
-                xml.xpath("//qbo:SearchResults/qbo:CdmCollections/xmlns:#{container}").each do |xa|
+                xml.xpath("//qbo:SearchResults/qbo:CdmCollections/xmlns:#{model::XML_NODE}").each do |xa|
                   results << model.from_xml(xa)
                 end
               end
               collection.entries = results
               collection.current_page = xml.xpath("//qbo:SearchResults/qbo:CurrentPage")[0].text.to_i
             rescue => ex
-              log("Error parsing XML: #{ex.message}")
+              #log("Error parsing XML: #{ex.message}")
               raise IntuitRequestException.new("Error parsing XML: #{ex.message}")
             end
             collection
@@ -121,25 +151,26 @@ module Quickeebooks
           end
         end
 
-        def do_http_post(url, body = "", params = {}, headers = {}) # throws IntuitRequestException
-          url = add_query_string_to_url(url, params)
-          do_http(:post, url, body, headers)
+        def do_http_post(resource, body = "", params = {}, headers = {}) # throws IntuitRequestException
+          url = add_query_string_to_url(resource, params)
+          do_http(:post, resource, body, headers)
         end
 
-        def do_http_get(url, params = {}, headers = {}) # throws IntuitRequestException
+        def do_http_get(resource, params = {}, headers = {}) # throws IntuitRequestException
           url = add_query_string_to_url(url, params)
-          do_http(:get, url, "", headers)
+          do_http(:get, resource, "", headers)
         end
 
-        def do_http(method, url, body, headers) # throws IntuitRequestException
+        def do_http(method, resource, body, headers) # throws IntuitRequestException
           unless headers.has_key?('Content-Type')
             headers.merge!({'Content-Type' => 'application/xml'})
           end
+          determine_base_url unless determined_base_url?
           # puts "METHOD = #{method}"
           # puts "URL = #{url}"
           # puts "BODY = #{body == nil ? "<NIL>" : body}"
           # puts "HEADERS = #{headers.inspect}"
-          response = @oauth.request(method, url, body, headers)
+          response = @oauth.request(method, resource, body, headers)
           check_response(response)
         end
 
@@ -199,4 +230,4 @@ module Quickeebooks
       end
     end
   end
-end
+end

data/lib/quickeebooks/version.rb

@@ -1,5 +1,5 @@
 module Quickeebooks
 
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 
 end

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

@@ -7,6 +7,13 @@ module Quickeebooks
     module Model
       class Account < Quickeebooks::Windows::Model::IntuitType
         include ActiveModel::Validations
+        
+        XML_COLLECTION_NODE = 'Accounts'
+        XML_NODE = 'Account'
+        
+        # https://services.intuit.com/sb/account/v2/<realmID>
+        REST_RESOURCE = "account"
+        
         xml_convention :camelcase
         xml_accessor :id, :from => 'Id'
         xml_accessor :sync_token, :from => 'SyncToken', :as => Integer

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

@@ -29,6 +29,14 @@ module Quickeebooks
         def default?
           default == "true"
         end
+        
+        def state
+          country_sub_division_code
+        end
+        
+        def state=(new_state)
+          self.country_sub_division_code = new_state
+        end
 
       end
     end

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

@@ -4,7 +4,7 @@ module Quickeebooks
   module Windows
     module Model
       class CustomField < Quickeebooks::Windows::Model::IntuitType
-        xml_accessor :definition_id, :from => 'DefinitionId'
+        xml_accessor :definition_id, :from => 'DefinitionId', :as => Quickeebooks::Windows::Model::Id
         xml_accessor :value, :from => 'Value'
         xml_accessor :name, :from => 'Name'
       end

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

@@ -18,8 +18,11 @@ module Quickeebooks
         XML_COLLECTION_NODE = 'Customers'
         XML_NODE = 'Customer'
         
+        # https://services.intuit.com/sb/customer/v2/<realmID>
+        REST_RESOURCE = "customer"
+        
         xml_convention :camelcase
-        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 :synchronized, :from => 'Synchronized'
         xml_accessor :meta_data, :from => 'MetaData', :as => Quickeebooks::Windows::Model::MetaData
@@ -76,6 +79,14 @@ module Quickeebooks
           active == 'true'
         end
         
+        def billing_address
+          addresses.detect { |address| address.tag == "Billing" }
+        end
+
+        def shipping_address
+          addresses.detect { |address| address.tag == "Shipping" }
+        end
+        
         def has_required_attributes
           if name.is_a?(String) && name.index(':') != nil
             errors.add(:name, "Attribute :name cannot contain a colon")

data/lib/quickeebooks/windows/model/customer_msg.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 CustomerMsg < Quickeebooks::Windows::Model::IntuitType
+
+        XML_COLLECTION_NODE = 'CustomerMsgs'
+        XML_NODE = 'CustomerMsg'
+        
+        # https://services.intuit.com/sb/customermsg/v2/<realmID>
+        REST_RESOURCE = "customermsg"
+        
+        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/error.rb

@@ -0,0 +1,19 @@
+require "quickeebooks/windows/model/object_ref"
+module Quickeebooks
+  module Windows
+    module Model
+      class Error < 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
+        xml_accessor :code, :from => 'ErrorCode'
+        xml_accessor :desc, :from => 'ErrorDesc'
+        
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require "quickeebooks"
+
+module Quickeebooks
+  module Windows
+    module Model
+      class ExternalKey < 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/id.rb

@@ -0,0 +1,21 @@
+require "quickeebooks"
+
+module Quickeebooks
+  module Windows
+    module Model
+      class Id < 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/invoice.rb

@@ -1,3 +1,4 @@
+require 'quickeebooks/windows/model/id'
 require 'quickeebooks/windows/model/invoice_header'
 require 'quickeebooks/windows/model/invoice_line_item'
 require 'quickeebooks/windows/model/address'
@@ -9,8 +10,15 @@ module Quickeebooks
     module Model
       class Invoice < Quickeebooks::Windows::Model::IntuitType
         include ActiveModel::Validations
+        
+        XML_COLLECTION_NODE = 'Invoices'
+        XML_NODE = 'Invoice'
+        
+        # https://services.intuit.com/sb/invoice/v2/<realmID>
+        REST_RESOURCE = "invoice"
+        
         xml_convention :camelcase
-        xml_accessor :id, :from => 'Id', :as => Integer
+        xml_accessor :id, :from => 'Id', :as => Quickeebooks::Windows::Model::Id
         xml_accessor :sync_token, :from => 'SyncToken', :as => Integer
         xml_accessor :meta_data, :from => 'MetaData', :as => Quickeebooks::Windows::Model::MetaData
         xml_accessor :external_key, :from => 'ExternalKey'
@@ -27,7 +35,7 @@ module Quickeebooks
         def initialize
           ensure_line_items_initialization
         end
-
+        
         private
 
         def after_parse

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

@@ -14,26 +14,24 @@ module Quickeebooks
         xml_accessor :msg, :from => 'Msg'
         xml_accessor :note, :from => 'Note'
         xml_accessor :status, :from => 'Status'
-        xml_accessor :customer_id, :from => 'CustomerId'
+        xml_accessor :customer_id, :from => 'CustomerId', :as => Quickeebooks::Windows::Model::Id
         xml_accessor :customer_name, :from => 'CustomerName'
-        xml_accessor :job_id, :from => 'JobId'
+        xml_accessor :job_id, :from => 'JobId', :as => Quickeebooks::Windows::Model::Id
         xml_accessor :job_name, :from => 'JobName'
-        xml_accessor :remit_to_id, :from => 'RemitToId'
+        xml_accessor :remit_to_id, :from => 'RemitToId', :as => Quickeebooks::Windows::Model::Id
         xml_accessor :remit_to_name, :from => 'RemitToName'
-        xml_accessor :class_id, :from => 'ClassId'
+        xml_accessor :class_id, :from => 'ClassId', :as => Quickeebooks::Windows::Model::Id
         xml_accessor :class_name, :from => 'ClassName'
-        xml_accessor :sales_rep_id, :from => 'SalesRepId'
+        xml_accessor :sales_rep_id, :from => 'SalesRepId', :as => Quickeebooks::Windows::Model::Id
         xml_accessor :sales_rep_name, :from => 'SalesRepName'
-        xml_accessor :sales_rep_id, :from => 'SalesRepId'
-        xml_accessor :sales_rep_name, :from => 'SalesRepName'
-        xml_accessor :sales_tax_code_id, :from => 'SalesTaxCodeId'
+        xml_accessor :sales_tax_code_id, :from => 'SalesTaxCodeId', :as => Quickeebooks::Windows::Model::Id
         xml_accessor :sales_tax_code_name, :from => 'SalesTaxCodeName'
         xml_accessor :po_number, :from => 'PONumber'
         xml_accessor :ship_date, :from => 'ShipDate', :as => Time
         xml_accessor :sub_total_amount, :from => 'SubTotalAmt', :as => Float
-        xml_accessor :tax_id, :from => 'TaxId'
-        xml_accessor :tax_name, :from => 'TaxName'
-        xml_accessor :tax_group_id, :from => 'TaxGroupId'
+        xml_accessor :tax_id, :from => 'TaxId' # FEIN
+        xml_accessor :tax_name, :from => 'TaxName' # Business Name related to the FEIN
+        xml_accessor :tax_group_id, :from => 'TaxGroupId', :as => Quickeebooks::Windows::Model::Id
         xml_accessor :tax_group_name, :from => 'TaxGroupName'
         xml_accessor :tax_rate, :from => 'TaxRate', :as => Float
         xml_accessor :tax_amount, :from => 'TaxAmt', :as => Float
@@ -41,17 +39,17 @@ module Quickeebooks
         xml_accessor :to_be_printed, :from => 'ToBePrinted'
         xml_accessor :to_be_emailed, :from => 'ToBeEmailed'
         xml_accessor :custom, :from => 'Custom'
-        xml_accessor :ar_account_id, :from => 'ARAccountId'
+        xml_accessor :ar_account_id, :from => 'ARAccountId', :as => Quickeebooks::Windows::Model::Id
         xml_accessor :ar_account_name, :from => 'ARAccountName'
-        xml_accessor :sales_term_id, :from => 'SalesTermId'
+        xml_accessor :sales_term_id, :from => 'SalesTermId', :as => Quickeebooks::Windows::Model::Id
         xml_accessor :sales_term_name, :from => 'SalesTermName'
         xml_accessor :due_date, :from => 'DueDate', :as => Time
         xml_accessor :billing_address, :from => 'BillAddr', :as => Quickeebooks::Windows::Model::Address
         xml_accessor :shipping_address, :from => 'ShipAddr', :as => Quickeebooks::Windows::Model::Address
         xml_accessor :bill_email, :from => 'BillEmail'
-        xml_accessor :ship_method_id, :from => 'ShipMethodId'
+        xml_accessor :ship_method_id, :from => 'ShipMethodId', :as => Quickeebooks::Windows::Model::Id
         xml_accessor :ship_method_name, :from => 'ShipMethodName'
-        xml_accessor :balance, :from => 'Balance'
+        xml_accessor :balance, :from => 'Balance', :as => Float
         xml_accessor :discount_amount, :from => 'DiscountAmt', :as => Float
         xml_accessor :discount_rate, :from => 'DiscountRate', :as => Float
         xml_accessor :discount_account_id, :from => 'DiscountAccountId'

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

@@ -3,35 +3,35 @@ module Quickeebooks
     module Model
       class InvoiceLineItem < Quickeebooks::Windows::Model::IntuitType
         xml_name 'Line'
-        xml_accessor :id, :from => 'Id'
+        xml_accessor :id, :from => 'Id', :as => Quickeebooks::Windows::Model::Id
         xml_accessor :desc, :from => 'Desc'
         xml_accessor :group_member, :from => 'GroupMember'
         xml_accessor :custom_fields, :from => 'CustomField', :as => [Quickeebooks::Windows::Model::CustomField]
         xml_accessor :amount, :from => 'Amount', :as => Float
-        xml_accessor :class_id, :from => 'ClassId'
+        xml_accessor :class_id, :from => 'ClassId', :as => Quickeebooks::Windows::Model::Id
         xml_accessor :class_name, :from => 'ClassName'
         xml_accessor :taxable, :from => 'Taxable'
-        xml_accessor :item_id, :from => 'ItemId'
+        xml_accessor :item_id, :from => 'ItemId', :as => Quickeebooks::Windows::Model::Id
         xml_accessor :item_name, :from => 'ItemName'
         xml_accessor :item_type, :from => 'ItemType'        
         xml_accessor :unit_price, :from => 'UnitPrice', :as => Float
         xml_accessor :rate_percent, :from => 'RatePercent', :as => Float
-        xml_accessor :price_level_id, :from => 'PriceLevelId'
+        xml_accessor :price_level_id, :from => 'PriceLevelId', :as => Quickeebooks::Windows::Model::Id
         xml_accessor :price_level_name, :from => 'PriceLevelName'
         xml_accessor :uom_id, :from => 'UOMId'
         xml_accessor :uom_abbrev, :from => 'UOMAbbrv'
         xml_accessor :override_item_account_id, :from => 'OverrideItemAccountId'
         xml_accessor :override_item_account_name, :from => 'OverrideItemAccountName'
-        xml_accessor :discount_id, :from => 'DiscountId'
+        xml_accessor :discount_id, :from => 'DiscountId', :as => Quickeebooks::Windows::Model::Id
         xml_accessor :discount_name, :from => 'DiscountName'
         xml_accessor :quantity, :from => 'Qty', :as => Float
-        xml_accessor :sales_tax_code_id, :from => 'SalesTaxCodeId'
+        xml_accessor :sales_tax_code_id, :from => 'SalesTaxCodeId', :as => Quickeebooks::Windows::Model::Id
         xml_accessor :sales_tax_code_name, :from => 'SalesTaxCodeName'
         xml_accessor :service_date, :from => 'ServiceDate', :as => Time
         xml_accessor :custom1, :from => 'Custom1'
         xml_accessor :custom2, :from => 'Custom2'
         xml_accessor :txn_id, :from => 'TxnId'
-        xml_accessor :txn_line_id, :from => 'TxnLineId'
+        xml_accessor :txn_line_id, :from => 'TxnLineId', :as => Quickeebooks::Windows::Model::Id
       end
     end
   end