zuora_api 1.7.65g → 1.7.66d

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 844d4f29e48548bf298907952d760386687b8d9f0cc4b6f1ce26defe42d9ce30
-  data.tar.gz: 38661f9da6c4032fe418941f1dddb1581680df7297e6eb8164deab377f82c54a
+  metadata.gz: 899b9f7281ac70fc96cedd3a94fefd95184be57b4b8e596d3a33c4d140252faf
+  data.tar.gz: c1c3a2fac114b367e084208b806fe30e64a5441710b85e4d1c3a74ac24f5a6c1
 SHA512:
-  metadata.gz: 7c149b5fbb73d911e7b55dd10bf3f2d2149695a2d42866936dc43eeb1916191b54d3f666e187c08db69d84467f6e90e13750ab8f5c127b7d3610cc0484b07853
-  data.tar.gz: ab1ecee455a237c5b2077a8e331b25d9aa2fbc82ec46ad5be9579898d1b8c4c879f8c213efe2dd494c3941f9376557af1ee5d698ec093f60729b8f198ac8b174
+  metadata.gz: '09d7e01c4c7592705644eafc7310de8de7c02b9d3f938cd6aa7388aa05cc64ca8d43f1485680f2f17210744073ee7a0e541525eaad83d7b0c7548fd626fb38cb'
+  data.tar.gz: 1831e616a849cc266b126fe085b8765a6493dcc578d5875315f44ef53c698908ede7eb1b47bcff254e71ff1c27eaee2abbdabcc35994f78f89d7d8894c5a6978

data/.gitlab-ci.yml

@@ -35,6 +35,7 @@ rspec-testing:
   script:
   - bundle install
   - rspec
+  coverage: '/\(\d+.\d+\%\) covered/'
 
 rubygems-deploy:
   stage: deploy

data/lib/zuora_api/exceptions.rb

@@ -177,14 +177,15 @@ module ZuoraAPI
     end
 
     class ZuoraAPITemporaryError < Error
-      attr_reader :code, :response
+      attr_reader :code, :response, :errors
       attr_writer :default_message
 
-      def initialize(message = nil,response=nil, errors = [], successes = [], *args)
+      def initialize(message = nil, response = nil, errors = [], successes = [], *args)
         @code = response.class.to_s == "HTTParty::Response" ? response.code : nil
         @message = parse_message(message)
         @response = response
         @default_message = "There is a temporary error with zuora system."
+        @errors = errors
       end
 
       def to_s

data/lib/zuora_api/login.rb

@@ -39,8 +39,8 @@ module ZuoraAPI
 
     ZUORA_SERVER_ERRORS = [
       ZuoraAPI::Exceptions::ZuoraAPIInternalServerError,
-      ZuoraAPI::Exceptions::ZuoraAPIConnectionTimeout,
-      ZuoraAPI::Exceptions::ZuoraAPIReadTimeout,
+        ZuoraAPI::Exceptions::ZuoraAPIConnectionTimeout,
+        ZuoraAPI::Exceptions::ZuoraAPIReadTimeout,
       ZuoraAPI::Exceptions::ZuoraUnexpectedError
     ].freeze
     
@@ -428,7 +428,8 @@ module ZuoraAPI
     def soap_call(
       ns1: 'ns1', 
       ns2: 'ns2', 
-      batch_size: nil, 
+      batch_size: nil,
+      headers: {},
       single_transaction: false, 
       debug: false, 
       zuora_track_id: nil, 
@@ -471,7 +472,7 @@ module ZuoraAPI
       input_xml.xpath('//ns1:session', 'ns1' =>'http://api.zuora.com/').children.remove
       Rails.logger.debug("Request SOAP XML: #{input_xml.to_xml(:save_with => XML_SAVE_OPTIONS).strip}") if debug
 
-      headers = { 'Content-Type' => "text/xml; charset=utf-8", 'Accept' => 'text/xml'}
+      headers.merge!({ 'Content-Type' => "text/xml; charset=utf-8", 'Accept' => 'text/xml'})
       headers['Zuora-Track-Id'] = zuora_track_id if zuora_track_id.present?
 
       request = HTTParty::Request.new(
@@ -500,20 +501,18 @@ module ZuoraAPI
         end
 
         retry
-      else
-        if errors.include?(ex.class)
-          raise ex
-        else
-          return output_xml, input_xml, response
-        end
       end
+        
+      raise ex if errors.include?(ex.class)
+  
+      return output_xml, input_xml, response
+      
     rescue *ZUORA_API_ERRORS => ex
-      if errors.include?(ex.class)
-        raise ex
-      else
-        response = ex.response unless response
-        return output_xml, input_xml, response
-      end
+      raise ex if errors.include?(ex.class)
+     
+      response = ex.response unless response
+      return output_xml, input_xml, response
+      
     rescue *CONNECTION_EXCEPTIONS => ex
       if tries.zero?
         if output_exception_messages
@@ -629,21 +628,8 @@ module ZuoraAPI
           end
         end
 
-        if (response.code == 400 && response.headers.fetch('content-type', []).include?('text/html'))
-          raise ZuoraAPI::Exceptions::ZuoraAPIInternalServerError.new(response.body, response)
-        elsif response.code == 500  
-          if response.headers.fetch('content-type', []).include?('application/json')
-            begin
-              output_json = JSON.parse(response.body)
-              self.raise_errors(type: :JSON, body: output_json, response: response)
-            rescue JSON::ParserError => ex
-              raise ZuoraAPI::Exceptions::ZuoraAPIInternalServerError.new(response.body, response)
-            end
-          else
-            raise ZuoraAPI::Exceptions::ZuoraAPIInternalServerError.new(response.body, response)
-          end
-        end
-
+        self.errors_via_content_type(response: response, type: :xml)
+        
       when :JSON
         case request_path
         when /^\/query\/jobs.*/  #DataQuery Paths
@@ -671,6 +657,10 @@ module ZuoraAPI
           when /^GET::400::\/api\/rest\/v1\/reports\/(reportlabels\/)?([a-zA-Z0-9\-_]+)\/report-details$/ # Get report, capture of the id is present if needed in future error responses.
             raise ZuoraAPI::Exceptions::ZuoraAPIError.new(reporting_message, response) if reporting_message.present?
           end
+        when /\/objects\/batch\//
+          if body['code'].present? && /61$/.match(body['code'].to_s).present? # if last 2 digits of code are 61
+            raise ZuoraAPI::Exceptions::ZuoraAPITemporaryError.new(body['message'], nil, body['details'])
+          end
         end
 
         body = body.dig("results").present? ? body["results"] : body if body.class == Hash
@@ -731,7 +721,6 @@ module ZuoraAPI
           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
-
           #Internal Server Error
           if codes_array.map{|code| code.to_s.slice(6,7).to_i}.include?(60)
             if messages_array.uniq.size == 1 
@@ -742,6 +731,11 @@ module ZuoraAPI
             raise ZuoraAPI::Exceptions::ZuoraAPIInternalServerError.new("#{messages_array.join(', ')}", response)
           end
 
+          #Retryiable Service Error
+          if codes_array.map{|code| code.to_s.slice(6,7).to_i}.include?(61)
+            raise ZuoraAPI::Exceptions::ZuoraAPITemporaryError.new("#{messages_array.join(', ')}", response)
+          end
+
           #Request exceeded limit
           if codes_array.map{|code| code.to_s.slice(6,7).to_i}.include?(70)
             raise ZuoraAPI::Exceptions::ZuoraAPIRequestLimit.new("#{messages_array.join(', ')}", response)
@@ -794,32 +788,56 @@ module ZuoraAPI
           end
         end
 
+        if body.class == Hash && body['message'].present?
+          raise ZuoraAPI::Exceptions::ZuoraAPIInternalServerError.new(body['message'], response) if response.code == 500
+          raise ZuoraAPI::Exceptions::ZuoraAPIError.new(body['message'], response) if ![200,201].include?(response.code)
+        end
+
+        self.errors_via_content_type(response: response, type: :json)
+
         #All other errors
-        if response.code == 500
-          if body.class == Hash && body['message'].present?
-            raise ZuoraAPI::Exceptions::ZuoraAPIInternalServerError.new(body['message'], response)
-          else
-            response_content_types = response.headers.transform_keys(&:downcase).fetch('content-type', []).first || ''
+        raise ZuoraAPI::Exceptions::ZuoraAPIError.new(response.body, response) if ![200,201].include?(response.code) 
+      end
+    end
 
-            if response_content_types.include?('application/xml') || response_content_types.include?('text/xml')
-              self.raise_errors(type: :SOAP, body: Nokogiri::XML(response.body), response: response)
-            else
-              raise ZuoraAPI::Exceptions::ZuoraAPIInternalServerError.new(response.body, response)
-            end
-          end
-        elsif ![200,201].include?(response.code)
-          if body['message'].present?
-            raise ZuoraAPI::Exceptions::ZuoraAPIError.new(body['message'], response)
-          else
-            if 403 == response.code && response.body.include?("Forbidden")
-              raise ZuoraAPI::Exceptions::ZuoraAPIInternalServerError.new(response.body, response)
-            else
-              raise ZuoraAPI::Exceptions::ZuoraAPIError.new(response.body, response)
-            end
+    def errors_via_content_type(response: nil, type: :xml)
+      response_content_types = response.headers.transform_keys(&:downcase).fetch('content-type', []).first || ""
+      
+      if response_content_types.include?('application/json') && type != :json
+        output_json = JSON.parse(response.body)
+        self.raise_errors(type: :JSON, body: output_json, response: response)
+      
+      elsif (response_content_types.include?('application/xml') || response_content_types.include?('text/xml')) and type != :xml
+        output_xml = Nokogiri::XML(response.body)
+        self.raise_errors(type: :SOAP, body: output_xml, response: response)
+
+      elsif response_content_types.include?('text/html')
+        raise ZuoraAPI::Exceptions::ZuoraAPIInternalServerError.new("Akamai Error", response) if response.headers.fetch('server', '') == 'AkamaiGHost'
+
+        parse_body = Nokogiri::HTML(response.body)
+        error_title = parse_body.xpath('//h2').text
+        error_title = parse_body.xpath('//h1').text if error_title.blank?
+        error_message = parse_body.xpath('//p').text
+
+        error_message = error_title if error_message.blank?
+
+        if error_title.present?
+          case error_title
+          when /Service Unavailable/
+            raise ZuoraAPI::Exceptions::ZuoraAPIConnectionTimeout.new(error_message, response)
+          when /Client sent a bad request./, /Bad Request/, /403 Forbidden/
+            raise ZuoraAPI::Exceptions::ZuoraAPIInternalServerError.new(error_message, response)    
+          else 
+            raise ZuoraAPI::Exceptions::ZuoraAPIInternalServerError.new(error_message, response)
           end
         end
+
+        raise ZuoraAPI::Exceptions::ZuoraAPIInternalServerError.new("Http response body is missing", response) if response.body.blank?
       end
+
+      raise ZuoraAPI::Exceptions::ZuoraAPIInternalServerError.new(response.body, response) if response.code == 500
     end
+          
 
     def get_soap_error_and_message(body)
       error   = body.xpath('//fns:FaultCode', 'fns' =>'http://fault.api.zuora.com/').text
@@ -885,7 +903,7 @@ module ZuoraAPI
       when /.*soapenv:Server.*/
         if /^Invalid value.*for type.*|^Id is invalid|^date string can not be less than 19 charactors$/.match(message).present?
           raise ZuoraAPI::Exceptions::ZuoraAPIError.new(message, response, errors, success)
-        elsif /^Invalid white space character \(.*\) in text to output$/.match(message).present?
+        elsif /^Invalid white space character \(.*\) in text to output$|^Invalid null character in text to output$/.match(message).present?
           raise ZuoraAPI::Exceptions::ZuoraAPIUnkownError.new(message, response, errors, success)
         end
         raise ZuoraAPI::Exceptions::ZuoraAPIInternalServerError.new(message, response, errors, success)
@@ -1065,10 +1083,10 @@ module ZuoraAPI
       if self.class.to_s == 'ZuoraAPI::Oauth' && ex.message.include?("Authentication type is not supported by this Login")
         session_type = :bearer
         retry
-      else
-        Rails.logger.debug("Rest Call - Session Bad Auth type")
-        raise ex
       end
+      Rails.logger.debug("Rest Call - Session Bad Auth type")
+      raise ex
+      
     rescue ZuoraAPI::Exceptions::ZuoraAPISessionError => ex
       if !tries.zero? && z_session
         tries -= 1
@@ -1081,20 +1099,17 @@ module ZuoraAPI
         end
 
         retry
-      else
-        if errors.include?(ex.class)
-          raise ex
-        else
-          return [output_json, response]
-        end
       end
+
+      raise ex if errors.include?(ex.class)
+      return [output_json, response]
+      
     rescue *ZUORA_API_ERRORS => ex
-      if errors.include?(ex.class)
-        raise ex
-      else
-        response = ex.response unless response
-        return [output_json, response]
-      end
+      raise ex if errors.include?(ex.class)
+      
+      response = ex.response unless response
+      return [output_json, response]
+  
     rescue ZuoraAPI::Exceptions::BadEntityError => ex
       raise ex
     rescue *CONNECTION_EXCEPTIONS => ex
@@ -1313,7 +1328,7 @@ module ZuoraAPI
       end
     end
 
-    def getDataSourceExport(query, extract: true, encrypted: false, zip: true, z_track_id: nil)
+    def getDataSourceExport(query, extract: true, encrypted: false, zip: true, z_track_id: "")
       begin
         tries ||= 3
         request = Nokogiri::XML::Builder.new do |xml|
@@ -1399,6 +1414,15 @@ module ZuoraAPI
           raise ex
         end
 
+      rescue ZuoraAPI::Exceptions::ZuoraUnexpectedError => ex
+        if !(tries -= 1).zero?
+          Rails.logger.info("Trace ID: #{z_track_id} UnexpectedError, will retry after 10 seconds")
+          sleep 10
+          retry
+        else
+          raise ex
+        end
+
       rescue *ZUORA_API_ERRORS => ex
         raise ex
 

data/lib/zuora_api/logins/oauth.rb

@@ -37,7 +37,13 @@ module ZuoraAPI
       begin
         self.current_session = response.headers.to_h['set-cookie'][0].split(';')[0].split('=',2)[1].gsub('%3D', '=')
       rescue NoMethodError => ex 
-        Rails.logger.fatal("Failure Parsing Cookie Headers", response.headers.to_s)
+        Rails.logger.fatal("Failure Parsing Cookie Headers", {
+          response: {
+            status: response.code,
+            params: response.body.to_s,
+            headers: response.headers.to_s,
+          }
+        })
         raise ZuoraAPI::Exceptions::ZuoraAPIAuthenticationTypeError.new("Failure Parsing Cookie Headers")
       end 
     rescue ZuoraAPI::Exceptions::ZuoraAPISessionError => ex
@@ -47,12 +53,10 @@ module ZuoraAPI
         self.new_session(auth_type: :bearer)
         retry
       end
-      raise ex if errors.include?(ex.class)
-      return [output_json, response]
+      raise ex
 
-    rescue ZuoraAPI::Exceptions::ZuoraAPIError, ZuoraAPI::Exceptions::ZuoraAPIRequestLimit, ZuoraAPI::Exceptions::ZuoraAPILockCompetition  => ex
-      raise ex if errors.include?(ex.class)
-      return [output_json, response]
+    rescue ZuoraAPI::Exceptions::ZuoraAPIError, ZuoraAPI::Exceptions::ZuoraAPIRequestLimit, ZuoraAPI::Exceptions::ZuoraAPILockCompetition => ex
+      raise ex
 
     rescue *(CONNECTION_EXCEPTIONS + CONNECTION_READ_EXCEPTIONS) => ex
       if !tries.zero?

data/lib/zuora_api/version.rb

@@ -1,3 +1,3 @@
 module ZuoraAPI
-  VERSION = "1.7.65g"
+  VERSION = "1.7.66d"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zuora_api
 version: !ruby/object:Gem::Version
-  version: 1.7.65g
+  version: 1.7.66d
 platform: ruby
 authors:
 - Zuora Strategic Solutions Group
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-14 00:00:00.000000000 Z
+date: 2020-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler