quickbooks-ruby 0.4.0 → 1.0.16

data/lib/quickbooks/model/line_ex.rb

@@ -0,0 +1,9 @@
+
+module Quickbooks
+  module Model
+    class LineEx < BaseModel
+
+      xml_accessor :name_values, :from => "NameValue", :as => [NameValue]
+    end
+  end
+end

data/lib/quickbooks/model/linked_transaction.rb

@@ -1,9 +1,16 @@
 module Quickbooks
   module Model
     class LinkedTransaction < BaseModel
+      #== Constants
+      DEFAULT_TXN_TYPE = 'BillPaymentCheck'.freeze
+
       xml_accessor :txn_id, :from => 'TxnId'
       xml_accessor :txn_type, :from => 'TxnType'
       xml_accessor :txn_line_id, :from => 'TxnLineId'
+
+      def bill_payment_check_type?
+        txn_type.to_s == DEFAULT_TXN_TYPE
+      end
     end
   end
 end

data/lib/quickbooks/model/physical_address.rb

@@ -20,11 +20,11 @@ module Quickbooks
       end
 
       def lat_to_f
-        BigDecimal.new(lat)
+        BigDecimal(lat)
       end
 
       def lon_to_f
-        BigDecimal.new(lon)
+        BigDecimal(lon)
       end
 
       def have_lat?

data/lib/quickbooks/model/preferences.rb

@@ -19,16 +19,40 @@ module Quickbooks
       PREFERENCE_SECTIONS = {
         :accounting_info      => %w(TrackDepartments DepartmentTerminology ClassTrackingPerTxnLine? ClassTrackingPerTxn? CustomerTerminology),
         :product_and_services => %w(ForSales? ForPurchase? QuantityWithPriceAndRate? QuantityOnHand?),
-        :sales_forms          => %w(CustomTxnNumbers? AllowDeposit? AllowDiscount? DefaultDiscountAccount? AllowEstimates? EstimateMessage? 
-                                                ETransactionEnabledStatus? ETransactionAttachPDF? ETransactionPaymentEnabled? IPNSupportEnabled? 
-                                                AllowServiceDate? AllowShipping? DefaultShippingAccount? DefaultTerms DefaultCustomerMessage),
         :vendor_and_purchase  => %w(TrackingByCustomer? BillableExpenseTracking? DefaultTerms? DefaultMarkup? POCustomField),
         :time_tracking        => %w(UseServices? BillCustomers? ShowBillRateToAll WorkWeekStartDate MarkTimeEntiresBillable?),
-        :tax                  => %w(UsingSalesTax?),
+        :tax                  => %w(UsingSalesTax? PartnerTaxEnabled?),
         :currency             => %w(MultiCurrencyEnabled? HomeCurrency),
         :report               => %w(ReportBasis)
       }
 
+      xml_reader :sales_forms, :from => "SalesFormsPrefs", :as => create_preference_class(*%w(
+        AllowDeposit?
+        AllowDiscount?
+        AllowEstimates?
+        AllowServiceDate?
+        AllowShipping?
+        AutoApplyCredit?
+        CustomField?
+        CustomTxnNumbers?
+        DefaultCustomerMessage
+        DefaultDiscountAccount?
+        DefaultShippingAccount?
+        DefaultTerms
+        EmailCopyToCompany?
+        EstimateMessage
+        ETransactionAttachPDF?
+        ETransactionEnabledStatus
+        ETransactionPaymentEnabled?
+        IPNSupportEnabled?
+        SalesEmailBcc
+        SalesEmailCc
+        UsingPriceLevels?
+        UsingProgressInvoicing?
+      )) {
+        xml_reader :custom_fields, :as => [CustomField], :from => 'CustomField', in: 'CustomField'
+      }
+
       PREFERENCE_SECTIONS.each do |section_name, fields|
         xml_reader section_name, :from => "#{section_name}_prefs".camelize, :as => create_preference_class(*fields)
       end

data/lib/quickbooks/model/purchase_change.rb

@@ -0,0 +1,7 @@
+module Quickbooks
+  module Model
+    class PurchaseChange < ChangeModel
+      XML_NODE = "Purchase"
+    end
+  end
+end

data/lib/quickbooks/model/purchase_line_item.rb

@@ -12,6 +12,7 @@ module Quickbooks
       xml_accessor :description, :from => 'Description'
       xml_accessor :amount, :from => 'Amount', :as => BigDecimal, :to_xml => Proc.new { |val| val.to_f }
       xml_accessor :detail_type, :from => 'DetailType'
+      xml_accessor :received, :from => 'Received', :as => BigDecimal, :to_xml => to_xml_big_decimal
 
       #== Various detail types
       xml_accessor :account_based_expense_line_detail, :from => ACCOUNT_BASED_EXPENSE_LINE_DETAIL, :as => AccountBasedExpenseLineDetail

data/lib/quickbooks/model/purchase_order.rb

@@ -16,6 +16,7 @@ module Quickbooks
       xml_accessor :txn_date, :from => 'TxnDate', :as => Date
       xml_accessor :custom_fields, :from => 'CustomField', :as => [CustomField]
       xml_accessor :private_note, :from => 'PrivateNote'
+      xml_accessor :memo, :from => 'Memo'
 
       xml_accessor :linked_transactions, :from => 'LinkedTxn', :as => [LinkedTransaction]
       xml_accessor :line_items, :from => 'Line', :as => [PurchaseLineItem]
@@ -23,10 +24,11 @@ module Quickbooks
       xml_accessor :attachable_ref, :from => 'AttachableRef', :as => BaseReference
       xml_accessor :vendor_ref, :from => 'VendorRef', :as => BaseReference
       xml_accessor :ap_account_ref, :from => 'APAccountRef', :as => BaseReference
+      xml_accessor :po_email, from: "POEmail", as: EmailAddress
       xml_accessor :class_ref, :from => 'ClassRef', :as => BaseReference
       xml_accessor :sales_term_ref, :from => 'SalesTermRef', :as => BaseReference
 
-      xml_accessor :total, :from => 'TotalAmt', :as => BigDecimal, :to_xml => Proc.new { |val| val.to_f }
+      xml_accessor :total, :from => 'TotalAmt', :as => BigDecimal, :to_xml => to_xml_big_decimal
       xml_accessor :due_date, :from => 'DueDate', :as => Date
       xml_accessor :vendor_address, :from => 'VendorAddr', :as => PhysicalAddress
       xml_accessor :ship_address, :from => 'ShipAddr', :as => PhysicalAddress

data/lib/quickbooks/model/refund_receipt_change.rb

@@ -0,0 +1,8 @@
+module Quickbooks
+  module Model
+    # Refer to: https://developer.intuit.com/docs/0100_accounting/0300_developer_guides/change_data_capture
+    class RefundReceiptChange < ChangeModel
+      XML_NODE = "RefundReceipt"
+    end
+  end
+end

data/lib/quickbooks/model/report.rb

@@ -37,16 +37,18 @@ module Quickbooks
         row_node.elements.map.with_index do |el, i|
           value = el.attr('value')
 
-          if i.zero? # Return the first column as a string, its the label.
-            value
-          elsif value.blank?
-            nil
-          else
-            BigDecimal(value)
-          end
+          next nil if value.blank?
+
+          parse_row_value(value)
         end
       end
 
+      def parse_row_value(value)
+        BigDecimal(value)
+      rescue ArgumentError
+        value
+      end
+
     end
   end
 end

data/lib/quickbooks/model/sales_receipt.rb

@@ -20,6 +20,7 @@ module Quickbooks
       xml_accessor :department_ref, :from => 'DepartmentRef', :as => BaseReference
       xml_accessor :bill_email, :from => 'BillEmail', :as => EmailAddress
       xml_accessor :bill_address, :from => 'BillAddr', :as => PhysicalAddress
+      xml_accessor :delivery_info, :from => 'DeliveryInfo', :as => DeliveryInfo
       xml_accessor :ship_address, :from => 'ShipAddr', :as => PhysicalAddress
       xml_accessor :po_number, :from => 'PONumber'
       xml_accessor :ship_method_ref, :from => 'ShipMethodRef', :as => BaseReference
@@ -54,9 +55,10 @@ module Quickbooks
       validate :line_item_size
       validate :document_numbering
 
-      def email=(email)
-        self.bill_email = EmailAddress.new(email)
+      def billing_email_address=(email_address_string)
+        self.bill_email = EmailAddress.new(email_address_string)
       end
+      alias_method :email=, :billing_email_address=  # backward backward compatibility to v0.4.6
 
     end
   end

data/lib/quickbooks/model/tax_rate.rb

@@ -16,7 +16,7 @@ module Quickbooks
       xml_accessor :tax_return_line_ref, :from => "TaxReturnLineRef", :as => BaseReference
       xml_accessor :special_tax_type, :from => "SpecialTaxType"
       xml_accessor :display_type, :from => "DisplayType"
-      xml_accessor :effective_tax_rate, :from => "EffectiveTaxRate"
+      xml_accessor :effective_tax_rate, :from => "EffectiveTaxRate", :as => [EffectiveTaxRate]
 
       validates_presence_of :name, :rate_value
 

data/lib/quickbooks/model/time_activity.rb

@@ -43,10 +43,11 @@ module Quickbooks
       validates_inclusion_of :name_of, :in => NAMEOF_OPTIONS
       validate :existence_of_employee_ref, :if => Proc.new { |ta| ta.name_of == "Employee" }
       validate :existence_of_vendor_ref, :if => Proc.new { |ta| ta.name_of == "Vendor" }
+      validates :description, length: { maximum: 4000 }
 
       def existence_of_employee_ref
         if employee_ref.nil? || (employee_ref && employee_ref.value == 0)
-          errors.add(:employee_ref, "VendorRef is required and must be a non-zero value.")
+          errors.add(:employee_ref, "EmployeeRef is required and must be a non-zero value.")
         end
       end
 

data/lib/quickbooks/model/transfer.rb

@@ -0,0 +1,21 @@
+module Quickbooks
+  module Model
+    class Transfer < BaseModel
+      XML_COLLECTION_NODE = "Transfer"
+      XML_NODE = "Transfer"
+      REST_RESOURCE = 'transfer'
+
+      xml_accessor :id, :from => 'Id'
+      xml_accessor :sync_token, :from => 'SyncToken', :as => Integer
+      xml_accessor :meta_data, :from => 'MetaData', :as => MetaData
+      xml_accessor :txn_date, :from => 'TxnDate', :as => Date
+      xml_accessor :currency_ref, :from => 'CurrencyRef', :as => BaseReference
+      xml_accessor :private_note, :from => 'PrivateNote'
+      xml_accessor :from_account_ref, :from => 'FromAccountRef', :as => BaseReference
+      xml_accessor :to_account_ref, :from => 'ToAccountRef', :as => BaseReference
+      xml_accessor :amount, :from => 'Amount', :as => BigDecimal, :to_xml => to_xml_big_decimal
+
+      reference_setters :currency_ref, :to_account_ref, :from_account_ref
+    end
+  end
+end

data/lib/quickbooks/model/vendor.rb

@@ -41,6 +41,7 @@ module Quickbooks
       xml_accessor :account_number, :from => 'AcctNum'
       xml_accessor :is_1099?, :from => 'Vendor1099'
       xml_accessor :currency_ref, :from => 'CurrencyRef', :as => BaseReference
+      xml_accessor :bill_rate, from: "BillRate", as: BigDecimal, to_xml: to_xml_big_decimal
 
       #== Validations
       validate :names_cannot_contain_invalid_characters

data/lib/quickbooks/service/access_token.rb

@@ -3,7 +3,7 @@ module Quickbooks
     class AccessToken < BaseService
 
       RENEW_URL = "https://appcenter.intuit.com/api/v1/connection/reconnect"
-      DISCONNECT_URL = "https://appcenter.intuit.com/api/v1/connection/disconnect"
+      DISCONNECT_URL = "https://developer.api.intuit.com/v2/oauth2/tokens/revoke"
 
       # https://developer.intuit.com/docs/0025_quickbooksapi/0053_auth_auth/oauth_management_api#Reconnect
       def renew
@@ -21,18 +21,19 @@ module Quickbooks
 
       # https://developer.intuit.com/docs/0025_quickbooksapi/0053_auth_auth/oauth_management_api#Disconnect
       def disconnect
-        result = nil
-        response = do_http_get(DISCONNECT_URL)
-        if response
-          code = response.code.to_i
-          if code == 200
-            result = Quickbooks::Model::AccessTokenResponse.from_xml(response.plain_body)
-          end
-        end
+        conn = Faraday.new
+        conn.basic_auth oauth.client.id, oauth.client.secret
+        url = "#{DISCONNECT_URL}?minorversion=#{Quickbooks.minorversion}"
+        response = conn.post(url, token: oauth.refresh_token || oauth.token)
 
-        result
+        if response.success?
+          Quickbooks::Model::AccessTokenResponse.new(error_code: "0")
+        else
+          Quickbooks::Model::AccessTokenResponse.new(
+            error_code: response.status.to_s, error_message: response.reason_phrase
+          )
+        end
       end
-
     end
   end
 end

data/lib/quickbooks/service/base_service.rb

@@ -7,8 +7,11 @@ module Quickbooks
       attr_accessor :company_id
       attr_accessor :oauth
       attr_reader :base_uri
-      attr_reader :last_response_body
       attr_reader :last_response_xml
+      attr_reader :last_response_intuit_tid
+      attr_accessor :before_request
+      attr_accessor :around_request
+      attr_accessor :after_request
 
       XML_NS = %{xmlns="http://schema.intuit.com/finance/v3"}
       HTTP_CONTENT_TYPE = 'application/xml'
@@ -17,6 +20,8 @@ module Quickbooks
       BASE_DOMAIN = 'quickbooks.api.intuit.com'
       SANDBOX_DOMAIN = 'sandbox-quickbooks.api.intuit.com'
 
+      RequestInfo = Struct.new(:url, :headers, :body, :method)
+
       def initialize(attributes = {})
         domain = Quickbooks.sandbox_mode ? SANDBOX_DOMAIN : BASE_DOMAIN
         @base_uri = "https://#{domain}/v3/company"
@@ -25,6 +30,7 @@ module Quickbooks
 
       def access_token=(token)
         @oauth = token
+        rebuild_connection!
       end
 
       def company_id=(company_id)
@@ -36,6 +42,22 @@ module Quickbooks
         @company_id = company_id
       end
 
+      # def oauth_v2?
+      #   @oauth.is_a? OAuth2::AccessToken
+      # end
+
+      # [OAuth2] The default Faraday connection does not have gzip or multipart support.
+      # We need to reset the existing connection and build a new one.
+      def rebuild_connection!
+        @oauth.client.connection = nil
+        @oauth.client.connection.build do |builder|
+          builder.use :gzip
+          builder.request :multipart
+          builder.request :url_encoded
+          builder.adapter :net_http
+        end
+      end
+
       def url_for_resource(resource)
         "#{url_for_base}/#{resource}"
       end
@@ -49,15 +71,19 @@ module Quickbooks
         self.class::HTTP_CONTENT_TYPE == "application/json"
       end
 
+      def is_pdf?
+        self.class::HTTP_CONTENT_TYPE == "application/pdf"
+      end
+
       def default_model_query
         "SELECT * FROM #{self.class.name.split("::").last}"
       end
 
-      def url_for_query(query = nil, start_position = 1, max_results = 20)
+      def url_for_query(query = nil, start_position = 1, max_results = 20, options = {})
         query ||= default_model_query
         query = "#{query} STARTPOSITION #{start_position} MAXRESULTS #{max_results}"
 
-        "#{url_for_base}/query?query=#{URI.encode_www_form_component(query)}"
+        "#{url_for_base}/query?query=#{CGI.escape(query)}"
       end
 
       private
@@ -174,6 +200,21 @@ module Quickbooks
         do_http(:get, url, {}, headers)
       end
 
+      def do_http_raw_get(url, params = {}, headers = {})
+        url = add_query_string_to_url(url, params)
+        unless headers.has_key?('Content-Type')
+          headers['Content-Type'] = self.class::HTTP_CONTENT_TYPE
+        end
+        unless headers.has_key?('Accept')
+          headers['Accept'] = self.class::HTTP_ACCEPT
+        end
+        unless headers.has_key?('Accept-Encoding')
+          headers['Accept-Encoding'] = HTTP_ACCEPT_ENCODING
+        end
+        raw_response = oauth_get(url, headers)
+        Quickbooks::Service::Responses::OAuthHttpResponse.wrap(raw_response)
+      end
+
       def do_http_file_upload(uploadIO, url, metadata = nil)
         headers = {
           'Content-Type' => 'multipart/form-data'
@@ -188,6 +229,8 @@ module Quickbooks
           body['file_metadata_0'] = param_part
         end
 
+        url = add_query_string_to_url(url, {})
+
         do_http(:upload, url, body, headers)
       end
 
@@ -211,31 +254,71 @@ module Quickbooks
         log_request_body(body)
         log "REQUEST HEADERS = #{headers.inspect}"
 
-        response = case method
+        request_info = RequestInfo.new(url, headers, body, method)
+        before_request.call(request_info) if before_request
+
+        raw_response = with_around_request(request_info) do
+          case method
           when :get
-            @oauth.get(url, headers)
+            oauth_get(url, headers)
           when :post
-            @oauth.post(url, body, headers)
+            oauth_post(url, body, headers)
           when :upload
-            @oauth.post_with_multipart(url, body, headers)
+            oauth_post_with_multipart(url, body, headers)
           else
             raise "Do not know how to perform that HTTP operation"
           end
-        check_response(response, :request => body)
+        end
+
+        after_request.call(request_info, raw_response.body) if after_request
+
+        response = Quickbooks::Service::Responses::OAuthHttpResponse.wrap(raw_response)
+        log "------ QUICKBOOKS-RUBY RESPONSE ------"
+        log "RESPONSE CODE = #{response.code}"
+        log_response_body(response)
+        if response.respond_to?(:headers)
+          log "RESPONSE HEADERS = #{response.headers}"
+        end
+        check_response(response, request: body)
+      end
+
+      def oauth_get(url, headers)
+        @oauth.get(url, headers: headers, raise_errors: false)
       end
 
-      def add_query_string_to_url(url, params)
+      def oauth_post(url, body, headers)
+        @oauth.post(url, headers: headers, body: body, raise_errors: false)
+      end
+
+      def oauth_post_with_multipart(url, body, headers)
+        @oauth.post_with_multipart(url, headers: headers, body: body, raise_errors: false)
+      end
+
+      def add_query_string_to_url(url, params = {})
+        params ||= {}
+        params['minorversion'] = Quickbooks.minorversion
         if params.is_a?(Hash) && !params.empty?
-          url + "?" + params.collect { |k| "#{k.first}=#{k.last}" }.join("&")
+          keyvalues = params.collect { |k| "#{k.first}=#{k.last}" }.join("&")
+          delim = url.index("?") != nil ? "&" : "?"
+          url + delim + keyvalues
         else
           url
         end
       end
 
       def check_response(response, options = {})
-        log "------ QUICKBOOKS-RUBY RESPONSE ------"
-        log "RESPONSE CODE = #{response.code}"
-        log_response_body(response)
+        if is_json?
+          parse_json(response.plain_body)
+        elsif !is_pdf?
+          parse_xml(response.plain_body)
+        end
+
+        @last_response_intuit_tid = if response.respond_to?(:headers) && response.headers
+          response.headers['intuit_tid']
+        else
+          nil
+        end
+
         status = response.code.to_i
         case status
         when 200
@@ -248,12 +331,23 @@ module Quickbooks
         when 302
           raise "Unhandled HTTP Redirect"
         when 401
-          raise Quickbooks::AuthorizationFailure
+          raise Quickbooks::AuthorizationFailure, parse_intuit_error
         when 403
-          raise Quickbooks::Forbidden
+          message = parse_intuit_error[:message]
+          if message.include?('ThrottleExceeded')
+            raise Quickbooks::ThrottleExceeded, message
+          end
+          raise Quickbooks::Forbidden, message
+        when 404
+          raise Quickbooks::NotFound
+        when 413
+          raise Quickbooks::RequestTooLarge
         when 400, 500
           parse_and_raise_exception(options)
-        when 503, 504
+        when 429
+          message = parse_intuit_error[:message]
+          raise Quickbooks::TooManyRequests, message
+        when 502, 503, 504
           raise Quickbooks::ServiceUnavailable
         else
           raise "HTTP Error Code: #{status}, Msg: #{response.plain_body}"
@@ -264,10 +358,10 @@ module Quickbooks
         log "RESPONSE BODY:"
         if is_json?
           log ">>>>#{response.plain_body.inspect}"
-          parse_json(response.plain_body)
+        elsif is_pdf?
+          log("BODY is a PDF : not dumping")
         else
           log(log_xml(response.plain_body))
-          parse_xml(response.plain_body)
         end
       end
 
@@ -275,8 +369,26 @@ module Quickbooks
         log "REQUEST BODY:"
         if is_json?
           log(body.inspect)
+        elsif is_pdf?
+          log("BODY is a PDF : not dumping")
         else
-          log(log_xml(body))
+          #multipart request for uploads arrive here in a Hash with UploadIO vals
+          if body.is_a?(Hash)
+            body.each do |k,v|
+              log('BODY PART:')
+              val_content = v.inspect
+              if v.is_a?(UploadIO)
+                if v.content_type == 'application/xml'
+                  if v.io.is_a?(StringIO)
+                    val_content = log_xml(v.io.string)
+                  end
+                end
+              end
+              log("#{k}: #{val_content}")
+            end
+          else
+            log(log_xml(body))
+          end
         end
       end
 
@@ -291,17 +403,22 @@ module Quickbooks
         else
           ex.request_xml = options[:request]
         end
+        ex.intuit_tid = err[:intuit_tid]
         raise ex
       end
 
       def response_is_error?
-        @last_response_xml.xpath("//xmlns:IntuitResponse/xmlns:Fault")[0] != nil
-      rescue Nokogiri::XML::XPath::SyntaxError => exception
-        true
+        begin
+          @last_response_xml.xpath("//xmlns:IntuitResponse/xmlns:Fault")[0] != nil
+        rescue Nokogiri::XML::XPath::SyntaxError => exception
+          #puts @last_response_xml.to_xml.to_s
+          #puts "WTF: #{exception.inspect}:#{exception.backtrace.join("\n")}"
+          true
+        end
       end
 
       def parse_intuit_error
-        error = {:message => "", :detail => "", :type => nil, :code => 0}
+        error = {:message => "", :detail => "", :type => nil, :code => 0, :intuit_tid => @last_response_intuit_tid}
         fault = @last_response_xml.xpath("//xmlns:IntuitResponse/xmlns:Fault")[0]
         if fault
           error[:type] = fault.attributes['type'].value
@@ -313,7 +430,7 @@ module Quickbooks
               error[:code] = code_attr.value
             end
             element_attr = error_element.attributes['element']
-            if code_attr
+            if element_attr
               error[:element] = code_attr.value
             end
             error[:message] = error_element.xpath("//xmlns:Message").text
@@ -328,6 +445,13 @@ module Quickbooks
         error
       end
 
+      def with_around_request(request_info, &block)
+        if around_request
+          around_request.call(request_info, &block)
+        else
+          block.call
+        end
+      end
     end
   end
 end