zuora_api 1.9.07 → 1.9.08

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eac21d6215f0ab25d7ec77243bdf3a0a1e144cffe89fc36cb2f054be7d429b6d
-  data.tar.gz: b1664b343cbf0045ecd156325dc4dbd2975dbe85f2972aa03a797c5cccc88cd1
+  metadata.gz: a012abdd5eacb3b9743866d78557e5bb97f52067de92a9aec0e46d45252e190c
+  data.tar.gz: 005d7186d019c95060f7ec531f0b548382dc6e274e80522d97a79500ee645938
 SHA512:
-  metadata.gz: 4d10222b8220ce484cf7a75c36a04697b2defcf88a130c10e3dd22e8c6f040fc1794d0af243b5c9a56fb163e331aadd5a14e7679fc98f88924d0c3bad55981d6
-  data.tar.gz: fe07226773ef63aa5435592fd5c81c40dde1e7dc64b1551b4e692b0cd1215b373620864e36b0d21c8439dd5c41916f165c0e6fde5ea67ccbf246c5a945b65eec
+  metadata.gz: 81d8472647c0b37ceee7fadf82610b28deb9b52b35f84740840de68b65f07ded753114e5e86ab6f936740eedf730a9a42f57bdf0e08b91c8a63b711300fb8c5b
+  data.tar.gz: 2aef7becdbfa2b9b4bdf5d598bd5be23f528f1a09181178df233d8ef218f1c801978d1d1c60d20808b07b7e83981d2bb4dbe1c786a5616977713c064f8fade62

data/lib/zuora_api/exceptions.rb

@@ -125,6 +125,12 @@ module ZuoraAPI
       end
     end
 
+    class ZuoraAPIRequestConcurrentLimit < ZuoraAPIRequestLimit
+    end
+
+    class ZuoraAPIRequestRateLimit < ZuoraAPIRequestLimit
+    end
+
     class ZuoraAPIUnkownError < Error
       attr_reader :code, :response
       attr_writer :default_message

data/lib/zuora_api/login.rb

