zuora_api 1.9.06 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6e64337c34783cccc2728c5a083e3f41c8601f48f27b8d836ebf8bfc2c6fe16
-  data.tar.gz: cb402b07025dec307d1e025455275723f76bcc8ff3b77068f5d59a326bac0860
+  metadata.gz: 17131e6d6129f3831868f5a029b5c1f781e7fb31ca31fddd682b8bd0a3994f68
+  data.tar.gz: 748d5ac46b7647dd5ebfaf2338de458a2ff42e65d138b045dcd40e1eb5741f2d
 SHA512:
-  metadata.gz: 674922fea272843b6430b56230f9db90ab57a3d368990ec15998f5c3c7dabc55c2fbd6b14834ccf1c8ee87d1e39ef96bb8687a63c82283c81a02a4d513bc3a1f
-  data.tar.gz: ea2596a105636403530c22aacaf9a0365f223d3cc48ab1264a70aa18720f3391e5f7070cb5c97a4cf8c16b7f812a3be80da30a2cebf531fd6d586d1d1b85091d
+  metadata.gz: 289f4b0e533dbc666d649017ca97669525adc14976d135bbd9191955f5fe70384c3506261d65b89071752e1a23137593d70cb4afd47805a67a2b400e34e7fe3f
+  data.tar.gz: c85623dad76f6c4d02a49bbdddb602191c709576717cc2fad66a2b5324ff9824469fb3d1a70e98ad07c477a3b0191e47e1c5890e93bd7a13aaf5937302d0b8e4

data/lib/zuora_api/login.rb

@@ -7,8 +7,9 @@ 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_Endpoints = {'Test': '107.0', 'Sandbox': '107.0', 'Production': '107.0', 'Performance': '107.0', 'Services': '96.0', 'Unknown': '96.0', 'Staging': '107.0'}.freeze
+    MIN_Endpoints = {'Test': '108.0', 'Sandbox': '108.0', 'Production': '108.0', 'Performance': '108.0', 'Services': '96.0', 'Unknown': '96.0', 'Staging': '108.0'}.freeze
     XML_SAVE_OPTIONS = Nokogiri::XML::Node::SaveOptions::AS_XML | Nokogiri::XML::Node::SaveOptions::NO_DECLARATION
+    USER_AGENT = "Zuora#{ENV['Z_APPLICATION_NAME']&.capitalize}/#{ENV['Z_APPLICATION_VERSION']&.delete('v')}"
 
     CONNECTION_EXCEPTIONS = [
       Net::OpenTimeout,
@@ -44,9 +45,9 @@ module ZuoraAPI
       ZuoraAPI::Exceptions::ZuoraUnexpectedError
     ].freeze
 
-    attr_accessor :region, :url, :wsdl_number, :current_session, :bearer_token, :oauth_session_expires_at, :environment, :status, :errors, :current_error, :user_info, :tenant_id, :tenant_name, :entity_id, :timeout_sleep, :hostname, :zconnect_provider
+    attr_accessor :region, :url, :wsdl_number, :current_session, :bearer_token, :oauth_session_expires_at, :environment, :status, :errors, :current_error, :user_info, :tenant_id, :tenant_name, :entity_id, :entity_identifier, :entity_header_type, :timeout_sleep, :hostname, :zconnect_provider
 
-    def initialize(url: nil, entity_id: nil, session: nil, status: nil, bearer_token: nil, oauth_session_expires_at: nil, **keyword_args)
+    def initialize(url: nil, entity_id: nil, entity_identifier: nil, session: nil, status: nil, bearer_token: nil, oauth_session_expires_at: nil, **keyword_args)
       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?
@@ -60,6 +61,8 @@ module ZuoraAPI
         self.url = url
       end
       self.entity_id = get_entity_id(entity_id: entity_id)
+      self.entity_identifier = entity_identifier
+      self.entity_header_type = :entity_id
       self.errors = Hash.new
       self.current_session = session
       self.bearer_token = bearer_token
@@ -75,7 +78,7 @@ module ZuoraAPI
       zsession = cookies["ZSession"]
       begin
         if !zsession.blank?
-          response = HTTParty.get("https://#{self.hostname}/apps/v1/identity", :headers => {'Cookie' => "ZSession=#{zsession}", 'Content-Type' => 'application/json'})
+          response = HTTParty.get("https://#{self.hostname}/apps/v1/identity", :headers => {'Cookie' => "ZSession=#{zsession}", 'Content-Type' => 'application/json', "User-Agent" => USER_AGENT})
           output_json = JSON.parse(response.body)
         else
           raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZSession cookie present")
@@ -91,7 +94,7 @@ module ZuoraAPI
       zsession = cookies["ZSession"]
       begin
         if zsession.present?
-          response = HTTParty.get("https://#{self.hostname}/apps/v1/navigation", :headers => {'Cookie' => "ZSession=#{zsession}", 'Content-Type' => 'application/json'})
+          response = HTTParty.get("https://#{self.hostname}/apps/v1/navigation", :headers => {'Cookie' => "ZSession=#{zsession}", 'Content-Type' => 'application/json', "User-Agent" => USER_AGENT})
           output_json = JSON.parse(response.body)
         else
           raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZSession cookie present")
@@ -107,7 +110,7 @@ module ZuoraAPI
       zsession = cookies["ZSession"]
       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'})
+          response = HTTParty.put("https://#{self.hostname}/apps/v1/preference/navigation", :body => state.to_json, :headers => {'Cookie' => "ZSession=#{zsession}", 'Content-Type' => 'application/json', "User-Agent" => USER_AGENT})
           output_json = JSON.parse(response.body)
         else
           raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZSession cookie present")
@@ -123,7 +126,7 @@ module ZuoraAPI
       zsession = cookies["ZSession"]
       begin
         if !zsession.blank?
-          response = HTTParty.post("https://#{self.hostname}/apps/v1/navigation/fetch", :headers => {'Cookie' => "ZSession=#{zsession}", 'Content-Type' => 'application/json'})
+          response = HTTParty.post("https://#{self.hostname}/apps/v1/navigation/fetch", :headers => {'Cookie' => "ZSession=#{zsession}", 'Content-Type' => 'application/json', "User-Agent" => USER_AGENT})
           output_json = JSON.parse(response.body)
         else
           raise ZuoraAPI::Exceptions::ZuoraAPIError.new("No ZSession cookie present")
@@ -176,7 +179,7 @@ module ZuoraAPI
           raise ZuoraAPI::Exceptions::ZuoraAPIError.new("Zuora User ID not provided")
         end
       elsif !client_id.nil? && !client_secret.nil?
-        bearer_response = HTTParty.post("https://#{self.hostname}/oauth/token", :headers => {'Content-Type' => 'application/x-www-form-urlencoded', 'Accept' => 'application/json'}, :body => {'client_id' => client_id, 'client_secret' => URI::encode(client_secret), 'grant_type' => 'client_credentials'})
+        bearer_response = HTTParty.post("https://#{self.hostname}/oauth/token", :headers => {'Content-Type' => 'application/x-www-form-urlencoded', 'Accept' => 'application/json', "User-Agent" => USER_AGENT}, :body => {'client_id' => client_id, 'client_secret' => URI::encode(client_secret), 'grant_type' => 'client_credentials'})
         bearer_hash = JSON.parse(bearer_response.body)
         bearer_token = bearer_hash["access_token"]
         authorization = "Bearer #{bearer_token}"
@@ -184,7 +187,7 @@ module ZuoraAPI
 
       if !authorization.blank? && !user_id.blank? && !entity_ids.blank?
         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)
+        oauth_response = HTTParty.post(endpoint, :headers => {'authorization' => authorization, 'Content-Type' => 'application/json', "User-Agent" => USER_AGENT}, :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 if !use_api_generated_client_secret
@@ -433,12 +436,12 @@ module ZuoraAPI
             end
             if single_transaction
               xml["#{ns1}"].CallOptions do
-                xml.useSingleTransaction single_transaction
+                xml["#{ns1}"].useSingleTransaction single_transaction
               end
             end
             if batch_size
               xml["#{ns1}"].QueryOptions do
-                xml.batchSize batch_size
+                xml["#{ns1}"].batchSize batch_size
               end
             end
           end
@@ -453,6 +456,7 @@ module ZuoraAPI
 
       headers.merge!({ 'Content-Type' => "text/xml; charset=utf-8", 'Accept' => 'text/xml'})
       headers['Zuora-Track-Id'] = zuora_track_id if zuora_track_id.present?
+      headers["User-Agent"] = USER_AGENT
 
       request = HTTParty::Request.new(
         Net::HTTP::Post,
@@ -1020,13 +1024,42 @@ module ZuoraAPI
       return self.get_file(url: self.aqua_endpoint("file/#{fileId}"))
     end
 
+    def entity_header
+      if self.entity_header_type == :entity_name && self.entity_identifier.present?
+        { "entityName" => self.entity_identifier }
+      elsif self.entity_id.present?
+        { "Zuora-Entity-Ids" => self.entity_id }
+      else
+        {}
+      end
+    end
+
+    def insert_entity_header(destination_headers, lookup_headers: nil)
+      # The entity header may be added to a place other than where we look for it
+      lookup_headers = destination_headers if lookup_headers.nil?
+
+      entity_header_options = %w(zuora-entity-ids entityid entityname)
+      # If the customer doesn't supply an entity header, fill it in
+      if (entity_header_options & lookup_headers.keys.map(&:downcase)).blank?
+        entity_header = self.entity_header
+        if entity_header.present?
+          destination_headers.merge!(entity_header)
+          entity_header_options_to_exclude =
+            entity_header_options.
+              reject { |header| header == entity_header.keys.first&.downcase }
+          destination_headers.delete_if { |key, _| entity_header_options_to_exclude.include?(key.to_s.downcase) }
+        end
+      end
+    end
+
     def describe_call(object = nil, log_errors = true)
       tries ||= 2
 
       base = self.url.include?(".com") ? self.url.split(".com")[0].concat(".com") : self.url.split(".eu")[0].concat(".eu")
       url = object ? "#{base}/apps/api/describe/#{object}" : "#{base}/apps/api/describe/"
-      headers = self.entity_id.present? ? {"Zuora-Entity-Ids" => self.entity_id, 'Content-Type' => "text/xml; charset=utf-8"} : {'Content-Type' => "text/xml; charset=utf-8"}
-      response = HTTParty.get(url,  headers: {"Authorization" => self.get_session(prefix: true, auth_type: :basic)}.merge(headers), :timeout => 130)
+      headers = { "Content-Type" => "text/xml; charset=utf-8" }.merge(self.entity_header)
+
+      response = HTTParty.get(url,  headers: {"Authorization" => self.get_session(prefix: true, auth_type: :basic), "User-Agent" => USER_AGENT}.merge(headers), :timeout => 130)
 
       raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new(self.current_error.present? ? self.current_error : 'Describe call 401', response) if response.code == 401
 
@@ -1112,12 +1145,11 @@ module ZuoraAPI
       authentication_headers = {}
       if z_session
         authentication_headers = {"Authorization" => self.get_session(prefix: true, auth_type: session_type, zuora_track_id: zuora_track_id) }
-        if self.entity_id.present?
-          authentication_headers["Zuora-Entity-Ids"] = self.entity_id if headers.dig("Zuora-Entity-Ids").nil?
-          authentication_headers.delete_if { |key, value| ["entityId", "entityName"].include?(key.to_s) }
-        end
+
+        self.insert_entity_header(authentication_headers, lookup_headers: headers)
       end
       headers['Zuora-Track-Id'] = zuora_track_id if zuora_track_id.present?
+      headers['User-Agent'] = USER_AGENT
 
       modified_headers = {'Content-Type' => "application/json; charset=utf-8"}.merge(authentication_headers).merge(headers)
 
@@ -1279,10 +1311,12 @@ module ZuoraAPI
       http.use_ssl = true  if !uri.scheme.nil? && uri.scheme.downcase == 'https'
       if z_session
         headers = headers.merge({"Authorization" => self.get_session(prefix: true)})
-        headers = headers.merge({"Zuora-Entity-Ids" => self.entity_id}) if !self.entity_id.blank?
+
+        self.insert_entity_header(headers)
       end
 
       headers['Zuora-Track-Id'] = zuora_track_id if zuora_track_id.present?
+      headers["User-Agent"] = USER_AGENT
 
       response_save = nil
       http.request_get(uri.request_uri, headers) do |response|

data/lib/zuora_api/logins/oauth.rb

@@ -32,7 +32,7 @@ module ZuoraAPI
     end
     
     def get_z_session(debug: false, zuora_track_id: nil)
-      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?
       output_json, response = self.rest_call(:url => self.rest_endpoint("connections"), :session_type => :bearer, :headers => headers)
       begin

data/lib/zuora_api/version.rb

@@ -1,3 +1,3 @@
 module ZuoraAPI
-  VERSION = "1.9.06"
+  VERSION = "1.10.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zuora_api
 version: !ruby/object:Gem::Version
-  version: 1.9.06
+  version: 1.10.0
 platform: ruby
 authors:
 - Zuora Strategic Solutions Group
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-18 00:00:00.000000000 Z
+date: 2021-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -219,7 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: Gem that provides easy integration to Zuora