zuora_api 1.11.2 → 1.12.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1377cfe445b9ff82e0504e86ef89413c815b4250152769ec11bf6b7b8804cdd9
-  data.tar.gz: 9882ca98957ecf177985037124f9e77722fe9c1eeea430f8c5f632fc4327162c
+  metadata.gz: 5a2690391a9d7bad276fb66fa2acaa3706687fd295ba4805c97a6002f88029f0
+  data.tar.gz: c2fc324283e85c202a17ac07ad75037edaec3b2eca54e36bc97b5fd64e7985ba
 SHA512:
-  metadata.gz: 5043d898c8ec80517f01bd65daf031880aa4ab91e14669eedece02be8dab5c7b895abeb8d48330c89a9159875f8a9418adb2db2b3017bfe5b698100bb3035183
-  data.tar.gz: 85ca8f78f0807ed8c7533e612a0816dcbdf52ec71131c1c122cc110e89898c0dfbe69d560e5130e50f438bced5235331ee4590af12912248319bddfae52cc376
+  metadata.gz: 1d2e855b40b12dc10fc0f06843d4b960dd08beffe2d8df0b8236238df525d005d704b0d301780e4d1a46e7da8f2eaad5e0a7a9959fb2560be20045275acb0b17
+  data.tar.gz: 39f6a0bcd95f5021c59ce4a64c6ed9e7715d7f817237a42169f0a7fd0a71e49c542e556c18d201e80cab83f3b0e30c3ab3bce30a3950aea5e808ca4f9ae43c94

data/lib/zuora_api/login.rb

@@ -5,20 +5,36 @@ require 'zuora_api/exceptions'
 
 module ZuoraAPI
   class Login
-    ENVIRONMENTS = [TEST = 'Test', SANDBOX = 'Sandbox', PRODUCTION = 'Production', PREFORMANCE = 'Preformance', SERVICES = 'Services', UNKNOWN = 'Unknown', STAGING = 'Staging' ]
-    REGIONS = [EU = 'EU', US = 'US', NA = 'NA' ]
-    MIN_Endpoints = {'Test': '126.0', 'Sandbox': '126.0', 'Production': '126.0', 'Performance': '126.0', 'Services': '96.0', 'Unknown': '96.0', 'Staging': '127.0'}.freeze
+    ENVIRONMENTS = [TEST = 'Test', SANDBOX = 'Sandbox', PRODUCTION = 'Production', PREFORMANCE = 'Preformance', SERVICES = 'Services', UNKNOWN = 'Unknown', STAGING = 'Staging', PREPROD='Preprod', QAD5='QAD5', QAD6='QAD6', QAD7='QAD7', QAD8='QAD8', QAD9='QAD9' ]
+    REGIONS = [EU = 'EU', US = 'US', NA = 'NA', JP = 'JP' ]
+    WSDL_VERSION = ENV['ZUORA_WSDL_VERSION'] || '155.0'
+    MIN_Endpoints = {
+      'Test': WSDL_VERSION,
+      'Sandbox': WSDL_VERSION,
+      'Production': WSDL_VERSION,
+      'Performance': WSDL_VERSION,
+      'Services': '96.0',
+      'Unknown': '96.0',
+      'Staging': WSDL_VERSION,
+      'Preprod': WSDL_VERSION,
+      'QAD5': WSDL_VERSION,
+      'QAD6': WSDL_VERSION,
+      'QAD7': WSDL_VERSION,
+      'QAD8': WSDL_VERSION,
+      'QAD9': WSDL_VERSION
+    }.freeze
     XML_SAVE_OPTIONS = Nokogiri::XML::Node::SaveOptions::AS_XML | Nokogiri::XML::Node::SaveOptions::NO_DECLARATION
     USER_AGENT = "Zuora#{ENV['Z_APPLICATION_NAME']&.capitalize}/#{ENV['Z_APPLICATION_VERSION']&.delete('v')}"
 
     CONNECTION_EXCEPTIONS = [
       Net::OpenTimeout,
-      OpenSSL::SSL::SSLError,
-      Errno::ECONNREFUSED,
       SocketError,
-      Errno::EHOSTUNREACH,
+      OpenSSL::SSL::SSLError,
+      Errno::ECONNREFUSED, #A remote host refused to allow the network connection
+      Errno::EINVAL, #Invalid argument. This is used to indicate various kinds of problems with passing the wrong argument to a library function.
+      Errno::EHOSTUNREACH, #The remote host for a requested network connection is not reachable.
       Errno::EADDRNOTAVAIL,
-      Errno::ETIMEDOUT,
+      Errno::ETIMEDOUT, #ETIMEDOUT  A socket operation with a specified timeout received no response during the timeout period.
     ].freeze
 
     CONNECTION_READ_EXCEPTIONS = [
@@ -145,13 +161,17 @@ module ZuoraAPI
                       "Staging" => "https://reporting-stg11.zan.svc.auw2.zuora.com/api/rest/v1/",
                       "Performance" => "https://zconnectpt1.zuora.com/api/rest/v1/",
                       "Services" => "https://reporting-svc08.svc.auw2.zuora.com/api/rest/v1/"},
