zuora_api 1.9.09 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6da8c9fbf54221b62336d0221ada0f53e9d22690b7a6a52cd83f214314b5ba5
-  data.tar.gz: be31b09eef19df8b8d1fcbd70b9a11980f125c4eb4d5f96c3259ed516ab88934
+  metadata.gz: 17131e6d6129f3831868f5a029b5c1f781e7fb31ca31fddd682b8bd0a3994f68
+  data.tar.gz: 748d5ac46b7647dd5ebfaf2338de458a2ff42e65d138b045dcd40e1eb5741f2d
 SHA512:
-  metadata.gz: d6382ae611e80b38e574357baa771b432c4e554662293e98e4a73ca446c9445264d902f0b604ee071fe9dac6cf6bee4fde8319f0f782975955fdd562cf921b6c
-  data.tar.gz: 1008b0e7e533e01b6636cc82e3e79b21c825d095d789d83c73c96142d9de78556c0caa38775aedb97a3b27e43a93f16281680f10a7d988fb005951084a36f75e
+  metadata.gz: 289f4b0e533dbc666d649017ca97669525adc14976d135bbd9191955f5fe70384c3506261d65b89071752e1a23137593d70cb4afd47805a67a2b400e34e7fe3f
+  data.tar.gz: c85623dad76f6c4d02a49bbdddb602191c709576717cc2fad66a2b5324ff9824469fb3d1a70e98ad07c477a3b0191e47e1c5890e93bd7a13aaf5937302d0b8e4

data/lib/zuora_api/login.rb

@@ -45,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?
@@ -61,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
@@ -1022,12 +1024,41 @@ 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"}
+      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
@@ -1114,10 +1145,8 @@ 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
@@ -1282,7 +1311,8 @@ 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?

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.09"
+  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.09
+  version: 1.10.0
 platform: ruby
 authors:
 - Zuora Strategic Solutions Group
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-04 00:00:00.000000000 Z
+date: 2021-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler