quickbooks-ruby 1.0.1 → 2.0.7

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"
@@ -37,24 +42,18 @@ module Quickbooks
         @company_id = company_id
       end
 
-      def oauth_v1?
-        @oauth.is_a? OAuth::AccessToken
-      end
-
-      def oauth_v2?
-        @oauth.is_a? OAuth2::AccessToken
-      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!
-        return unless oauth_v2?
-        @oauth.client.connection = nil
-        @oauth.client.connection.build do |builder|
-          builder.use :gzip
-          builder.request :multipart
-          builder.request :url_encoded
-          builder.adapter :net_http
+        @oauth.client.connection = Faraday.new do |f|
+          f.request :multipart
+          f.request :gzip
+          f.request :url_encoded
+          f.adapter ::Quickbooks.http_adapter
         end
       end
 
@@ -225,10 +224,12 @@ module Quickbooks
         if metadata
           standalone_prefix = '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>'
           meta_data_xml = "#{standalone_prefix}\n#{metadata.to_xml_ns.to_s}"
-          param_part = UploadIO.new(StringIO.new(meta_data_xml), "application/xml")
+          param_part = Faraday::UploadIO.new(StringIO.new(meta_data_xml), "application/xml")
           body['file_metadata_0'] = param_part
         end
 
+        url = add_query_string_to_url(url, {})
+
         do_http(:upload, url, body, headers)
       end
 
@@ -246,58 +247,47 @@ module Quickbooks
           headers['Accept-Encoding'] = HTTP_ACCEPT_ENCODING
         end
 
-        log "------ QUICKBOOKS-RUBY REQUEST ------"
-        log "METHOD = #{method}"
-        log "RESOURCE = #{url}"
-        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"
+        log_request(method, url, body, headers)
+
+        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_response(response)
+
         check_response(response, request: body)
       end
 
       def oauth_get(url, headers)
-        if oauth_v1?
-          @oauth.get(url, headers)
-        elsif oauth_v2?
-          @oauth.get(url, headers: headers, raise_errors: false)
-        else
-          raise InvalidOauthAccessTokenObject.new(@oauth)
-        end
+        @oauth.get(url, headers: headers, raise_errors: false)
       end
 
       def oauth_post(url, body, headers)
-        if oauth_v1?
-          @oauth.post(url, body, headers)
-        elsif oauth_v2?
-          @oauth.post(url, headers: headers, body: body, raise_errors: false)
-        else
-          raise InvalidOauthAccessTokenObject.new(@oauth)
-        end
+        @oauth.post(url, headers: headers, body: body, raise_errors: false)
       end
 
       def oauth_post_with_multipart(url, body, headers)
-        if oauth_v1?
-          @oauth.post_with_multipart(url, body, headers)
-        elsif oauth_v2?
-          @oauth.post_with_multipart(url, headers: headers, body: body, raise_errors: false)
-        else
-          raise InvalidOauthAccessTokenObject.new(@oauth)
-        end
+        @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 ? "&" : "?"
@@ -308,12 +298,18 @@ module Quickbooks
       end
 
       def check_response(response, options = {})
-        log "------ QUICKBOOKS-RUBY RESPONSE ------"
-        log "RESPONSE CODE = #{response.code}"
-        if response.respond_to?(:headers)
-          log "RESPONSE HEADERS = #{response.headers}"
+        if is_json?
+          parse_json(response.plain_body)
+        elsif !is_pdf?
+          parse_xml(response.plain_body)
         end
-        log_response_body(response)
+
+        @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
@@ -326,7 +322,7 @@ module Quickbooks
         when 302
           raise "Unhandled HTTP Redirect"
         when 401
-          raise Quickbooks::AuthorizationFailure
+          raise Quickbooks::AuthorizationFailure, parse_intuit_error
         when 403
           message = parse_intuit_error[:message]
           if message.include?('ThrottleExceeded')
@@ -349,57 +345,84 @@ module Quickbooks
         end
       end
 
-      def log_response_body(response)
-        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
+      def log_request(method, url, body, headers)
+        messages = []
+        messages << "------ QUICKBOOKS-RUBY REQUEST ------"
+        messages << "METHOD = #{method}"
+        messages << "RESOURCE = #{url}"
+        messages.concat(request_body_messages(body))
+        messages << "REQUEST HEADERS = #{headers.inspect}"
+
+        log_multiple(messages)
       end
 
-      def log_request_body(body)
-        log "REQUEST BODY:"
+      def request_body_messages(body)
+        messages = []
+        messages <<  "REQUEST BODY:"
         if is_json?
-          log(body.inspect)
+          messages <<  body.inspect
         elsif is_pdf?
-          log("BODY is a PDF : not dumping")
+          messages <<  "BODY is a PDF : not dumping"
         else
           #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:')
+              messages << 'BODY PART:'
               val_content = v.inspect
-              if v.is_a?(UploadIO)
+              if v.is_a?(Faraday::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}")
+              messages << "#{k}: #{val_content}"
             end
           else
-            log(log_xml(body))
+            messages << log_xml(body)
           end
         end
+        messages
+      end
+
+      def log_response(response)
+        messages = []
+        messages << "------ QUICKBOOKS-RUBY RESPONSE ------"
+        messages << "RESPONSE CODE = #{response.code}"
+        messages.concat(response_body_messages(response))
+        messages << "RESPONSE HEADERS = #{response.headers}" if response.respond_to?(:headers)
+
+        log_multiple(messages)
+      end
+
+      def response_body_messages(response)
+        messages = []
+        messages << "RESPONSE BODY:"
+        if is_json?
+          messages << ">>>>#{response.plain_body.inspect}"
+        elsif is_pdf?
+          messages << "BODY is a PDF : not dumping"
+        else
+          messages << log_xml(response.plain_body)
+        end
+
+        messages
       end
 
       def parse_and_raise_exception(options = {})
         err = parse_intuit_error
-        ex = Quickbooks::IntuitRequestException.new("#{err[:message]}:\n\t#{err[:detail]}")
+        element_msg = err[:element] ? "#{err[:element]}: " : ""
+        ex = Quickbooks::IntuitRequestException.new("#{element_msg}#{err[:message]}:\n\t#{err[:detail]}")
         ex.code = err[:code]
         ex.detail = err[:detail]
         ex.type = err[:type]
+        ex.element = err[:element] if err[:element]
         if is_json?
           ex.request_json = options[:request]
         else
           ex.request_xml = options[:request]
         end
+        ex.intuit_tid = err[:intuit_tid]
         raise ex
       end
 
@@ -414,7 +437,7 @@ module Quickbooks
       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
@@ -426,8 +449,8 @@ module Quickbooks
               error[:code] = code_attr.value
             end
             element_attr = error_element.attributes['element']
-            if code_attr
-              error[:element] = code_attr.value
+            if element_attr
+              error[:element] = element_attr.try(:value)
             end
             error[:message] = error_element.xpath("//xmlns:Message").text
             error[:detail] = error_element.xpath("//xmlns:Detail").text
@@ -441,6 +464,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/credit_memo.rb

@@ -6,6 +6,12 @@ module Quickbooks
         delete_by_query_string(credit_memo)
       end
 
+      def pdf(credit_memo)
+        url = "#{url_for_resource(model::REST_RESOURCE)}/#{credit_memo.id}/pdf"
+        response = do_http_raw_get(url, {}, {'Accept' => 'application/pdf'})
+        response.plain_body
+      end
+
       private
 
       def model

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/payment.rb

@@ -19,6 +19,12 @@ module Quickbooks
         end
       end
 
+      def pdf(payment)
+        url = "#{url_for_resource(model::REST_RESOURCE)}/#{payment.id}/pdf"
+        response = do_http_raw_get(url, {}, {'Accept' => 'application/pdf'})
+        response.plain_body
+      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/purchase_change.rb

@@ -0,0 +1,16 @@
+module Quickbooks
+  module Service
+    class PurchaseChange < ChangeService
+
+      private
+
+      def entity
+        "Purchase"
+      end
+
+      def model
+        Quickbooks::Model::PurchaseChange
+      end
+    end
+  end
+end

data/lib/quickbooks/service/purchase_order.rb

@@ -6,6 +6,22 @@ module Quickbooks
         delete_by_query_string(purchase_order)
       end
 
+      def fetch_by_id(id, params = {})
+        url = "#{url_for_base}/purchaseorder/#{id}?minorversion=#{Quickbooks.minorversion}"
+        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.minorversion}"
+      end
+
+      def pdf(purchase_order)
+        url = "#{url_for_resource(model::REST_RESOURCE)}/#{purchase_order.id}/pdf"
+        response = do_http_raw_get(url, {}, {'Accept' => 'application/pdf'})
+        response.plain_body
+      end
+
     private
 
       def model

data/lib/quickbooks/service/refund_receipt.rb

@@ -6,6 +6,12 @@ module Quickbooks
         delete_by_query_string(refund_receipt)
       end
 
+      def pdf(refund_receipt)
+        url = "#{url_for_resource(model::REST_RESOURCE)}/#{refund_receipt.id}/pdf"
+        response = do_http_raw_get(url, {}, {'Accept' => 'application/pdf'})
+        response.plain_body
+      end
+
       private
 
       def model

data/lib/quickbooks/service/responses/oauth_http_response.rb

@@ -7,11 +7,7 @@ module Quickbooks
       class OAuthHttpResponse
 
         def self.wrap(response)
-          if response.is_a?(OAuth2::Response)
-            Quickbooks::Service::Responses::OAuth2HttpResponse.new(response)
-          else
-            Quickbooks::Service::Responses::OAuth1HttpResponse.new(response)
-          end
+          Quickbooks::Service::Responses::OAuth2HttpResponse.new(response)
         end
 
       end

data/lib/quickbooks/service/sales_receipt.rb

@@ -15,7 +15,7 @@ module Quickbooks
       def send(sr, email_address=nil)
         query = email_address.present? ? "?sendTo=#{email_address}" : ""
         url = "#{url_for_resource(model::REST_RESOURCE)}/#{sr.id}/send#{query}"
-        response = do_http_post(url,{})
+        response = do_http_post(url, "", {}, { 'Content-Type' => 'application/octet-stream' })
         if response.code.to_i == 200
           model.from_xml(parse_singular_entity_response(model, response.plain_body))
         else

data/lib/quickbooks/service/service_crud.rb

@@ -33,7 +33,10 @@ module Quickbooks
         if field.class == Symbol
           field = field.to_s.camelcase
         end
-        q = "select * from %s where %s = '%s'" % [model.resource_for_singular, field, selector]
+
+        clause = Quickbooks::Util::QueryBuilder.new.clause(field, '=', selector)
+        q = "select * from %s where %s" % [model.resource_for_singular, clause]
+
         self.query(q, options)
       end
 

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/service/upload.rb

@@ -9,7 +9,7 @@ module Quickbooks
       # attachable: Quickbooks::Model::Attachable meta-data details, can be null
       def upload(path_to_file, mime_type, attachable = nil)
         url = url_for_resource("upload")
-        uploadIO = class_for_io.new(path_to_file, mime_type)
+        uploadIO = Faraday::UploadIO.new(path_to_file, mime_type)
         response = do_http_file_upload(uploadIO, url, attachable)
         prefix = "AttachableResponse/xmlns:Attachable"
         if response.code.to_i == 200
@@ -19,10 +19,6 @@ module Quickbooks
         end
       end
 
-      def class_for_io
-        oauth.is_a?(OAuth2::AccessToken) ? Faraday::UploadIO : UploadIO
-      end
-
       def download(uploadId)
         url = url_for_resource("download/#{uploadId}")
         do_http_get(url, {}, headers)

data/lib/quickbooks/util/logging.rb

@@ -1,12 +1,26 @@
 module Quickbooks
   module Util
     module Logging
+      attr_writer :log
+
       def log(msg)
-        ::Quickbooks.log(msg)
+        ::Quickbooks.log(msg) if log?
+      end
+
+      def log_multiple(messages)
+        if condense_logs?
+          log(messages.join("\n"))
+        else
+          messages.each(&method(:log))
+        end
       end
 
       def log?
-        ::Quickbooks.log?
+        defined?(@log) ? @log : ::Quickbooks.log?
+      end
+
+      def condense_logs?
+        ::Quickbooks.condense_logs?
       end
 
       def log_xml(str)