zuora_api 1.7.81 → 1.8.00

data/lib/zuora_api/logins/basic.rb

@@ -10,22 +10,113 @@ module ZuoraAPI
     end
 
     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?)
+      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?)
 
-        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?
+      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
           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
+
+      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   
+
+      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) if retrieved_session.blank?
-        self.current_session = retrieved_session
+        raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new("No session found for api call.", response_query) if retrieved_session.blank?
         self.status = 'Active'
+        self.current_session = retrieved_session
+      end
+      return self.status
+    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
+      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'
         return self.status
       end
     end

data/lib/zuora_api/logins/oauth.rb

@@ -12,18 +12,16 @@ module ZuoraAPI
     end
 
     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
+      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) if self.status == 'Active'
+      else
+        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
 
     def get_active_bearer_token
@@ -32,35 +30,59 @@ module ZuoraAPI
     end
     
     def get_z_session(debug: false, zuora_track_id: nil)
+      tries ||= 2
       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)
       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)
+        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.zero?
+        tries -= 1
+        Rails.logger.debug {"Session Invalid"}
+        self.new_session(auth_type: :bearer)
+        retry
+      end
+      raise ex if errors.include?(ex.class)
+      return [output_json, response]
+
+    rescue ZuoraAPI::Exceptions::ZuoraAPIError, ZuoraAPI::Exceptions::ZuoraAPIRequestLimit, ZuoraAPI::Exceptions::ZuoraAPILockCompetition  => ex
+      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
+        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(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,
-        timeout_retry: true,
-        headers: headers,
-        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,
+        :session_type => :bearer,
+        :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"]
@@ -70,6 +92,44 @@ module ZuoraAPI
       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 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.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
+      end
     end
 
     def oauth_expired?

data/lib/zuora_api/version.rb

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

data/zuora_api.gemspec

@@ -0,0 +1,30 @@
+# 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", "~> 1.12"
+  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_dependency("nokogiri")
+  spec.add_dependency("httparty")
+  spec.add_dependency("rubyzip")
+  spec.add_dependency("railties", ">= 4.1.0", "< 6")
+end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: zuora_api
 version: !ruby/object:Gem::Version
-  version: 1.7.81
+  version: 1.8.00
 platform: ruby
 authors:
 - Zuora Strategic Solutions Group
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-12 00:00:00.000000000 Z
+date: 2020-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.12'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -68,26 +68,12 @@ 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: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -145,7 +131,7 @@ dependencies:
         version: 4.1.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -155,7 +141,7 @@ dependencies:
         version: 4.1.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6'
 description: Gem that provides easy integration to Zuora
 email:
 - connect@zuora.com
@@ -163,9 +149,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- MIT-LICENSE
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
 - README.md
 - Rakefile
+- bin/console
+- bin/setup
 - lib/insights_api/login.rb
 - lib/zuora_api.rb
 - lib/zuora_api/exceptions.rb
@@ -173,6 +167,7 @@ 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: {}
@@ -191,7 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Gem that provides easy integration to Zuora

data/MIT-LICENSE

@@ -1,20 +0,0 @@
-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.