zuora_api 1.7.66 → 1.11.2

data/lib/zuora_api/logins/basic.rb

@@ -10,113 +10,22 @@ module ZuoraAPI
     end
 
     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?)
+      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
-
-      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_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.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'
+        self.status = 'Active'
         return self.status
       end
     end

data/lib/zuora_api/logins/oauth.rb

@@ -12,16 +12,18 @@ module ZuoraAPI
     end
 
     def new_session(auth_type: nil, zuora_track_id: nil)
-      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'
+      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
@@ -30,59 +32,37 @@ 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 = self.entity_header
       headers['Zuora-Track-Id'] = zuora_track_id if zuora_track_id.present?
+      headers['X-Amzn-Trace-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.headers.to_s)
-        raise ZuoraAPI::Exceptions::ZuoraAPIAuthenticationTypeError.new("Failure Parsing Cookie Headers")
+        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 
-    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 = {"Content-Type" => "application/x-www-form-urlencoded" }
       headers['Zuora-Track-Id'] = zuora_track_id if zuora_track_id.present?
+      headers['X-Amzn-Trace-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 => 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,
+        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"]
@@ -92,44 +72,6 @@ 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.66"
+  VERSION = "1.11.2"
 end

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

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: zuora_api
 version: !ruby/object:Gem::Version
-  version: 1.7.66
+  version: 1.11.2
 platform: ruby
 authors:
 - Zuora Strategic Solutions Group
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-02 00:00:00.000000000 Z
+date: 2022-10-03 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
@@ -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
@@ -80,6 +94,34 @@ dependencies:
     - - ">="
       - !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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ougai
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -129,9 +171,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.1.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -139,9 +178,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.1.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
 description: Gem that provides easy integration to Zuora
 email:
 - connect@zuora.com
@@ -149,17 +185,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".gitlab-ci.yml"
-- ".rspec"
-- ".travis.yml"
-- CHANGELOG.md
-- Gemfile
-- Gemfile.lock
+- MIT-LICENSE
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - lib/insights_api/login.rb
 - lib/zuora_api.rb
 - lib/zuora_api/exceptions.rb
@@ -167,7 +195,6 @@ 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: {}
@@ -186,7 +213,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Gem that provides easy integration to Zuora

data/.gitignore

@@ -1,10 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-.idea

data/.gitlab-ci.yml

@@ -1,63 +0,0 @@
-image: ruby:2.6
-stages:
-  - setup
-  - test
-  - deploy
-
-setup:
-  stage: setup
-  allow_failure: true
-  cache:
-    key: gems
-    paths:
-      - vendor/bundle
-  script:
-  - apt-get update -qy
-  - apt-get install -y nodejs
-  - bundle install
-
-rubocop-testing:
-  stage: test
-  allow_failure: true
-  script:
-  - gem install rubocop
-  - rubocop --lint
-
-security-testing:
-  stage: test
-  allow_failure: true
-  script:
-  - gem install brakeman
-  - brakeman
-
-rspec-testing:
-  stage: test
-  script:
-  - bundle install
-  - rspec
-
-rubygems-deploy:
-  stage: deploy
-  allow_failure: false
-  script:
-  - echo "deb http://ftp.us.debian.org/debian testing main contrib non-free" >> /etc/apt/sources.list
-  - apt-get update
-  - apt-get install -y git
-  - apt-get clean all
-  - gem install dpl
-  - if [[ "staging"  == $CI_BUILD_REF_SLUG ]];then  export VERSION=`git describe --match "[0-9]*\.[0-9]*\.[0-9]*[a-z]" --abbrev=0 --tags HEAD`; fi
-  - if [[ "master"  == $CI_BUILD_REF_SLUG ]];then export VERSION=`git describe --exclude "[0-9]*\.[0-9]*\.[0-9]*[a-z]" --abbrev=0 --tags HEAD`; fi
-  - echo $VERSION
-  - sed -i "s/0.0.1/$VERSION/" lib/zuora_api/version.rb
-  - git add lib/zuora_api/version.rb
-  - git config --global user.email "connect@zuora.com"
-  - git config --global user.name "Connect Automation"
-  - git commit -m "Automated Version Update $VERSION"
-  - bundle install
-  - gem install rake
-  - version=$(rake install | grep -o 'pkg/zuora_api-.*gem')
-  - curl -u $USERNAME:$PASSWORD https://rubygems.org/api/v1/api_key.yaml > ~/.gem/credentials; chmod 0600 ~/.gem/credentials
-  - gem push $version
-  only:
-    - master
-    - staging

data/.rspec

@@ -1,2 +0,0 @@
---format documentation
---color

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.3.0
-before_install: gem install bundler -v 1.12.5

data/CHANGELOG.md

@@ -1,105 +0,0 @@
-# Changelog
-All notable changes to this project will be documented in this file.
-
-## [1.7.07] - 2018-9-10
-### Changed
-- Cookie name for service endpoint integration
-
-## [1.7.06] - 2018-8-25
-### Added
-- Retry for 502/503
-- Standard exception for 504
-
-## [1.7.05] - 2018-8-25
-### Added
-- Added support for oauth token forbidden
-
-## [1.7.02] - 2018-8-23
-### Added
-- Added mulit part support for rest call
-
-## [1.7.01] - 2018-8-06
-### Changed
-- Changed library used to determine host
-- Added retry for 504 timouts in file download
-
-## [1.7.00] - 2018-8-05
-### Changed
-- Raise proper exception when oauth client is from deactivated user.
-- Support for rails < 6
-
-## [1.6.53] - 2018-7-29
-### Changed
-- Don't attempt zsession login if bearer token is bad
-
-## [1.6.51 - 1.6.51] - 2018-7-22
-### Changed
-- Retry on address not available.
-
-## [1.6.47 - 1.6.48] - 2018-6-26
-### Changed
-- Changed error raise statements when incorrect credentials are supplied to Basic/Oauth Logins
-
-## [1.6.45] - 2018-5-30
-### Changed
-- Fix retry so headers are reinstaniated on session failure. 
-
-## [1.6.41] - 2018-5-30
-### Changed
-- Retry added on SSL connection failure
-
-## [1.6.39-1.6.40] - 2018-5-30
-### Changed
-- Added validation to fix bad urls entered into object initialization
-
-## [1.6.38] - 2018-5-26
-### Changed
-- HttpParty validation before code extraction
-
-## [1.6.37] - 2018-5-23
-### Added
-- Added method to determine rest endpoint domain
-
-## [1.6.36] - 2018-5-22
-### Changed
-- Fixed zuora staging 2 endpoint
-
-## [1.6.33] - 2018-5-15
-### Changed
-- Added Errno::EHOSTUNREACH to list of retriable error codes
-
-## [1.6.32] - 2018-5-14
-### Changed
-- Don't log fatal errors, allow application to decide for file download
-- Don't change api url if the user set a high api url
-
-###Removed
-- Force encoding
-
-## [1.6.28] - 2018-3-12
-### Added
-- Way to avoid force encoding for filedownload
-
-## [1.6.28] - 2018-3-12
-### Added
-- Way to avoid force encoding for filedownload
-
-## [1.6.22] - 2019-01-03
-### Changed
-- get_identity method - supports ZSession auth now
-- updated rspecs accordingly
-
-## [1.6.18] - 2018-12-06
-### Added
-- zconnect_provider attribute accessor for identifying ZConnect cookies
-- Methods for Hallway integration:
-- get_identity
-- get_full_nav
-- set_nav
-- refresh_nav
-- get_oauth_client
-
-### Changed
-- The way environment and region are set
-
-

data/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in zuora.gemspec
-gemspec