zuora_api 1.7.00 → 1.8.00

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   
 
@@ -94,12 +97,18 @@ module ZuoraAPI
         self.current_session = retrieved_session
       end
       return self.status
-    rescue *(CONNECTION_EXCEPTIONS).concat(CONNECTION_READ_EXCEPTIONS) => ex 
-      if !(tries -= 1).zero?
-        Rails.logger.info {"#{ex.class} Timed out will retry after 5 seconds"}
+    rescue *(CONNECTION_EXCEPTIONS + CONNECTION_READ_EXCEPTIONS) => ex
+      if !tries.zero?
+        tries -= 1
         sleep(self.timeout_sleep)
         retry
       else
+        if Rails.logger.class.to_s == "Ougai::Logger"
+          Rails.logger.error("BasicLogin - Timed out", ex) 
+        else
+          Rails.logger.error("BasicLogin - #{ex.class} Timed out") 
+        end
+
         self.current_error = "Request timed out. Try again"
         self.status = 'Timeout'
         return self.status

data/lib/zuora_api/logins/oauth.rb

@@ -1,6 +1,6 @@
 module ZuoraAPI
   class Oauth < Login
-    attr_accessor :oauth_client_id, :oauth_secret, :bearer_token, :oauth_session_expires_at
+    attr_accessor :oauth_client_id, :oauth_secret, :bearer_token, :oauth_session_expires_at, :scope_entities
     
     def initialize(oauth_client_id: nil, oauth_secret: nil, bearer_token: nil, oauth_session_expires_at: nil, **keyword_args)
       self.oauth_client_id = oauth_client_id
@@ -11,15 +11,15 @@ module ZuoraAPI
       super
     end
 
-    def new_session(raise_errors: false, auth_type: nil)
+    def new_session(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,66 +29,83 @@ 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', '=')
+      begin
+        self.current_session = response.headers.to_h['set-cookie'][0].split(';')[0].split('=',2)[1].gsub('%3D', '=')
+      rescue NoMethodError => ex 
+        Rails.logger.fatal("Failure Parsing Cookie Headers", response.headers.to_s)
+        raise ZuoraAPI::Exceptions::ZuoraAPIAuthenticationTypeError.new("Failure Parsing Cookie Headers")
+      end 
     rescue ZuoraAPI::Exceptions::ZuoraAPISessionError => ex
-      if !(tries -= 1).zero?
+      if !tries.zero?
+        tries -= 1
         Rails.logger.debug {"Session Invalid"}
         self.new_session(auth_type: :bearer)
         retry
-      else
-        if errors.include?(ex.class)
-          raise ex
-        else
-          return [output_json, response]
-        end
       end
+      raise ex if errors.include?(ex.class)
+      return [output_json, response]
+
     rescue ZuoraAPI::Exceptions::ZuoraAPIError, ZuoraAPI::Exceptions::ZuoraAPIRequestLimit, ZuoraAPI::Exceptions::ZuoraAPILockCompetition  => ex
-      if errors.include?(ex.class)
-        raise ex
-      else
-        return [output_json, response]
-      end
-    rescue *(CONNECTION_EXCEPTIONS).concat(CONNECTION_READ_EXCEPTIONS) => ex
-      if !(tries -= 1).zero?
-        Rails.logger.info {"#{ex.class} Timed out will retry after 5 seconds"}
+      raise ex if errors.include?(ex.class)
+      return [output_json, response]
+
+    rescue *(CONNECTION_EXCEPTIONS + CONNECTION_READ_EXCEPTIONS) => ex
+      if !tries.zero?
+        tries -= 1
         sleep(self.timeout_sleep)
         retry
+      end
+      if Rails.logger.class.to_s == "Ougai::Logger"
+        Rails.logger.error("OAuthLogin - Timed out", ex) 
       else
-        self.current_error = "Request timed out. Try again"
-        self.status = 'Timeout'
-        return self.status
+        Rails.logger.error("OAuthLogin - #{ex.class} Timed out") 
       end
+      self.current_error = "Request timed out. Try again"
+      self.status = 'Timeout'
+      return self.status
     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"}
       )
 
       self.bearer_token = output_json["access_token"]
+      self.scope_entities = output_json.fetch('scope', '').split(" ").map { |scope| scope.split('.').last.gsub('-', '') if scope.include?('entity.') }.compact.uniq
       self.oauth_session_expires_at = Time.now.to_i + output_json["expires_in"].to_i
       self.current_error = nil
       self.status = 'Active'
 
       return self.status
+
+    rescue ZuoraAPI::Exceptions::ZuoraAPIInternalServerError => ex
+      raise ex if tries.zero?
+
+      tries -= 1
+      sleep(self.timeout_sleep)
+      retry
     rescue ZuoraAPI::Exceptions::ZuoraAPISessionError => ex
       self.bearer_token = nil
       self.oauth_session_expires_at = nil
       self.current_error = ex.message
       case ex.message
       when "Forbidden"
-        self.current_error = "The user associated to OAuth credential, '#{self.oauth_client_id}', set has been deactivated."
+        self.current_error = "The user associated to OAuth credential set has been deactivated."
         self.status = 'Deactivated'
       else
         self.current_error = "Invalid login, please check client ID and Client Secret or URL endpoint"
@@ -98,12 +115,17 @@ module ZuoraAPI
       return self.status
     rescue ZuoraAPI::Exceptions::ZuoraAPIError, ZuoraAPI::Exceptions::ZuoraAPIRequestLimit, ZuoraAPI::Exceptions::ZuoraAPILockCompetition  => ex
       raise ex
-    rescue *(CONNECTION_EXCEPTIONS).concat(CONNECTION_READ_EXCEPTIONS) => ex
-      if !(tries -= 1).zero?
-        Rails.logger.info {"#{ex.class} Timed out will retry after 5 seconds"}
+    rescue *(CONNECTION_EXCEPTIONS + CONNECTION_READ_EXCEPTIONS) => ex
+      if !tries.zero?
+        tries -= 1
         sleep(self.timeout_sleep)
         retry
       else
+        if Rails.logger.class.to_s == "Ougai::Logger"
+          Rails.logger.error("OAuthLogin - Timed out will retry after #{self.timeout_sleep} seconds", ex) 
+        else
+          Rails.logger.error("OAuthLogin - #{ex.class} Timed out will retry after #{self.timeout_sleep} seconds") 
+        end
         self.current_error = "Invalid login, please check client ID and Client Secret or URL endpoint"
         self.status = 'Timeout'
         return self.status

data/lib/zuora_api/version.rb

@@ -1,3 +1,3 @@
 module ZuoraAPI
-  VERSION = "1.7.00"
+  VERSION = "1.8.00"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zuora_api
 version: !ruby/object:Gem::Version
-  version: 1.7.00
+  version: 1.8.00
 platform: ruby
 authors:
 - Zuora Strategic Solutions Group
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-05 00:00:00.000000000 Z
+date: 2020-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler