zuora_api 1.6.37 → 1.6.38

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07b9ce6f6da3f91cb2a8a029a3a383dd7fdb8c8ed72a0b7760b2d6b864646ee5
-  data.tar.gz: bf0f0aee956840d439f8675fd6f4fc9ec7f26e4e1d425e885ab6fb601835c67f
+  metadata.gz: db27825f234df0bf22824cd3100d5b4ed5f6565fc46cbbbab742dd62f2b02261
+  data.tar.gz: 298711ae7f8362f91c67c8f66fa3b685e7f8beb44eb3dbc9233225b5e5e6e1e4
 SHA512:
-  metadata.gz: d73a30e914434e29fbd4834278f518d1bd71256dde1c14c494d7b4e2157db1e5cb48d7bae209ba093db9aa714e0573c858331e88ad476fcf1ca6c2a197627c6a
-  data.tar.gz: 2ccc42456bbc58afbc133594c0f6ba4d5df263b64257cbf3efd8cb09572bad1980410c36cfc56788ce69f9e6dd7c533aa16754759bb5c2ee19850bfee6f77d53
+  metadata.gz: cf541c7e898feec11cc498a81fa1f3eacb9920d8315eee5feca4001ea656de14c71b14fcca73ada4065c80950aa25b490d054b61c59432588d60e8a7fae22eeb
+  data.tar.gz: 2d4f8d1c8c141e3646eb25deefac6acd288ff2e996d73736ce96c8f8d9a3844079bfff08b08f2af2f07cc205fbd870b8896af61bb77b72e97aac68e859627c36

data/lib/zuora_api/exceptions.rb

@@ -6,8 +6,8 @@ module ZuoraAPI
       attr_reader :code, :response
       attr_writer :default_message
 
-      def initialize(message = nil,response=nil, code =nil)
-        @code = code
+      def initialize(message = nil,response=nil)
+        @code = response.present? && response.class.to_s == "HTTParty::Response" ? response.code : nil
         @message = message
         @response = response
         @default_message = "Error with Zuora Session."
@@ -22,8 +22,8 @@ module ZuoraAPI
       attr_reader :code, :response, :errors, :successes
       attr_writer :default_message
 
-      def initialize(message = nil,response=nil, code =nil, errors = [], successes = [])
-        @code = code
+      def initialize(message = nil,response=nil, errors = [], successes = [],  *args)
+        @code = response.present? && response.class.to_s == "HTTParty::Response" ? response.code : nil
         @message = message
         @response = response
         @default_message = "Error with Zuora Entity"
@@ -40,8 +40,8 @@ module ZuoraAPI
       attr_reader :code, :response, :errors, :successes
       attr_writer :default_message
 
-      def initialize(message = nil,response=nil, code =nil, errors = [], successes = [])
-        @code = code
+      def initialize(message = nil,response=nil, errors = [], successes = [],  *args)
+        @code = response.present? && response.class.to_s == "HTTParty::Response" ? response.code : nil
         @message = message
         @response = response
         @default_message = "Error communicating with Zuora."
@@ -58,8 +58,8 @@ module ZuoraAPI
       attr_reader :code, :response
       attr_writer :default_message
 
-      def initialize(message = nil,response=nil, code =nil)
-        @code = code
+      def initialize(message = nil,response=nil,  *args)
+        @code = response.present? && response.class.to_s == "HTTParty::Response" ? response.code : nil
         @message = message
         @response = response
         @default_message = "Your request limit has been exceeded for zuora."
@@ -74,8 +74,24 @@ module ZuoraAPI
       attr_reader :code, :response
       attr_writer :default_message
 
-      def initialize(message = nil,response=nil, code =nil)
-        @code = code
+      def initialize(message = nil,response=nil,  *args)
+        @code = response.present? && response.class.to_s == "HTTParty::Response" ? response.code : nil
+        @message = message
+        @response = response
+        @default_message = "Operation failed due to lock competition. Please retry"
+      end
+
+      def to_s
+        @message || @default_message
+      end
+    end
+
+    class ZuoraDataIntegrity < Error
+      attr_reader :code, :response
+      attr_writer :default_message
+
+      def initialize(message = nil,response=nil,  *args)
+        @code = response.present? && response.class.to_s == "HTTParty::Response" ? response.code : nil
         @message = message
         @response = response
         @default_message = "Operation failed due to lock competition. Please retry"
@@ -90,8 +106,8 @@ module ZuoraAPI
       attr_reader :code, :response
       attr_writer :default_message
 
-      def initialize(message = nil,response=nil, code =nil)
-        @code = code
+      def initialize(message = nil,response=nil, *args)
+        @code = response.present? && response.class.to_s == "HTTParty::Response" ? response.code : nil
         @message = message
         @response = response
         @default_message = "There is a temporary error with zuora system."
@@ -106,8 +122,8 @@ module ZuoraAPI
       attr_reader :code, :response
       attr_writer :default_message
 
-      def initialize(message = nil,response=nil, code =nil)
-        @code = code
+      def initialize(message = nil,response=nil,  *args)
+        @code = response.present? && response.class.to_s == "HTTParty::Response" ? response.code : nil
         @message = message
         @response = response
         @default_message = "Authentication type is not supported by this Login"

data/lib/zuora_api/login.rb

@@ -1,6 +1,7 @@
 require "httparty"
 require "nokogiri"
 require "uri"
+require 'zuora_api/exceptions'
 
 module ZuoraAPI
   class Login
@@ -10,7 +11,8 @@ module ZuoraAPI
     XML_SAVE_OPTIONS = Nokogiri::XML::Node::SaveOptions::AS_XML | Nokogiri::XML::Node::SaveOptions::NO_DECLARATION
     CONNECTION_EXCEPTIONS = [Net::OpenTimeout, OpenSSL::SSL::SSLError, Errno::ECONNREFUSED, SocketError, Errno::EHOSTUNREACH]
     CONNECTION_READ_EXCEPTIONS = [Net::ReadTimeout, Errno::ECONNRESET, Errno::EPIPE]
-
+    ZUORA_API_ERRORS = [ZuoraAPI::Exceptions::ZuoraAPIError, ZuoraAPI::Exceptions::ZuoraAPIRequestLimit, ZuoraAPI::Exceptions::ZuoraAPILockCompetition, ZuoraAPI::Exceptions::ZuoraAPITemporaryError, ZuoraAPI::Exceptions::ZuoraDataIntegrity]
+    
     attr_accessor :region, :url, :wsdl_number, :current_session, :environment, :status, :errors, :current_error, :user_info, :tenant_id, :tenant_name, :entity_id, :timeout_sleep, :hostname, :zconnect_provider
 
     def initialize(url: nil, entity_id: nil, session: nil, status: nil, **keyword_args)
@@ -36,21 +38,21 @@ module ZuoraAPI
         if !zsession.blank?
           response = HTTParty.get("https://#{self.hostname}/apps/v1/identity", :headers => {'Cookie' => "ZSession=#{zsession}", 'Content-Type' => 'application/json'})
           output_json = JSON.parse(response.body)
-        elsif !zconnect_accesstoken.blank?
-          code = zconnect_accesstoken.split("#!").last
-          encrypted_token, tenant_id = Base64.decode64(code).split(":")
+        elsif zconnect_accesstoken.present?
           begin
+            code = zconnect_accesstoken.split("#!").last
+            encrypted_token, tenant_id = Base64.decode64(code).split(":")
             body = {'token' => encrypted_token}.to_json
           rescue => ex
-            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("Invalid ZConnect Cookie", {}, 400)
+            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("Invalid ZConnect Cookie")
           end
           response = HTTParty.post("https://#{self.hostname}/apps/zconnectsession/identity", :body => body, :headers => { 'Content-Type' => 'application/json' })
           output_json = JSON.parse(response.body)
         else
           if zconnect_accesstoken.blank? && cookies.keys.any? { |x| x.include? "ZConnect"}
-            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZConnect cookie present matching #{self.hostname}", {}, 400)
+            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZConnect cookie present matching #{self.hostname}")
           else
-            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZSession cookie present", {}, 400)
+            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZSession cookie present")
           end
         end
       rescue JSON::ParserError => ex
@@ -64,17 +66,17 @@ module ZuoraAPI
       zsession = cookies["ZSession"]
       zconnect_accesstoken = get_zconnect_accesstoken(cookies)
       begin
-        if !zsession.blank?
+        if zsession.present?
           response = HTTParty.get("https://#{self.hostname}/apps/v1/navigation", :headers => {'Cookie' => "ZSession=#{zsession}", 'Content-Type' => 'application/json'})
           output_json = JSON.parse(response.body)
-        elsif !zconnect_accesstoken.blank?
+        elsif zconnect_accesstoken.present?
           response = HTTParty.get("https://#{self.hostname}/apps/zconnectsession/navigation", :headers => {'Cookie' => "#{self.zconnect_provider}=#{zconnect_accesstoken}",'Content-Type' => 'application/json'})
           output_json = JSON.parse(response.body)
         else
           if zconnect_accesstoken.blank? && cookies.keys.any? { |x| x.include? "ZConnect"}
-            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZConnect cookie present matching #{self.hostname}", {}, 400)
+            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZConnect cookie present matching #{self.hostname}")
           else
-            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZSession cookie present", {}, 400)
+            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZSession cookie present")
           end
         end
       rescue JSON::ParserError => ex
@@ -96,9 +98,9 @@ module ZuoraAPI
           output_json = JSON.parse(response.body)
         else
           if zconnect_accesstoken.blank? && cookies.keys.any? { |x| x.include? "ZConnect"}
-            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZConnect cookie present matching #{self.hostname}", {}, 400)
+            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZConnect cookie present matching #{self.hostname}")
           else
-            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZSession cookie present", {}, 400)
+            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZSession cookie present")
           end
         end
       rescue JSON::ParserError => ex
@@ -120,9 +122,9 @@ module ZuoraAPI
           output_json = JSON.parse(response.body)
         else
           if zconnect_accesstoken.blank? && cookies.keys.any? { |x| x.include? "ZConnect"}
-            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZConnect cookie present matching #{self.hostname}", {}, 400)
+            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZConnect cookie present matching #{self.hostname}")
           else
-            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZSession cookie present", {}, 400)
+            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZSession cookie present")
           end
         end
       rescue JSON::ParserError => ex
@@ -170,12 +172,12 @@ module ZuoraAPI
         if entity_ids.blank? && cookies["ZuoraCurrentEntity"].present?
           entity_ids = Array(cookies["ZuoraCurrentEntity"].unpack("a8a4a4a4a12").join('-'))
         else
-          raise ZuoraAPI::Exceptions::ZuoraAPIError.new("Zuora Entity ID not provided", {}, 400)
+          raise ZuoraAPI::Exceptions::ZuoraAPIError.new("Zuora Entity ID not provided")
         end
         if user_id.blank? && cookies["Zuora-User-Id"].present?
           user_id = cookies["Zuora-User-Id"]
         else
-          raise ZuoraAPI::Exceptions::ZuoraAPIError.new("Zuora User ID not provided", {}, 400)
+          raise ZuoraAPI::Exceptions::ZuoraAPIError.new("Zuora User ID not provided")
         end
       elsif !client_id.nil? && !client_secret.nil?
         bearer_response = HTTParty.post("https://#{self.hostname}/oauth/token", :headers => {'Content-Type' => 'application/x-www-form-urlencoded', 'Accept' => 'application/json'}, :body => {'client_id' => client_id, 'client_secret' => URI::encode(client_secret), 'grant_type' => 'client_credentials'})
@@ -192,12 +194,12 @@ module ZuoraAPI
           output_json["clientSecret"] = new_client_secret
           return output_json
         elsif oauth_response.code == 401 && !oauth_response.message.blank?
-          raise ZuoraAPI::Exceptions::ZuoraAPIError.new(output_json["message"], {}, oauth_response.code)
+          raise ZuoraAPI::Exceptions::ZuoraAPIError.new(output_json["message"], oauth_response)
         else
-          raise ZuoraAPI::Exceptions::ZuoraAPIError.new(output_json["error"], {}, oauth_response.code)
+          raise ZuoraAPI::Exceptions::ZuoraAPIError.new(output_json["error"], oauth_response)
         end
       else