-             "EU" => {"Sandbox" => "https://zconnect.sandbox.eu.zuora.com/api/rest/v1/",
-                      "Production" => "https://zconnect.eu.zuora.com/api/rest/v1/",
-                      "Services"=> "https://reporting-sbx0000.sbx.aec1.zuora.com/api/rest/v1/",
-                      "Test" => "https://zconnect-services0002.test.eu.zuora.com/api/rest/v1/"},
-             "NA" => {"Sandbox" => "https://zconnect.sandbox.na.zuora.com/api/rest/v1/",
-                      "Production" => "https://zconnect.na.zuora.com/api/rest/v1/",
-                      "Services"=> ""}
+              "EU" => {"Sandbox" => "https://zconnect.sandbox.eu.zuora.com/api/rest/v1/",
+                        "Production" => "https://zconnect.eu.zuora.com/api/rest/v1/",
+                        "Services"=> "https://reporting-sbx0000.sbx.aec1.zuora.com/api/rest/v1/",
+                        "Test" => "https://zconnect-services0002.test.eu.zuora.com/api/rest/v1/"},
+              "NA" => {"Sandbox" => "https://zconnect.sandbox.na.zuora.com/api/rest/v1/",
+                        "Production" => "https://zconnect.na.zuora.com/api/rest/v1/",
+                        "Services"=> ""},
+              "JP" => {
+                "Production" => "https://zconnect-prod05.ap.zuora.com/api/rest/v1/",
+                "Test" => "https://zconnect-services0003.test.ap.zuora.com/api/rest/v1/"
+              }
       }
       return map[self.region][self.environment].insert(-1, path)
     end
@@ -203,11 +223,11 @@ module ZuoraAPI
     end
 
     def self.environments
-      %w(Sandbox Production Services Performance Staging Test)
+      %w(Sandbox Production Services Performance Staging Test Preprod QAD5 QAD6 QAD7 QAD8 QAD9)
     end
 
     def self.regions
-      %w(US EU NA)
+      %w(US EU NA JP)
     end
 
     def self.endpoints
@@ -216,7 +236,14 @@ module ZuoraAPI
                        "Performance" => "https://pt1.zuora.com/apps/services/a/",
                        "Services" => "https://services347.zuora.com/apps/services/a/",
                        "Staging" => "https://staging2.zuora.com/apps/services/a/",
-                       "Test" => "https://test.zuora.com/apps/services/a/"},
+                       "Test" => "https://test.zuora.com/apps/services/a/",
+                       "Preprod" => "https://preprod.zuora.com/apps/services/a/",
+                       "QAD5" => "https://app-5.qad.na.zuora.com/apps/services/a/",
+                       "QAD6" => "https://app-6.qad.na.zuora.com/apps/services/a/",
+                       "QAD7" => "https://app-7.qad.na.zuora.com/apps/services/a/",
+                       "QAD8" => "https://app-8.qad.na.zuora.com/apps/services/a/",
+                       "QAD9" => "https://app-9.qad.na.zuora.com/apps/services/a/",
+                      },
               "EU" => {"Sandbox" => "https://sandbox.eu.zuora.com/apps/services/a/",
                        "Production" => "https://eu.zuora.com/apps/services/a/",
                        "Performance" => "https://pt1.eu.zuora.com/apps/services/a/",
@@ -226,7 +253,17 @@ module ZuoraAPI
                        "Production" => "https://na.zuora.com/apps/services/a/",
                        "Performance" => "https://pt1.na.zuora.com/apps/services/a/",
                        "Services" => "https://services347.na.zuora.com/apps/services/a/",
-                       "Test" => "https://test.zuora.com/apps/services/a/"}
+                       "Test" => "https://test.zuora.com/apps/services/a/",
+                       "Preprod" => "https://preprod.zuora.com/apps/services/a/",
+                       "QAD5" => "https://app-5.qad.na.zuora.com/apps/services/a/",
+                       "QAD6" => "https://app-6.qad.na.zuora.com/apps/services/a/",
+                       "QAD7" => "https://app-7.qad.na.zuora.com/apps/services/a/",
+                       "QAD8" => "https://app-8.qad.na.zuora.com/apps/services/a/",
+                       "QAD9" => "https://app-9.qad.na.zuora.com/apps/services/a/",
+                      },
+              "JP" => {"Sandbox" => "https://sandbox.ap.zuora.com/apps/services/a/",
+                       "Production" => "https://ap.zuora.com/apps/services/a/",
+                       "Test" => "https://test.ap.zuora.com/apps/services/a/"}
             }
     end
 
@@ -248,6 +285,8 @@ module ZuoraAPI
           self.region = "EU"
         elsif /(?<=\.|\/|^)(na)(?=\.|\/|$)/ === self.hostname
           self.region = "NA"
+        elsif /(?<=\.|\/|^)(ap)(?=\.|\/|$)/ === self.hostname
+          self.region = "JP"
         else
           self.region = "US"
         end
@@ -262,6 +301,16 @@ module ZuoraAPI
         case self.hostname
         when /(?<=\.|\/|-|^)(apisandbox|sandbox)(?=\.|\/|-|$)/
           self.environment = 'Sandbox'
+        when /(?<=\.|\/|-|^)(app-5\.qad)(?=\.|\/|-|$)/
+          self.environment = 'QAD5'
+        when /(?<=\.|\/|-|^)(app-6\.qad)(?=\.|\/|-|$)/
+          self.environment = 'QAD6'
+        when /(?<=\.|\/|-|^)(app-7\.qad)(?=\.|\/|-|$)/
+          self.environment = 'QAD7'
+        when /(?<=\.|\/|-|^)(app-8\.qad)(?=\.|\/|-|$)/
+          self.environment = 'QAD8'
+        when /(?<=\.|\/|-|^)(app-9\.qad)(?=\.|\/|-|$)/
+          self.environment = 'QAD9'
         when /(?<=\.|\/|^)(service[\d]*|services[\d]*|ep-edge)(?=\.|\/|$)/
           self.environment = 'Services'
         when /(?<=\.|\/|-|^)(pt[\d]*)(?=\.|\/|-|$)/
@@ -270,8 +319,10 @@ module ZuoraAPI
           self.environment = 'Staging'
         when /(?<=\.|\/|^)(test)(?=\.|\/|$)/
           self.environment = 'Test'
-        when /(?<=\.|\/|^)(www|api)(?=\.|\/|$)/, /(^|tls10\.|origin-www\.|zforsf\.|eu\.|na\.)(zuora\.com)/
+        when /(?<=\.|\/|^)(www|api)(?=\.|\/|$)/, /(^|tls10\.|origin-www\.|zforsf\.|eu\.|na\.|ap\.)(zuora\.com)/
           self.environment = 'Production'
+        when /(?<=\.|\/|-|^)(preprod|preprod)(?=\.|\/|-|$)/
+          self.environment = 'Preprod'
         else
           self.environment = 'Unknown'
         end
@@ -283,9 +334,10 @@ module ZuoraAPI
     def update_zconnect_provider
       update_region if self.region.blank?
       update_environment if self.environment.blank?
