zuora_api 1.10.1 → 1.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3b3400576f3df87efec934f2e76fc13b6e427c20cb36dff8e4c81dc95abfc1d
-  data.tar.gz: 9250a4ef4c4b1dc7de382e2325533536e646d3f36ada93afeb59a0aa90a87166
+  metadata.gz: 8cf78cb3b1e25a9394f07c8557a23b8822d4f5cf48839bfad5e6f8e2ab3ad1e7
+  data.tar.gz: 76d6cd10a87cbae7dc3a5898192c9cc1c8683c374ae0008b116bef46ecc79cda
 SHA512:
-  metadata.gz: a1ad5caf8f7689f9522e5b880cf742d9bd3a20f52b662dfb59f091c17c986ae972b66f97adc2752a16aee77fcd019934e338276ae61ba802918e65543df1ccbf
-  data.tar.gz: 2ec1e093f0bfb3d7815434addb8372e5cf6ddee2b06957add664c86b411e2c026e8e018ad0c7a9508c12a660d4bf1373f8099e10ca191a462c338d9a6ac99a58
+  metadata.gz: 4e53ec1c8acb9ba3d7ce1247f5516162d85095567421082b025fd04117a4cdc463854ec136dc09f3283b09af493a1d68b17cda7c29f0d18d48faabfef949dea5
+  data.tar.gz: 0be11b3df708385da409848b1c953be59cd3efe4c8b658d55dd06e781a9c347df58cd809f32edb88063be4ea6ea11fada13396177ddb08233534afffd3458463

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': '114.0', 'Sandbox': '114.0', 'Production': '114.0', 'Performance': '114.0', 'Services': '96.0', 'Unknown': '96.0', 'Staging': '114.0'}.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')}"
 
@@ -30,6 +30,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,
@@ -457,6 +459,7 @@ module ZuoraAPI
       headers.merge!({ 'Content-Type' => "text/xml; charset=utf-8", 'Accept' => 'text/xml'})
       headers['Zuora-Track-Id'] = zuora_track_id if zuora_track_id.present?
       headers['X-Amzn-Trace-Id'] = zuora_track_id if zuora_track_id.present?
+
       headers["User-Agent"] = USER_AGENT
 
       request = HTTParty::Request.new(
@@ -617,10 +620,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
@@ -637,6 +637,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
@@ -729,7 +744,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
 
@@ -801,7 +821,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
@@ -809,6 +829,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)
@@ -944,7 +968,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/
@@ -1151,6 +1179,7 @@ module ZuoraAPI
       end
       headers['Zuora-Track-Id'] = zuora_track_id if zuora_track_id.present?
       headers['X-Amzn-Trace-Id'] = zuora_track_id if zuora_track_id.present?
+
       headers['User-Agent'] = USER_AGENT
 
       modified_headers = {'Content-Type' => "application/json; charset=utf-8"}.merge(authentication_headers).merge(headers)
@@ -1319,6 +1348,7 @@ module ZuoraAPI
 
       headers['Zuora-Track-Id'] = zuora_track_id if zuora_track_id.present?
       headers['X-Amzn-Trace-Id'] = zuora_track_id if zuora_track_id.present?
+
       headers["User-Agent"] = USER_AGENT
 
       response_save = nil
@@ -1434,6 +1464,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.10.1"
+  VERSION = "1.10.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zuora_api
 version: !ruby/object:Gem::Version
-  version: 1.10.1
+  version: 1.10.2
 platform: ruby
 authors:
 - Zuora Strategic Solutions Group
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-06 00:00:00.000000000 Z
+date: 2022-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler