zuora_api 1.7.66k → 1.7.81

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7fa1187b824462a04a69aedfa13b20c67727e30a8fccef9a62d7c5b5dde77224
-  data.tar.gz: ace9bbb9317ac71fecbff5af4fd24509f9698fcd33db71b3330342a4bca8d1aa
+  metadata.gz: e6c33a8033a33f0b2104721db4a09233874c8ee61df45a9d1167ec7301b5f9bf
+  data.tar.gz: f1fc6c8c62f7c7e054d84775cab9c283cb36bfde243e57cbe3f7f4eed5f80525
 SHA512:
-  metadata.gz: 9ac138aec48b305c7d3c972f4b533b6e4ab7ff21e937dc9c79992a23b8480542b7bc25449f90365e59509b239e3fa7bad89248b4273337cb8e9d53d6c782ff8b
-  data.tar.gz: 037f86064a5ea3434da2d5256d3652c36567036955ca7ebd1b56f50d86593415f615181d23c322b820506ece425f16b531a551073c6aa1517d4b8b7ee6005336
+  metadata.gz: 2894edcd05d8d4f5a94a725c705050d5ed63d582caebc721e91184adb6853daa036d5c13f942849ef665726c2005dd440212e1dde106cf643ea7fe6c5593b695
+  data.tar.gz: 4f933ca4535657b0f30feecc70412052cca33c99b1327a919d6c7f9966b16ce9663775c54af18c8665ad83838e8eafd16434253d7190fde8d3a7c6ff0a876758

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Zuora, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -145,3 +145,13 @@ Both do the same thing except one returns a url(data_export_insights) to downloa
 objectype: "ACCOUNT/USER"
 
 segmentuuid: A single or array of string or int of a segment uuid(s) that you get from the describe call. The csv holds a column with a bool that represents if that User or Account belongs to that segment.
+
+### License Information
+IN THE EVENT YOU ARE AN EXISTING ZUORA CUSTOMER, USE OF THIS SOFTWARE IS GOVERNED
BY THE MIT LICENSE SET FORTH BELOW AND NOT THE MASTER SUBSCRIPTION AGREEMENT OR OTHER COMMERCIAL AGREEMENT ENTERED INTO BETWEEN YOU AND ZUORA (“AGREEMENT”). FOR THE AVOIDANCE OF DOUBT, ZUORA’S OBLIGATIONS WITH RESPECT TO TECHNICAL SUPPORT, UPTIME, INDEMNIFICATION, AND SECURITY SET FORTH IN THE AGREEMENT DO NOT APPLY TO THE USE OF THIS SOFTWARE.  
+
+Copyright 2021 Zuora, Inc.
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+


data/lib/zuora_api/exceptions.rb

@@ -238,7 +238,7 @@ module ZuoraAPI
       end
     end
 
-    class ZuoraAPIReadTimeout < Net::ReadTimeout
+    class ZuoraAPIReadTimeout < Timeout::Error
       attr_reader :code, :response, :request
       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_Endpoint = '96.0'
+    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 = [
@@ -21,7 +21,7 @@ module ZuoraAPI
     ].freeze
 
     CONNECTION_READ_EXCEPTIONS = [
-      Net::ReadTimeout,
+      Timeout::Error,
       Errno::ECONNRESET,
       Errno::EPIPE
     ].freeze
@@ -50,10 +50,12 @@ module ZuoraAPI
       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?
+      self.update_environment
+      min_endpoint = MIN_Endpoints[self.environment.to_sym]
       if !/apps\/services\/a\/\d+\.\d$/.match(url.strip)
-        self.url = "https://#{hostname}/apps/services/a/#{MIN_Endpoint}"
-      elsif MIN_Endpoint.to_f > url.scan(/(\d+\.\d)$/).dig(0,0).to_f
-        self.url = url.gsub(/(\d+\.\d)$/, MIN_Endpoint)
+        self.url = "https://#{hostname}/apps/services/a/#{min_endpoint}"
+      elsif min_endpoint.to_f > url.scan(/(\d+\.\d)$/).dig(0,0).to_f
+        self.url = url.gsub(/(\d+\.\d)$/, min_endpoint)
       else
         self.url = url
       end
@@ -65,36 +67,18 @@ module ZuoraAPI
       self.status = status.blank? ? "Active" : status
       self.user_info = Hash.new
       self.update_region
-      self.update_environment
       self.update_zconnect_provider
       @timeout_sleep = 5
     end
 
     def get_identity(cookies)
       zsession = cookies["ZSession"]
-      zconnect_accesstoken = get_zconnect_accesstoken(cookies)
       begin
         if !zsession.blank?
           response = HTTParty.get("https://#{self.hostname}/apps/v1/identity", :headers => {'Cookie' => "ZSession=#{zsession}", 'Content-Type' => 'application/json'})
           output_json = JSON.parse(response.body)
-        elsif zconnect_accesstoken.present?
-          begin
-            code = zconnect_accesstoken.split("#!").last
-            encrypted_token, tenant_id = Base64.decode64(code).split(":")
-            body = {'token' => encrypted_token}.to_json
-          rescue => ex
-            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("Invalid ZConnect Cookie")
-          end
-          Rails.logger.info("Using ZConnect cookie in get_identity method")
-
-          response = HTTParty.post("https://#{self.hostname}/apps/zconnectsession/identity", :body => body, :headers => { 'Content-Type' => 'application/json' })
-          output_json = JSON.parse(response.body)
         else
-          if zconnect_accesstoken.blank? && cookies.keys.any? { |x| x.include? "ZConnect"}
-            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZConnect cookie present matching #{self.hostname}")
-          else
-            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZSession cookie present")
-          end
+          raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZSession cookie present")
         end
       rescue JSON::ParserError => ex
         output_json = {}
@@ -105,21 +89,12 @@ module ZuoraAPI
 
     def get_full_nav(cookies)
       zsession = cookies["ZSession"]
-      zconnect_accesstoken = get_zconnect_accesstoken(cookies)
       begin
         if zsession.present?
           response = HTTParty.get("https://#{self.hostname}/apps/v1/navigation", :headers => {'Cookie' => "ZSession=#{zsession}", 'Content-Type' => 'application/json'})
           output_json = JSON.parse(response.body)
-        elsif zconnect_accesstoken.present?
-          Rails.logger.info("Using ZConnect cookie in get_full_nav method")
-          response = HTTParty.get("https://#{self.hostname}/apps/zconnectsession/navigation", :headers => {'Cookie' => "#{self.zconnect_provider}=#{zconnect_accesstoken}",'Content-Type' => 'application/json'})
-          output_json = JSON.parse(response.body)
         else
-          if zconnect_accesstoken.blank? && cookies.keys.any? { |x| x.include? "ZConnect"}
-            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZConnect cookie present matching #{self.hostname}")
-          else
-            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZSession cookie present")
-          end
+          raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZSession cookie present")
         end
       rescue JSON::ParserError => ex
         output_json = {}
@@ -130,21 +105,12 @@ module ZuoraAPI
 
     def set_nav(state, cookies)
       zsession = cookies["ZSession"]
-      zconnect_accesstoken = get_zconnect_accesstoken(cookies)
       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'})
           output_json = JSON.parse(response.body)
-        elsif !zconnect_accesstoken.blank?
-          Rails.logger.info("Using ZConnect cookie in set_nav method")
-          response = HTTParty.post("https://#{self.hostname}/apps/zconnectsession/navigationstate", :body => state.to_json, :headers => {'Cookie' => "#{self.zconnect_provider}=#{zconnect_accesstoken}", 'Content-Type' => 'application/json'})
-          output_json = JSON.parse(response.body)
         else
-          if zconnect_accesstoken.blank? && cookies.keys.any? { |x| x.include? "ZConnect"}
-            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZConnect cookie present matching #{self.hostname}")
-          else
-            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZSession cookie present")
-          end
+          raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZSession cookie present")
         end
       rescue JSON::ParserError => ex
         output_json = {}
@@ -155,21 +121,12 @@ module ZuoraAPI
 
     def refresh_nav(cookies)
       zsession = cookies["ZSession"]
-      zconnect_accesstoken = get_zconnect_accesstoken(cookies)
       begin
         if !zsession.blank?
           response = HTTParty.post("https://#{self.hostname}/apps/v1/navigation/fetch", :headers => {'Cookie' => "ZSession=#{zsession}", 'Content-Type' => 'application/json'})
           output_json = JSON.parse(response.body)
-        elsif !zconnect_accesstoken.blank?
-          Rails.logger.info("Using ZConnect cookie in refresh_nav method")
-          response = HTTParty.post("https://#{self.hostname}/apps/zconnectsession/refresh-navbarcache", :headers => {'Cookie' => "#{self.zconnect_provider}=#{zconnect_accesstoken}", 'Content-Type' => 'application/json'})
-          output_json = JSON.parse(response.body)
         else
-          if zconnect_accesstoken.blank? && cookies.keys.any? { |x| x.include? "ZConnect"}
-            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZConnect cookie present matching #{self.hostname}")
-          else
-            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZSession cookie present")
-          end
+          raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZSession cookie present")
         end
       rescue JSON::ParserError => ex
         output_json = {}
@@ -178,15 +135,6 @@ module ZuoraAPI
       return output_json
     end
 
-    def get_zconnect_accesstoken(cookies)
-      accesstoken = nil
-      self.update_zconnect_provider
-      if !cookies[self.zconnect_provider].nil? && !cookies[self.zconnect_provider].empty?
-        accesstoken = cookies[self.zconnect_provider]
-      end
-      return accesstoken
-    end
-
     def reporting_url(path)
       map = {"US" => {"Sandbox" => "https://zconnectsandbox.zuora.com/api/rest/v1/",
                       "Production" => "https://zconnect.zuora.com/api/rest/v1/",
@@ -208,7 +156,7 @@ module ZuoraAPI
     # 1. Pass in cookies and optionally custom_authorities, name, and description
     # 2. Pass in user_id, entity_ids, client_id, client_secret, and optionally custom_authorities, name, and description
     # https://intranet.zuora.com/confluence/display/Sunburst/Create+an+OAuth+Client+through+API+Gateway#CreateanOAuthClientthroughAPIGateway-ZSession
-    def get_oauth_client (custom_authorities = [], info_name: "No Name", info_desc: "This client was created without a description.", user_id: nil, entity_ids: nil, client_id: nil, client_secret: nil, new_client_id: nil, new_client_secret: nil, cookies: nil)
+    def get_oauth_client (custom_authorities = [], info_name: "No Name", info_desc: "This client was created without a description.", user_id: nil, entity_ids: nil, client_id: nil, client_secret: nil, new_client_id: nil, new_client_secret: nil, cookies: nil, chomp_v1_from_genesis_endpoint: false, use_api_generated_client_secret: false)
       authorization = ""
       new_client_id = SecureRandom.uuid if new_client_id.blank?
       new_client_secret = SecureRandom.hex(10) if new_client_secret.blank?
@@ -234,11 +182,11 @@ module ZuoraAPI
       end
 
       if !authorization.blank? && !user_id.blank? && !entity_ids.blank?
-        endpoint = self.rest_endpoint("genesis/clients")
+        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)
         output_json = JSON.parse(oauth_response.body)
         if oauth_response.code == 201
-          output_json["clientSecret"] = new_client_secret
+          output_json["clientSecret"] = new_client_secret if !use_api_generated_client_secret
           return output_json
         elsif oauth_response.code == 401 && !oauth_response.message.blank?
           raise ZuoraAPI::Exceptions::ZuoraAPIError.new(output_json["message"], oauth_response)
@@ -305,7 +253,7 @@ module ZuoraAPI
     end
 
     def update_environment
-      if !self.url.blank?
+      if !self.hostname.blank?
         case self.hostname
         when /(?<=\.|\/|-|^)(apisandbox|sandbox)(?=\.|\/|-|$)/
           self.environment = 'Sandbox'
@@ -328,13 +276,13 @@ module ZuoraAPI
     end
 
     def update_zconnect_provider
-      region = update_region
-      environment = update_environment
+      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"},
                   "EU" => {"Sandbox" => "ZConnectSbxEU", "Services" => "ZConnectSvcEU", "Production" => "ZConnectProdEU", "Performance" => "ZConnectPT1EU", "Test" => "ZConnectTest"},
                   "Unknown" => {"Unknown" => "Unknown"}}
-      self.zconnect_provider = mappings[region][environment]
+      self.zconnect_provider = mappings[self.region][self.environment]
     end
 
     def aqua_endpoint(url="")
@@ -387,20 +335,20 @@ module ZuoraAPI
     end
 
     def new_session(auth_type: :basic, debug: false, zuora_track_id: nil)
-      tries ||= 2
+      retries ||= 2
       yield
 
     rescue ZuoraAPI::Exceptions::ZuoraAPISessionError => ex
-      self.status = 'Inactive/Invalid'
+      self.status = 'Invalid'
       self.current_error = ex.message
       raise
     rescue ZuoraAPI::Exceptions::ZuoraAPIError  => ex
       raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new(ex.message, ex.response)
 
     rescue ZuoraAPI::Exceptions::ZuoraAPIInternalServerError => ex
-      raise ex if tries.zero?
+      raise ex if retries.zero?
 
-      tries -= 1
+      retries -= 1
       sleep(self.timeout_sleep)
       retry
         
@@ -571,7 +519,7 @@ module ZuoraAPI
       end
 
       self.log(location: "SOAP Call", exception: ex, message: "Timed out", level: :error)  if output_exception_messages
-      ex = ZuoraAPI::Exceptions::ZuoraAPIReadTimeout.new("Received read timeout from 'https://#{rest_domain(endpoint: url)}'", nil, request) if ex.instance_of?(Net::ReadTimeout)
+      ex = ZuoraAPI::Exceptions::ZuoraAPIReadTimeout.new("Received read/write timeout from 'https://#{rest_domain(endpoint: url)}'", nil, request) if ex.is_a?(Timeout::Error) && !ex.instance_of?(ZuoraAPI::Exceptions::ZuoraAPIReadTimeout)
       raise ex
 
     rescue => ex
@@ -586,7 +534,7 @@ module ZuoraAPI
       when ZuoraAPI::Exceptions::ZuoraAPIUnkownError, ZuoraAPI::Exceptions::ZuoraDataIntegrity
         Rails.logger.error('Zuora Unknown/Integrity Error', ex, exception_args)
       when ZuoraAPI::Exceptions::ZuoraAPIRequestLimit
-        Rails.logger.info('Zuora APILimit Reached', exception_args)
+        Rails.logger.info('Zuora APILimit Reached', ex, exception_args)
       when *(ZuoraAPI::Login::ZUORA_API_ERRORS-ZuoraAPI::Login::ZUORA_SERVER_ERRORS)
         #Rails.logger.debug('Zuora API Error', ex, self.exception_args(ex))
       when *ZuoraAPI::Login::ZUORA_SERVER_ERRORS
@@ -605,12 +553,7 @@ module ZuoraAPI
 
     def exception_args(ex)
       args = {}
-      if ex.class == ZuoraAPI::Exceptions::ZuoraAPIRequestLimit
-        args.merge!({
-          zuora_trace_id: ex.response.headers["zuora-request-id"],
-          zuora_track_id: ex.response.request.options[:headers]["Zuora-Track-Id"]
-        })
-      elsif defined?(ex.response) && ex.response.present?
+      if defined?(ex.response) && ex.response.present?
         args.merge!({
           request: {
             path: ex.response.request.path.to_s,
@@ -755,14 +698,27 @@ module ZuoraAPI
           if body['code'].present? && /61$/.match(body['code'].to_s).present? # if last 2 digits of code are 61
             raise ZuoraAPI::Exceptions::ZuoraAPITemporaryError.new(body['message'], nil, body['details'])
           end
+        when /^\/api\/v1\/payment_plans.*/
+           raise ZuoraAPI::Exceptions::ZuoraAPIError.new(body['error'], response) if body['error']
         end
 
         body = body.dig("results").present? ? body["results"] : body if body.class == Hash
         if body.class == Hash && (!body["success"] || !body["Success"] || response.code != 200)
-          messages_array = body.fetch("reasons", []).map {|error| error['message']}.compact
-          messages_array = messages_array.push(body.dig("error", 'message')).compact if body.dig('error').class == Hash
-          codes_array =    body.fetch("reasons", []).map {|error| error['code']}.compact
-          codes_array = codes_array.push(body.dig("error", 'code')).compact  if body.dig('error').class == Hash
+          reason_keys = %w(reasons errors)
+          message_keys = %w(message title)
+          messages_array, codes_array = [[],[]]
+          reason_keys.each do |rsn_key|
+            message_keys.each do |msg_key|
+              messages_array = body.fetch(rsn_key, []).map {|error| error[msg_key]}.compact
+              break if messages_array.present?
+            end
+            codes_array = body.fetch(rsn_key, []).map {|error| error['code']}.compact
+            break if messages_array.present? && codes_array.present?
+          end
+          if body.dig('error').class == Hash
+            messages_array = messages_array.push(body.dig("error", 'message')).compact
+            codes_array = codes_array.push(body.dig("error", 'code')).compact
+          end
 
           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)
@@ -905,7 +861,7 @@ module ZuoraAPI
         output_json = JSON.parse(response.body)
         self.raise_errors(type: :JSON, body: output_json, response: response)
       
-      elsif (response_content_types.include?('application/xml') || response_content_types.include?('text/xml')) and type != :xml
+      elsif (response_content_types.include?('application/xml') || response_content_types.include?('text/xml') || response_content_types.include?('application/soap+xml')) and type != :xml
         output_xml = Nokogiri::XML(response.body)
         self.raise_errors(type: :SOAP, body: output_xml, response: response)
 
@@ -953,6 +909,11 @@ module ZuoraAPI
         message = body.xpath('//ns1:Message', 'ns1' =>'http://api.zuora.com/').text
       end
 
+      if error.blank? || message.blank?
+        error   = body.xpath('//soapenv:Value', 'soapenv'=>'http://www.w3.org/2003/05/soap-envelope').text
+        message = body.xpath('//soapenv:Text', 'soapenv'=>'http://www.w3.org/2003/05/soap-envelope').text
+      end
+
       #Update/Create/Delete Calls with multiple requests and responses
       if body.xpath('//ns1:result', 'ns1' =>'http://api.zuora.com/').size > 0 && body.xpath('//ns1:Errors', 'ns1' =>'http://api.zuora.com/').size > 0
         error = []
@@ -1003,10 +964,15 @@ module ZuoraAPI
       when /.*soapenv:Server.*/
         if /^Invalid value.*for type.*|^Id is invalid|^date string can not be less than 19 charactors$/.match(message).present?
           raise ZuoraAPI::Exceptions::ZuoraAPIError.new(message, response, errors, success)
-        elsif /^Invalid white space character \(.*\) in text to output$|^Invalid null character in text to output$/.match(message).present?
+        elsif /^unknown$|^Invalid white space character \(.*\) in text to output$|^Invalid null character in text to output$/.match(message).present?
           raise ZuoraAPI::Exceptions::ZuoraAPIUnkownError.new(message, response, errors, success)
         end
         raise ZuoraAPI::Exceptions::ZuoraAPIInternalServerError.new(message, response, errors, success)
+      when /soapenv:Receiver/
+        if /^com.ctc.wstx.exc.WstxUnexpectedCharException: Unexpected character.*$/.match(message).present?
+          raise ZuoraAPI::Exceptions::ZuoraAPIError.new(message, response, errors, success)
+        end
+        raise ZuoraAPI::Exceptions::ZuoraAPIInternalServerError.new(message, response, errors, success)
       else 
         raise ZuoraAPI::Exceptions::ZuoraAPIInternalServerError.new("Z:#{error}::#{message}", response, errors, success)
       end
@@ -1237,7 +1203,7 @@ module ZuoraAPI
       end
       
       self.log(location: "Rest Call", exception: ex, message: "Timed out", level: :error) if output_exception_messages
-      ex = ZuoraAPI::Exceptions::ZuoraAPIReadTimeout.new("Received read timeout from 'https://#{rest_domain(endpoint: url)}'", nil, request) if ex.instance_of?(Net::ReadTimeout)
+      ex = ZuoraAPI::Exceptions::ZuoraAPIReadTimeout.new("Received read/write timeout from 'https://#{rest_domain(endpoint: url)}'", nil, request) if ex.is_a?(Timeout::Error) && !ex.instance_of?(ZuoraAPI::Exceptions::ZuoraAPIReadTimeout)
       raise ex
 
     rescue => ex
@@ -1398,13 +1364,21 @@ module ZuoraAPI
           return file_handle
         when Net::HTTPUnauthorized
           if z_session
-            if !(retry_count -= 1).zero?
+            unless (retry_count -= 1).zero?
               self.new_session
-              raise response.class
+              raise ZuoraAPI::Exceptions::ZuoraAPISessionError, 'Retrying'
             end
             raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new(self.current_error)
           end
           raise
+        when Net::HTTPNotFound
+          if url.include?(self.fileURL)
+            raise ZuoraAPI::Exceptions::FileDownloadError.new(
+              "The current tenant does not have a file with id '#{url.split('/').last}'"
+            )
+          else
+            raise ZuoraAPI::Exceptions::FileDownloadError.new("File Download Failed #{response.class}")
+          end
         else
           raise ZuoraAPI::Exceptions::FileDownloadError.new("File Download Failed #{response.class}")
         end
@@ -1421,68 +1395,35 @@ module ZuoraAPI
 
     def getDataSourceExport(query, extract: true, encrypted: false, zip: true, z_track_id: "")
       tries ||= 3
-      request = Nokogiri::XML::Builder.new do |xml|
-        xml['SOAP-ENV'].Envelope('xmlns:SOAP-ENV' => "http://schemas.xmlsoap.org/soap/envelope/", 'xmlns:ns2' => "http://object.api.zuora.com/", 'xmlns:xsi' => "http://www.w3.org/2001/XMLSchema-instance", 'xmlns:ns1' => "http://api.zuora.com/") do
-          xml['SOAP-ENV'].Header do
-            xml['ns1'].SessionHeader do
-              xml['ns1'].session self.get_session(prefix: false, auth_type: :basic, zuora_track_id: z_track_id)
-            end
-          end
-          xml['SOAP-ENV'].Body do
-            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
+
+      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
-
-      response_query = HTTParty.post(self.url, body: request.to_xml(:save_with => XML_SAVE_OPTIONS).strip, headers: {'Content-Type' => "application/json; charset=utf-8", "Z-Track-Id" => z_track_id}, :timeout => 130)
-
-      output_xml = Nokogiri::XML(response_query.body)
-      raise_errors(type: :SOAP, body: output_xml, response: response_query) if output_xml.xpath('//ns1:Success', 'ns1' =>'http://api.zuora.com/').text != "true"
-
-      # raise "Export Creation Unsuccessful : #{response_query.code}: #{response_query.parsed_response}" if  output_xml.xpath('//ns1:Success', 'ns1' =>'http://api.zuora.com/').text != "true"
       
       id = output_xml.xpath('//ns1:Id', 'ns1' =>'http://api.zuora.com/').text
 
-      confirmRequest = Nokogiri::XML::Builder.new do |xml|
-        xml['SOAP-ENV'].Envelope('xmlns:SOAP-ENV' => "http://schemas.xmlsoap.org/soap/envelope/", 'xmlns:ns2' => "http://object.api.zuora.com/", 'xmlns:xsi' => "http://www.w3.org/2001/XMLSchema-instance", 'xmlns:ns1' => "http://api.zuora.com/") do
-          xml['SOAP-ENV'].Header do
-            xml['ns1'].SessionHeader do
-              xml['ns1'].session self.get_session(prefix: false, auth_type: :basic, zuora_track_id: z_track_id)
-            end
-          end
-          xml['SOAP-ENV'].Body do
-            xml['ns1'].query do
-              xml['ns1'].queryString "SELECT  Id, CreatedById, CreatedDate, Encrypted, FileId, Format, Name, Query, Size, Status, StatusReason, UpdatedById, UpdatedDate, Zip From Export where Id = '#{id}'"
-            end
-          end
-        end
-      end
       result = 'Waiting'
-
       while result != "Completed"
         sleep 3
-        response_query = HTTParty.post(self.url, body: confirmRequest.to_xml(:save_with => XML_SAVE_OPTIONS).strip, headers: {'Content-Type' => "application/json; charset=utf-8", "Z-Track-Id" => z_track_id}, :timeout => 130)
-
-        output_xml = Nokogiri::XML(response_query.body)
+        output_xml, input_xml = self.soap_call(debug: false, timeout_retry: true, zuora_track_id: z_track_id) do |xml|
+          xml['ns1'].query do
+            xml['ns1'].queryString "SELECT Id, CreatedById, CreatedDate, Encrypted, FileId, Format, Name, Query, Size, Status, StatusReason, UpdatedById, UpdatedDate, Zip From Export where Id = '#{id}'"
+          end
+        end
         result = output_xml.xpath('//ns2:Status',  'ns2' =>'http://object.api.zuora.com/').text
-        status_code = response_query.code if response_query
-
-        raise_errors(type: :SOAP, body: output_xml, response: response_query) if result.blank? || result == "Failed"
-        # raise "Export Creation Unsuccessful : #{response_query.code}: #{response_query.parsed_response}" if result.blank? || result == "Failed"
       end
 
       file_id = output_xml.xpath('//ns2:FileId',  'ns2' =>'http://object.api.zuora.com/').text
       export_file = get_file(:url => self.fileURL(file_id))
       export_file_path = export_file.path
-      Rails.logger.debug("=====> Export path #{export_file.path}")
 
       if extract && zip
         require "zip"
@@ -1506,24 +1447,18 @@ module ZuoraAPI
     rescue ZuoraAPI::Exceptions::ZuoraUnexpectedError => ex
       if !(tries -= 1).zero?
         Rails.logger.info("Trace ID: #{z_track_id} UnexpectedError, will retry after 10 seconds")
-        sleep 10
+        sleep(self.timeout_sleep)
         retry
       end
       raise ex
-
-    rescue *ZUORA_API_ERRORS => ex
-      raise ex
-
+      
     rescue *(CONNECTION_EXCEPTIONS + CONNECTION_READ_EXCEPTIONS) => ex
       if !(tries -= 1).zero?
         Rails.logger.info("Trace ID: #{z_track_id} Timed out will retry after 5 seconds")
-        sleep 5
+        sleep(self.timeout_sleep)
         retry
       end
       raise ex
-
-    rescue ZuoraAPI::Exceptions::BadEntityError => ex
-      raise ex
     end
 
     def query(query, parse = false)

data/lib/zuora_api/version.rb

@@ -1,3 +1,3 @@
 module ZuoraAPI
-  VERSION = "1.7.66k"
+  VERSION = "1.7.81"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zuora_api
 version: !ruby/object:Gem::Version
-  version: 1.7.66k
+  version: 1.7.81
 platform: ruby
 authors:
 - Zuora Strategic Solutions Group
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-23 00:00:00.000000000 Z
+date: 2021-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -145,7 +145,7 @@ dependencies:
         version: 4.1.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -155,7 +155,7 @@ dependencies:
         version: 4.1.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '6.1'
 description: Gem that provides easy integration to Zuora
 email:
 - connect@zuora.com
@@ -163,17 +163,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".gitlab-ci.yml"
-- ".rspec"
-- ".travis.yml"
-- CHANGELOG.md
-- Gemfile
-- Gemfile.lock
+- MIT-LICENSE
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - lib/insights_api/login.rb
 - lib/zuora_api.rb
 - lib/zuora_api/exceptions.rb
@@ -181,7 +173,6 @@ files:
 - lib/zuora_api/logins/basic.rb
 - lib/zuora_api/logins/oauth.rb
 - lib/zuora_api/version.rb
-- zuora_api.gemspec
 homepage: https://connect.zuora.com
 licenses: []
 metadata: {}
@@ -196,11 +187,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Gem that provides easy integration to Zuora

data/.gitignore

@@ -1,10 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-.idea

data/.gitlab-ci.yml

@@ -1,64 +0,0 @@
-image: ruby:2.7
-stages:
-  - setup
-  - test
-  - deploy
-
-setup:
-  stage: setup
-  allow_failure: true
-  cache:
-    key: gems
-    paths:
-      - vendor/bundle
-  script:
-  - apt-get update -qy
-  - apt-get install -y nodejs
-  - bundle install
-
-rubocop-testing:
-  stage: test
-  allow_failure: true
-  script:
-  - gem install rubocop
-  - rubocop --lint
-
-security-testing:
-  stage: test
-  allow_failure: true
-  script:
-  - gem install brakeman
-  - brakeman
-
-rspec-testing:
-  stage: test
-  script:
-  - bundle install
-  - rspec
-  coverage: '/\(\d+.\d+\%\) covered/'
-
-rubygems-deploy:
-  stage: deploy
-  allow_failure: false
-  script:
-  - echo "deb http://ftp.us.debian.org/debian testing main contrib non-free" >> /etc/apt/sources.list
-  - apt-get update
-  - apt-get install -y git
-  - apt-get clean all
-  - gem install dpl
-  - if [[ "staging"  == $CI_BUILD_REF_SLUG ]];then  export VERSION=`git describe --match "[0-9]*\.[0-9]*\.[0-9]*[a-z]" --abbrev=0 --tags HEAD`; fi
-  - if [[ "master"  == $CI_BUILD_REF_SLUG ]];then export VERSION=`git describe --exclude "[0-9]*\.[0-9]*\.[0-9]*[a-z]" --abbrev=0 --tags HEAD`; fi
-  - echo $VERSION
-  - sed -i "s/0.0.1/$VERSION/" lib/zuora_api/version.rb
-  - git add lib/zuora_api/version.rb
-  - git config --global user.email "connect@zuora.com"
-  - git config --global user.name "Connect Automation"
-  - git commit -m "Automated Version Update $VERSION"
-  - bundle install
-  - gem install rake
-  - version=$(rake install | grep -o 'pkg/zuora_api-.*gem')
-  - curl -u $USERNAME:$PASSWORD https://rubygems.org/api/v1/api_key.yaml > ~/.gem/credentials; chmod 0600 ~/.gem/credentials
-  - gem push $version
-  only:
-    - master
-    - staging

data/.rspec

@@ -1,2 +0,0 @@
---format documentation
---color

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.3.0
-before_install: gem install bundler -v 1.12.5

data/CHANGELOG.md

@@ -1,105 +0,0 @@
-# Changelog
-All notable changes to this project will be documented in this file.
-
-## [1.7.07] - 2018-9-10
-### Changed
-- Cookie name for service endpoint integration
-
-## [1.7.06] - 2018-8-25
-### Added
-- Retry for 502/503
-- Standard exception for 504
-
-## [1.7.05] - 2018-8-25
-### Added
-- Added support for oauth token forbidden
-
-## [1.7.02] - 2018-8-23
-### Added
-- Added mulit part support for rest call
-
-## [1.7.01] - 2018-8-06
-### Changed
-- Changed library used to determine host
-- Added retry for 504 timouts in file download
-
-## [1.7.00] - 2018-8-05
-### Changed
-- Raise proper exception when oauth client is from deactivated user.
-- Support for rails < 6
-
-## [1.6.53] - 2018-7-29
-### Changed
-- Don't attempt zsession login if bearer token is bad
-
-## [1.6.51 - 1.6.51] - 2018-7-22
-### Changed
-- Retry on address not available.
-
-## [1.6.47 - 1.6.48] - 2018-6-26
-### Changed
-- Changed error raise statements when incorrect credentials are supplied to Basic/Oauth Logins
-
-## [1.6.45] - 2018-5-30
-### Changed
-- Fix retry so headers are reinstaniated on session failure. 
-
-## [1.6.41] - 2018-5-30
-### Changed
-- Retry added on SSL connection failure
-
-## [1.6.39-1.6.40] - 2018-5-30
-### Changed
-- Added validation to fix bad urls entered into object initialization
-
-## [1.6.38] - 2018-5-26
-### Changed
-- HttpParty validation before code extraction
-
-## [1.6.37] - 2018-5-23
-### Added
-- Added method to determine rest endpoint domain
-
-## [1.6.36] - 2018-5-22
-### Changed
-- Fixed zuora staging 2 endpoint
-
-## [1.6.33] - 2018-5-15
-### Changed
-- Added Errno::EHOSTUNREACH to list of retriable error codes
-
-## [1.6.32] - 2018-5-14
-### Changed
-- Don't log fatal errors, allow application to decide for file download
-- Don't change api url if the user set a high api url
-
-###Removed
-- Force encoding
-
-## [1.6.28] - 2018-3-12
-### Added
-- Way to avoid force encoding for filedownload
-
-## [1.6.28] - 2018-3-12
-### Added
-- Way to avoid force encoding for filedownload
-
-## [1.6.22] - 2019-01-03
-### Changed
-- get_identity method - supports ZSession auth now
-- updated rspecs accordingly
-
-## [1.6.18] - 2018-12-06
-### Added
-- zconnect_provider attribute accessor for identifying ZConnect cookies
-- Methods for Hallway integration:
-- get_identity
-- get_full_nav
-- set_nav
-- refresh_nav
-- get_oauth_client
-
-### Changed
-- The way environment and region are set
-
-

data/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-ruby "2.7.1"
-# Specify your gem's dependencies in zuora.gemspec
-gemspec

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "zuora"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/zuora_api.gemspec

@@ -1,31 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'zuora_api/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "zuora_api"
-  spec.version       = ZuoraAPI::VERSION
-  spec.authors       = ["Zuora Strategic Solutions Group"]
-  spec.email         = ["connect@zuora.com"]
-
-  spec.summary       = %q{Gem that provides easy integration to Zuora}
-  spec.description   = %q{Gem that provides easy integration to Zuora}
-  spec.homepage      = "https://connect.zuora.com"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency("webmock")
-  spec.add_development_dependency("simplecov", "~> 0.18.5")
-  spec.add_dependency("ougai")
-  spec.add_dependency("nokogiri")
-  spec.add_dependency("httparty")
-  spec.add_dependency("rubyzip")
-  spec.add_dependency("railties", ">= 4.1.0", "< 6")
-end