-      mappings = {"US" => {"Sandbox" => "ZConnectSbx",   "Services" => "ZConnectSvcUS", "Production" => "ZConnectProd",   "Performance" => "ZConnectPT1", "Test" => "ZConnectTest", "Staging" => "ZConnectQA", "KubeSTG" => "ZConnectDev", "KubeDEV" => "ZConnectDev", "KubePROD" => "ZConnectDev"},
-                  "NA" => {"Sandbox" => "ZConnectSbxNA", "Services" => "ZConnectSvcNA", "Production" => "ZConnectProdNA", "Performance" => "ZConnectPT1NA"},
+      mappings = {"US" => {"Sandbox" => "ZConnectSbx", "Services" => "ZConnectSvcUS", "Production" => "ZConnectProd",   "Performance" => "ZConnectPT1",   "Preprod" => "ZConnectPreprod", "Test" => "ZConnectTest", "Staging" => "ZConnectQA", "QAD5" => "ZConnectQA", "QAD6" => "ZConnectQA", "QAD7" => "ZConnectQA", "QAD8" => "ZConnectQA", "QAD9" => "ZConnectQA", "KubeSTG" => "ZConnectDev", "KubeDEV" => "ZConnectDev", "KubePROD" => "ZConnectDev"},
+                  "NA" => {"Sandbox" => "ZConnectSbxNA", "Services" => "ZConnectSvcNA", "Production" => "ZConnectProdNA", "Performance" => "ZConnectPT1NA", "QAD5" => "ZConnectQA", "QAD6" => "ZConnectQA", "QAD7" => "ZConnectQA", "QAD8" => "ZConnectQA", "QAD9" => "ZConnectQA"},
                   "EU" => {"Sandbox" => "ZConnectSbxEU", "Services" => "ZConnectSvcEU", "Production" => "ZConnectProdEU", "Performance" => "ZConnectPT1EU", "Test" => "ZConnectTest"},
+                  "JP" => {"Sandbox" => "ZConnectSbxAP", "Services" => "ZConnectSvcAP", "Production" => "ZConnectProdAP", "Performance" => "ZConnectPT1AP", "Test" => "ZConnectTest"},
                   "Unknown" => {"Unknown" => "Unknown"}}
       self.zconnect_provider = mappings[self.region][self.environment]
     end
@@ -303,7 +355,7 @@ module ZuoraAPI
     def rest_endpoint(url="", domain=true, prefix='/v1/')
       update_environment
       endpoint = url
-      url_postfix = {"US" => ".", "EU" => ".eu.", "NA" => ".na."}[self.region]
+      url_postfix = {"US" => ".", "EU" => ".eu.", "NA" => ".na.", "JP" => ".ap."}[self.region]
 
       case self.environment
       when 'Test'
@@ -321,6 +373,18 @@ module ZuoraAPI
         endpoint = "#{https}rest#{host}"
       when 'Staging'
         endpoint = "https://rest-staging2.zuora.com"
+      when 'Preprod'
+        endpoint = "https://rest.preprod.zuora.com"
+      when 'QAD5'
+        endpoint = "https://rest-5.qad.na.zuora.com"
+      when 'QAD6'
+        endpoint = "https://rest-6.qad.na.zuora.com"
+      when 'QAD7'
+        endpoint = "https://rest-7.qad.na.zuora.com"
+      when 'QAD8'
+        endpoint = "https://rest-8.qad.na.zuora.com"
+      when 'QAD9'
+        endpoint = "https://rest-9.qad.na.zuora.com"
       when 'Unknown'
         raise "Environment unknown, returning passed in parameter unaltered"
       end
@@ -532,13 +596,21 @@ module ZuoraAPI
     rescue => ex
       raise ex
     ensure
-      self.error_logger(ex) if defined?(ex)
+      if defined?(ex)
+        if keyword_args[:log_error_requests]
+          self.error_logger(ex, **keyword_args)
+        else
+          self.error_logger(ex)
+        end
+      end
     end
 
-    def error_logger(ex)
+    def error_logger(ex, **args)
       return unless Rails.logger.is_a? Ougai::Logger
 
       exception_args = Rails.logger.with_fields.merge(self.exception_args(ex))
+      exception_args.merge!(**args) if args[:log_error_requests]
+
       case ex
       when ZuoraAPI::Exceptions::ZuoraAPIUnkownError, ZuoraAPI::Exceptions::ZuoraDataIntegrity
         Rails.logger.error('Zuora Unknown/Integrity Error', ex, exception_args)
@@ -548,9 +620,10 @@ module ZuoraAPI
           Rails.logger.info('Zuora APILimit Reached', ex, exception_args)
         end
       when *(ZuoraAPI::Login::ZUORA_API_ERRORS-ZuoraAPI::Login::ZUORA_SERVER_ERRORS)
-        #Rails.logger.debug('Zuora API Error', ex, self.exception_args(ex))
+        Rails.logger.error('Zuora API Error', ex, exception_args) if args[:log_error_requests]
       when *ZuoraAPI::Login::ZUORA_SERVER_ERRORS
         Rails.logger.error('Zuora Server Error', ex, exception_args)
+      else
       end
     end
 
@@ -659,6 +732,8 @@ module ZuoraAPI
               if new_message.present?
                 if new_message.include?("The query exceeded maximum processing time")
                   error, message = ['TRANSACTION_FAILED', new_message.concat(" Please see KC for the Max Timeout Specification https://community.zuora.com/t5/Release-Notifications/Upcoming-Change-for-AQuA-and-Data-Source-Export-January-2021/ba-p/35024")]
+                elsif new_message.include?("There is no field named")
+                  error, message = ['TRANSACTION_FAILED', new_message]
                 else
                   error, message = ['UNEXPECTED_ERROR', new_message]
                 end
@@ -765,7 +840,7 @@ module ZuoraAPI
           if body['path'] == '/oauth/token'
             if body['status'] == 403 && response.code == 403
               raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new("Forbidden", response)
-            elsif body['status'] == 400 && response.code == 400 && body['message'].include?("Invalid client id")
+            elsif body['status'] == 400 && response.code == 400
               raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new("Invalid Oauth Client Id", response)
             end
           end
@@ -842,7 +917,7 @@ module ZuoraAPI
         end
 
         #Zuora REST Actions error (Create, Update, Delete, Amend)
-        if body.class == Array
+        if body.class == Array && !body.compact.blank?
           all_errors = body.select {|obj| !obj['Success'] || !obj['success'] }.map {|obj| obj['Errors'] || obj['errors'] }.compact
           all_success = body.select {|obj| obj['Success'] || obj['success']}.compact
 
@@ -864,14 +939,30 @@ module ZuoraAPI
         end
 
         if body.class == Hash && body['message'].present?
+
+          if body['message'] && body['code'].present?
+            raise_errors_helper(error: body['code'], message: body['message'], raise_final: false)
+          end
+
           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)
+          raise ZuoraAPI::Exceptions::ZuoraAPIError.new(body['message'], response) if ![200,201,202].include?(response.code)
+        end
+
+        if body.class == Hash && body['errors'].present?
+          if body['errors'].class == Array && body.dig('errors', 0).is_a?(Hash)
+            raise ZuoraAPI::Exceptions::ZuoraAPIError.new(body['errors'][0].fetch("message", "No error message. Zuora API Error"), response)
+          end
         end
 
         self.errors_via_content_type(response: response, type: :json)
 
         #All other errors
-        raise ZuoraAPI::Exceptions::ZuoraAPIError.new(response.body, response) if ![200,201].include?(response.code)
+        if ![200,201,202].include?(response.code)
+          if body == [nil]
+            raise ZuoraAPI::Exceptions::ZuoraAPIError.new('No error message. Invalid API request', response) 
+          end
+          raise ZuoraAPI::Exceptions::ZuoraAPIError.new(response.body, response) 
+        end
       end
     end
 
@@ -953,7 +1044,7 @@ module ZuoraAPI
       return error, success, message
     end
 
-    def raise_errors_helper(error: nil, message: nil, response: nil, errors: [], success: [])
+    def raise_errors_helper(error: nil, message: nil, response: nil, errors: [], success: [], raise_final: true)
       case error
       when /.*INVALID_SESSION/
         raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new(message, response, errors, success)
@@ -997,7 +1088,7 @@ module ZuoraAPI
         end
         raise ZuoraAPI::Exceptions::ZuoraAPIInternalServerError.new(message, response, errors, success)
       else
-        raise ZuoraAPI::Exceptions::ZuoraAPIInternalServerError.new("Z:#{error}::#{message}", response, errors, success)
+        raise ZuoraAPI::Exceptions::ZuoraAPIInternalServerError.new("Z:#{error}::#{message}", response, errors, success) if raise_final
       end
     end
 
@@ -1261,7 +1352,13 @@ module ZuoraAPI
     rescue => ex
       raise ex
     ensure
-      self.error_logger(ex) if defined?(ex)
+      if defined?(ex)
+        if keyword_args[:log_error_requests]
+          self.error_logger(ex, **keyword_args)
+        else
+          self.error_logger(ex)
+        end
+      end
     end
 
     def update_create_tenant
@@ -1341,7 +1438,6 @@ module ZuoraAPI
         status_code = response.code if response
         case response
         when Net::HTTPOK
-          Rails.logger.warn("Headers: #{response.to_hash.to_s}")
           if output_file_name.present?
             file_ending ||= output_file_name.end_with?(".csv.zip") ? ".csv.zip" : File.extname(output_file_name)
             filename ||= File.basename(output_file_name, file_ending)
@@ -1437,6 +1533,13 @@ module ZuoraAPI
         end
       end
 
+    rescue ZuoraAPI::Exceptions::FileDownloadError => ex
+      if ex.message.match(/.*The current tenant does not have a file with id.*/)
+        raise
+      else
+        Rails.logger.error("File Download Failed")
+        raise
+      end
     rescue => ex
       sleep(5)
       if (retry_count -= 1) >= 0

data/lib/zuora_api/version.rb

@@ -1,3 +1,3 @@
 module ZuoraAPI
-  VERSION = "1.11.2"
+  VERSION = "1.12.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zuora_api
 version: !ruby/object:Gem::Version
-  version: 1.11.2
+  version: 1.12.8
 platform: ruby
 authors:
 - Zuora Strategic Solutions Group
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-03 00:00:00.000000000 Z
+date: 2026-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler