zuora_api 1.8.23 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0ab2609485e4d653738cdd84169feac4058531f4caac36e62b88fd8910008cc
-  data.tar.gz: d86b6df5e09c4eed423b362e0334f5605da724e6a7956bd6c896aeccbc9e3fa5
+  metadata.gz: 2c377d99b1a4c4a64d1b46d45b19e42136da2e0faba049e7a45621b3daaa41ad
+  data.tar.gz: e00b3a6e9628aed4086190a3be983bd7998196812df9d53010c274f882a36749
 SHA512:
-  metadata.gz: 42c8e4f181cb4c64275db13bb0104d47864cd80e3b53a930fd48373b4fa43aa4022bc21162f38fe53dcadeca06ea601e0d7dd25161a5a57678c3008b1239b046
-  data.tar.gz: 8f06a60bc4263a8529dbb5c6a862668cce4f1bda5b5f33f6df25f67bb49f79c7382cc2192d486a4c09802590e990041ad7a8fa627cd5e88975c9636c6e716eb1
+  metadata.gz: 14c76c2a211f55a38d79940436241c3fa9203a2c1a960415a3a2287950adb6059461571703530d4754e803833f3ffc98e42182c50588498a51070a0a6984cadb
+  data.tar.gz: a2176a640fb0f77bbc0893f5161c30c822a9a8cc1147b33e6f088ce60240666a19853f82e5d85ecf676273c9a9ecc59c7aaee006f0aa63c8fd52b8fdc60ee2d1

data/README.md

@@ -147,11 +147,10 @@ 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.  
+IN THE EVENT YOU ARE AN EXISTING ZUORA CUSTOMER, USE OF THIS SOFTWARE IS GOVERNED
BYGOVERNEDBY 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.rb

@@ -4,6 +4,8 @@ require "zuora_api/logins/basic"
 require "zuora_api/logins/oauth"
 require 'zuora_api/exceptions'
 require "insights_api/login"
+require "ougai"
+
 module ZuoraAPI
   # Your code goes here...
 end

data/lib/zuora_api/login.rb

@@ -43,7 +43,7 @@ module ZuoraAPI
         ZuoraAPI::Exceptions::ZuoraAPIReadTimeout,
       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
 
     def initialize(url: nil, entity_id: nil, session: nil, status: nil, bearer_token: nil, oauth_session_expires_at: nil, **keyword_args)
@@ -299,7 +299,7 @@ module ZuoraAPI
       update_environment
       endpoint = url
       url_postfix = {"US" => ".", "EU" => ".eu.", "NA" => ".na."}[self.region]
-    
+
       case self.environment
       when 'Test'
         endpoint = "https://rest.test#{url_postfix}zuora.com"
@@ -351,7 +351,7 @@ module ZuoraAPI
       retries -= 1
       sleep(self.timeout_sleep)
       retry
-        
+
     rescue *(CONNECTION_EXCEPTIONS + CONNECTION_READ_EXCEPTIONS) => ex
       self.log(location: "BasicLogin", exception: ex, message: "Timed out", level: :error)
 
@@ -402,18 +402,18 @@ module ZuoraAPI
     end
 
     def soap_call(
-      ns1: 'ns1', 
-      ns2: 'ns2', 
+      ns1: 'ns1',
+      ns2: 'ns2',
       batch_size: nil,
       headers: {},
-      single_transaction: false, 
-      debug: false, 
-      zuora_track_id: nil, 
-      errors: [ZuoraAPI::Exceptions::ZuoraAPISessionError].concat(ZUORA_API_ERRORS), 
-      z_session: true, 
-      timeout_retry: false, 
+      single_transaction: false,
+      debug: false,
+      zuora_track_id: nil,
+      errors: [ZuoraAPI::Exceptions::ZuoraAPISessionError].concat(ZUORA_API_ERRORS),
+      z_session: true,
+      timeout_retry: false,
       timeout: 130,
-      timeout_sleep_interval: self.timeout_sleep, 
+      timeout_sleep_interval: self.timeout_sleep,
       output_exception_messages: true,
       skip_session: false,
       **keyword_args)
@@ -484,17 +484,17 @@ module ZuoraAPI
 
         retry
       end
-        
+
       raise ex if errors.include?(ex.class)
-  
+
       return output_xml, input_xml, response
-      
+
     rescue *ZUORA_API_ERRORS => ex
       raise ex if errors.include?(ex.class)
-     
+
       response = ex.response unless response
       return output_xml, input_xml, response
-      
+
     rescue *CONNECTION_EXCEPTIONS => ex
       if !tries.zero?
         tries -= 1
@@ -504,8 +504,8 @@ module ZuoraAPI
       end
 
       self.log(location: "SOAP Call", exception: ex, message: "Timed out", level: :error)  if output_exception_messages
-      raise ex 
-      
+      raise ex
+
     rescue *CONNECTION_READ_EXCEPTIONS => ex
       if !tries.zero?
         tries -= 1
@@ -524,11 +524,13 @@ module ZuoraAPI
 
     rescue => ex
       raise ex
-    ensure 
-      self.error_logger(ex) if defined?(ex) && Rails.logger.class.to_s == "Ougai::Logger"
+    ensure
+      self.error_logger(ex) if defined?(ex)
     end
 
     def error_logger(ex)
+      return unless Rails.logger.is_a? Ougai::Logger
+
       exception_args = Rails.logger.with_fields.merge(self.exception_args(ex))
       case ex
       when ZuoraAPI::Exceptions::ZuoraAPIUnkownError, ZuoraAPI::Exceptions::ZuoraDataIntegrity
@@ -544,10 +546,10 @@ module ZuoraAPI
 
     def log(location: "Rest Call", exception: nil, message: "Timed out will retry after #{self.timeout_sleep} seconds", level: :info )
       level = :debug if ![:debug, :info, :warn, :error, :fatal].include?(level)
-      if Rails.logger.class.to_s == "Ougai::Logger"
-        Rails.logger.send(level.to_sym, "#{location} - #{message}", exception) 
+      if Rails.logger.is_a? Ougai::Logger
+        Rails.logger.send(level.to_sym, "#{location} - #{message}", exception)
       else
-        Rails.logger.send(level.to_sym, "#{location} - #{exception.class} #{message}") 
+        Rails.logger.send(level.to_sym, "#{location} - #{exception.class} #{message}")
       end
     end
 
@@ -612,14 +614,14 @@ module ZuoraAPI
       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
           when /^\/v1\/connections$/
-            response_headers = response.headers.to_h      
+            response_headers = response.headers.to_h
             raise ZuoraAPI::Exceptions::ZuoraAPIInternalServerError.new("Missing cookies for authentication call", response) if response_headers['set-cookie'].blank?
-            z_session_cookie = response_headers.fetch('set-cookie', []).select{|x| x.match(/^ZSession=.*/) }.first 
+            z_session_cookie = response_headers.fetch('set-cookie', []).select{|x| x.match(/^ZSession=.*/) }.first
             raise ZuoraAPI::Exceptions::ZuoraAPIInternalServerError.new("Missing ZSession cookie for authentication call", response) if z_session_cookie.blank?
           end
         end
@@ -629,7 +631,7 @@ module ZuoraAPI
       when :SOAP
         error, success, message = get_soap_error_and_message(body)
 
-        if body.xpath('//fns:LoginFault', 'fns' =>'http://fault.api.zuora.com/').present? 
+        if body.xpath('//fns:LoginFault', 'fns' =>'http://fault.api.zuora.com/').present?
           raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new(message, response)
         end
 
@@ -666,19 +668,19 @@ module ZuoraAPI
         end
 
         self.errors_via_content_type(response: response, type: :xml)
-        
+
       when :JSON
         case request_path
         when /^\/query\/jobs.*/  #DataQuery Paths
           return if body.class != Hash
           case match_string
-          when /^GET::200::\/query\/jobs\/([a-zA-Z0-9\-_]+)$/ #Get DQ job, Capture of the id is present if needed in future error responses. 
+          when /^GET::200::\/query\/jobs\/([a-zA-Z0-9\-_]+)$/ #Get DQ job, Capture of the id is present if needed in future error responses.
             if body.dig('data', "errorCode") == "LINK_10000005"
               raise ZuoraAPI::Exceptions::ZuoraAPITemporaryError.new(body.dig('data', "errorMessage"), response)
-            elsif (body.dig('data', "errorMessage").present? || body.dig('data', "queryStatus") == "failed") 
+            elsif (body.dig('data', "errorMessage").present? || body.dig('data', "queryStatus") == "failed")
               raise ZuoraAPI::Exceptions::ZuoraAPIError.new(body.dig('data', "errorMessage"), response)
             end
-          when /^GET::404::\/query\/jobs\/([a-zA-Z0-9\-_]+)$/ #Get DQ job not found, capture of the id is present if needed in future error responses. 
+          when /^GET::404::\/query\/jobs\/([a-zA-Z0-9\-_]+)$/ #Get DQ job not found, capture of the id is present if needed in future error responses.
             raise ZuoraAPI::Exceptions::ZuoraAPIError.new(body.dig('message'), response) if body.dig('message').present?
           when /^POST::400::\/query\/jobs$/ #Create DQ job
             raise ZuoraAPI::Exceptions::ZuoraAPIError.new(body.dig('message'), response) if body.dig('message').present?
@@ -741,7 +743,7 @@ module ZuoraAPI
           end
 
           #Oauth Tokens - User deactivated
-          if body['path'] == '/oauth/token' 
+          if body['path'] == '/oauth/token'
             if body['status'] == 403 && response.code == 403
               raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new("Forbidden", response)
             elsif body['status'] == 400 && response.code == 400 && body['message'].include?("Invalid client id")
@@ -752,7 +754,7 @@ module ZuoraAPI
           if body['error'] == 'Unauthorized' && body['status'] == 401
             if body['message'].present?
               raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new(body['message'], response)
-            else 
+            else
               raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new("#{messages_array.join(', ')}", response)
             end
           end
@@ -777,7 +779,7 @@ module ZuoraAPI
           end
           #Internal Server Error
           if codes_array.map{|code| code.to_s.slice(6,7).to_i}.include?(60)
-            if messages_array.uniq.size == 1 
+            if messages_array.uniq.size == 1
               if messages_array.first.match(/^Transaction declined.*|^There is an invoice pending tax.*|^The Zuora GetTax call to Avalara.*|^The tax calculation call to Zuora Connect returned the following error: Status Code: 4.*/)
                 raise ZuoraAPI::Exceptions::ZuoraAPIError.new(messages_array.first, response)
               end
@@ -850,17 +852,17 @@ module ZuoraAPI
         self.errors_via_content_type(response: response, type: :json)
 
         #All other errors
-        raise ZuoraAPI::Exceptions::ZuoraAPIError.new(response.body, response) if ![200,201].include?(response.code) 
+        raise ZuoraAPI::Exceptions::ZuoraAPIError.new(response.body, response) if ![200,201].include?(response.code)
       end
     end
 
     def errors_via_content_type(response: nil, type: :xml)
       response_content_types = response.headers.transform_keys(&:downcase).fetch('content-type', []).first || ""
-      
+
       if response_content_types.include?('application/json') && type != :json
         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') || 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)
@@ -880,10 +882,10 @@ module ZuoraAPI
           when /Service Unavailable/
             raise ZuoraAPI::Exceptions::ZuoraAPIConnectionTimeout.new(error_message, response)
           when /Client sent a bad request./, /Bad Request/, /403 Forbidden/
-            raise ZuoraAPI::Exceptions::ZuoraAPIInternalServerError.new(error_message, response)    
+            raise ZuoraAPI::Exceptions::ZuoraAPIInternalServerError.new(error_message, response)
           when /414 Request-URI Too Large/
             raise ZuoraAPI::Exceptions::ZuoraAPIError.new("Request URL is too long", response)
-          else 
+          else
             raise ZuoraAPI::Exceptions::ZuoraAPIInternalServerError.new(error_message, response)
           end
         end
@@ -893,7 +895,7 @@ module ZuoraAPI
 
       raise ZuoraAPI::Exceptions::ZuoraAPIInternalServerError.new(response.body, response) if response.code == 500
     end
-          
+
 
     def get_soap_error_and_message(body)
       error   = body.xpath('//fns:FaultCode', 'fns' =>'http://fault.api.zuora.com/').text
@@ -973,7 +975,7 @@ module ZuoraAPI
           raise ZuoraAPI::Exceptions::ZuoraAPIError.new(message, response, errors, success)
         end
         raise ZuoraAPI::Exceptions::ZuoraAPIInternalServerError.new(message, response, errors, success)
-      else 
+      else
         raise ZuoraAPI::Exceptions::ZuoraAPIInternalServerError.new("Z:#{error}::#{message}", response, errors, success)
       end
     end
@@ -1093,7 +1095,7 @@ module ZuoraAPI
       session_type: :basic,
       timeout_retry: false,
       timeout: 130,
-      timeout_sleep_interval: self.timeout_sleep, 
+      timeout_sleep_interval: self.timeout_sleep,
       multipart: false,
       stream_body: false,
       output_exception_messages: true,
@@ -1152,7 +1154,7 @@ module ZuoraAPI
       end
       Rails.logger.debug("Rest Call - Session Bad Auth type")
       raise ex
-      
+
     rescue ZuoraAPI::Exceptions::ZuoraAPISessionError => ex
       if !tries.zero? && z_session
         tries -= 1
@@ -1169,13 +1171,13 @@ module ZuoraAPI
 
       raise ex if errors.include?(ex.class)
       return [output_json, response]
-      
+
     rescue *ZUORA_API_ERRORS => ex
       raise ex if errors.include?(ex.class)
-      
+
       response = ex.response unless response
       return [output_json, response]
-  
+
     rescue ZuoraAPI::Exceptions::BadEntityError => ex
       raise ex
     rescue *CONNECTION_EXCEPTIONS => ex
@@ -1187,8 +1189,8 @@ module ZuoraAPI
       end
 
       self.log(location: "Rest Call", exception: ex, message: "Timed out", level: :error) if output_exception_messages
-      raise ex 
-   
+      raise ex
+
     rescue *CONNECTION_READ_EXCEPTIONS => ex
 
       if !tries.zero?
@@ -1201,15 +1203,15 @@ module ZuoraAPI
           retry
         end
       end
-      
+
       self.log(location: "Rest Call", exception: ex, message: "Timed out", level: :error) if output_exception_messages
       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
       raise ex
-    ensure 
-      self.error_logger(ex) if defined?(ex) && Rails.logger.class.to_s == "Ougai::Logger"
+    ensure
+      self.error_logger(ex) if defined?(ex)
     end
 
     def update_create_tenant
@@ -1407,7 +1409,7 @@ module ZuoraAPI
           end
         end
       end
-      
+
       id = output_xml.xpath('//ns1:Id', 'ns1' =>'http://api.zuora.com/').text
 
       result = 'Waiting'
@@ -1451,7 +1453,7 @@ module ZuoraAPI
         retry
       end
       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")

data/lib/zuora_api/version.rb

@@ -1,3 +1,3 @@
 module ZuoraAPI
-  VERSION = "1.8.23"
+  VERSION = "1.9.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zuora_api
 version: !ruby/object:Gem::Version
-  version: 1.8.23
+  version: 1.9.0
 platform: ruby
 authors:
 - Zuora Strategic Solutions Group
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-12 00:00:00.000000000 Z
+date: 2021-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -70,16 +84,30 @@ dependencies:
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-cobertura
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.18.5
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.18.5
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ougai
   requirement: !ruby/object:Gem::Requirement
@@ -145,7 +173,7 @@ dependencies:
         version: 4.1.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -155,7 +183,7 @@ dependencies:
         version: 4.1.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
 description: Gem that provides easy integration to Zuora
 email:
 - connect@zuora.com
@@ -191,7 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: Gem that provides easy integration to Zuora