quickbooks-ruby 1.0.6 → 1.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c912118ddd84fcffd9348f9c80986c5acd65645f3f1df65175ff091c13a3478b
-  data.tar.gz: '0739b9834c0ac6f1a46c8741acf6742970b490a7c6648f40c20361036fd9bb0c'
+  metadata.gz: 59f6b50352335b6f8142b4b2e6ab4f3057104998119ff634f436bbf64e5009d4
+  data.tar.gz: c6b0639561b040957fcef550fc6e117d0f3327f522c3ec8fc87edb622ef23523
 SHA512:
-  metadata.gz: 9aeb39c90d47fa2e2319b0a66ed44b2e61627642a6302c585206483ee6a5ced61fad94170a9c2b7f8ccfcf66b4f9940a4fcb5000f5eb1c513719ff9639712159
-  data.tar.gz: de3b723c54f1371baa1e8b0b7f20ef4c8a70cdfbd4687d2ff437bb6501337b9f20c2627329ba22d73707af99d686848c84ea14315d034116449eec0eb5dba1cb
+  metadata.gz: e27ca054b8ad9281542eebcfa83fdcc6ec7a3855b7afc54fe2bb62d0981de4b1ef840b6e77ba11c164f6092263d6aa3e752b7fe0e3fc79baa747cc559a0e07cc
+  data.tar.gz: 0b354dd455d03cf7625f9ac0fd8cae75e928aa52bc3e5edaf2ca5a4bea5b148cef9ef0122430c360bc1e14b6130cc57e30b84caaac7c13dd2293bac8fa0ba23d

data/lib/quickbooks-ruby.rb

@@ -75,6 +75,7 @@ require 'quickbooks/model/invoice_line_item'
 require 'quickbooks/model/invoice_group_line_detail'
 require 'quickbooks/model/company_info'
 require 'quickbooks/model/company_currency'
+require 'quickbooks/model/customer_type'
 require 'quickbooks/model/customer'
 require 'quickbooks/model/delivery_info'
 require 'quickbooks/model/sales_receipt'
@@ -137,6 +138,8 @@ require 'quickbooks/service/class'
 require 'quickbooks/service/attachable'
 require 'quickbooks/service/company_info'
 require 'quickbooks/service/company_currency'
+require 'quickbooks/service/customer_type'
+require 'quickbooks/service/custom_field'
 require 'quickbooks/service/customer'
 require 'quickbooks/service/department'
 require 'quickbooks/service/invoice'
@@ -188,6 +191,7 @@ Faraday::Middleware.register_middleware :gzip => lambda { Gzip }
 module Quickbooks
   @@sandbox_mode = false
   @@logger = nil
+  @@minorversion = 47
 
   class << self
     def sandbox_mode
@@ -198,6 +202,14 @@ module Quickbooks
       @@sandbox_mode = sandbox_mode
     end
 
+    def minorversion=(v)
+      @@minorversion = v
+    end
+
+    def minorversion
+      @@minorversion
+    end
+
     def logger
       @@logger ||= ::Logger.new($stdout) # TODO: replace with a real log file
     end
@@ -246,6 +258,7 @@ module Quickbooks
   class TooManyRequests < Error; end
   class ServiceUnavailable < Error; end
   class MissingRealmError < Error; end
+  class UnsupportedOperation < Error; end
 
   class IntuitRequestException < Error
     attr_accessor :message, :code, :detail, :type, :intuit_tid, :request_xml, :request_json

data/lib/quickbooks/faraday/middleware/gzip.rb

@@ -23,6 +23,8 @@ class Gzip < Faraday::Middleware
   def call(env)
     env[:request_headers][ACCEPT_ENCODING] ||= SUPPORTED_ENCODINGS
     @app.call(env).on_complete do |response_env|
+      break if response_env[:response_headers].nil?
+
       case response_env[:response_headers][CONTENT_ENCODING]
       when 'gzip'
         reset_body(response_env, &method(:uncompress_gzip))

data/lib/quickbooks/model/account.rb