-        raise ZuoraAPI::Exceptions::ZuoraAPIError.new("Insufficient credentials provided", {}, 400)
+        raise ZuoraAPI::Exceptions::ZuoraAPIError.new("Insufficient credentials provided")
       end
     end
 
@@ -257,7 +259,7 @@ module ZuoraAPI
       if !self.url.blank?
         if /(?<=\.|\/|-|^)(apisandbox|sandbox)(?=\.|\/|-|$)/ === self.hostname
           self.environment = 'Sandbox'
-        elsif /(?<=\.|\/|^)(service|services[\d]*|ep-edge)(?=\.|\/|$)/ === self.hostname
+        elsif /(?<=\.|\/|^)(service[\d]*|services[\d]*|ep-edge)(?=\.|\/|$)/ === self.hostname
           self.environment = 'Services'
         elsif /(?<=\.|\/|-|^)(pt[\d]*)(?=\.|\/|-|$)/ === self.hostname
           self.environment = 'Performance'
@@ -332,7 +334,7 @@ module ZuoraAPI
       when 'Services'
         https = /https:\/\/|http:\/\//.match(self.url)[0]
         host = self.hostname
-        endpoint = "#{https}#{host}/apps/v1/#{url}"
+        endpoint = "#{https}rest#{host}/v1/#{url}"
       when 'Staging'
         endpoint = "https://rest-staging2.zuora.com/v1/".concat(url)
       when 'Unknown'
@@ -389,7 +391,7 @@ module ZuoraAPI
       end
     end
 
