zuora_api 1.9.08 → 1.9.09

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a012abdd5eacb3b9743866d78557e5bb97f52067de92a9aec0e46d45252e190c
-  data.tar.gz: 005d7186d019c95060f7ec531f0b548382dc6e274e80522d97a79500ee645938
+  metadata.gz: a6da8c9fbf54221b62336d0221ada0f53e9d22690b7a6a52cd83f214314b5ba5
+  data.tar.gz: be31b09eef19df8b8d1fcbd70b9a11980f125c4eb4d5f96c3259ed516ab88934
 SHA512:
-  metadata.gz: 81d8472647c0b37ceee7fadf82610b28deb9b52b35f84740840de68b65f07ded753114e5e86ab6f936740eedf730a9a42f57bdf0e08b91c8a63b711300fb8c5b
-  data.tar.gz: 2aef7becdbfa2b9b4bdf5d598bd5be23f528f1a09181178df233d8ef218f1c801978d1d1c60d20808b07b7e83981d2bb4dbe1c786a5616977713c064f8fade62
+  metadata.gz: d6382ae611e80b38e574357baa771b432c4e554662293e98e4a73ca446c9445264d902f0b604ee071fe9dac6cf6bee4fde8319f0f782975955fdd562cf921b6c
+  data.tar.gz: 1008b0e7e533e01b6636cc82e3e79b21c825d095d789d83c73c96142d9de78556c0caa38775aedb97a3b27e43a93f16281680f10a7d988fb005951084a36f75e

data/lib/zuora_api/exceptions.rb

@@ -125,12 +125,6 @@ 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,8 +7,9 @@ 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': '107.0', 'Sandbox': '107.0', 'Production': '107.0', 'Performance': '107.0', 'Services': '96.0', 'Unknown': '96.0', 'Staging': '107.0'}.freeze
+    MIN_Endpoints = {'Test': '108.0', 'Sandbox': '108.0', 'Production': '108.0', 'Performance': '108.0', 'Services': '96.0', 'Unknown': '96.0', 'Staging': '108.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')}"
 
     CONNECTION_EXCEPTIONS = [
       Net::OpenTimeout,
@@ -29,8 +30,6 @@ 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,
@@ -77,7 +76,7 @@ module ZuoraAPI
       zsession = cookies["ZSession"]
       begin
         if !zsession.blank?
-          response = HTTParty.get("https://#{self.hostname}/apps/v1/identity", :headers => {'Cookie' => "ZSession=#{zsession}", 'Content-Type' => 'application/json'})
+          response = HTTParty.get("https://#{self.hostname}/apps/v1/identity", :headers => {'Cookie' => "ZSession=#{zsession}", 'Content-Type' => 'application/json', "User-Agent" => USER_AGENT})
           output_json = JSON.parse(response.body)
         else
           raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZSession cookie present")
@@ -93,7 +92,7 @@ module ZuoraAPI
       zsession = cookies["ZSession"]
       begin
         if zsession.present?
-          response = HTTParty.get("https://#{self.hostname}/apps/v1/navigation", :headers => {'Cookie' => "ZSession=#{zsession}", 'Content-Type' => 'application/json'})
+          response = HTTParty.get("https://#{self.hostname}/apps/v1/navigation", :headers => {'Cookie' => "ZSession=#{zsession}", 'Content-Type' => 'application/json', "User-Agent" => USER_AGENT})
           output_json = JSON.parse(response.body)
         else
           raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZSession cookie present")
@@ -109,7 +108,7 @@ module ZuoraAPI
       zsession = cookies["ZSession"]
       begin
         if !zsession.blank?
-          response = HTTParty.put("https://#{self.hostname}/apps/v1/preference/navigation", :body => state.to_json, :headers => {'Cookie' => "ZSession=#{zsession}", 'Content-Type' => 'application/json'})
+          response = HTTParty.put("https://#{self.hostname}/apps/v1/preference/navigation", :body => state.to_json, :headers => {'Cookie' => "ZSession=#{zsession}", 'Content-Type' => 'application/json', "User-Agent" => USER_AGENT})
           output_json = JSON.parse(response.body)
         else
           raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZSession cookie present")
@@ -125,7 +124,7 @@ module ZuoraAPI
       zsession = cookies["ZSession"]
       begin
         if !zsession.blank?
-          response = HTTParty.post("https://#{self.hostname}/apps/v1/navigation/fetch", :headers => {'Cookie' => "ZSession=#{zsession}", 'Content-Type' => 'application/json'})
+          response = HTTParty.post("https://#{self.hostname}/apps/v1/navigation/fetch", :headers => {'Cookie' => "ZSession=#{zsession}", 'Content-Type' => 'application/json', "User-Agent" => USER_AGENT})
           output_json = JSON.parse(response.body)
         else
           raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZSession cookie present")
@@ -140,13 +139,14 @@ 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://reporting-sbx.zan.0001.sbx.auw2.zuora.com/api/rest/v1/",
+                      "Test" => "https://zconnect-services0001.test.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/"},
+                      "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"=> ""}
@@ -177,7 +177,7 @@ module ZuoraAPI
           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'})
+        bearer_response = HTTParty.post("https://#{self.hostname}/oauth/token", :headers => {'Content-Type' => 'application/x-www-form-urlencoded', 'Accept' => 'application/json', "User-Agent" => USER_AGENT}, :body => {'client_id' => client_id, 'client_secret' => URI::encode(client_secret), 'grant_type' => 'client_credentials'})
         bearer_hash = JSON.parse(bearer_response.body)
         bearer_token = bearer_hash["access_token"]
         authorization = "Bearer #{bearer_token}"
@@ -185,7 +185,7 @@ module ZuoraAPI
 
       if !authorization.blank? && !user_id.blank? && !entity_ids.blank?
         endpoint = chomp_v1_from_genesis_endpoint ? self.rest_endpoint.chomp("v1/").concat("genesis/clients") : self.rest_endpoint("genesis/clients")
-        oauth_response = HTTParty.post(endpoint, :headers => {'authorization' => authorization, 'Content-Type' => 'application/json'}, :body => {'clientId' => new_client_id, 'clientSecret' => new_client_secret, 'userId' => user_id, 'entityIds' => entity_ids, 'customAuthorities' => custom_authorities, 'additionalInformation' => {'description' => info_desc, 'name' => info_name}}.to_json)
+        oauth_response = HTTParty.post(endpoint, :headers => {'authorization' => authorization, 'Content-Type' => 'application/json', "User-Agent" => USER_AGENT}, :body => {'clientId' => new_client_id, 'clientSecret' => new_client_secret, 'userId' => user_id, 'entityIds' => entity_ids, 'customAuthorities' => custom_authorities, 'additionalInformation' => {'description' => info_desc, 'name' => info_name}}.to_json)
         output_json = JSON.parse(oauth_response.body)
         if oauth_response.code == 201
           output_json["clientSecret"] = new_client_secret if !use_api_generated_client_secret
@@ -434,12 +434,12 @@ module ZuoraAPI
             end
             if single_transaction
               xml["#{ns1}"].CallOptions do
-                xml.useSingleTransaction single_transaction
+                xml["#{ns1}"].useSingleTransaction single_transaction
               end
             end
             if batch_size
               xml["#{ns1}"].QueryOptions do
-                xml.batchSize batch_size
+                xml["#{ns1}"].batchSize batch_size
               end
             end
           end
@@ -454,6 +454,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["User-Agent"] = USER_AGENT
 
       request = HTTParty::Request.new(
         Net::HTTP::Post,
@@ -613,7 +614,10 @@ module ZuoraAPI
       case response.code
       when 504
         raise ZuoraAPI::Exceptions::ZuoraAPIReadTimeout.new("Received 504 from 'https://#{rest_domain(endpoint: request_uri)}'", response)
-      when 401, 429
+      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
+
       else
         if body.class == Hash
           case request_path
@@ -630,21 +634,6 @@ 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
@@ -737,12 +726,7 @@ module ZuoraAPI
             codes_array = codes_array.push(body.dig("error", 'code')).compact
           end
 
-          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')
+          if body['message'] == '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
 
@@ -814,7 +798,7 @@ module ZuoraAPI
 
           #Request exceeded limit
           if codes_array.map{|code| code.to_s.slice(6,7).to_i}.include?(70)
-            raise ZuoraAPI::Exceptions::ZuoraAPIRequestConcurrentLimit.new("#{messages_array.join(', ')}", response)
+            raise ZuoraAPI::Exceptions::ZuoraAPIRequestLimit.new("#{messages_array.join(', ')}", response)
           end
 
           #All Errors catch
@@ -822,10 +806,6 @@ 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)
@@ -961,11 +941,7 @@ module ZuoraAPI
       when /.*INVALID_SESSION/
         raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new(message, response, errors, success)
       when /.*REQUEST_EXCEEDED_LIMIT/
-        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
+        raise ZuoraAPI::Exceptions::ZuoraAPIRequestLimit.new(message, response, errors, success)
       when /.*LOCK_COMPETITION/
         raise ZuoraAPI::Exceptions::ZuoraAPILockCompetition.new(message, response, errors, success)
       when /.*BATCH_FAIL_ERROR/
@@ -1052,7 +1028,7 @@ module ZuoraAPI
       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"}
-      response = HTTParty.get(url,  headers: {"Authorization" => self.get_session(prefix: true, auth_type: :basic)}.merge(headers), :timeout => 130)
+      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
 
@@ -1144,6 +1120,7 @@ module ZuoraAPI
         end
       end
       headers['Zuora-Track-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)
 
@@ -1309,6 +1286,7 @@ module ZuoraAPI
       end
 
       headers['Zuora-Track-Id'] = zuora_track_id if zuora_track_id.present?
+      headers["User-Agent"] = USER_AGENT
 
       response_save = nil
       http.request_get(uri.request_uri, headers) do |response|
@@ -1423,56 +1401,6 @@ 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.08"
+  VERSION = "1.9.09"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zuora_api
 version: !ruby/object:Gem::Version
-  version: 1.9.08
+  version: 1.9.09
 platform: ruby
 authors:
 - Zuora Strategic Solutions Group
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-26 00:00:00.000000000 Z
+date: 2021-08-04 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.15
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: Gem that provides easy integration to Zuora