@@ -7,7 +7,7 @@ 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': '108.0', 'Sandbox': '108.0', 'Production': '108.0', 'Performance': '108.0', 'Services': '96.0', 'Unknown': '96.0', 'Staging': '108.0'}.freeze
+    MIN_Endpoints = {'Test': '107.0', 'Sandbox': '107.0', 'Production': '107.0', 'Performance': '107.0', 'Services': '96.0', 'Unknown': '96.0', 'Staging': '107.0'}.freeze
     XML_SAVE_OPTIONS = Nokogiri::XML::Node::SaveOptions::AS_XML | Nokogiri::XML::Node::SaveOptions::NO_DECLARATION
 
     CONNECTION_EXCEPTIONS = [
@@ -29,6 +29,8 @@ module ZuoraAPI
     ZUORA_API_ERRORS = [
       ZuoraAPI::Exceptions::ZuoraAPIError,
       ZuoraAPI::Exceptions::ZuoraAPIRequestLimit,
+      ZuoraAPI::Exceptions::ZuoraAPIRequestConcurrentLimit,
+      ZuoraAPI::Exceptions::ZuoraAPIRequestRateLimit,
       ZuoraAPI::Exceptions::ZuoraAPILockCompetition,
       ZuoraAPI::Exceptions::ZuoraAPITemporaryError,
       ZuoraAPI::Exceptions::ZuoraDataIntegrity,
@@ -138,14 +140,13 @@ module ZuoraAPI
     def reporting_url(path)
       map = {"US" => {"Sandbox" => "https://zconnectsandbox.zuora.com/api/rest/v1/",
                       "Production" => "https://zconnect.zuora.com/api/rest/v1/",
-                      "Test" => "https://zconnect-services0001.test.zuora.com/api/rest/v1/",
+                      "Test" => "https://reporting-sbx.zan.0001.sbx.auw2.zuora.com/api/rest/v1/",
                       "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/"},
+                      "Services"=> "https://reporting-sbx0000.sbx.aec1.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"=> ""}
@@ -612,10 +613,7 @@ module ZuoraAPI
       case response.code
       when 504
         raise ZuoraAPI::Exceptions::ZuoraAPIReadTimeout.new("Received 504 from 'https://#{rest_domain(endpoint: request_uri)}'", response)
-      when 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.", response)
-      when 401
-
+      when 401, 429
       else
         if body.class == Hash
           case request_path
@@ -632,6 +630,21 @@ module ZuoraAPI
       when :SOAP
         error, success, message = get_soap_error_and_message(body)
 
+        if response.code == 429
+          if message.to_s.downcase.include?('concurrent')
+            raise ZuoraAPI::Exceptions::ZuoraAPIRequestConcurrentLimit.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::ZuoraAPIRequestRateLimit.new(
+              "Rate limiting. Please resubmit your request later.",
+              response
+            )
+          end
+        end
+
         if body.xpath('//fns:LoginFault', 'fns' =>'http://fault.api.zuora.com/').present?
           raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new(message, response)
         end
@@ -724,7 +737,12 @@ module ZuoraAPI
             codes_array = codes_array.push(body.dig("error", 'code')).compact
           end
 
-          if body['message'] == 'request exceeded limit'
+          body_message = body.fetch('message', '').downcase
+          if body_message.include?('rate limit exceeded')
+            raise ZuoraAPI::Exceptions::ZuoraAPIRequestRateLimit.new("The total number of requests has exceeded the rate limit allowed by the system. Please resubmit your request later.", response)
+          end
+
+          if body_message.include?('request exceeded limit')
             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
 
@@ -796,7 +814,7 @@ module ZuoraAPI
 
           #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)
+            raise ZuoraAPI::Exceptions::ZuoraAPIRequestConcurrentLimit.new("#{messages_array.join(', ')}", response)
           end
 
           #All Errors catch
@@ -804,6 +822,10 @@ module ZuoraAPI
             raise ZuoraAPI::Exceptions::ZuoraAPIError.new("#{messages_array.join(', ')}", response)
           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.", response)
+          end
+
           #Zuora REST Query Errors
           if body["faultcode"].present?
             raise_errors_helper(error:  body["faultcode"], message: body["faultstring"], response: response)
@@ -939,7 +961,11 @@ module ZuoraAPI
       when /.*INVALID_SESSION/
         raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new(message, response, errors, success)
       when /.*REQUEST_EXCEEDED_LIMIT/
-        raise ZuoraAPI::Exceptions::ZuoraAPIRequestLimit.new(message, response, errors, success)
+        if message.to_s.downcase.include?('concurrent')
+          raise ZuoraAPI::Exceptions::ZuoraAPIRequestConcurrentLimit.new(message, response, errors, success)
+        else
+          raise ZuoraAPI::Exceptions::ZuoraAPIRequestRateLimit.new(message, response, errors, success)
+        end
       when /.*LOCK_COMPETITION/
         raise ZuoraAPI::Exceptions::ZuoraAPILockCompetition.new(message, response, errors, success)
       when /.*BATCH_FAIL_ERROR/
@@ -1397,6 +1423,56 @@ module ZuoraAPI
       raise
     end
 
+    def create_data_source_export(query: "", encrypted: false, zip: true, z_track_id: "")
+      begin
+        output_xml, input_xml = self.soap_call(debug: false, timeout_retry: true, zuora_track_id: z_track_id) do |xml|
+          xml['ns1'].create do
+            xml['ns1'].zObjects('xsi:type' => "ns2:Export") do
+              xml['ns2'].Format 'csv'
+              xml['ns2'].Zip zip
+              xml['ns2'].Name 'googman'
+              xml['ns2'].Query query
+              xml['ns2'].Encrypted encrypted
+            end
+          end
+        end
+
+        return output_xml.xpath('//ns1:Id', 'ns1' =>'http://api.zuora.com/').text
+      rescue Exception => ex
+        raise ex.class.new("#{z_track_id} #{ex.message}")
+      end
+    end
+
+    def check_export_status(export_id: "")
+      begin
+        response, full_response = self.rest_call(method: :get,url: self.rest_endpoint("object/export/#{export_id}"))
+
+        return full_response.parsed_response
+      rescue Exception => ex
+        raise ex
+      end
+    end
+
+    def get_export_file(file_id: "", extract: true, zip: true)
+      begin
+        export_file_path = self.get_file(:url => self.rest_endpoint("files/#{file_id}")).path
+
+        if extract && zip
+          require "zip"
+          new_path = export_file_path.partition('.zip').first
+          zipped = Zip::File.open(export_file_path)
+          file_handle = zipped.entries.first
+          file_handle.extract(new_path)
+          File.delete(export_file_path)
+          return new_path
+        else
+          return export_file_path
+        end
+      rescue Exception => ex
+        raise ex
+      end
+    end
+
     def getDataSourceExport(query, extract: true, encrypted: false, zip: true, z_track_id: "")
       tries ||= 3
 

data/lib/zuora_api/version.rb

@@ -1,3 +1,3 @@
 module ZuoraAPI
-  VERSION = "1.9.07"
+  VERSION = "1.9.08"
 end

metadata

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