quickbooks-ruby 1.0.20 → 2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e850d8a1075bd9f614e7b05c1747d0d7b1fc9b193ef9230975729693131a43d2
-  data.tar.gz: a2f7317e4bbfff9ee6c040eb1b19684981ff3dbde9cbe25f66cbbfd58dec9f1c
+  metadata.gz: cc115bc7b925447fecb75976b448e66406441c9fd56208e964ac34844fdcd37a
+  data.tar.gz: fd1ca0b526c14cdadda7a1e276c3dcedb9b8c68e7c76be0aa074df30c63e0382
 SHA512:
-  metadata.gz: 8465d4443dd61ad7a71d4d33b34c4bfa8a0d2de787ed510363763a0a51447f6126e1c37cdef7bd70c8176ce388e5ea4bad78bb0193d197083eb072f5eac4c3da
-  data.tar.gz: f652a956529f77766099c5e6c69ad4aceabc58e9277740bad2d4747b3991ca6a5ab73aa1017a4c4074c4ca1ecd3016ced27bdd0b7adc64293b27056f13067207
+  metadata.gz: ce9c6d1732ab2d6ffd2a9ea57c2dad7f091867bb9af828a8bb25140f79a7d739cccd4f59d9b45665ec500d50241e2fbd65c833f4f307d71ba84543cdaec71725
+  data.tar.gz: 9bd4d94b4270280b142d93c3ee9bff0b579d4009fc5afe9a217404d201df6e74ea6db8a7fc5b33e48f16e919ea6716bd77f5aeb4e362421db659d1d9f8ac0bf4

data/lib/quickbooks/model/vendor_credit.rb

@@ -28,6 +28,8 @@ module Quickbooks
 
       xml_accessor :currency_ref, :from => 'CurrencyRef', :as => BaseReference
       xml_accessor :exchange_rate, :from => 'ExchangeRate', :as => BigDecimal, :to_xml => to_xml_big_decimal
+      
+      xml_accessor :linked_transactions, :from => 'LinkedTxn', :as => [LinkedTransaction]
 
       reference_setters
 

data/lib/quickbooks/service/access_token.rb

@@ -22,7 +22,7 @@ module Quickbooks
       def disconnect
         connection = Faraday.new(headers: { 'Content-Type' => 'application/json' }) do |f|
           f.adapter(::Quickbooks.http_adapter)
-          f.basic_auth(oauth.client.id, oauth.client.secret)
+          f.request(:authorization, :basic, oauth.client.id, oauth.client.secret)
         end
 
         url = "#{DISCONNECT_URL}?minorversion=#{Quickbooks.minorversion}"

data/lib/quickbooks/service/base_service.rb

@@ -49,12 +49,11 @@ module Quickbooks
       # [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 ::Quickbooks.http_adapter
+        @oauth.client.connection = Faraday.new do |f|
+          f.request :multipart
+          f.request :gzip
+          f.request :url_encoded
+          f.adapter ::Quickbooks.http_adapter
         end
       end
 
@@ -248,11 +247,7 @@ 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}"
+        log_request(method, url, body, headers)
 
         request_info = RequestInfo.new(url, headers, body, method)
         before_request.call(request_info) if before_request
@@ -273,12 +268,8 @@ module Quickbooks
         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
+        log_response(response)
+
         check_response(response, request: body)
       end
 
@@ -354,28 +345,29 @@ module Quickbooks
         end
       end
 
-      def log_response_body(response)
-        log "RESPONSE BODY:"
-        if is_json?
-          log ">>>>#{response.plain_body.inspect}"
-        elsif is_pdf?
-          log("BODY is a PDF : not dumping")
-        else
-          log(log_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.content_type == 'application/xml'
@@ -384,12 +376,37 @@ module Quickbooks
                   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 = {})

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/util/logging.rb

@@ -5,10 +5,22 @@ module Quickbooks
         ::Quickbooks.log(msg)
       end
 
+      def log_multiple(messages)
+        if condense_logs?
+          log(messages.join("\n"))
+        else
+          messages.each(&method(:log))
+        end
+      end
+
       def log?
         ::Quickbooks.log?
       end
 
+      def condense_logs?
+        ::Quickbooks.condense_logs?
+      end
+
       def log_xml(str)
         if ::Quickbooks.log_xml_pretty_print? && !(str and str.empty?)
           Nokogiri::XML(str).to_xml

data/lib/quickbooks/version.rb

@@ -1,5 +1,5 @@
 module Quickbooks
 
-  VERSION = "1.0.20"
+  VERSION = "2.0"
 
 end

data/lib/quickbooks-ruby.rb

@@ -8,12 +8,13 @@ require 'date'
 require 'forwardable'
 require 'oauth2'
 require 'net/http/post/multipart'
+require 'faraday/multipart'
+require 'faraday/gzip'
 require 'quickbooks/util/collection'
 require 'quickbooks/util/logging'
 require 'quickbooks/util/http_encoding_helper'
 require 'quickbooks/util/name_entity'
 require 'quickbooks/util/query_builder'
-require 'quickbooks/faraday/middleware/gzip'
 
 #== OAuth Responses
 require 'quickbooks/service/responses/oauth_http_response'
@@ -187,9 +188,6 @@ require 'quickbooks/service/transfer'
 require 'quickbooks/service/change_data_capture'
 require 'quickbooks/service/refund_receipt_change'
 
-# Register Faraday Middleware
-Faraday::Middleware.register_middleware :gzip => lambda { Gzip }
-
 module Quickbooks
   @@sandbox_mode = false
   @@logger = nil
@@ -230,13 +228,18 @@ module Quickbooks
     end
 
     # set logging on or off
-    attr_writer :log, :log_xml_pretty_print
+    attr_writer :log, :log_xml_pretty_print, :condense_logs
 
     # Returns whether to log. Defaults to 'false'.
     def log?
       @log ||= false
     end
 
+    # Returns whether to limit log lines
+    def condense_logs?
+      @condense_logs ||= false
+    end
+
     # pretty printing the xml in the logs is "on" by default
     def log_xml_pretty_print?
       defined?(@log_xml_pretty_print) ? @log_xml_pretty_print : true

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: quickbooks-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.20
+  version: '2.0'
 platform: ruby
 authors:
 - Cody Caughlan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-17 00:00:00.000000000 Z
+date: 2022-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: roxml
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,42 @@ dependencies:
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-gzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -199,7 +227,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/quickbooks-ruby.rb
-- lib/quickbooks/faraday/middleware/gzip.rb
 - lib/quickbooks/model/access_token_response.rb
 - lib/quickbooks/model/account.rb
 - lib/quickbooks/model/account_based_expense_line_detail.rb
@@ -383,7 +410,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

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

@@ -1,74 +0,0 @@
-# https://github.com/lostisland/faraday_middleware/blob/master/lib/faraday_middleware/gzip.rb
-
-require 'faraday'
-
-# Middleware to automatically decompress response bodies. If the
-# "Accept-Encoding" header wasn't set in the request, this sets it to
-# "gzip,deflate" and appropriately handles the compressed response from the
-# server. This resembles what Ruby 1.9+ does internally in Net::HTTP#get.
-#
-# This middleware is NOT necessary when these adapters are used:
-# - net_http on Ruby 1.9+
-# - net_http_persistent on Ruby 2.0+
-# - em_http
-class Gzip < Faraday::Middleware
-  dependency 'zlib'
-
-  ACCEPT_ENCODING = 'Accept-Encoding'.freeze
-  CONTENT_ENCODING = 'Content-Encoding'.freeze
-  CONTENT_LENGTH = 'Content-Length'.freeze
-  SUPPORTED_ENCODINGS = 'gzip,deflate,br'.freeze
-  RUBY_ENCODING = '1.9'.respond_to?(:force_encoding)
-
-  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))
-      when 'deflate'
-        reset_body(response_env, &method(:inflate))
-      when 'br'
-        reset_body(response_env, &method(:brotli_inflate))
-      end
-    end
-  end
-
-  def reset_body(env)
-    env[:body] = yield(env[:body])
-    env[:response_headers].delete(CONTENT_ENCODING)
-    env[:response_headers][CONTENT_LENGTH] = env[:body].length
-  end
-
-  def uncompress_gzip(body)
-    io = StringIO.new(body)
-    gzip_reader = if RUBY_ENCODING
-      Zlib::GzipReader.new(io, :encoding => 'ASCII-8BIT')
-    else
-      Zlib::GzipReader.new(io)
-    end
-    gzip_reader.read
-  end
-
-  def inflate(body)
-    # Inflate as a DEFLATE (RFC 1950+RFC 1951) stream
-    Zlib::Inflate.inflate(body)
-  rescue Zlib::DataError
-    # Fall back to inflating as a "raw" deflate stream which
-    # Microsoft servers return
-    inflate = Zlib::Inflate.new(-Zlib::MAX_WBITS)
-    begin
-      inflate.inflate(body)
-    ensure
-      inflate.close
-    end
-  end
-
-  def brotli_inflate(body)
-    self.class.dependency 'brotli'
-
-    Brotli.inflate(body)
-  end
-end