zuora_api 1.7.05 → 1.7.7e

data/lib/zuora_api/logins/basic.rb

@@ -9,105 +9,23 @@ module ZuoraAPI
       super
     end
 
-    def new_session(auth_type: :basic, debug: false)
-      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?)
+    def new_session(auth_type: :basic, debug: false, zuora_track_id: nil)
+      super do 
+        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?)
 
-      tries ||= 2
-      request = Nokogiri::XML::Builder.new do |xml|
-        xml['SOAP-ENV'].Envelope('xmlns:SOAP-ENV' =>"http://schemas.xmlsoap.org/soap/envelope/", 'xmlns:api' => "http://api.zuora.com/" ) do
-          xml['SOAP-ENV'].Header
-          xml['SOAP-ENV'].Body do
-            xml['api'].login do
-              xml['api'].username self.username
-              xml['api'].password self.password
-              xml['api'].entityId self.entity_id if !self.entity_id.blank?
-            end
+        output_xml, input_xml, response = soap_call(timeout_retry: true, skip_session: true, zuora_track_id: zuora_track_id) do |xml|
+          xml['api'].login do
+            xml['api'].username self.username
+            xml['api'].password self.password
+            xml['api'].entityId self.entity_id if !self.entity_id.blank?
           end
         end
-      end
-      
-      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)
-      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   
-
-      if !response_query.success?
-        self.current_session = nil
-        if output_xml.namespaces.size > 0  && output_xml.xpath('//soapenv:Fault').size > 0
-          self.current_error = output_xml.xpath('//fns:FaultMessage', 'fns' =>'http://fault.api.zuora.com/').text
-          if self.current_error.include?('deactivated')
-            self.status = 'Deactivated'
-            self.current_error = 'Deactivated user login, please check with Zuora tenant administrator'
-            self.errors[:username] = self.current_error
-          elsif self.current_error.include?('inactive')
-            self.status = 'Inactive'
-            self.current_error = 'Inactive user login, please check with Zuora tenant administrator'
-            self.errors[:username] = self.current_error
-          elsif self.current_error.include?("invalid username or password") || self.current_error.include?("Invalid login. User name and password do not match.")
-            self.status = 'Invalid Login'
-            self.current_error = 'Invalid login, please check username and password or URL endpoint'
-            self.errors[:username] = self.current_error
-            self.errors[:password] = self.current_error
-          elsif self.current_error.include?('unsupported version')
-            self.status = 'Unsupported API Version'
-            self.current_error = 'Unsupported API version, please verify URL endpoint'
-            self.errors[:url] = self.current_error
-          elsif self.current_error.include?('invalid api version')
-            self.status = 'Invalid API Version'
-            self.current_error = 'Invalid API version, please verify URL endpoint'
-            self.errors[:url] = self.current_error
-          elsif self.current_error.include?('invalid session')
-            self.status = 'Invalid Session'
-            self.current_error = 'Session invalid, please update session and verify URL endpoint'
-            self.errors[:session] = self.current_error
-          elsif self.current_error.include?('Your IP address')
-            self.status = 'Restricted IP'
-            self.current_error = 'IP restricted, contact Zuora tenant administrator and remove IP restriction'
-            self.errors[:base] = self.current_error
-          elsif self.current_error.include?('This account has been locked')
-            self.status = 'Locked'
-            self.current_error = 'Locked user login, please wait or navigate to Zuora to unlock user'
-            self.errors[:username] = self.current_error
-          elsif self.current_error.include?('Entity not exist:')
-            self.status = 'Entity Missing'
-            self.errors[:base] = self.current_error
-          else
-            self.status = 'Unknown'
-            self.current_error =  output_xml.xpath('//faultstring').text if self.current_error.blank?
-            self.errors[:base] = self.current_error
-          end
 
-        else
-          self.status = 'Unknown'
-          self.current_error =  output_xml.xpath('//faultstring').text if self.current_error.blank?
-          self.errors[:base] = self.current_error
-        end
-      else             
-        #Username & password combo
         retrieved_session = output_xml.xpath('//ns1:Session', 'ns1' =>'http://api.zuora.com/').text
-        raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new("No session found for api call.", response_query) if retrieved_session.blank?
-        self.status = 'Active'
+        raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new("No session found for api call.", response) if retrieved_session.blank?
         self.current_session = retrieved_session
-      end
-      return self.status
-    rescue *(CONNECTION_EXCEPTIONS + CONNECTION_READ_EXCEPTIONS) => ex
-      if !(tries -= 1).zero?
-        Rails.logger.info {"#{ex.class} Timed out will retry after 5 seconds"}
-        sleep(self.timeout_sleep)
-        retry
-      else
-        self.current_error = "Request timed out. Try again"
-        self.status = 'Timeout'
-        return self.status
-      end
-    rescue EOFError
-      if self.url.match?(/.*services\d{1,}.zuora.com*/)
-        self.current_error = "Services tenant '#{self.url.scan(/.*\/\/(services\d{1,}).zuora.com*/).last.first}' is no longer available."
-        self.status = 'Not Available'
+        self.status = 'Active'
         return self.status
       end
     end

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,17 +11,19 @@ module ZuoraAPI
       super
     end
 