@@ -4,7 +4,6 @@ module Quickbooks
       XML_COLLECTION_NODE = "Account"
       XML_NODE = "Account"
       REST_RESOURCE = 'account'
-      MINORVERSION = 13
 
       ASSET = 'Asset'
       EQUITY = 'Equity'

data/lib/quickbooks/model/bill.rb

@@ -16,6 +16,7 @@ module Quickbooks
       xml_accessor :department_ref, :from => 'DepartmentRef', :as => BaseReference
 
       xml_accessor :line_items, :from => 'Line', :as => [BillLineItem]
+      xml_accessor :txn_tax_detail, :from => 'TxnTaxDetail', :as => TransactionTaxDetail
 
       xml_accessor :private_note, :from => 'PrivateNote'
 

data/lib/quickbooks/model/customer.rb

@@ -16,8 +16,6 @@ module Quickbooks
       include NameEntity::Quality
       include NameEntity::PermitAlterations
 
-      MINORVERSION = 33
-
       xml_name XML_NODE
       xml_accessor :id, :from => 'Id'
       xml_accessor :sync_token, :from => 'SyncToken', :as => Integer
@@ -56,12 +54,15 @@ module Quickbooks
       xml_accessor :notes, :from => 'Notes'
       xml_accessor :currency_ref, :from => 'CurrencyRef', :as => BaseReference
       xml_accessor :tax_exemption_reason_id, :from => 'TaxExemptionReasonId'
+      xml_accessor :primary_tax_identifier, :from => 'PrimaryTaxIdentifier'
+      xml_accessor :customer_type_ref, :from => 'CustomerTypeRef', :as => BaseReference
 
       #== Validations
       validate :names_cannot_contain_invalid_characters
       validate :email_address_is_valid
 
-      reference_setters :parent_ref, :sales_term_ref, :payment_method_ref, :default_tax_code_ref, :currency_ref
+      reference_setters :parent_ref, :sales_term_ref, :payment_method_ref, :default_tax_code_ref, :currency_ref,
+                        :customer_type_ref
 
       def job?
         job.to_s == 'true'

data/lib/quickbooks/model/customer_type.rb

@@ -0,0 +1,15 @@
+module Quickbooks
+  module Model
+    class CustomerType < BaseModel
+      XML_COLLECTION_NODE = "CustomerType"
+      XML_NODE = "CustomerType"
+      REST_RESOURCE = 'customertype'
+
+      xml_accessor :id, :from => 'Id'
+      xml_accessor :sync_token, :from => 'SyncToken', :as => Integer
+      xml_accessor :meta_data, :from => 'MetaData', :as => MetaData
+      xml_accessor :name, :from => 'Name'
+      xml_accessor :active?, :from => 'Active'
+    end
+  end
+end

data/lib/quickbooks/model/invoice.rb

@@ -17,7 +17,6 @@ module Quickbooks
       XML_COLLECTION_NODE = "Invoice"
       XML_NODE = "Invoice"
       EMAIL_STATUS_NEED_TO_SEND = 'NeedToSend'
-      MINORVERSION = 37
 
       xml_accessor :id, :from => 'Id'
       xml_accessor :sync_token, :from => 'SyncToken', :as => Integer

data/lib/quickbooks/model/item.rb

@@ -10,7 +10,6 @@ module Quickbooks
       XML_COLLECTION_NODE = "Item"
       XML_NODE = "Item"
       REST_RESOURCE = 'item'
-      MINORVERSION = 33
 
       INVENTORY_TYPE = 'Inventory'
       NON_INVENTORY_TYPE = 'NonInventory'
@@ -31,6 +30,7 @@ module Quickbooks
       xml_accessor :level, :from => 'Level', :as => Integer
       xml_accessor :pref_vendor_ref, :from => 'PrefVendorRef', :as => BaseReference
       xml_accessor :tax_classification_ref, :from => 'TaxClassificationRef', :as => BaseReference
+      xml_accessor :class_ref, :from => 'ClassRef', :as => BaseReference
 
       # read-only
       xml_accessor :fully_qualified_name, :from => 'FullyQualifiedName'
@@ -52,13 +52,11 @@ module Quickbooks
       xml_accessor :inv_start_date, :from => 'InvStartDate', :as => Date
       xml_accessor :custom_fields, :from => "CustomField", as: [CustomField]
       xml_accessor :print_grouped_items?, :from => 'PrintGroupedItems'
-
-
       xml_accessor :item_group_details, :from => 'ItemGroupDetail', :as => ItemGroupDetail
 
       reference_setters :parent_ref, :income_account_ref, :expense_account_ref
       reference_setters :asset_account_ref, :sales_tax_code_ref, :purchase_tax_code_ref
-      reference_setters :pref_vendor_ref, :tax_classification_ref
+      reference_setters :pref_vendor_ref, :tax_classification_ref, :class_ref
 
       #== Validations
       validates_length_of :name, :minimum => 1

data/lib/quickbooks/model/preferences.rb

@@ -4,7 +4,6 @@ module Quickbooks
       XML_COLLECTION_NODE = "Preferences"
       XML_NODE            = "Preferences"
       REST_RESOURCE       = 'preferences'
-      MINORVERSION = 32
 
       xml_name XML_NODE
 

data/lib/quickbooks/model/purchase_order.rb

@@ -8,7 +8,6 @@ module Quickbooks
       REST_RESOURCE = 'purchaseorder'
       XML_COLLECTION_NODE = "PurchaseOrder"
       XML_NODE = "PurchaseOrder"
-      MINORVERSION = 45
 
       xml_accessor :id, :from => 'Id'
       xml_accessor :sync_token, :from => 'SyncToken', :as => Integer

data/lib/quickbooks/model/report.rb

@@ -38,7 +38,7 @@ module Quickbooks
           value = el.attr('value')
 
           next nil if value.blank?
-          next value if value.to_s.match(/^\d+$|^\d+.\d+$|^-\d+|^-\d+.\d+$|^.\d+$/).nil?
+          next value if value.to_s.match(/^\d+$|^\d+\.\d+$|^-\d+|^-\d+\.\d+$|^\.\d+$/).nil?
           BigDecimal(value)
         end
       end

data/lib/quickbooks/service/access_token.rb

@@ -23,7 +23,8 @@ module Quickbooks
       def disconnect
         conn = Faraday.new
         conn.basic_auth oauth.client.id, oauth.client.secret
-        response = conn.post(DISCONNECT_URL, token: oauth.refresh_token || oauth.token)
+        url = "#{DISCONNECT_URL}?minorversion=#{Quickbooks.minorversion}"
+        response = conn.post(url, token: oauth.refresh_token || oauth.token)
 
         if response.success?
           Quickbooks::Model::AccessTokenResponse.new(error_code: "0")

data/lib/quickbooks/service/account.rb

@@ -7,11 +7,6 @@ module Quickbooks
         update(account, :sparse => true)
       end
 
-      def url_for_query(query = nil, start_position = 1, max_results = 20, options = {})
-        url = super(query, start_position, max_results, options)
-        "#{url}&minorversion=#{Quickbooks::Model::Account::MINORVERSION}"
-      end
-
       private
 
       def model

data/lib/quickbooks/service/base_service.rb

@@ -9,6 +9,9 @@ module Quickbooks
       attr_reader :base_uri
       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"
@@ -224,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
 
@@ -247,17 +254,24 @@ module Quickbooks
         log_request_body(body)
         log "REQUEST HEADERS = #{headers.inspect}"
 
-        raw_response = case method
-        when :get
-          oauth_get(url, headers)
-        when :post
-          oauth_post(url, body, headers)
-        when :upload
-          oauth_post_with_multipart(url, body, headers)
-        else
-          raise "Do not know how to perform that HTTP operation"
+        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)
+          when :post
+            oauth_post(url, body, headers)
+          when :upload
+            oauth_post_with_multipart(url, body, headers)
+          else
+            raise "Do not know how to perform that HTTP operation"
+          end
         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}"
@@ -280,7 +294,9 @@ module Quickbooks
         @oauth.post_with_multipart(url, headers: headers, body: body, raise_errors: false)
       end
 
-      def add_query_string_to_url(url, params)
+      def add_query_string_to_url(url, params = {})
+        params ||= {}
+        params['minorversion'] = Quickbooks.minorversion
         if params.is_a?(Hash) && !params.empty?
           keyvalues = params.collect { |k| "#{k.first}=#{k.last}" }.join("&")
           delim = url.index("?") != nil ? "&" : "?"
@@ -429,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

data/lib/quickbooks/service/custom_field.rb

@@ -0,0 +1,20 @@
+module Quickbooks
+  module Service
+    class CustomField < BaseService
+
+      def delete(customer_type)
+        raise Quickbooks::UnsupportedOperation.new('Deleting CustomerType is not supported by Intuit')
+      end
+
+      def create(customer_type)
+        raise Quickbooks::UnsupportedOperation.new('Creating/updating CustomerType is not supported by Intuit')
+      end
+
+      private
+
+      def model
+        Quickbooks::Model::CustomField
+      end
+    end
+  end
+end

data/lib/quickbooks/service/customer.rb

@@ -7,21 +7,11 @@ module Quickbooks
         update(customer, :sparse => true)
       end
 
-      def url_for_resource(resource)
-        url = super(resource)
-        "#{url}?minorversion=#{Quickbooks::Model::Customer::MINORVERSION}"
-      end
-
       def fetch_by_id(id, params = {})
-        url = "#{url_for_base}/customer/#{id}?minorversion=#{Quickbooks::Model::Customer::MINORVERSION}"
+        url = "#{url_for_base}/customer/#{id}"
         fetch_object(model, url, params)
       end
 
-      def url_for_query(query = nil, start_position = 1, max_results = 20, options = {})
-        url = super(query, start_position, max_results, options)
-        "#{url}&minorversion=#{Quickbooks::Model::Customer::MINORVERSION}"
-      end
-
       private
 
       def model

data/lib/quickbooks/service/customer_type.rb

@@ -0,0 +1,20 @@
+module Quickbooks
+  module Service
+    class CustomerType < BaseService
+
+      def delete(customer_type)
+        raise Quickbooks::UnsupportedOperation.new('Deleting CustomerType is not supported by Intuit')
+      end
+
+      def create(customer_type)
+        raise Quickbooks::UnsupportedOperation.new('Creating/updating CustomerType is not supported by Intuit')
+      end
+
+      private
+
+      def model
+        Quickbooks::Model::CustomerType
+      end
+    end
+  end
+end

data/lib/quickbooks/service/invoice.rb

@@ -6,20 +6,11 @@ module Quickbooks
         delete_by_query_string(invoice)
       end
 
-      def url_for_resource(resource)
-        url = super(resource)
-      end
-
       def fetch_by_id(id, params = {})
-        url = "#{url_for_base}/invoice/#{id}?minorversion=#{Quickbooks::Model::Invoice::MINORVERSION}"
+        url = "#{url_for_base}/invoice/#{id}"
         fetch_object(model, url, params)
       end
 
-      def url_for_query(query = nil, start_position = 1, max_results = 20, options = {})
-        url = super(query, start_position, max_results, options)
-        "#{url}&minorversion=#{Quickbooks::Model::Invoice::MINORVERSION}"
-      end
-
       def send(invoice, email_address=nil)
         query = email_address.present? ? "?sendTo=#{email_address}" : ""
         url = "#{url_for_resource(model::REST_RESOURCE)}/#{invoice.id}/send#{query}"

data/lib/quickbooks/service/item.rb

@@ -7,21 +7,11 @@ module Quickbooks
         update(item, :sparse => true)
       end
 
-      def url_for_resource(resource)
-        url = super(resource)
-        "#{url}?minorversion=#{Quickbooks::Model::Item::MINORVERSION}"
-      end
-
       def fetch_by_id(id, params = {})
-        url = "#{url_for_base}/item/#{id}?minorversion=#{Quickbooks::Model::Item::MINORVERSION}"
+        url = "#{url_for_base}/item/#{id}"
         fetch_object(model, url, params)
       end
 
-      def url_for_query(query = nil, start_position = 1, max_results = 20, options = {})
-        url = super(query, start_position, max_results, options)
-        "#{url}&minorversion=#{Quickbooks::Model::Item::MINORVERSION}"
-      end
-
       private
 
       def model

data/lib/quickbooks/service/preferences.rb

@@ -2,11 +2,6 @@ module Quickbooks
   module Service
     class Preferences < BaseService
 
-      def url_for_query(query = nil, start_position = 1, max_results = 20, options = {})
-        url = super(query, start_position, max_results, options)
-        "#{url}&minorversion=#{Quickbooks::Model::Preferences::MINORVERSION}"
-      end
-
       private
 
       def model

data/lib/quickbooks/service/service_crud_json.rb

@@ -8,7 +8,7 @@ module Quickbooks
 
       def create(entity, options = {})
         raise Quickbooks::InvalidModelException.new(entity.errors.full_messages.join(',')) unless entity.valid?
-        response = do_http(:post, url_for_resource(model.resource_for_singular), entity.to_json, options)
+        response = do_http_post(url_for_resource(model.resource_for_singular), entity.to_json, options)
         if response.code.to_i == 200
           JSON.parse(response.plain_body)
         else

data/lib/quickbooks/util/query_builder.rb

@@ -10,26 +10,27 @@ module Quickbooks
       end
 
       def clause(field, operator, value)
+        # replace with an escaped backslash
+        escape_single_quotes = -> field { field.to_s.gsub("'", "\\\\'") }
+
         value = case value
                 when DateTime, Time
                   value.iso8601
                 when Date
                   value.strftime('%Y-%m-%d')
                 when Array
-                  value = value.map{|v| v.to_s.gsub("'", "\\\\'") }
+                  value = value.map(&escape_single_quotes)
                 else
-                  # escape single quotes with an escaped backslash
-                  value = value.gsub("'", "\\\\'")
+                  value = escape_single_quotes.call(value)
                 end
 
         if operator.downcase == 'in' && value.is_a?(Array)
-          value = value.map{|v| "#{VALUE_QUOTE}#{v}#{VALUE_QUOTE}"}
+          value = value.map { |v| "#{VALUE_QUOTE}#{v}#{VALUE_QUOTE}" }
           "#{field} #{operator} (#{value.join(', ')})"
         else
           "#{field} #{operator} #{VALUE_QUOTE}#{value}#{VALUE_QUOTE}"
         end
       end
-
     end
   end
 end

data/lib/quickbooks/version.rb

@@ -1,5 +1,5 @@
 module Quickbooks
 
-  VERSION = "1.0.6"
+  VERSION = "1.0.11"
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quickbooks-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.11
 platform: ruby
 authors:
 - Cody Caughlan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-10 00:00:00.000000000 Z
+date: 2020-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -28,16 +28,16 @@ dependencies:
   name: roxml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
@@ -202,6 +202,7 @@ files:
 - lib/quickbooks/model/custom_field.rb
 - lib/quickbooks/model/customer.rb
 - lib/quickbooks/model/customer_change.rb
+- lib/quickbooks/model/customer_type.rb
 - lib/quickbooks/model/definition.rb
 - lib/quickbooks/model/delivery_info.rb
 - lib/quickbooks/model/department.rb
@@ -293,8 +294,10 @@ files:
 - lib/quickbooks/service/company_info.rb
 - lib/quickbooks/service/credit_memo.rb
 - lib/quickbooks/service/credit_memo_change.rb
+- lib/quickbooks/service/custom_field.rb
 - lib/quickbooks/service/customer.rb
 - lib/quickbooks/service/customer_change.rb
+- lib/quickbooks/service/customer_type.rb
 - lib/quickbooks/service/department.rb
 - lib/quickbooks/service/deposit.rb
 - lib/quickbooks/service/employee.rb