zuora_api 1.7.13 → 1.7.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62968a91f99405f15607b43a289b27eb23a4772a9b16d9be9616db09ddc2730e
-  data.tar.gz: 39a1210526da151191e137a2606ba8726926b563a9520b2b06214cd41649d362
+  metadata.gz: 1341b77e28327eae9e39ecf734228e3e17d1588547521f82b146535b1bd5b624
+  data.tar.gz: a0885a72edd3a19ecc0d78df21de5b853344686a1576048143738c6adedbc536
 SHA512:
-  metadata.gz: e317dc4c7584e3632a16166dd7cf874b3fc03b6bc9d34712d8c4380a82f358fc06720e7a813271022791ab1df7f30d4e8fbeb9bfa5e2951338038b959dc37746
-  data.tar.gz: 35bc55f8d0f1c035a8f6dfa18e61248fe56d2d5c4a46de65ba2480ae3f5748b9509fd9313c6208eae97d9fd6b9298d925ec99006d69e76894f7ddd7497238e99
+  metadata.gz: 1e5af953d2398afbe87dcc58abe3875d62534af545969d4cef868d622546fb86cbcf2028dc061733f164f72881b34835e5cf53dcf183b5aa543c58ca060393bb
+  data.tar.gz: 9af30e6797dc920c78bb8f075b0e72a02ee532645c457fe91eb87156bf57590706b91e275ad1f711b82bda8f7831639b31ad56bb2434ecfa48df8c94b8dc39f4

data/lib/zuora_api/login.rb

@@ -382,10 +382,10 @@ module ZuoraAPI
       return self.wsdl_number > 68 ? '%Y-%m-%d' : '%Y-%m-%dT%H:%M:%S'
     end
 
-    def new_session(auth_type: :basic, debug: false)
+    def new_session(auth_type: :basic, debug: false, zuora_track_id: nil)
     end
 
-    def get_session(prefix: false, auth_type: :basic)
+    def get_session(prefix: false, auth_type: :basic, zuora_track_id: nil)
       Rails.logger.debug("Get session for #{auth_type} - #{self.class.to_s}") if Rails.env.to_s == 'development'
       case auth_type
       when :basic
@@ -393,13 +393,13 @@ module ZuoraAPI
           case self.class.to_s
           when 'ZuoraAPI::Oauth'
             if self.bearer_token.blank? || self.oauth_expired?
-              self.new_session(auth_type: :bearer)
+              self.new_session(auth_type: :bearer, zuora_track_id: zuora_track_id)
             end
-            self.get_z_session if self.status == 'Active'
+            self.get_z_session(zuora_track_id: zuora_track_id) if self.status == 'Active'
           when 'ZuoraAPI::Basic'
-            self.new_session(auth_type: :basic)
+            self.new_session(auth_type: :basic, zuora_track_id: zuora_track_id)
           else
-            self.new_session(auth_type: :basic)
+            self.new_session(auth_type: :basic, zuora_track_id: zuora_track_id)
           end
         end
         raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new(self.current_error) if self.status != 'Active'
@@ -408,7 +408,7 @@ module ZuoraAPI
         case self.class.to_s
         when 'ZuoraAPI::Oauth'
           if self.bearer_token.blank? || self.oauth_expired?
-            self.new_session(auth_type: :bearer)
+            self.new_session(auth_type: :bearer, zuora_track_id: zuora_track_id)
           end
         when 'ZuoraAPI::Basic'
           raise ZuoraAPI::Exceptions::ZuoraAPIAuthenticationTypeError.new("Basic Login, does not support Authentication of Type: #{auth_type}")
@@ -421,7 +421,7 @@ module ZuoraAPI
       end
     end
 
-    def soap_call(ns1: 'ns1', ns2: 'ns2', batch_size: nil, single_transaction: false, debug: false, errors: [ZuoraAPI::Exceptions::ZuoraAPISessionError].concat(ZUORA_API_ERRORS), z_session: true, timeout_retry: false, timeout: 120,**keyword_args)
+    def soap_call(ns1: 'ns1', ns2: 'ns2', batch_size: nil, single_transaction: false, debug: false, zuora_track_id: nil, errors: [ZuoraAPI::Exceptions::ZuoraAPISessionError].concat(ZUORA_API_ERRORS), z_session: true, timeout_retry: false, timeout: 120,**keyword_args)
       tries ||= 2
       xml = Nokogiri::XML::Builder.new do |xml|
         xml['SOAP-ENV'].Envelope('xmlns:SOAP-ENV' => "http://schemas.xmlsoap.org/soap/envelope/",
@@ -431,7 +431,7 @@ module ZuoraAPI
                                  "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)
+              xml["#{ns1}"].session self.get_session(prefix: false, auth_type: :basic, zuora_track_id: zuora_track_id)
             end
             if single_transaction
               xml["#{ns1}"].CallOptions do
@@ -454,7 +454,15 @@ module ZuoraAPI
       input_xml.xpath('//ns1:session', 'ns1' =>'http://api.zuora.com/').children.remove
       Rails.logger.debug("Request SOAP XML: #{input_xml.to_xml(:save_with => XML_SAVE_OPTIONS).strip}") if debug
 
-      response = HTTParty.post(self.url,:body => xml.doc.to_xml(:save_with => XML_SAVE_OPTIONS).strip, :headers => {'Content-Type' => "text/xml; charset=utf-8"}, :timeout => timeout)
+      headers = { 'Content-Type' => "text/xml; charset=utf-8" }
+      headers['Zuora-Track-Id'] = zuora_track_id if zuora_track_id.present?
+
+      response = HTTParty.post(
+        self.url,
+        :body => xml.doc.to_xml(:save_with => XML_SAVE_OPTIONS).strip,
+        :headers => headers,
+        :timeout => timeout
+      )
       output_xml = Nokogiri::XML(response.body)
       Rails.logger.debug("Response SOAP XML: #{output_xml.to_xml(:save_with => XML_SAVE_OPTIONS).strip}") if debug
 
@@ -462,7 +470,7 @@ module ZuoraAPI
     rescue ZuoraAPI::Exceptions::ZuoraAPISessionError => ex
       if !(tries -= 1).zero? && z_session
         Rails.logger.debug("SOAP Call - Session Invalid")
-        self.new_session(auth_type: :basic)
+        self.new_session(auth_type: :basic, zuora_track_id: zuora_track_id)
         retry
       else
         if errors.include?(ex.class)

data/lib/zuora_api/logins/basic.rb

@@ -9,7 +9,7 @@ module ZuoraAPI
       super
     end
 
-    def new_session(auth_type: :basic, debug: false)
+    def new_session(auth_type: :basic, debug: false, zuora_track_id: nil)
       raise ZuoraAPI::Exceptions::ZuoraAPIAuthenticationTypeError.new("Basic Login, does not support Authentication of Type: #{auth_type}") if auth_type != :basic
       raise ZuoraAPI::Exceptions::ZuoraAPIAuthenticationTypeError.new("Request Basic Login but either 'Username' or 'Password' were not passed.") if (self.password.blank? && self.username.blank?)
 
@@ -30,8 +30,11 @@ module ZuoraAPI
       input_xml = Nokogiri::XML(request.to_xml(:save_with => XML_SAVE_OPTIONS).strip)
       input_xml.xpath('//ns1:session', 'ns1' =>'http://api.zuora.com/').children.remove
       Rails.logger.debug('Connect') {"SOAP XML: #{input_xml.to_xml(:save_with => XML_SAVE_OPTIONS).strip}"} if debug
-      
-      response_query = HTTParty.post(self.url,:body => request.to_xml(:save_with => XML_SAVE_OPTIONS).strip, :headers => {'Content-Type' => "text/xml; charset=utf-8"}, :timeout => 10)
+
+      headers = { 'Content-Type' => "text/xml; charset=utf-8" }
+      headers['Zuora-Track-Id'] = zuora_track_id if zuora_track_id.present?
+
+      response_query = HTTParty.post(self.url,:body => request.to_xml(:save_with => XML_SAVE_OPTIONS).strip, :headers => headers, :timeout => 10)
       output_xml = Nokogiri::XML(response_query.body)
       Rails.logger.debug('Connect') {"Response Code: #{response_query.code} SOAP XML: #{output_xml.to_xml(:save_with => XML_SAVE_OPTIONS).strip}"} if debug   
 

data/lib/zuora_api/logins/oauth.rb

@@ -11,15 +11,15 @@ module ZuoraAPI
       super
     end
 
-    def new_session(raise_errors: false, auth_type: nil)
+    def new_session(raise_errors: false, auth_type: nil, zuora_track_id: nil)
       if auth_type ==  :bearer
-        get_bearer_token()
+        get_bearer_token(zuora_track_id: zuora_track_id)
       elsif auth_type == :basic
-        get_bearer_token() if self.oauth_expired?
-        get_z_session() if self.status == 'Active'
+        get_bearer_token(zuora_track_id: zuora_track_id) if self.oauth_expired?
+        get_z_session(zuora_track_id: zuora_track_id) if self.status == 'Active'
       else
-        get_bearer_token()
-        get_z_session() if self.status == 'Active'
+        get_bearer_token(zuora_track_id: zuora_track_id)
+        get_z_session(zuora_track_id: zuora_track_id) if self.status == 'Active'
       end
       return self.status
     end
@@ -29,9 +29,10 @@ module ZuoraAPI
       return self.bearer_token
     end
     
-    def get_z_session(debug: false)
+    def get_z_session(debug: false, zuora_track_id: nil)
       tries ||= 2
-      headers = self.entity_id.present? ? {"Zuora-Entity-Ids" => self.entity_id } : {}    
+      headers = self.entity_id.present? ? {"Zuora-Entity-Ids" => self.entity_id } : {}
+      headers['Zuora-Track-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)
       self.current_session = response.headers.to_h['set-cookie'][0].split(';')[0].split('=',2)[1].gsub('%3D', '=')
     rescue ZuoraAPI::Exceptions::ZuoraAPISessionError => ex
@@ -64,15 +65,18 @@ module ZuoraAPI
       end
     end
 
-    def get_bearer_token
+    def get_bearer_token(zuora_track_id: nil)
       tries ||= 2
       raise ZuoraAPI::Exceptions::ZuoraAPIAuthenticationTypeError.new("Request Oauth Login but either 'Oauth Client Id' or 'Oauth Secret' were not passed") if self.oauth_client_id.blank? || self.oauth_secret.blank?
 
+      headers = { "content-type" => "application/x-www-form-urlencoded" }
+      headers['Zuora-Track-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"), 
         :z_session => false,
         :session_type => :bearer,
-        :headers => {"content-type" => "application/x-www-form-urlencoded"},
+        :headers => headers,
         :body => {"client_id"=> self.oauth_client_id, "client_secret"=>self.oauth_secret, "grant_type" =>"client_credentials"}
       )
 

data/lib/zuora_api/version.rb

@@ -1,3 +1,3 @@
 module ZuoraAPI
-  VERSION = "1.7.13"
+  VERSION = "1.7.14"
 end

metadata

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