-    def new_session(raise_errors: false, auth_type: nil)
-      if auth_type ==  :bearer
-        get_bearer_token()
-      elsif auth_type == :basic
-        get_bearer_token() if self.oauth_expired?
-        get_z_session() if self.status == 'Active'
-      else
-        get_bearer_token()
-        get_z_session() if self.status == 'Active'
+    def new_session(auth_type: nil, zuora_track_id: nil)
+      super do
+        if auth_type ==  :bearer
+          get_bearer_token(zuora_track_id: zuora_track_id)
+        elsif auth_type == :basic
+          get_bearer_token(zuora_track_id: zuora_track_id) if self.oauth_expired?
+          get_z_session(zuora_track_id: zuora_track_id)
+        else
+          get_bearer_token(zuora_track_id: zuora_track_id) if self.oauth_expired?
+          get_z_session(zuora_track_id: zuora_track_id) 
+        end
+        return self.status
       end
-      return self.status
     end
 
     def get_active_bearer_token
@@ -29,85 +31,45 @@ module ZuoraAPI
       return self.bearer_token
     end
     
-    def get_z_session(debug: false)
-      tries ||= 2
-      headers = self.entity_id.present? ? {"Zuora-Entity-Ids" => self.entity_id } : {}    
+    def get_z_session(debug: false, zuora_track_id: nil)
+      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
-      if !(tries -= 1).zero?
-        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
-    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 + CONNECTION_READ_EXCEPTIONS) => ex
-      if !(tries -= 1).zero?
-        Rails.logger.info {"#{ex.class} Timed out will retry after 5 seconds"}
-        sleep(self.timeout_sleep)
-        retry
-      else
-        self.current_error = "Request timed out. Try again"
-        self.status = 'Timeout'
-        return self.status
-      end
+      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: {
+            status: response.code,
+            params: response.body.to_s,
+            headers: response.headers.to_s,
+          }
+        })
+        raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new("Failure Parsing Cookie Headers", response)
+      end 
     end
 
-    def get_bearer_token
-      tries ||= 2
+    def get_bearer_token(zuora_track_id: nil)
       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"},
-        :body => {"client_id"=> self.oauth_client_id, "client_secret"=>self.oauth_secret, "grant_type" =>"client_credentials"}
+        url: self.rest_endpoint.chomp('v1/').concat("oauth/token"), 
+        z_session: false,
+        timeout_retry: true,
+        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::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.status = 'Deactivated'
-      else
-        self.current_error = "Invalid login, please check client ID and Client Secret or URL endpoint"
-        self.status = 'Invalid Login'
-      end
-
-      return self.status
-    rescue ZuoraAPI::Exceptions::ZuoraAPIError, ZuoraAPI::Exceptions::ZuoraAPIRequestLimit, ZuoraAPI::Exceptions::ZuoraAPILockCompetition  => ex
-      raise ex
-    rescue *(CONNECTION_EXCEPTIONS + CONNECTION_READ_EXCEPTIONS) => ex
-      if !(tries -= 1).zero?
-        Rails.logger.info {"#{ex.class} Timed out will retry after 5 seconds"}
-        sleep(self.timeout_sleep)
-        retry
-      else
-        self.current_error = "Invalid login, please check client ID and Client Secret or URL endpoint"
-        self.status = 'Timeout'
-        return self.status
-      end
     end
 
     def oauth_expired?

data/lib/zuora_api/version.rb

@@ -1,3 +1,3 @@
 module ZuoraAPI
-  VERSION = "1.7.05"
+  VERSION = "1.7.7e"
 end

data/zuora_api.gemspec

@@ -18,13 +18,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.12"
+  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")
+  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")
+  spec.add_dependency 'railties', '>= 4.1.0', '< 6.1'
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: zuora_api
 version: !ruby/object:Gem::Version
-  version: 1.7.05
+  version: 1.7.7e
 platform: ruby
 authors:
 - Zuora Strategic Solutions Group
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-25 00:00:00.000000000 Z
+date: 2020-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -68,12 +68,26 @@ dependencies:
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+- !ruby/object:Gem::Dependency
+  name: ougai
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -131,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
@@ -141,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
@@ -160,6 +174,10 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- gemfiles/Gemfile-rails.5.0.x
+- gemfiles/Gemfile-rails.5.1.x
+- gemfiles/Gemfile-rails.5.2.x
+- gemfiles/Gemfile-rails.6.0.x
 - lib/insights_api/login.rb
 - lib/zuora_api.rb
 - lib/zuora_api/exceptions.rb
@@ -182,11 +200,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Gem that provides easy integration to Zuora