zuora_api 1.9.09 → 1.10.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6da8c9fbf54221b62336d0221ada0f53e9d22690b7a6a52cd83f214314b5ba5
-  data.tar.gz: be31b09eef19df8b8d1fcbd70b9a11980f125c4eb4d5f96c3259ed516ab88934
+  metadata.gz: cb8a07811203b9141471afb4cb85bc7b3c62b6e2ce6c9254985d3ad7683f2540
+  data.tar.gz: 58fefaba666d1999c169fcc02208b6df7fca95aa0bc9b219d7aa1fb8c02e1599
 SHA512:
-  metadata.gz: d6382ae611e80b38e574357baa771b432c4e554662293e98e4a73ca446c9445264d902f0b604ee071fe9dac6cf6bee4fde8319f0f782975955fdd562cf921b6c
-  data.tar.gz: 1008b0e7e533e01b6636cc82e3e79b21c825d095d789d83c73c96142d9de78556c0caa38775aedb97a3b27e43a93f16281680f10a7d988fb005951084a36f75e
+  metadata.gz: 1c3c2d7503e8afb612edf442105d6c78d8feb6b480d625dc119ce2cd49645bbd2ad60e9090c93489e56af2921cc97921178c31aa0384a966fb3ed74efb5d2d32
+  data.tar.gz: ec1bc529dba10ef46600ae676fe693d63a3852ee466acd10332cdfb611beb4bee52d3c909a2b4d39d4b303f42782391fd0e32c63ecd54d5006c3cd1cbea8ca5f

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

@@ -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,
@@ -45,9 +47,9 @@ module ZuoraAPI
       ZuoraAPI::Exceptions::ZuoraUnexpectedError
     ].freeze
 
-    attr_accessor :region, :url, :wsdl_number, :current_session, :bearer_token, :oauth_session_expires_at, :environment, :status, :errors, :current_error, :user_info, :tenant_id, :tenant_name, :entity_id, :timeout_sleep, :hostname, :zconnect_provider
+    attr_accessor :region, :url, :wsdl_number, :current_session, :bearer_token, :oauth_session_expires_at, :environment, :status, :errors, :current_error, :user_info, :tenant_id, :tenant_name, :entity_id, :entity_identifier, :entity_header_type, :timeout_sleep, :hostname, :zconnect_provider
 
-    def initialize(url: nil, entity_id: nil, session: nil, status: nil, bearer_token: nil, oauth_session_expires_at: nil, **keyword_args)
+    def initialize(url: nil, entity_id: nil, entity_identifier: nil, session: nil, status: nil, bearer_token: nil, oauth_session_expires_at: nil, **keyword_args)
       raise "URL is nil or empty, but URL is required" if url.nil? || url.empty?
       # raise "URL is improper. URL must contain zuora.com, zuora.eu, or zuora.na" if /zuora.com|zuora.eu|zuora.na/ === url
       self.hostname = /(?<=https:\/\/|http:\/\/)(.*?)(?=\/|$)/.match(url)[0] if !/(?<=https:\/\/|http:\/\/)(.*?)(?=\/|$)/.match(url).nil?
@@ -61,6 +63,8 @@ module ZuoraAPI
         self.url = url
       end
       self.entity_id = get_entity_id(entity_id: entity_id)
+      self.entity_identifier = entity_identifier
+      self.entity_header_type = :entity_id
       self.errors = Hash.new
       self.current_session = session
       self.bearer_token = bearer_token
@@ -454,6 +458,8 @@ 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(
@@ -614,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
@@ -634,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
@@ -726,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
 
@@ -798,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
@@ -806,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)
@@ -941,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/
@@ -1022,12 +1053,44 @@ module ZuoraAPI
       return self.get_file(url: self.aqua_endpoint("file/#{fileId}"))
     end
 
+    def entity_header
+      if self.entity_header_type == :entity_name && self.entity_identifier.present?
+        { "entityName" => self.entity_identifier }
+      elsif self.entity_id.present?
+        { "Zuora-Entity-Ids" => self.entity_id }
+      else
+        {}
+      end
+    end
+
+    def insert_entity_header(destination_headers, lookup_headers: nil)
+      # The entity header may be added to a place other than where we look for it
+      lookup_headers = destination_headers if lookup_headers.nil?
+
+      entity_header_options = %w(zuora-entity-ids entityid entityname)
+      # If the customer doesn't supply an entity header, fill it in
+      if (entity_header_options & lookup_headers.keys.map(&:downcase)).blank?
+        entity_header = self.entity_header
+        if entity_header.present?
+          destination_headers.merge!(entity_header)
+          entity_header_options_to_exclude =
+            entity_header_options.
+              reject { |header| header == entity_header.keys.first&.downcase }
+          destination_headers.delete_if { |key, _| entity_header_options_to_exclude.include?(key.to_s.downcase) }
+        end
+      end
+    end
+
     def describe_call(object = nil, log_errors = true)
       tries ||= 2
 
       base = self.url.include?(".com") ? self.url.split(".com")[0].concat(".com") : self.url.split(".eu")[0].concat(".eu")
-      url = object ? "#{base}/apps/api/describe/#{object}" : "#{base}/apps/api/describe/"
-      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"}
+
+      version = self.url.scan(/(\d+\.\d)$/).dig(0,0).to_f
+      url = object ? "#{base}/apps/api/#{version}/describe/#{object}" : "#{base}/apps/api/#{version}/describe/"
+
+      headers = { "Content-Type" => "text/xml; charset=utf-8" }.merge(self.entity_header)
+
       response = HTTParty.get(url,  headers: {"Authorization" => self.get_session(prefix: true, auth_type: :basic), "User-Agent" => USER_AGENT}.merge(headers), :timeout => 130)
 
       raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new(self.current_error.present? ? self.current_error : 'Describe call 401', response) if response.code == 401
@@ -1114,12 +1177,12 @@ module ZuoraAPI
       authentication_headers = {}
       if z_session
         authentication_headers = {"Authorization" => self.get_session(prefix: true, auth_type: session_type, zuora_track_id: zuora_track_id) }
-        if self.entity_id.present?
-          authentication_headers["Zuora-Entity-Ids"] = self.entity_id if headers.dig("Zuora-Entity-Ids").nil?
-          authentication_headers.delete_if { |key, value| ["entityId", "entityName"].include?(key.to_s) }
-        end
+
+        self.insert_entity_header(authentication_headers, lookup_headers: headers)
       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)
@@ -1282,10 +1345,13 @@ module ZuoraAPI
       http.use_ssl = true  if !uri.scheme.nil? && uri.scheme.downcase == 'https'
       if z_session
         headers = headers.merge({"Authorization" => self.get_session(prefix: true)})
-        headers = headers.merge({"Zuora-Entity-Ids" => self.entity_id}) if !self.entity_id.blank?
+
+        self.insert_entity_header(headers)
       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
 
       response_save = nil
@@ -1401,6 +1467,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/logins/oauth.rb

@@ -32,8 +32,9 @@ module ZuoraAPI
     end
     
     def get_z_session(debug: false, zuora_track_id: nil)
-      headers = self.entity_id.present? ? {"Zuora-Entity-Ids" => self.entity_id } : {}
+      headers = self.entity_header
       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?
       output_json, response = self.rest_call(:url => self.rest_endpoint("connections"), :session_type => :bearer, :headers => headers)
       begin
         self.current_session = response.headers.to_h['set-cookie'][0].split(';')[0].split('=',2)[1].gsub('%3D', '=')
@@ -54,6 +55,7 @@ module ZuoraAPI
 
       headers = { "content-type" => "application/x-www-form-urlencoded" }
       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?
 
       output_json, response = self.rest_call(:method => :post, 
         url: self.rest_endpoint.chomp('v1/').concat("oauth/token"), 

data/lib/zuora_api/version.rb

@@ -1,3 +1,3 @@
 module ZuoraAPI
-  VERSION = "1.9.09"
+  VERSION = "1.10.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zuora_api
 version: !ruby/object:Gem::Version
-  version: 1.9.09
+  version: 1.10.3
 platform: ruby
 authors:
 - Zuora Strategic Solutions Group
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-04 00:00:00.000000000 Z
+date: 2022-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -219,7 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.2.32
 signing_key: 
 specification_version: 4
 summary: Gem that provides easy integration to Zuora