zuora_api 1.7.66j → 1.7.80

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46c1d463bc291f1e674a92bc6dc28a35cb9df005a5e773124d752f624ebc9890
-  data.tar.gz: bda2d5483c779155ebffd6e7b7f0472f6a19410f0dc47c168449acd3b31378f8
+  metadata.gz: b0865872f720e280a3a4805d314d27a3e2649b861495f80cf8523f4eb43f2c1e
+  data.tar.gz: cc80008e33f6b47245acc1a0b8cdb0ec326f4a714c842e434b25bd5643e94123
 SHA512:
-  metadata.gz: a979bfcd6e7e668d0a87f097973b86b174d977862d002e7a2a60413e98d4a7481345a5a318ba5906b69ee0fdd8d9a18a96494ec93b476a7a16a3137a38352ca9
-  data.tar.gz: 794dd0825636ab56d6aa5008fc9a7d9bd0f5e136db6223d426032b4eee16fd3e942842206c5ad39d50e5fa28aab44f7dc2bfa1f779027e03e6ff2e3fedd81075
+  metadata.gz: 051c3a5244695357f0ecf6a42ee1eda7981c0145ed3b50d9e0b751dbbdf6e4aba1d7e36e69eec28056e2fb3b56888c48113699d32ab0f6479272e339b3c1ade2
+  data.tar.gz: f20c6fd7e534de55b5b94120e812ba19e18fda5f41e63f8f9183fb66d8ea4a0a01f441918d84196b2aa027724228b63332f54aea94b9515142534d5fff15574c

data/.gitignore

@@ -7,4 +7,5 @@
 /pkg/
 /spec/reports/
 /tmp/
-.idea
+.idea
+.DS_Store

data/.gitlab-ci.yml

@@ -1,21 +1,8 @@
 image: ruby:2.7
 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
@@ -30,11 +17,23 @@ security-testing:
   - gem install brakeman
   - brakeman
 
-rspec-testing:
+ruby:test:
   stage: test
+  cache:
+    key: ruby:$RUBY_VERSION-rails:$RAILS_VERSION
+    paths:
+      - vendor/ruby
+  parallel:
+    matrix:
+      - RUBY_VERSION: "2.7"
+        RAILS_VERSION: ["5.0", "5.1", "5.2", "6.0"]
+  before_script:
+    - bundle config set path 'vendor/ruby'
+    - bundle config --global gemfile "gemfiles/Gemfile-rails.$RAILS_VERSION.x"
+    - bundle install
   script:
-  - bundle install
-  - rspec
+    - bundle exec rails -v
+    - bundle exec rspec
   coverage: '/\(\d+.\d+\%\) covered/'
 
 rubygems-deploy:

data/Gemfile

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

data/catalog-info.yaml

@@ -0,0 +1,12 @@
+---
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  annotations:
+    backstage.io/techdocs-ref: "gitlab:https://gitlab.zeta.tools/extension-products/shared-libraries/zuora-gem.git"
+  description: "Zuora API Rails Gem"
+  name: Zuora-Gem
+spec:
+  lifecycle: production
+  owner: connect@zuora.com
+  type: library

data/docs/index.md

@@ -0,0 +1,147 @@
+# Zuora Gem
+
+[![Gem Version](https://badge.fury.io/rb/zuora_api.svg)](https://badge.fury.io/rb/zuora_api) [![coverage report](https://gitlab.0.ecc.auw2.zuora/extension-products/shared-libraries/zuora-gem/badges/master/coverage.svg)](https://gitlab.0.ecc.auw2.zuora/extension-products/shared-libraries/zuora-gem/commits/master)
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zuora_api'
+```
+Then execute `bundle install` in your terminal
+
+## Usage
+
+### Zuora Login Object
+In order to make API calls a Zuora Login object must be created
+
+```ruby
+zuora_client = ZuoraAPI::Login.new(username: "username", password: "password", url: "url")
+```
+
+|        Name         |    Type     |                                       Description                                        |                                                                       Example                                                                       |
+| ------------------- | ----------- | ---------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
+| username            | `Attribute` | Username to the Zuora environment                                                        | `zuora_client.username = "username"`                                                                                                                |
+| password            | `Attribute` | password to the Zuora environment                                                        | `zuora_client.password = "Password"`                                                                                                                |
+| url                 | `Attribute` | Endpoint to the Zuora tenant                                                             | `zuora_client.url = "www.zuora.com"`                                                                                                                |
+| wsdl_number         | `Attribute` | WSDL number of the zuora login                                                           | `wsdl = zuora_client.wsdl_number`                                                                                                                   |
+| status              | `Attribute` | Status of the login                                                                      | `zuora_client.status`                                                                                                                               |
+| current_session     | `Attribute` | Current session for the login                                                            | `zuora_client.current_session`                                                                                                                      |
+| environment         | `Attribute` | environment of the login                                                                 | `zuora_client.environment`                                                                                                                          |
+| errors              | `Attribute` | Any errors that the login has based on the login call                                    | `zuora_client.errors`                                                                                                                               |
+| current_error       | `Attribute` | Current error from the new_session call                                                  | `zuora_client.current_error`                                                                                                                        |
+| user_info           | `Attribute` | Information related to the login                                                         | `zuora_client.user_info`                                                                                                                            |
+| tenant_id           | `Attribute` | Tenant ID the login is associated to                                                     | `zuora_client.tenant_id`                                                                                                                            |
+| tenant_name         | `Attribute` | Tenant Name of tenant the login is associated to                                         | `zuora_client.tenant_name`                                                                                                                          |
+| entity_id           | `Attribute` | Current entity the login session is associated to                                        | `zuora_client.entity_id`                                                                                                                            |
+| rest_call           | `Method`    | Executes a REST call                                                                     | `zuora_client.rest_call()`                                                                                                                          |
+| soap_call           | `Method`    | Executes a SOAP call                                                                     | `output_xml, input_xml = zuora_client.soap_call() do `|xml, args|` xml['ns1'].query do xml['ns1'].queryString "select id, name from account" end end` |
+| query               | `Method`    | Executes a query call                                                                    | `zuora_client.query("select id, name from account")`                                                                                                |
+| getDataSourceExport | `Method`    | Pulls a data source export with the given query and returns the file location            | `zuora_client.getDataSourceExport("select id, name from account")`                                                                                  |
+| describe_call       | `Method`    | Performs the describe call against the Zuora tenant for all objects or a specific object | `response = zuora_client.describe_call("Account")`                                                                                                  |
+| createJournalRun    | `Method`    | Creates a Journal Run                                                                    | `zuora_client.createJournalRun(call)`                                                                                                               |
+| checkJRStatus       | `Method`    | Checks the status of a journal run                                                       | `zuora_client.checkJRStatus(journal_run_id)`                                                                                                        |
+| update_environment  | `Method`    | Sets the login's environment based on the url                                            | `zuora_client.update_environment`                                                                                                                   |
+| aqua_endpoint       | `Method`    | Returns the AQuA endpoint for the login based off the environment                        | `zuora_client.aqua_endpoint`                                                                                                                        |
+| rest_endpoint       | `Method`    | Returns the REST endpoint for the login based off the environment                        | `zuora_client.rest_endpoint`                                                                                                                          |
+| fileURL             | `Method`    | Returns the URL for files                                                                | `zuora_client.fileURL`                                                                                                                                |
+| dateFormat          | `Method`    | Returns the data format syntax based on the wsdl_number                                  | `zuora_client.dateFormat`                                                                                                                             |
+| new_session         | `Method`    | Create a new session                                                                     | `zuora_client.new_session`                                                                                                                          |
+| get_session         | `Method`    | Returns the current session                                                              | `zuora_client.get_session`|
+
+## Rest Call
+```ruby
+zuora_client.rest_call(method: :get, body: {}, url: zuora_client.rest_endpoint("catalog/products?pageSize=4"))
+```
+
+### Soap Call
+Returns both output and input XML
+
+```ruby
+zuora_client.soap_call(ns1: 'ns1', ns2: 'ns2', batch_size: nil, single_transaction: false)
+```
+
+Example Call
+
+```ruby
+output_xml, input_xml = zuora_client.soap_call() do |xml, args|
+ xml['ns1'].query do
+  xml['ns1'].queryString "select id, name from account"
+ end
+end
+```
+### Query
+```ruby
+zuora_client.query("select id from account")
+```
+### Data Export
+Returns the file location of the data source export after downloading from Zuora
+
+```ruby
+zuora_client.getDataSourceExport("select id from account")
+```
+
+|   Name    |                              Description                               | Default |                                    Example                                    |
+| --------- | ---------------------------------------------------------------------- | ------- | ----------------------------------------------------------------------------- |
+| query     | The query to execute                                                   | `N/A`   | `zuora_client.getDataSourceExport("select id from account")`                  |
+| zip       | Indicates if the data source export should be a zip                    | `true`  | `zuora_client.getDataSourceExport("select id from account", zip: false)`      |
+| extract   | Indicates if the data source export should be extracted if it is a zip | `true`  | `zuora_client.getDataSourceExport("select id from account", extract: false)`  |
+| encrypted | Indicates if the data source export should be encrypted                | `false` | `zuora_client.getDataSourceExport("select id from account", encrypted: true)` |
+
+### Describe Call
+This returns all available objects from the describe call as a hash. This response can be accessed by using response["Account"] to retrieve all related data about that object.
+
+```ruby
+response = zuora_client.describe_call("Account")
+```
+This returns all information and fields related to that object model as a hash.
+
+```ruby
+response = zuora_client.describe_call()
+```
+
+### Journal Run
+```ruby
+zuora_client.createJournalRun(call)
+```
+
+## Insights API
+
+In order to make API calls a Zuora Login object must be created by running:
+
+```ruby
+insightsapi = InsightsAPI::Login.new(api_token: "api token", url: "Nw1.api.insights.zuora.com/api/")
+```
+
+Note that the login will default to the insights production url.
+
+```ruby
+Date format: "YYYY-MM-DDT00:00:00Z"
+```
+
+### Uploading Data into Insights
+```ruby
+insightsapi.upload_into_insights(dataSourceName, recordType, batchDate, filePath)
+```
+dataSourceName: What system the data is coming from.
+recordType: The type of records ie: "EVENTS, ATTRIBUTES, and METRICS"
+batachDate: The date the data applies to.
+
+### Describing Insights Data
+```ruby
+insightsapi.describe(type: "ACCOUNT/USER", object: "ATTRIBUTES/EVENTS/SEGMENTS/METRICS")
+```
+Returns json payload describing attributes, events, metrics for each Account or User.
+
+### Downloading Data from Insights
+```ruby
+insightsapi.data_export_insights(objecttype, segmentuuid, startDate: nil, endDate: nil, tries: 30)
+```
+```ruby
+insightsapi.data_export_insights_file(objecttype, segmentuuid, startDate: nil, endDate: nil, tries: 30)
+```
+Both do the same thing except one returns a url(data_export_insights) to download the file yourself and the other returns an actual Ruby temporary file(data_export_insights_file).
+
+objectype: "ACCOUNT/USER"
+
+segmentuuid: A single or array of string or int of a segment uuid(s) that you get from the describe call. The csv holds a column with a bool that represents if that User or Account belongs to that segment.

data/gemfiles/Gemfile-rails.5.0.x

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec path: "../"
+
+gem "rails", "~> 5.0.0"

data/gemfiles/Gemfile-rails.5.1.x

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec path: "../"
+
+gem "rails", "~> 5.1.0"

data/gemfiles/Gemfile-rails.5.2.x

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec path: "../"
+
+gem "rails", "~> 5.2.0"

data/gemfiles/Gemfile-rails.6.0.x

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec path: "../"
+
+gem "rails", "~> 6.0.0"

data/lib/zuora_api/login.rb

@@ -7,7 +7,7 @@ module ZuoraAPI
   class Login
     ENVIRONMENTS = [TEST = 'Test', SANDBOX = 'Sandbox', PRODUCTION = 'Production', PREFORMANCE = 'Preformance', SERVICES = 'Services', UNKNOWN = 'Unknown', STAGING = 'Staging' ]
     REGIONS = [EU = 'EU', US = 'US', NA = 'NA' ]
-    MIN_Endpoint = '96.0'
+    MIN_Endpoints = {'Test': '107.0', 'Sandbox': '107.0', 'Production': '107.0', 'Performance': '107.0', 'Services': '96.0', 'Unknown': '96.0', 'Staging': '107.0'}.freeze
     XML_SAVE_OPTIONS = Nokogiri::XML::Node::SaveOptions::AS_XML | Nokogiri::XML::Node::SaveOptions::NO_DECLARATION
 
     CONNECTION_EXCEPTIONS = [
@@ -50,10 +50,12 @@ module ZuoraAPI
       raise "URL is nil or empty, but URL is required" if url.nil? || url.empty?
       # raise "URL is improper. URL must contain zuora.com, zuora.eu, or zuora.na" if /zuora.com|zuora.eu|zuora.na/ === url
       self.hostname = /(?<=https:\/\/|http:\/\/)(.*?)(?=\/|$)/.match(url)[0] if !/(?<=https:\/\/|http:\/\/)(.*?)(?=\/|$)/.match(url).nil?
+      self.update_environment
+      min_endpoint = MIN_Endpoints[self.environment.to_sym]
       if !/apps\/services\/a\/\d+\.\d$/.match(url.strip)
-        self.url = "https://#{hostname}/apps/services/a/#{MIN_Endpoint}"
-      elsif MIN_Endpoint.to_f > url.scan(/(\d+\.\d)$/).dig(0,0).to_f
-        self.url = url.gsub(/(\d+\.\d)$/, MIN_Endpoint)
+        self.url = "https://#{hostname}/apps/services/a/#{min_endpoint}"
+      elsif min_endpoint.to_f > url.scan(/(\d+\.\d)$/).dig(0,0).to_f
+        self.url = url.gsub(/(\d+\.\d)$/, min_endpoint)
       else
         self.url = url
       end
@@ -65,36 +67,18 @@ module ZuoraAPI
       self.status = status.blank? ? "Active" : status
       self.user_info = Hash.new
       self.update_region
-      self.update_environment
       self.update_zconnect_provider
       @timeout_sleep = 5
     end
 
     def get_identity(cookies)
       zsession = cookies["ZSession"]
-      zconnect_accesstoken = get_zconnect_accesstoken(cookies)
       begin
         if !zsession.blank?
           response = HTTParty.get("https://#{self.hostname}/apps/v1/identity", :headers => {'Cookie' => "ZSession=#{zsession}", 'Content-Type' => 'application/json'})
           output_json = JSON.parse(response.body)
-        elsif zconnect_accesstoken.present?
-          begin
-            code = zconnect_accesstoken.split("#!").last
-            encrypted_token, tenant_id = Base64.decode64(code).split(":")
-            body = {'token' => encrypted_token}.to_json
-          rescue => ex
-            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("Invalid ZConnect Cookie")
-          end
-          Rails.logger.info("Using ZConnect cookie in get_identity method")
-
-          response = HTTParty.post("https://#{self.hostname}/apps/zconnectsession/identity", :body => body, :headers => { 'Content-Type' => 'application/json' })
-          output_json = JSON.parse(response.body)
         else
-          if zconnect_accesstoken.blank? && cookies.keys.any? { |x| x.include? "ZConnect"}
-            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZConnect cookie present matching #{self.hostname}")
-          else
-            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZSession cookie present")
-          end
+          raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZSession cookie present")
         end
       rescue JSON::ParserError => ex
         output_json = {}
@@ -105,21 +89,12 @@ module ZuoraAPI
 
     def get_full_nav(cookies)
       zsession = cookies["ZSession"]
-      zconnect_accesstoken = get_zconnect_accesstoken(cookies)
       begin
         if zsession.present?
           response = HTTParty.get("https://#{self.hostname}/apps/v1/navigation", :headers => {'Cookie' => "ZSession=#{zsession}", 'Content-Type' => 'application/json'})
           output_json = JSON.parse(response.body)
-        elsif zconnect_accesstoken.present?
-          Rails.logger.info("Using ZConnect cookie in get_full_nav method")
-          response = HTTParty.get("https://#{self.hostname}/apps/zconnectsession/navigation", :headers => {'Cookie' => "#{self.zconnect_provider}=#{zconnect_accesstoken}",'Content-Type' => 'application/json'})
-          output_json = JSON.parse(response.body)
         else
-          if zconnect_accesstoken.blank? && cookies.keys.any? { |x| x.include? "ZConnect"}
-            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZConnect cookie present matching #{self.hostname}")
-          else
-            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZSession cookie present")
-          end
+          raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZSession cookie present")
         end
       rescue JSON::ParserError => ex
         output_json = {}
@@ -130,21 +105,12 @@ module ZuoraAPI
 
     def set_nav(state, cookies)
       zsession = cookies["ZSession"]
-      zconnect_accesstoken = get_zconnect_accesstoken(cookies)
       begin
         if !zsession.blank?
           response = HTTParty.put("https://#{self.hostname}/apps/v1/preference/navigation", :body => state.to_json, :headers => {'Cookie' => "ZSession=#{zsession}", 'Content-Type' => 'application/json'})
           output_json = JSON.parse(response.body)
-        elsif !zconnect_accesstoken.blank?
-          Rails.logger.info("Using ZConnect cookie in set_nav method")
-          response = HTTParty.post("https://#{self.hostname}/apps/zconnectsession/navigationstate", :body => state.to_json, :headers => {'Cookie' => "#{self.zconnect_provider}=#{zconnect_accesstoken}", 'Content-Type' => 'application/json'})
-          output_json = JSON.parse(response.body)
         else
-          if zconnect_accesstoken.blank? && cookies.keys.any? { |x| x.include? "ZConnect"}
-            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZConnect cookie present matching #{self.hostname}")
-          else
-            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZSession cookie present")
-          end
+          raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZSession cookie present")
         end
       rescue JSON::ParserError => ex
         output_json = {}
@@ -155,21 +121,12 @@ module ZuoraAPI
 
     def refresh_nav(cookies)
       zsession = cookies["ZSession"]
-      zconnect_accesstoken = get_zconnect_accesstoken(cookies)
       begin
         if !zsession.blank?
           response = HTTParty.post("https://#{self.hostname}/apps/v1/navigation/fetch", :headers => {'Cookie' => "ZSession=#{zsession}", 'Content-Type' => 'application/json'})
           output_json = JSON.parse(response.body)
-        elsif !zconnect_accesstoken.blank?
-          Rails.logger.info("Using ZConnect cookie in refresh_nav method")
-          response = HTTParty.post("https://#{self.hostname}/apps/zconnectsession/refresh-navbarcache", :headers => {'Cookie' => "#{self.zconnect_provider}=#{zconnect_accesstoken}", 'Content-Type' => 'application/json'})
-          output_json = JSON.parse(response.body)
         else
-          if zconnect_accesstoken.blank? && cookies.keys.any? { |x| x.include? "ZConnect"}
-            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZConnect cookie present matching #{self.hostname}")
-          else
-            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZSession cookie present")
-          end
+          raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZSession cookie present")
         end
       rescue JSON::ParserError => ex
         output_json = {}
@@ -178,15 +135,6 @@ module ZuoraAPI
       return output_json
     end
 
-    def get_zconnect_accesstoken(cookies)
-      accesstoken = nil
-      self.update_zconnect_provider
-      if !cookies[self.zconnect_provider].nil? && !cookies[self.zconnect_provider].empty?
-        accesstoken = cookies[self.zconnect_provider]
-      end
-      return accesstoken
-    end
-
     def reporting_url(path)
       map = {"US" => {"Sandbox" => "https://zconnectsandbox.zuora.com/api/rest/v1/",
                       "Production" => "https://zconnect.zuora.com/api/rest/v1/",
@@ -208,7 +156,7 @@ module ZuoraAPI
     # 1. Pass in cookies and optionally custom_authorities, name, and description
     # 2. Pass in user_id, entity_ids, client_id, client_secret, and optionally custom_authorities, name, and description
     # https://intranet.zuora.com/confluence/display/Sunburst/Create+an+OAuth+Client+through+API+Gateway#CreateanOAuthClientthroughAPIGateway-ZSession
-    def get_oauth_client (custom_authorities = [], info_name: "No Name", info_desc: "This client was created without a description.", user_id: nil, entity_ids: nil, client_id: nil, client_secret: nil, new_client_id: nil, new_client_secret: nil, cookies: nil)
+    def get_oauth_client (custom_authorities = [], info_name: "No Name", info_desc: "This client was created without a description.", user_id: nil, entity_ids: nil, client_id: nil, client_secret: nil, new_client_id: nil, new_client_secret: nil, cookies: nil, chomp_v1_from_genesis_endpoint: false, use_api_generated_client_secret: false)
       authorization = ""
       new_client_id = SecureRandom.uuid if new_client_id.blank?
       new_client_secret = SecureRandom.hex(10) if new_client_secret.blank?
@@ -234,11 +182,11 @@ module ZuoraAPI
       end
 
       if !authorization.blank? && !user_id.blank? && !entity_ids.blank?
-        endpoint = self.rest_endpoint("genesis/clients")
+        endpoint = chomp_v1_from_genesis_endpoint ? self.rest_endpoint.chomp("v1/").concat("genesis/clients") : self.rest_endpoint("genesis/clients")
         oauth_response = HTTParty.post(endpoint, :headers => {'authorization' => authorization, 'Content-Type' => 'application/json'}, :body => {'clientId' => new_client_id, 'clientSecret' => new_client_secret, 'userId' => user_id, 'entityIds' => entity_ids, 'customAuthorities' => custom_authorities, 'additionalInformation' => {'description' => info_desc, 'name' => info_name}}.to_json)
         output_json = JSON.parse(oauth_response.body)
         if oauth_response.code == 201
-          output_json["clientSecret"] = new_client_secret
+          output_json["clientSecret"] = new_client_secret if !use_api_generated_client_secret
           return output_json
         elsif oauth_response.code == 401 && !oauth_response.message.blank?
           raise ZuoraAPI::Exceptions::ZuoraAPIError.new(output_json["message"], oauth_response)
@@ -305,7 +253,7 @@ module ZuoraAPI
     end
 
     def update_environment
-      if !self.url.blank?
+      if !self.hostname.blank?
         case self.hostname
         when /(?<=\.|\/|-|^)(apisandbox|sandbox)(?=\.|\/|-|$)/
           self.environment = 'Sandbox'
@@ -328,13 +276,13 @@ module ZuoraAPI
     end
 
     def update_zconnect_provider
-      region = update_region
-      environment = update_environment
+      update_region if self.region.blank?
+      update_environment if self.environment.blank?
       mappings = {"US" => {"Sandbox" => "ZConnectSbx",   "Services" => "ZConnectSvcUS", "Production" => "ZConnectProd",   "Performance" => "ZConnectPT1", "Test" => "ZConnectTest", "Staging" => "ZConnectQA", "KubeSTG" => "ZConnectDev", "KubeDEV" => "ZConnectDev", "KubePROD" => "ZConnectDev"},
                   "NA" => {"Sandbox" => "ZConnectSbxNA", "Services" => "ZConnectSvcNA", "Production" => "ZConnectProdNA", "Performance" => "ZConnectPT1NA"},
                   "EU" => {"Sandbox" => "ZConnectSbxEU", "Services" => "ZConnectSvcEU", "Production" => "ZConnectProdEU", "Performance" => "ZConnectPT1EU", "Test" => "ZConnectTest"},
                   "Unknown" => {"Unknown" => "Unknown"}}
-      self.zconnect_provider = mappings[region][environment]
+      self.zconnect_provider = mappings[self.region][self.environment]
     end
 
     def aqua_endpoint(url="")
@@ -387,20 +335,20 @@ module ZuoraAPI
     end
 
     def new_session(auth_type: :basic, debug: false, zuora_track_id: nil)
-      tries ||= 2
+      retries ||= 2
       yield
 
     rescue ZuoraAPI::Exceptions::ZuoraAPISessionError => ex
-      self.status = 'Inactive/Invalid'
+      self.status = 'Invalid'
       self.current_error = ex.message
       raise
     rescue ZuoraAPI::Exceptions::ZuoraAPIError  => ex
       raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new(ex.message, ex.response)
 
     rescue ZuoraAPI::Exceptions::ZuoraAPIInternalServerError => ex
-      raise ex if tries.zero?
+      raise ex if retries.zero?
 
-      tries -= 1
+      retries -= 1
       sleep(self.timeout_sleep)
       retry
         
@@ -586,7 +534,7 @@ module ZuoraAPI
       when ZuoraAPI::Exceptions::ZuoraAPIUnkownError, ZuoraAPI::Exceptions::ZuoraDataIntegrity
         Rails.logger.error('Zuora Unknown/Integrity Error', ex, exception_args)
       when ZuoraAPI::Exceptions::ZuoraAPIRequestLimit
-        Rails.logger.info('Zuora APILimit Reached', exception_args)
+        Rails.logger.info('Zuora APILimit Reached', ex, exception_args)
       when *(ZuoraAPI::Login::ZUORA_API_ERRORS-ZuoraAPI::Login::ZUORA_SERVER_ERRORS)
         #Rails.logger.debug('Zuora API Error', ex, self.exception_args(ex))
       when *ZuoraAPI::Login::ZUORA_SERVER_ERRORS
@@ -605,12 +553,7 @@ module ZuoraAPI
 
     def exception_args(ex)
       args = {}
-      if ex.class == ZuoraAPI::Exceptions::ZuoraAPIRequestLimit
-        args.merge!({
-          zuora_trace_id: ex.response.headers["zuora-request-id"],
-          zuora_track_id: ex.response.request.options[:headers]["Zuora-Track-Id"]
-        })
-      elsif defined?(ex.response) && ex.response.present?
+      if defined?(ex.response) && ex.response.present?
         args.merge!({
           request: {
             path: ex.response.request.path.to_s,
@@ -697,12 +640,12 @@ module ZuoraAPI
            ).present?
           result = body.xpath('//ns2:Status', 'ns2' => 'http://object.api.zuora.com/').text
           if result == 'Failed'
-            reason = body.xpath('//ns2:StatusReason', 'ns2' => 'http://object.api.zuora.com/').text
-            if reason.present?
-              message = body.xpath('//ns2:StatusReason', 'ns2' => 'http://object.api.zuora.com/').text
-              error = message.match(/^[\w\d]{16}\: (Unexpected error.|No HTTP Response|Socket Timeout|There is an internal error, please try again later)/).present? ? 'UNEXPECTED_ERROR' : 'FATAL_ERROR'  
+            message = body.xpath('//ns2:StatusReason', 'ns2' => 'http://object.api.zuora.com/').text
+            error = 'FATAL_ERROR'
+            if message.present?
+              identifier, new_message = message.scan(/^([\w\d]{16})\: (.*)/).first
+              error, message = ['UNEXPECTED_ERROR', new_message] if new_message.present?
             else
-              error = 'FATAL_ERROR'
               message = 'Export failed due to unknown reason. Consult api logs.'
             end
           end
@@ -755,14 +698,27 @@ module ZuoraAPI
           if body['code'].present? && /61$/.match(body['code'].to_s).present? # if last 2 digits of code are 61
             raise ZuoraAPI::Exceptions::ZuoraAPITemporaryError.new(body['message'], nil, body['details'])
           end
+        when /^\/api\/v1\/payment_plans.*/
+           raise ZuoraAPI::Exceptions::ZuoraAPIError.new(body['error'], response) if body['error']
         end
 
         body = body.dig("results").present? ? body["results"] : body if body.class == Hash
         if body.class == Hash && (!body["success"] || !body["Success"] || response.code != 200)
-          messages_array = body.fetch("reasons", []).map {|error| error['message']}.compact
-          messages_array = messages_array.push(body.dig("error", 'message')).compact if body.dig('error').class == Hash
-          codes_array =    body.fetch("reasons", []).map {|error| error['code']}.compact
-          codes_array = codes_array.push(body.dig("error", 'code')).compact  if body.dig('error').class == Hash
+          reason_keys = %w(reasons errors)
+          message_keys = %w(message title)
+          messages_array, codes_array = [[],[]]
+          reason_keys.each do |rsn_key|
+            message_keys.each do |msg_key|
+              messages_array = body.fetch(rsn_key, []).map {|error| error[msg_key]}.compact
+              break if messages_array.present?
+            end
+            codes_array = body.fetch(rsn_key, []).map {|error| error['code']}.compact
+            break if messages_array.present? && codes_array.present?
+          end
+          if body.dig('error').class == Hash
+            messages_array = messages_array.push(body.dig("error", 'message')).compact
+            codes_array = codes_array.push(body.dig("error", 'code')).compact
+          end
 
           if body['message'] == 'request exceeded limit'
             raise ZuoraAPI::Exceptions::ZuoraAPIRequestLimit.new("The total number of concurrent requests has exceeded the limit allowed by the system. Please resubmit your request later.", response)
@@ -905,7 +861,7 @@ module ZuoraAPI
         output_json = JSON.parse(response.body)
         self.raise_errors(type: :JSON, body: output_json, response: response)
       
-      elsif (response_content_types.include?('application/xml') || response_content_types.include?('text/xml')) and type != :xml
+      elsif (response_content_types.include?('application/xml') || response_content_types.include?('text/xml') || response_content_types.include?('application/soap+xml')) and type != :xml
         output_xml = Nokogiri::XML(response.body)
         self.raise_errors(type: :SOAP, body: output_xml, response: response)
 
@@ -953,6 +909,11 @@ module ZuoraAPI
         message = body.xpath('//ns1:Message', 'ns1' =>'http://api.zuora.com/').text
       end
 
+      if error.blank? || message.blank?
+        error   = body.xpath('//soapenv:Value', 'soapenv'=>'http://www.w3.org/2003/05/soap-envelope').text
+        message = body.xpath('//soapenv:Text', 'soapenv'=>'http://www.w3.org/2003/05/soap-envelope').text
+      end
+
       #Update/Create/Delete Calls with multiple requests and responses
       if body.xpath('//ns1:result', 'ns1' =>'http://api.zuora.com/').size > 0 && body.xpath('//ns1:Errors', 'ns1' =>'http://api.zuora.com/').size > 0
         error = []
@@ -1003,10 +964,15 @@ module ZuoraAPI
       when /.*soapenv:Server.*/
         if /^Invalid value.*for type.*|^Id is invalid|^date string can not be less than 19 charactors$/.match(message).present?
           raise ZuoraAPI::Exceptions::ZuoraAPIError.new(message, response, errors, success)
-        elsif /^Invalid white space character \(.*\) in text to output$|^Invalid null character in text to output$/.match(message).present?
+        elsif /^unknown$|^Invalid white space character \(.*\) in text to output$|^Invalid null character in text to output$/.match(message).present?
           raise ZuoraAPI::Exceptions::ZuoraAPIUnkownError.new(message, response, errors, success)
         end
         raise ZuoraAPI::Exceptions::ZuoraAPIInternalServerError.new(message, response, errors, success)
+      when /soapenv:Receiver/
+        if /^com.ctc.wstx.exc.WstxUnexpectedCharException: Unexpected character.*$/.match(message).present?
+          raise ZuoraAPI::Exceptions::ZuoraAPIError.new(message, response, errors, success)
+        end
+        raise ZuoraAPI::Exceptions::ZuoraAPIInternalServerError.new(message, response, errors, success)
       else 
         raise ZuoraAPI::Exceptions::ZuoraAPIInternalServerError.new("Z:#{error}::#{message}", response, errors, success)
       end
@@ -1398,13 +1364,21 @@ module ZuoraAPI
           return file_handle
         when Net::HTTPUnauthorized
           if z_session
-            if !(retry_count -= 1).zero?
+            unless (retry_count -= 1).zero?
               self.new_session
-              raise response.class
+              raise ZuoraAPI::Exceptions::ZuoraAPISessionError, 'Retrying'
             end
             raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new(self.current_error)
           end
           raise
+        when Net::HTTPNotFound
+          if url.include?(self.fileURL)
+            raise ZuoraAPI::Exceptions::FileDownloadError.new(
+              "The current tenant does not have a file with id '#{url.split('/').last}'"
+            )
+          else
+            raise ZuoraAPI::Exceptions::FileDownloadError.new("File Download Failed #{response.class}")
+          end
         else
           raise ZuoraAPI::Exceptions::FileDownloadError.new("File Download Failed #{response.class}")
         end
@@ -1421,68 +1395,35 @@ module ZuoraAPI
 
     def getDataSourceExport(query, extract: true, encrypted: false, zip: true, z_track_id: "")
       tries ||= 3
-      request = Nokogiri::XML::Builder.new do |xml|
-        xml['SOAP-ENV'].Envelope('xmlns:SOAP-ENV' => "http://schemas.xmlsoap.org/soap/envelope/", 'xmlns:ns2' => "http://object.api.zuora.com/", 'xmlns:xsi' => "http://www.w3.org/2001/XMLSchema-instance", '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, zuora_track_id: z_track_id)
-            end
-          end
-          xml['SOAP-ENV'].Body do
-            xml['ns1'].create do
-              xml['ns1'].zObjects('xsi:type' => "ns2:Export") do
-                xml['ns2'].Format 'csv'
-                xml['ns2'].Zip zip
-                xml['ns2'].Name 'googman'
-                xml['ns2'].Query query
-                xml['ns2'].Encrypted encrypted
-              end
-            end
+
+      output_xml, input_xml = self.soap_call(debug: false, timeout_retry: true, zuora_track_id: z_track_id) do |xml|
+        xml['ns1'].create do
+          xml['ns1'].zObjects('xsi:type' => "ns2:Export") do
+            xml['ns2'].Format 'csv'
+            xml['ns2'].Zip zip
+            xml['ns2'].Name 'googman'
+            xml['ns2'].Query query
+            xml['ns2'].Encrypted encrypted
           end
         end
       end
-
-      response_query = HTTParty.post(self.url, body: request.to_xml(:save_with => XML_SAVE_OPTIONS).strip, headers: {'Content-Type' => "application/json; charset=utf-8", "Z-Track-Id" => z_track_id}, :timeout => 130)
-
-      output_xml = Nokogiri::XML(response_query.body)
-      raise_errors(type: :SOAP, body: output_xml, response: response_query) if output_xml.xpath('//ns1:Success', 'ns1' =>'http://api.zuora.com/').text != "true"
-
-      # raise "Export Creation Unsuccessful : #{response_query.code}: #{response_query.parsed_response}" if  output_xml.xpath('//ns1:Success', 'ns1' =>'http://api.zuora.com/').text != "true"
       
       id = output_xml.xpath('//ns1:Id', 'ns1' =>'http://api.zuora.com/').text
 
-      confirmRequest = Nokogiri::XML::Builder.new do |xml|
-        xml['SOAP-ENV'].Envelope('xmlns:SOAP-ENV' => "http://schemas.xmlsoap.org/soap/envelope/", 'xmlns:ns2' => "http://object.api.zuora.com/", 'xmlns:xsi' => "http://www.w3.org/2001/XMLSchema-instance", '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, zuora_track_id: z_track_id)
-            end
-          end
-          xml['SOAP-ENV'].Body do
-            xml['ns1'].query do
-              xml['ns1'].queryString "SELECT  Id, CreatedById, CreatedDate, Encrypted, FileId, Format, Name, Query, Size, Status, StatusReason, UpdatedById, UpdatedDate, Zip From Export where Id = '#{id}'"
-            end
-          end
-        end
-      end
       result = 'Waiting'
-
       while result != "Completed"
         sleep 3
-        response_query = HTTParty.post(self.url, body: confirmRequest.to_xml(:save_with => XML_SAVE_OPTIONS).strip, headers: {'Content-Type' => "application/json; charset=utf-8", "Z-Track-Id" => z_track_id}, :timeout => 130)
-
-        output_xml = Nokogiri::XML(response_query.body)
+        output_xml, input_xml = self.soap_call(debug: false, timeout_retry: true, zuora_track_id: z_track_id) do |xml|
+          xml['ns1'].query do
+            xml['ns1'].queryString "SELECT Id, CreatedById, CreatedDate, Encrypted, FileId, Format, Name, Query, Size, Status, StatusReason, UpdatedById, UpdatedDate, Zip From Export where Id = '#{id}'"
+          end
+        end
         result = output_xml.xpath('//ns2:Status',  'ns2' =>'http://object.api.zuora.com/').text
-        status_code = response_query.code if response_query
-
-        raise_errors(type: :SOAP, body: output_xml, response: response_query) if result.blank? || result == "Failed"
-        # raise "Export Creation Unsuccessful : #{response_query.code}: #{response_query.parsed_response}" if result.blank? || result == "Failed"
       end
 
       file_id = output_xml.xpath('//ns2:FileId',  'ns2' =>'http://object.api.zuora.com/').text
       export_file = get_file(:url => self.fileURL(file_id))
       export_file_path = export_file.path
-      Rails.logger.debug("=====> Export path #{export_file.path}")
 
       if extract && zip
         require "zip"
@@ -1506,24 +1447,18 @@ module ZuoraAPI
     rescue ZuoraAPI::Exceptions::ZuoraUnexpectedError => ex
       if !(tries -= 1).zero?
         Rails.logger.info("Trace ID: #{z_track_id} UnexpectedError, will retry after 10 seconds")
-        sleep 10
+        sleep(self.timeout_sleep)
         retry
       end
       raise ex
-
-    rescue *ZUORA_API_ERRORS => ex
-      raise ex
-
+      
     rescue *(CONNECTION_EXCEPTIONS + CONNECTION_READ_EXCEPTIONS) => ex
       if !(tries -= 1).zero?
         Rails.logger.info("Trace ID: #{z_track_id} Timed out will retry after 5 seconds")
-        sleep 5
+        sleep(self.timeout_sleep)
         retry
       end
       raise ex
-
-    rescue ZuoraAPI::Exceptions::BadEntityError => ex
-      raise ex
     end
 
     def query(query, parse = false)

data/lib/zuora_api/version.rb

@@ -1,3 +1,3 @@
 module ZuoraAPI
-  VERSION = "1.7.66j"
+  VERSION = "1.7.80"
 end

data/zuora_api.gemspec

@@ -27,5 +27,5 @@ Gem::Specification.new do |spec|
   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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zuora_api
 version: !ruby/object:Gem::Version
-  version: 1.7.66j
+  version: 1.7.80
 platform: ruby
 authors:
 - Zuora Strategic Solutions Group
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-19 00:00:00.000000000 Z
+date: 2021-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -145,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
@@ -155,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
@@ -174,6 +174,12 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- catalog-info.yaml
+- docs/index.md
+- 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
@@ -196,11 +202,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Gem that provides easy integration to Zuora