-    def soap_call(ns1: 'ns1', ns2: 'ns2', batch_size: nil, single_transaction: false, debug: false, errors: [ZuoraAPI::Exceptions::ZuoraAPISessionError, ZuoraAPI::Exceptions::ZuoraAPIError, ZuoraAPI::Exceptions::ZuoraAPIRequestLimit, ZuoraAPI::Exceptions::ZuoraAPILockCompetition], 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, errors: [ZuoraAPI::Exceptions::ZuoraAPISessionError].concat(ZUORA_API_ERRORS), z_session: true, timeout_retry: false, timeout: 120,**keyword_args)
       tries ||= 2
       xml = Nokogiri::XML::Builder.new do |xml|
         xml['SOAP-ENV'].Envelope('xmlns:SOAP-ENV' => "http://schemas.xmlsoap.org/soap/envelope/",
@@ -439,7 +441,7 @@ module ZuoraAPI
           return output_xml, input_xml, response
         end
       end
-    rescue ZuoraAPI::Exceptions::ZuoraAPIError, ZuoraAPI::Exceptions::ZuoraAPIRequestLimit, ZuoraAPI::Exceptions::ZuoraAPILockCompetition => ex
+    rescue *ZUORA_API_ERRORS => ex
       if errors.include?(ex.class)
         raise ex
       else
@@ -502,33 +504,39 @@ module ZuoraAPI
           if error.class == String
             case error
             when "INVALID_SESSION"
-              raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new("#{error}::#{message}", body, response.code )
+              raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new("#{error}::#{message}", response)
             when "REQUEST_EXCEEDED_LIMIT"
-              raise ZuoraAPI::Exceptions::ZuoraAPIRequestLimit.new("#{error}::#{message}", body, response.code)
+              raise ZuoraAPI::Exceptions::ZuoraAPIRequestLimit.new("#{error}::#{message}", response)
             when "LOCK_COMPETITION"
-              raise ZuoraAPI::Exceptions::ZuoraAPILockCompetition.new("#{error}::#{message}", body, response.code)
+              raise ZuoraAPI::Exceptions::ZuoraAPILockCompetition.new("#{error}::#{message}", response)
             when "BATCH_FAIL_ERROR"
               if message.include?("optimistic locking failed")
-                raise ZuoraAPI::Exceptions::ZuoraAPILockCompetition.new("#{error}::#{message}", body, response.code) 
+                raise ZuoraAPI::Exceptions::ZuoraAPILockCompetition.new("#{error}::#{message}", response) 
               else
-                raise ZuoraAPI::Exceptions::ZuoraAPIError.new("#{error}::#{message}", body, response.code)
+                raise ZuoraAPI::Exceptions::ZuoraAPIError.new("#{error}::#{message}", response)
               end
             when "TEMPORARY_ERROR"
-              raise ZuoraAPI::Exceptions::ZuoraAPITemporaryError.new("#{error}::#{message}", body, response.code)
+              raise ZuoraAPI::Exceptions::ZuoraAPITemporaryError.new("#{error}::#{message}", response)
+            when "INVALID_VALUE"
+              if message.include?("data integrity violation")
+                raise ZuoraAPI::Exceptions::ZuoraDataIntegrity.new("Data Integrity Violation", response)
+              else
+                raise ZuoraAPI::Exceptions::ZuoraAPIError.new("#{error}::#{message}", response)
+              end
             else
-              raise ZuoraAPI::Exceptions::ZuoraAPIError.new("#{error}::#{message}", body, response.code) if error.present?
+              raise ZuoraAPI::Exceptions::ZuoraAPIError.new("#{error}::#{message}", response) if error.present?
             end
           elsif error.class == Array
-              if error[0].include?("LOCK_COMPETITION") && error.count == 1
-                raise ZuoraAPI::Exceptions::ZuoraAPILockCompetition.new(error.group_by {|v| v}.map {|k,v| "(#{v.size}x) - #{k == "::" ? 'UNKNOWN::No error provided' : k}"}.join(', '), body, response.code)
-              else
-                raise ZuoraAPI::Exceptions::ZuoraAPIError.new(error.group_by {|v| v}.map {|k,v| "(#{v.size}x) - #{k == "::" ? 'UNKNOWN::No error provided' : k}"}.join(', '), body, response.code, error, success)
-              end
+            if error[0].include?("LOCK_COMPETITION") && error.count == 1
+              raise ZuoraAPI::Exceptions::ZuoraAPILockCompetition.new(error.group_by {|v| v}.map {|k,v| "(#{v.size}x) - #{k == "::" ? 'UNKNOWN::No error provided' : k}"}.join(', '), response)
+            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
         end
-
+        
         if response.code == 429
-          raise ZuoraAPI::Exceptions::ZuoraAPIRequestLimit.new("The total number of concurrent requests has exceeded the limit allowed by the system. Please resubmit your request later.", body, response.code)
+          raise ZuoraAPI::Exceptions::ZuoraAPIRequestLimit.new("The total number of concurrent requests has exceeded the limit allowed by the system. Please resubmit your request later.", response)
         end
 
       when :JSON
@@ -538,58 +546,58 @@ module ZuoraAPI
           codes_array = (body["reasons"] || []).map {|error| error['code']}.compact
 
           if body['message'] == "No bearer token" && response.code == 400
-            raise ZuoraAPI::Exceptions::ZuoraAPIAuthenticationTypeError.new()
+            raise ZuoraAPI::Exceptions::ZuoraAPIAuthenticationTypeError.new("Authentication type is not supported by this Login", response)
           end
 
           if body['errorMessage']
-            raise ZuoraAPI::Exceptions::ZuoraAPIError.new(body['errorMessage'],body,response.code)
+            raise ZuoraAPI::Exceptions::ZuoraAPIError.new(body['errorMessage'], response)
           end
 
           if body.dig("reasons").nil? ? false : body.dig("reasons")[0].dig("code") == 90000020
-            raise ZuoraAPI::Exceptions::BadEntityError.new("#{messages_array.join(', ')}", body, response.code)
+            raise ZuoraAPI::Exceptions::BadEntityError.new("#{messages_array.join(', ')}", response)
           end
 
           if body['error'] == 'Unauthorized' && body['status'] = 401
-            raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new("#{messages_array.join(', ')}", body, response.code)
+            raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new("#{messages_array.join(', ')}", response)
           end
           #Authentication failed
           if codes_array.map{|code| code.to_s.slice(6,7).to_i}.include?(11) || response.code == 401
-            raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new("#{messages_array.join(', ')}", body, response.code)
+            raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new("#{messages_array.join(', ')}", response)
           end
 
           #Zuora REST Create Amendment error #Authentication failed
           if body["faultcode"].present? && body["faultcode"] == "fns:INVALID_SESSION"
-            raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new("#{body['faultstring']}", body, response.code)
+            raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new("#{body['faultstring']}", 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(', ')}", body, response.code)
+            raise ZuoraAPI::Exceptions::ZuoraAPIRequestLimit.new("#{messages_array.join(', ')}", response)
           end
 
           #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(', ')}", body, response.code)
-          end
+            raise ZuoraAPI::Exceptions::ZuoraAPILockCompetition.new("#{messages_array.join(', ')}", response)
+          end          
 
           #All Errors catch
           if codes_array.size > 0
-            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("#{messages_array.join(', ')}", body, response.code)
+            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("#{messages_array.join(', ')}", response)
           end
 
           #Zuora REST Query Errors
           if body["faultcode"].present?
             case body["faultcode"]
             when "fns:MALFORMED_QUERY"
-              raise ZuoraAPI::Exceptions::ZuoraAPIError.new("#{body["faultcode"]}::#{body["faultstring"]}", body, response.code)
+              raise ZuoraAPI::Exceptions::ZuoraAPIError.new("#{body["faultcode"]}::#{body["faultstring"]}", response)
             when "fns:REQUEST_EXCEEDED_LIMIT"
-              raise ZuoraAPI::Exceptions::ZuoraAPIRequestLimit.new("#{body["faultcode"]}::#{body["faultstring"]}", body, response.code)
+              raise ZuoraAPI::Exceptions::ZuoraAPIRequestLimit.new("#{body["faultcode"]}::#{body["faultstring"]}", response)
             when "fns:LOCK_COMPETITION"
-              raise ZuoraAPI::Exceptions::ZuoraAPILockCompetition.new("#{body["faultcode"]}::#{body["faultstring"]}", body, response.code)
+              raise ZuoraAPI::Exceptions::ZuoraAPILockCompetition.new("#{body["faultcode"]}::#{body["faultstring"]}", response)
             when "INVALID_SESSION"
-              raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new("#{body["faultcode"]}::#{body["faultstring"]}", body, response.code)
+              raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new("#{body["faultcode"]}::#{body["faultstring"]}", response)
             else
-              raise ZuoraAPI::Exceptions::ZuoraAPIError.new("#{body["faultcode"]}::#{body["faultstring"]}", body, response.code)
+              raise ZuoraAPI::Exceptions::ZuoraAPIError.new("#{body["faultcode"]}::#{body["faultstring"]}", response)
             end
           end
 
@@ -598,7 +606,7 @@ module ZuoraAPI
             (body["Errors"] || []).select { |obj| errors.push(obj["Message"]) }.compact
             (body["errors"] || []).select { |obj| errors.push(obj["Message"]) }.compact
             if errors.size > 0
-              raise ZuoraAPI::Exceptions::ZuoraAPIError.new("#{errors.join(", ")}", body, response.code, errors)
+              raise ZuoraAPI::Exceptions::ZuoraAPIError.new("#{errors.join(", ")}", response, errors)
             end
           end
         end
@@ -610,22 +618,27 @@ module ZuoraAPI
 
           if all_success.blank? && all_errors.present?
             error_codes = all_errors.flatten.group_by {|error| error['Code']}.keys.uniq
-            if error_codes.size == 1 && error_codes[0] == "LOCK_COMPETITION"
-              raise ZuoraAPI::Exceptions::ZuoraAPILockCompetition.new("Retry Lock Competition", body, response.code)
+            error_messages = all_errors.flatten.group_by {|error| error['Message']}.keys.uniq
+            if error_codes.size == 1 || error_messages.size == 1
+              if error_codes.first == "LOCK_COMPETITION"
+                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
 
           if all_errors.size > 0
-            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("#{all_errors.flatten.group_by {|error| error['Message']}.keys.uniq.join(' ')}", body, response.code, all_errors, all_success  )
+            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("#{all_errors.flatten.group_by {|error| error['Message']}.keys.uniq.join(' ')}", response, all_errors, all_success)
           end
         end
 
         #All other errors
         if response.code != 200
           if response.code == 429
-            raise ZuoraAPI::Exceptions::ZuoraAPIRequestLimit.new("The total number of concurrent requests has exceeded the limit allowed by the system. Please resubmit your request later.", body, response.code)
+            raise ZuoraAPI::Exceptions::ZuoraAPIRequestLimit.new("The total number of concurrent requests has exceeded the limit allowed by the system. Please resubmit your request later.", response)
           else
-            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("#{response.message}", body, response.code)
+            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("#{response.message}", response)
           end
         end
       end
@@ -648,7 +661,7 @@ module ZuoraAPI
       }
       response = self.rest_call(method: :post, body: params.to_json, url: self.aqua_endpoint("batch-query/"))
       if(response[0]["id"].nil?)
-        raise ZuoraAPI::Exceptions::ZuoraAPIError.new("Error in AQuA Process. #{response}")
+        raise ZuoraAPI::Exceptions::ZuoraAPIError.new("Error in AQuA Process.", response)
       end
       return getFileById(id: response[0]["id"])
     end
@@ -661,7 +674,7 @@ module ZuoraAPI
         response, fullResponse = self.rest_call(method: :get, body: {}, url: self.aqua_endpoint("batch-query/jobs/#{id}"))
         result = response["batches"][0]["status"]
         if result == "error"
-          raise ZuoraAPI::Exceptions::ZuoraAPIError.new("Aqua Error: #{response}")
+          raise ZuoraAPI::Exceptions::ZuoraAPIError.new("Aqua Error", response)
           break
         end
       end
@@ -677,7 +690,7 @@ module ZuoraAPI
       headers = self.entity_id.present? ? {"Zuora-Entity-Ids" => self.entity_id, 'Content-Type' => "text/xml; charset=utf-8"} : {'Content-Type' => "text/xml; charset=utf-8"}
       response = HTTParty.get(url,  headers: {"Authorization" => self.get_session(prefix: true, auth_type: :basic)}.merge(headers), :timeout => 120)
 
-      raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new(self.current_error.present? ? self.current_error : 'Describe call 401' ) if response.code == 401
+      raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new(self.current_error.present? ? self.current_error : 'Describe call 401', response) if response.code == 401
 
       output_xml = Nokogiri::XML(response.body)
       des_hash = Hash.new
@@ -730,7 +743,7 @@ module ZuoraAPI
       return des_hash
     end
 
-    def rest_call(method: :get, body: nil, headers: {}, url: rest_endpoint("catalog/products?pageSize=4"), debug: false, errors: [ZuoraAPI::Exceptions::ZuoraAPISessionError, ZuoraAPI::Exceptions::ZuoraAPIError, ZuoraAPI::Exceptions::ZuoraAPIRequestLimit, ZuoraAPI::Exceptions::ZuoraAPILockCompetition], z_session: true, session_type: :basic, timeout_retry: false, timeout: 120, **keyword_args)
+    def rest_call(method: :get, body: nil, headers: {}, url: rest_endpoint("catalog/products?pageSize=4"), debug: false, errors: [ZuoraAPI::Exceptions::ZuoraAPISessionError].concat(ZUORA_API_ERRORS), z_session: true, session_type: :basic, timeout_retry: false, timeout: 120, **keyword_args)
       tries ||= 2
 
       if self.entity_id.present?
@@ -772,7 +785,7 @@ module ZuoraAPI
           return [output_json, response]
         end
       end
-    rescue ZuoraAPI::Exceptions::ZuoraAPIError, ZuoraAPI::Exceptions::ZuoraAPIRequestLimit, ZuoraAPI::Exceptions::ZuoraAPILockCompetition  => ex
+    rescue *ZUORA_API_ERRORS => ex
       if errors.include?(ex.class)
         raise ex
       else
@@ -823,7 +836,7 @@ module ZuoraAPI
         Rails.logger.debug("Fetch Catalog URL #{url}")
         output_json, response = self.rest_call(:debug => false, :url => url, :errors => [ZuoraAPI::Exceptions::ZuoraAPISessionError], :timeout_retry => true )
         if !output_json['success'] =~ (/(true|t|yes|y|1)$/i) || output_json['success'].class != TrueClass
-          raise ZuoraAPI::Exceptions::ZuoraAPIError.new("Error Getting Catalog: #{output_json}")
+          raise ZuoraAPI::Exceptions::ZuoraAPIError.new("Error Getting Catalog: #{output_json}", response)
         end
         output_json["products"].each do |product|
           catalog_map[product["id"]] = {"productId" => product["id"]}

data/lib/zuora_api/logins/basic.rb

@@ -27,16 +27,16 @@ module ZuoraAPI
       
       input_xml = Nokogiri::XML(request.to_xml(:save_with => XML_SAVE_OPTIONS).strip)
       input_xml.xpath('//ns1:session', 'ns1' =>'http://api.zuora.com/').children.remove
-      Rails.logger.debug('Connect') {"Request Code: #{@response_query.code} SOAP XML: #{input_xml.to_xml(:save_with => XML_SAVE_OPTIONS).strip}"} if debug
+      Rails.logger.debug('Connect') {"SOAP XML: #{input_xml.to_xml(:save_with => XML_SAVE_OPTIONS).strip}"} if debug
       
-      @response_query = HTTParty.post(self.url,:body => request.to_xml(:save_with => XML_SAVE_OPTIONS).strip, :headers => {'Content-Type' => "text/xml; charset=utf-8"}, :timeout => 10)
-      @output_xml = Nokogiri::XML(@response_query.body)
-      Rails.logger.debug('Connect') {"Response Code: #{@response_query.code} SOAP XML: #{@output_xml.to_xml(:save_with => XML_SAVE_OPTIONS).strip}"} if debug   
+      response_query = HTTParty.post(self.url,:body => request.to_xml(:save_with => XML_SAVE_OPTIONS).strip, :headers => {'Content-Type' => "text/xml; charset=utf-8"}, :timeout => 10)
+      output_xml = Nokogiri::XML(response_query.body)
+      Rails.logger.debug('Connect') {"Response Code: #{response_query.code} SOAP XML: #{output_xml.to_xml(:save_with => XML_SAVE_OPTIONS).strip}"} if debug   
 
-      if !@response_query.success?
+      if !response_query.success?
         self.current_session = nil
-        if @output_xml.namespaces.size > 0  && @output_xml.xpath('//soapenv:Fault').size > 0
-          self.current_error = @output_xml.xpath('//fns:FaultMessage', 'fns' =>'http://fault.api.zuora.com/').text
+        if output_xml.namespaces.size > 0  && output_xml.xpath('//soapenv:Fault').size > 0
+          self.current_error = output_xml.xpath('//fns:FaultMessage', 'fns' =>'http://fault.api.zuora.com/').text
           if self.current_error.include?('deactivated')
             self.status = 'Deactivated'
             self.current_error = 'Deactivated user login, please check with Zuora tenant administrator'
@@ -75,19 +75,19 @@ module ZuoraAPI
             self.errors[:base] = self.current_error
           else
             self.status = 'Unknown'
-            self.current_error =  @output_xml.xpath('//faultstring').text if self.current_error.blank?
+            self.current_error =  output_xml.xpath('//faultstring').text if self.current_error.blank?
             self.errors[:base] = self.current_error
           end
 
         else
           self.status = 'Unknown'
-          self.current_error =  @output_xml.xpath('//faultstring').text if self.current_error.blank?
+          self.current_error =  output_xml.xpath('//faultstring').text if self.current_error.blank?
           self.errors[:base] = self.current_error
         end
       else             
         #Username & password combo
-        retrieved_session = @output_xml.xpath('//ns1:Session', 'ns1' =>'http://api.zuora.com/').text
-        raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new("No session found for api call.") if retrieved_session.blank?
+        retrieved_session = output_xml.xpath('//ns1:Session', 'ns1' =>'http://api.zuora.com/').text
+        raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new("No session found for api call.", response_query) if retrieved_session.blank?
         self.status = 'Active'
         self.current_session = retrieved_session
       end

data/lib/zuora_api/version.rb

@@ -1,3 +1,3 @@
 module ZuoraAPI
-  VERSION = "1.6.37"
+  VERSION = "1.6.38"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zuora_api
 version: !ruby/object:Gem::Version
-  version: 1.6.37
+  version: 1.6.38
 platform: ruby
 authors:
 - Zuora Strategic Solutions Group
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-24 00:00:00.000000000 Z
+date: 2019-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler