zuora_api 1.7.44 → 1.7.45

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c41d6dd1dbd9a4295b5bc51d4fce6d12f3f754d6078c2e07cf2da30da7c0968
-  data.tar.gz: eb505fe8a19eaa9f62f0ffad34fc00b3da4a12fbc8d61a030c24aebbc4a604cd
+  metadata.gz: e353ae18d8ad1c0601b8bb92a40804f88781ba32be2a5196870f125869dc8eb1
+  data.tar.gz: f087799a2134d2c9f33e8970f5c60c0faea80e788d9549100103ffdcd0d297b9
 SHA512:
-  metadata.gz: e8d139d75ee71fe6e3aedc9cac00744530b991e1c413f45102abdb8ac2d2eba48e462e9cf243b8a1994cba08c66efae147182d4fd05a547344c08cd88b890b23
-  data.tar.gz: e33f029050a4b8b91f5b076b1e509d4f7a5cb2edb8751b17cc639ae0a0ee4c5034250fa280b63e514c043cc4e9caecfc511fdf51ce7a5a3da2ecde48531279b2
+  metadata.gz: 4f948a1d0f0b04cbd14dcaff50f7c699c3195c8710ecb70a22802f4e4298bd6769b674ad2302e279fce1b2894ffe1b7ca8b7c6522ccc6ddc31735a3d27342ac0
+  data.tar.gz: 6d10f65bb4f49332d96d296c9167748e79129ac61a9f086ac1834a7671c32ecd7c089e1c38bf7678ee4211a6721e0f5c1e68a5199bfdcba37582beae1e9add3f

data/lib/zuora_api/exceptions.rb

@@ -51,6 +51,8 @@ module ZuoraAPI
           @message = "Adjustment cannot be created for invoice with a zero balance."
         when /The balance of all the invoice items and tax items is 0. No write-off is needed for the invoice .*./
           @message = "The balance of all the invoice items and tax items is 0. No write-off is needed for the invoice."
+        when /Json input does not match schema. Error(s): string ".*" is too long .*/
+          @message = "Json input does not match schema. Error(s): String is too long."
         else
           @message = message  
         end

data/lib/zuora_api/login.rb

@@ -16,7 +16,8 @@ module ZuoraAPI
       Errno::ECONNREFUSED,
       SocketError,
       Errno::EHOSTUNREACH,
-      Errno::EADDRNOTAVAIL
+      Errno::EADDRNOTAVAIL,
+      Errno::ETIMEDOUT,
     ].freeze
 
     CONNECTION_READ_EXCEPTIONS = [
@@ -385,7 +386,7 @@ module ZuoraAPI
     end
 
     def rest_domain
-      return URI(self.rest_endpoint).host      
+      return URI(self.rest_endpoint).host
     end
 
     def fileURL(url="")
@@ -429,13 +430,26 @@ module ZuoraAPI
         else
           raise ZuoraAPI::Exceptions::ZuoraAPIAuthenticationTypeError.new("Unknown Login, does not support Authentication of Type: #{auth_type}")
         end
-        
+
         raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new(self.current_error) if self.status != 'Active'
         return prefix ? "Bearer #{self.bearer_token}" : self.bearer_token.to_s
       end
     end
 
-    def soap_call(ns1: 'ns1', ns2: 'ns2', batch_size: nil, single_transaction: false, debug: false, zuora_track_id: nil, errors: [ZuoraAPI::Exceptions::ZuoraAPISessionError].concat(ZUORA_API_ERRORS), z_session: true, timeout_retry: false, timeout: 120,**keyword_args)
+    def soap_call(
+      ns1: 'ns1', 
+      ns2: 'ns2', 
+      batch_size: nil, 
+      single_transaction: false, 
+      debug: false, 
+      zuora_track_id: nil, 
+      errors: [ZuoraAPI::Exceptions::ZuoraAPISessionError].concat(ZUORA_API_ERRORS), 
+      soft_errors: [],
+      z_session: true, 
+      timeout_retry: false, 
+      timeout: 120,
+      output_exception_messages: true,
+      **keyword_args)
       tries ||= 2
       xml = Nokogiri::XML::Builder.new do |xml|
         xml['SOAP-ENV'].Envelope('xmlns:SOAP-ENV' => "http://schemas.xmlsoap.org/soap/envelope/",
@@ -480,7 +494,7 @@ module ZuoraAPI
       output_xml = Nokogiri::XML(response.body)
       Rails.logger.debug("Response SOAP XML: #{output_xml.to_xml(:save_with => XML_SAVE_OPTIONS).strip}") if debug
 
-      raise_errors(type: :SOAP, body: output_xml, response: response)
+      raise_errors(type: :SOAP, body: output_xml, response: response, soft_errors: soft_errors)
     rescue ZuoraAPI::Exceptions::ZuoraAPISessionError => ex
       if !tries.zero? && z_session
         tries -= 1
@@ -509,7 +523,13 @@ module ZuoraAPI
       end
     rescue *CONNECTION_EXCEPTIONS => ex
       if tries.zero?
-        Rails.logger.info("SOAP Call - #{ex.class} Timed out will retry after 5 seconds")
+        if output_exception_messages
+          if Rails.logger.class.to_s == "Ougai::Logger"
+            Rails.logger.error("SOAP Call - Timed out will retry after #{self.timeout_sleep} seconds", ex) 
+          else
+            Rails.logger.error("SOAP Call - #{ex.class} Timed out will retry after #{self.timeout_sleep} seconds") 
+          end
+        end
         raise ex 
       end
 
@@ -518,7 +538,13 @@ module ZuoraAPI
       retry
     rescue *CONNECTION_READ_EXCEPTIONS => ex
       if tries.zero?
-        Rails.logger.info("SOAP Call - #{ex.class} Timed out will retry after 5 seconds") 
+        if output_exception_messages
+          if Rails.logger.class.to_s == "Ougai::Logger"
+            Rails.logger.error("SOAP Call - Timed out will retry after #{self.timeout_sleep} seconds", ex) 
+          else
+            Rails.logger.error("SOAP Call - #{ex.class} Timed out will retry after #{self.timeout_sleep} seconds") 
+          end
+        end
         raise ex
       end
 
@@ -530,7 +556,13 @@ module ZuoraAPI
         sleep(self.timeout_sleep)
         retry
       else
-        Rails.logger.info("SOAP Call - #{ex.class} Timed out will retry after 5 seconds") 
+        if output_exception_messages
+          if Rails.logger.class.to_s == "Ougai::Logger"
+            Rails.logger.error("SOAP Call - Timed out will retry after #{self.timeout_sleep} seconds", ex) 
+          else
+            Rails.logger.error("SOAP Call - #{ex.class} Timed out will retry after #{self.timeout_sleep} seconds") 
+          end
+        end
         raise ex
       end
     rescue => ex
@@ -539,7 +571,7 @@ module ZuoraAPI
       return output_xml, input_xml, response
     end
 
-    def raise_errors(type: :SOAP, body: nil, response: nil)
+    def raise_errors(type: :SOAP, body: nil, response: nil, soft_errors: [])
       if [502,503].include?(response.code)
         raise ZuoraAPI::Exceptions::ZuoraAPIConnectionTimeout.new("Received #{response.code} from #{response.request.uri}", response)
       end
@@ -556,21 +588,45 @@ module ZuoraAPI
       when :SOAP
         error, success, message = get_soap_error_and_message(body)
 
+        if body.xpath('//ns1:queryResponse', 'ns1' => 'http://api.zuora.com/').present? &&
+           body.xpath(
+             '//ns1:records[@xsi:type="ns2:Export"]',
+             'ns1' => 'http://api.zuora.com/', 'xsi' => 'http://www.w3.org/2001/XMLSchema-instance'
+           ).present?
+          if body.xpath('//ns1:size', 'ns1' => 'http://api.zuora.com/').text.to_i < 1 && soft_errors.include?(:export_size_0)
+            error = 'UNEXPECTED_ERROR'
+            message = 'No export found.'
+          end
+
+          result = body.xpath('//ns2:Status', 'ns2' => 'http://object.api.zuora.com/').text
+          if result == 'Failed'
+            reason = body.xpath('//ns2:StatusReason', 'ns2' => 'http://object.api.zuora.com/').text
+            if reason.present?
+              message = body.xpath('//ns2:StatusReason', 'ns2' => 'http://object.api.zuora.com/').text
+              error = message.include?('Unexpected error') ? 'UNEXPECTED_ERROR' : 'FAIL_ERROR'
+            else
+              error = 'UNEXPECTED_ERROR'
+              message = 'Export failed due to unknown reason. Consult api logs.'
+            end
+          end
+        end
+
         #By default response if not passed in for SOAP as all SOAP is 200
         if error.present?
           if error.class == String
-            raise_errors_helper(error, message, response)
+            raise_errors_helper(error: error, message: message, response: response)
           elsif error.class == Array
             if error.uniq.size == 1
               err, msg = error[0].split('::')
-              raise_errors_helper(err, msg, response, error, success)
+              raise_errors_helper(error: err, message: msg, response: response, errors: error, success: success)
             else
               raise ZuoraAPI::Exceptions::ZuoraAPIError.new(error.group_by {|v| v}.map {|k,v| "(#{v.size}x) - #{k == "::" ? 'UNKNOWN::No error provided' : k}"}.join(', '), response, error, success)
             end
           end
-        elsif response.code == 500 ||
-              (response.code == 400 && response.headers.fetch('content-type', []).include?('text/html'))
-          raise ZuoraAPI::Exceptions::ZuoraAPIInternalServerError.new('Zuora API Internal Server Error', response)
+        end
+
+        if response.code == 500 || (response.code == 400 && response.headers.fetch('content-type', []).include?('text/html'))
+          raise ZuoraAPI::Exceptions::ZuoraAPIInternalServerError.new(response.body, response)
         end
 
       when :JSON
@@ -636,7 +692,7 @@ module ZuoraAPI
           #Locking contention
           if codes_array.map{|code| code.to_s.slice(6,7).to_i}.include?(50)
             raise ZuoraAPI::Exceptions::ZuoraAPILockCompetition.new("#{messages_array.join(', ')}", response)
-          end          
+          end
 
           #All Errors catch
           if codes_array.size > 0
@@ -645,22 +701,7 @@ module ZuoraAPI
 
           #Zuora REST Query Errors
           if body["faultcode"].present?
-            case body["faultcode"]
-            when "fns:MALFORMED_QUERY"
-              raise ZuoraAPI::Exceptions::ZuoraAPIError.new(body["faultstring"], response)
-            when "fns:REQUEST_EXCEEDED_LIMIT"
-              raise ZuoraAPI::Exceptions::ZuoraAPIRequestLimit.new(body["faultstring"], response)
-            when "fns:LOCK_COMPETITION"
-              raise ZuoraAPI::Exceptions::ZuoraAPILockCompetition.new(body["faultstring"], response)
-            when "INVALID_SESSION"
-              raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new(body["faultstring"], response)
-            when /fns:INVALID_TYPE/
-              raise ZuoraAPI::Exceptions::ZuoraAPIError.new(body["faultstring"], response)
-            when /.*soapenv:Server.*/
-              raise ZuoraAPI::Exceptions::ZuoraAPIInternalServerError.new(body["faultstring"], response)
-            else
-              raise ZuoraAPI::Exceptions::ZuoraAPIError.new("Z:#{body["faultcode"]}::#{body["faultstring"]}", response)
-            end
+            raise_errors_helper(error:  body["faultcode"], message: body["faultstring"], response: response)
           end
 
           if body["Errors"].present? || body["errors"].present?
@@ -686,7 +727,7 @@ module ZuoraAPI
                 raise ZuoraAPI::Exceptions::ZuoraAPILockCompetition.new("Retry Lock Competition", response)
               elsif error_messages.first.include?("data integrity violation")
                 raise ZuoraAPI::Exceptions::ZuoraDataIntegrity.new("Data Integrity Violation", response)
-              end 
+              end
             end
           end
 
@@ -746,7 +787,7 @@ module ZuoraAPI
       return error, success, message
     end
 
-    def raise_errors_helper(error, message, response, errors = [], success = [])
+    def raise_errors_helper(error: nil, message: nil, response: nil, errors: [], success: [])
       case error
       when /.*INVALID_SESSION/
         raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new(message, response, errors, success)
@@ -759,40 +800,31 @@ module ZuoraAPI
           raise ZuoraAPI::Exceptions::ZuoraAPILockCompetition.new(message, response, errors, success)
         elsif message.include?("org.hibernate.exception.ConstraintViolationException")
           raise ZuoraAPI::Exceptions::ZuoraAPIInternalServerError.new(message, response, errors, success)
-        else
-          raise ZuoraAPI::Exceptions::ZuoraAPIError.new(message, response, errors, success)
         end
+        raise ZuoraAPI::Exceptions::ZuoraAPIError.new(message, response, errors, success)
       when /.*TEMPORARY_ERROR/
         raise ZuoraAPI::Exceptions::ZuoraAPITemporaryError.new(message, response, errors, success)
       when /.*INVALID_VALUE/
         if message.include?("data integrity violation")
           raise ZuoraAPI::Exceptions::ZuoraDataIntegrity.new("Data Integrity Violation", response, errors), success
-        else
-          raise ZuoraAPI::Exceptions::ZuoraAPIError.new(message, response, errors, success)
         end
+        raise ZuoraAPI::Exceptions::ZuoraAPIError.new(message, response, errors, success)
       when /.*UNKNOWN_ERROR/
         if /payment\/refund|Credit Balance Adjustment|Payment Gateway|ARSettlement permission/.match(message).nil?
           raise ZuoraAPI::Exceptions::ZuoraAPIUnkownError.new(message, response, errors, success)
-        else
-          raise ZuoraAPI::Exceptions::ZuoraAPIError.new(message, response, errors, success)
         end
+        raise ZuoraAPI::Exceptions::ZuoraAPIError.new(message, response, errors, success)
       when /INVALID_ID/, /MAX_RECORDS_EXCEEDED/, /INVALID_FIELD/, /MALFORMED_QUERY/, /NO_PERMISSION/, /PDF_QUERY_ERROR/, /MISSING_REQUIRED_VALUE/, /INVALID_TYPE/, /TRANSACTION_FAILED/, /API_DISABLED/, /CANNOT_DELETE/, /ACCOUNTING_PERIOD_CLOSED/
         raise ZuoraAPI::Exceptions::ZuoraAPIError.new(message, response, errors, success)
+      when /.*UNEXPECTED_ERROR/
+        raise ZuoraAPI::Exceptions::ZuoraUnexpectedError.new(message.to_s, response, errors, success)
       when /.*soapenv:Server.*/
         if /Invalid value.*for type|Id is invalid/.match(message).present?
           raise ZuoraAPI::Exceptions::ZuoraAPIError.new(message, response, errors, success)
         end
         raise ZuoraAPI::Exceptions::ZuoraAPIInternalServerError.new(message, response, errors, success)
-      end
-
-      if response.code == 500
-        if message.present?
-          raise ZuoraAPI::Exceptions::ZuoraAPIError.new("Z:#{error}::#{message}", response, errors, success)
-        else
-          raise ZuoraAPI::Exceptions::ZuoraAPIInternalServerError.new(response.body, response, errors, success)
-        end
-      else
-        raise ZuoraAPI::Exceptions::ZuoraAPIError.new("Z:#{error}::#{message}", response, errors, success) if error.present?
+      else 
+        raise ZuoraAPI::Exceptions::ZuoraAPIInternalServerError.new("Z:#{error}::#{message}", response, errors, success)
       end
     end
 
@@ -875,7 +907,13 @@ module ZuoraAPI
       end
     rescue *(CONNECTION_EXCEPTIONS + CONNECTION_READ_EXCEPTIONS) => ex
       if tries.zero?
-        Rails.logger.info("Describe - #{ex.class} Timed out will retry after 5 seconds")
+        if log_errors
+          if Rails.logger.class.to_s == "Ougai::Logger"
+            Rails.logger.error("Describe - Timed out will retry after #{self.timeout_sleep} seconds", ex) 
+          else
+            Rails.logger.error("Describe - #{ex.class} Timed out will retry after #{self.timeout_sleep} seconds") 
+          end
+        end
         raise ex 
       end
 
@@ -911,6 +949,7 @@ module ZuoraAPI
       timeout: 120,
       multipart: false,
       stream_body: false,
+      output_exception_messages: true,
       **keyword_args,
       &block
     )
@@ -988,7 +1027,13 @@ module ZuoraAPI
       raise ex
     rescue *CONNECTION_EXCEPTIONS => ex
       if tries.zero?
-        Rails.logger.info("Rest Call - #{ex.class} Timed out will retry after 5 seconds")
+        if output_exception_messages
+          if Rails.logger.class.to_s == "Ougai::Logger"
+            Rails.logger.error("Rest Call - Timed out will retry after #{self.timeout_sleep} seconds", ex) 
+          else
+            Rails.logger.error("Rest Call - #{ex.class} Timed out will retry after #{self.timeout_sleep} seconds") 
+          end
+        end
         raise ex 
       end
 
@@ -997,7 +1042,13 @@ module ZuoraAPI
       retry
     rescue *CONNECTION_READ_EXCEPTIONS => ex
       if tries.zero?
-        Rails.logger.info("Rest Call - #{ex.class} Timed out will retry after 5 seconds")
+        if output_exception_messages
+          if Rails.logger.class.to_s == "Ougai::Logger"
+            Rails.logger.error("Rest Call - Timed out will retry after #{self.timeout_sleep} seconds", ex) 
+          else
+            Rails.logger.error("Rest Call - #{ex.class} Timed out will retry after #{self.timeout_sleep} seconds") 
+          end
+        end
         raise ex 
       end
 
@@ -1009,7 +1060,13 @@ module ZuoraAPI
         sleep(self.timeout_sleep)
         retry
       else
-        Rails.logger.info("Rest Call - #{ex.class} Timed out will retry after 5 seconds")
+        if output_exception_messages
+          if Rails.logger.class.to_s == "Ougai::Logger"
+            Rails.logger.error("Rest Call - Timed out will retry after #{self.timeout_sleep} seconds", ex) 
+          else
+            Rails.logger.error("Rest Call - #{ex.class} Timed out will retry after #{self.timeout_sleep} seconds") 
+          end
+        end
         raise ex
       end
     rescue => ex
@@ -1181,8 +1238,8 @@ module ZuoraAPI
           raise ZuoraAPI::Exceptions::FileDownloadError.new("File Download Failed #{response.class}")
         end
       end
-          
-    rescue => ex 
+
+    rescue => ex
       sleep(5)
       if (retry_count -= 1) >= 0
         retry

data/lib/zuora_api/version.rb

@@ -1,3 +1,3 @@
 module ZuoraAPI
-  VERSION = "1.7.44"
+  VERSION = "1.7.45"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zuora_api
 version: !ruby/object:Gem::Version
-  version: 1.7.44
+  version: 1.7.45
 platform: ruby
 authors:
 - Zuora Strategic Solutions Group
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-13 00:00:00.000000000 Z
+date: 2020-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler