zuora_api 1.4.11 → 1.4.12a

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bdfec52e22872643c4bebaf0180674c09e5a2f60
-  data.tar.gz: d090db16a0cb99fa37052909bb08bfb87a76c8e1
+  metadata.gz: 9c2ff60f716bb9b66d52c5767f031985de537182
+  data.tar.gz: 648b9c11245171abd400674c003249bb38306d2f
 SHA512:
-  metadata.gz: c7cab09f0e5afc76f8edaf57a6a759d38f1b4731238cfb67e0b2f33f6876192a508f59f08907de3a6b60d7dec1bb3783d2e808bd7f9d44310c9cd592fed14fcf
-  data.tar.gz: 2f8b5b10781c75f7a628e8cfe2499d937abfa921220bebe68fe23d4f76367188fe356ac5967c9ca46b9a4ca239ae5d226ce246736a095eed3969f0a1867f35eb
+  metadata.gz: 97b99413b83727c39068d3e139b39a91d8370235520010167e0bcddd965693cbdb32484e2ea1542b86ef37c7c5550068787a5129108a30a7de01057be724a381
+  data.tar.gz: 9d6ef8cb0f11fdf5a911a8e9f97b804b850ca941ec7b940d96b2f2d1d7062e85285dbaf3eb53f87df8980d99724a5f93ddab7e9913fa64cecc2f6f16c99ccc76

data/.gitlab-ci.yml

@@ -48,3 +48,16 @@ rubygems-deploy:
   - gem push $version
   only:
   - master
+
+rubygems-deploy:
+  stage: deploy
+  allow_failure: false
+  when: manual
+  script:
+  - 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:
+  - staging

data/lib/zuora_api.rb

@@ -2,6 +2,7 @@ require 'rails'
 require "zuora_api/login"
 require 'zuora_api/exceptions'
 require "insights_api/login"
+require "zuora_api/metrics_helper"
 module ZuoraAPI
   # Your code goes here...
 end

data/lib/zuora_api/login.rb

@@ -1,9 +1,12 @@
 require "httparty"
 require "nokogiri"
+require "uri"
+
 module ZuoraAPI
   class Login
     ENVIRONMENTS = [SANDBOX = 'Sandbox', PRODUCTION = 'Production', PREFORMANCE = 'Preformance', SERVICES = 'Services', UNKNOWN = 'Unknown' ]
     REGIONS = [EU = 'EU', US = 'US' ]
+    XML_SAVE_OPTIONS = Nokogiri::XML::Node::SaveOptions::AS_XML | Nokogiri::XML::Node::SaveOptions::NO_DECLARATION
     attr_accessor :username, :password, :region,:url, :wsdl_number, :current_session, :environment, :status, :errors, :current_error, :user_info, :tenant_id, :tenant_name, :entity_id, :timeout_sleep
 
     def initialize(username: nil, password: nil, status: nil, url: nil, entity_id: nil, session: nil, **keyword_args)
@@ -40,7 +43,6 @@ module ZuoraAPI
             }
     end
 
-
     def update_environment
       if !self.url.blank?
         env_path = self.url.split('https://').last.split('.zuora.com').first
@@ -113,15 +115,15 @@ module ZuoraAPI
           end
         end
       end
-     
 
-      input_xml = Nokogiri::XML(request.to_xml(:save_with => Nokogiri::XML::Node::SaveOptions::AS_XML | Nokogiri::XML::Node::SaveOptions::NO_DECLARATION).strip)
+
+      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') {"Request SOAP XML: #{input_xml.to_xml(:save_with => Nokogiri::XML::Node::SaveOptions::AS_XML | Nokogiri::XML::Node::SaveOptions::NO_DECLARATION).strip}"} if debug
-      
-      @response_query = HTTParty.post(self.url,:body => request.to_xml(:save_with => Nokogiri::XML::Node::SaveOptions::AS_XML | Nokogiri::XML::Node::SaveOptions::NO_DECLARATION).strip, :headers => {'Content-Type' => "text/xml; charset=utf-8"}, :timeout => 10)
+      Rails.logger.debug('Connect') {"Request SOAP XML: #{input_xml.to_xml(:save_with => XML_SAVE_OPTIONS).strip}"} if debug
+
+      @response_query = HTTParty.post(self.url,:body => request.to_xml(:save_with => XML_SAVE_OPTIONS).strip, :headers => {'Content-Type' => "text/xml; charset=utf-8"}, :timeout => 10)
       @output_xml = Nokogiri::XML(@response_query.body)
-      Rails.logger.debug('Connect') {"Response SOAP XML: #{@output_xml.to_xml(:save_with => Nokogiri::XML::Node::SaveOptions::AS_XML | Nokogiri::XML::Node::SaveOptions::NO_DECLARATION).strip}"} if debug
+      Rails.logger.debug('Connect') {"Response SOAP XML: #{@output_xml.to_xml(:save_with => XML_SAVE_OPTIONS).strip}"} if debug
 
 
       if !@response_query.success?
@@ -173,16 +175,16 @@ module ZuoraAPI
       else
         #If Session only is used for Gem TODO Depercate
         if (self.password.blank? && self.current_session.present?)
-          self.current_session = self.current_session 
+          self.current_session = self.current_session
           self.username        = @output_xml.xpath('//ns1:Username', 'ns1' =>'http://api.zuora.com/').text if self.username.blank?
-          
+
         #Username & password combo
         elsif (self.password.present? && self.username.present?)
           retrieved_session = @output_xml.xpath('//ns1:Session', 'ns1' =>'http://api.zuora.com/').text
           raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new("No session found for api call.") if retrieved_session.blank?
           self.current_session = retrieved_session
         end
-        
+
         self.current_error     = nil
         self.status            = 'Active'
       end
@@ -208,6 +210,9 @@ module ZuoraAPI
 
     def soap_call(ns1: 'ns1', ns2: 'ns2', batch_size: nil, single_transaction: false, debug: true, errors: [ZuoraAPI::Exceptions::ZuoraAPISessionError, ZuoraAPI::Exceptions::ZuoraAPIError, ZuoraAPI::Exceptions::ZuoraAPIRequestLimit, ZuoraAPI::Exceptions::ZuoraAPILockCompetition], z_session: true, timeout_retry: false, timeout: 120,**keyword_args)
       tries ||= 2
+      error_type = ""
+      start_time = Time.now
+
       xml = 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/",
@@ -235,16 +240,18 @@ module ZuoraAPI
         end
       end
 
-      input_xml = Nokogiri::XML(xml.to_xml(:save_with => Nokogiri::XML::Node::SaveOptions::AS_XML | Nokogiri::XML::Node::SaveOptions::NO_DECLARATION).strip)
+      input_xml = Nokogiri::XML(xml.to_xml(:save_with => XML_SAVE_OPTIONS).strip)
       input_xml.xpath('//ns1:session', 'ns1' =>'http://api.zuora.com/').children.remove
-      Rails.logger.debug('Connect') {"Request SOAP XML: #{input_xml.to_xml(:save_with => Nokogiri::XML::Node::SaveOptions::AS_XML | Nokogiri::XML::Node::SaveOptions::NO_DECLARATION).strip}"} if debug
-      response = HTTParty.post(self.url,:body => xml.doc.to_xml(:save_with => Nokogiri::XML::Node::SaveOptions::AS_XML | Nokogiri::XML::Node::SaveOptions::NO_DECLARATION).strip, :headers => {'Content-Type' => "text/xml; charset=utf-8"}, :timeout => timeout)
+      Rails.logger.debug('Connect') {"Request SOAP XML: #{input_xml.to_xml(:save_with => XML_SAVE_OPTIONS).strip}"} if debug
+
+      response = HTTParty.post(self.url,:body => xml.doc.to_xml(:save_with => XML_SAVE_OPTIONS).strip, :headers => {'Content-Type' => "text/xml; charset=utf-8"}, :timeout => timeout)
       output_xml = Nokogiri::XML(response.body)
-      Rails.logger.debug('Connect') {"Response SOAP XML: #{output_xml.to_xml(:save_with => Nokogiri::XML::Node::SaveOptions::AS_XML | Nokogiri::XML::Node::SaveOptions::NO_DECLARATION).strip}"} if debug
+      Rails.logger.debug('Connect') {"Response SOAP XML: #{output_xml.to_xml(:save_with => XML_SAVE_OPTIONS).strip}"} if debug
 
       raise_errors(type: :SOAP, body: output_xml, response: response)
-   
+
     rescue ZuoraAPI::Exceptions::ZuoraAPISessionError => ex
+      error_type = "#{ex.class}"
       if !(tries -= 1).zero? && z_session
         Rails.logger.debug {"Session Invalid"}
         self.new_session
@@ -253,16 +260,18 @@ module ZuoraAPI
         if errors.include?(ex.class)
           raise ex
         else
-          return [output_xml, input_xml]
+          return output_xml, input_xml, response
         end
       end
     rescue ZuoraAPI::Exceptions::ZuoraAPIError, ZuoraAPI::Exceptions::ZuoraAPIRequestLimit, ZuoraAPI::Exceptions::ZuoraAPILockCompetition => ex
+      error_type = "#{ex.class}"
       if errors.include?(ex.class)
         raise ex
       else
-        return [output_xml, input_xml]
+        return output_xml, input_xml, response
       end
     rescue Net::OpenTimeout, Errno::ECONNRESET, Errno::ECONNREFUSED, SocketError => ex
+      error_type = "#{ex.class}"
       if !(tries -= 1).zero? && timeout_retry
         Rails.logger.info {"#{ex.class} Timed out will retry after 5 seconds"}
         sleep(self.timeout_sleep)
@@ -271,15 +280,22 @@ module ZuoraAPI
         raise ex
       end
     rescue => ex
+      error_type = "#{ex.class}"
       raise ex
     else
-      return [output_xml, input_xml]
+      return output_xml, input_xml, response
+    ensure
+      # Writing to telegraf
+      end_time = Time.now #if exception is caught, need to measure end_time again
+      response_time = end_time - start_time
+      status_code = response.code if response
+      endpoint_name = URI(url).host
+      ::MetricsHelpers::MetricsHelpers.write_to_telegraf("response_time": response_time, "status_code": status_code, "endpoint_name": endpoint_name, "direction": "outbound", "error_type": error_type, "function_name": "#{self.class}##{__method__}", "method_name": "POST")
     end
 
     def raise_errors(type: :SOAP, body: nil, response: nil)
       case type
       when :SOAP
-
         error   = body.xpath('//fns:FaultCode', 'fns' =>'http://fault.api.zuora.com/').text
         message = body.xpath('//fns:FaultMessage', 'fns' =>'http://fault.api.zuora.com/').text
 
@@ -287,7 +303,7 @@ module ZuoraAPI
           error   = body.xpath('//faultcode').text
           message = body.xpath('//faultstring').text
         end
-        
+
         if error.blank? || message.blank?
           error   = body.xpath('//ns1:Code', 'ns1' =>'http://api.zuora.com/').text
           message = body.xpath('//ns1:Message', 'ns1' =>'http://api.zuora.com/').text
@@ -298,9 +314,9 @@ module ZuoraAPI
           error = []
           success = []
           body.xpath('//ns1:result', 'ns1' =>'http://api.zuora.com/').each_with_index do |call, object_index|
-              
+
             if call.xpath('./ns1:Success', 'ns1' =>'http://api.zuora.com/').text == 'false'
-              message = "#{call.xpath('./*/ns1:Code', 'ns1' =>'http://api.zuora.com/').text}::#{call.xpath('./*/ns1:Message', 'ns1' =>'http://api.zuora.com/').text}" 
+              message = "#{call.xpath('./*/ns1:Code', 'ns1' =>'http://api.zuora.com/').text}::#{call.xpath('./*/ns1:Message', 'ns1' =>'http://api.zuora.com/').text}"
               error.push(message)
             else
               success.push(call.xpath('./ns1:Id', 'ns1' =>'http://api.zuora.com/').text)
@@ -312,23 +328,27 @@ module ZuoraAPI
         if error.present?
           if error.class == String
             if error == "INVALID_SESSION"
-              raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new("#{error}::#{message}", body, response.present? ? response.code : nil )
+              raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new("#{error}::#{message}", body, response.code )
             end
             if error == "REQUEST_EXCEEDED_LIMIT"
-              raise ZuoraAPI::Exceptions::ZuoraAPIRequestLimit.new("#{error}::#{message}", body, response.present? ? response.code : nil)
+              raise ZuoraAPI::Exceptions::ZuoraAPIRequestLimit.new("#{error}::#{message}", body, response.code)
             end
             if error == "LOCK_COMPETITION"
-              raise ZuoraAPI::Exceptions::ZuoraAPILockCompetition.new("#{error}::#{message}", body, response.present? ? response.code : nil)
+              raise ZuoraAPI::Exceptions::ZuoraAPILockCompetition.new("#{error}::#{message}", body, response.code)
             end
             if error.present?
-              raise ZuoraAPI::Exceptions::ZuoraAPIError.new("#{error}::#{message}", body, response.present? ? response.code : nil)
+              raise ZuoraAPI::Exceptions::ZuoraAPIError.new("#{error}::#{message}", body, response.code)
             end
           elsif error.class == Array
-            raise ZuoraAPI::Exceptions::ZuoraAPIError.new(error.group_by {|v| v}.map {|k,v| "(#{v.size}x) - #{k}"}.join(', '), body, response.present? ? response.code : nil, error, success)
+            raise ZuoraAPI::Exceptions::ZuoraAPIError.new(error.group_by {|v| v}.map {|k,v| "(#{v.size}x) - #{k == "::" ? 'UNKNOWN::No error provided' : k}"}.join(', '), body, response.code, error, success)
           end
         end
- 
-      when :JSON        
+
+        if response.code == 429
+          raise ZuoraAPI::Exceptions::ZuoraAPIRequestLimit.new("The total number of concurrent requests has exceeded the limit allowed by the system. Please resubmit your request later.", body, response.code)
+        end
+
+      when :JSON
         if body.class == Hash && (!body["success"] || !body["Success"] || response.code != 200)
           messages_array = (body["reasons"] || []).map {|error| error['message']}.compact
           codes_array = (body["reasons"] || []).map {|error| error['code']}.compact
@@ -354,7 +374,7 @@ module ZuoraAPI
           end
 
           #All Errors catch
-          if codes_array.size > 0 
+          if codes_array.size > 0
             raise ZuoraAPI::Exceptions::ZuoraAPIError.new("#{messages_array.join(', ')}", body, response.code)
           end
 
@@ -371,7 +391,7 @@ module ZuoraAPI
               raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new("#{body["faultcode"]}::#{body["faultstring"]}", body, response.code)
             else
               raise ZuoraAPI::Exceptions::ZuoraAPIError.new("#{body["faultcode"]}::#{body["faultstring"]}", body, response.code)
-            end 
+            end
           end
 
           if body["Errors"].present? || body["errors"].present?
@@ -383,20 +403,24 @@ module ZuoraAPI
             end
           end
         end
- 
+
         #Zuora REST Actions error (Create, Update, Delete)
         if body.class == Array
           all_errors = body.select {|obj| !obj['Success'] || !obj['success'] }.map {|obj| obj['Errors'] || obj['errors'] }.compact
           all_success = body.select {|obj| obj['Success'] || obj['success']}.compact
 
-          if all_errors.size > 0 
-            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("#{all_errors.flatten.group_by {|error| error['Message']}.keys.uniq.join(' ')}", body, response.code, all_errors, all_success  ) 
+          if all_errors.size > 0
+            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("#{all_errors.flatten.group_by {|error| error['Message']}.keys.uniq.join(' ')}", body, response.code, all_errors, all_success  )
           end
         end
 
         #All other errors
         if response.code != 200
-          raise ZuoraAPI::Exceptions::ZuoraAPIError.new("#{response.message}", body, response.code)
+          if response.code == 429
+            raise ZuoraAPI::Exceptions::ZuoraAPIRequestLimit.new("The total number of concurrent requests has exceeded the limit allowed by the system. Please resubmit your request later.", body, response.code)
+          else
+            raise ZuoraAPI::Exceptions::ZuoraAPIError.new("#{response.message}", body, response.code)
+          end
         end
       end
     end
@@ -441,11 +465,16 @@ module ZuoraAPI
 
     def describe_call(object = nil)
       tries ||= 2
+
+      error_type = ""
+      start_time = Time.now
+
       self.get_session
       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.blank? ? {"entityId" => self.entity_id, 'Content-Type' => "text/xml; charset=utf-8"} : {'Content-Type' => "text/xml; charset=utf-8"}
-      response = HTTParty.get(url, :headers => headers , basic_auth: {:username => self.username, :password => self.password}, :timeout => 120)
+      response = HTTParty.get(url, :headers => headers , basic_auth: {:username => self.username, :password => self.password}, :timeout => 1)
+
       output_xml = Nokogiri::XML(response.body)
       des_hash = Hash.new
       if object == nil
@@ -476,6 +505,7 @@ module ZuoraAPI
         des_hash[:related_objects] = output_xml.xpath(".//related-objects").xpath(".//object").map{ |x| [x.xpath(".//name").text.to_sym, [ [:url, x.attributes["href"].value], [:label, x.xpath(".//name").text ] ].to_h] }.to_h
       end
     rescue Net::ReadTimeout, Net::OpenTimeout, Errno::EPIPE, Errno::ECONNRESET, Errno::ECONNREFUSED, SocketError => ex
+      error_type = "#{ex.class}"
       if !(tries -= 1).zero?
         Rails.logger.info {"#{ex.class} Timed out will retry after 5 seconds"}
         sleep(self.timeout_sleep)
@@ -484,18 +514,28 @@ module ZuoraAPI
         raise ex
       end
     rescue => ex
+      error_type = "#{ex.class}"
       raise ex
     else
       return des_hash
+    ensure
+      # Writing to telegraf
+      end_time = Time.now
+      response_time = end_time - start_time
+      status_code = response.code if response
+      endpoint_name = URI(url).host
+      ::MetricsHelpers::MetricsHelpers.write_to_telegraf("response_time": response_time, "status_code": status_code, "endpoint_name": endpoint_name, "direction": "outbound", "error_type": error_type, "function_name": "#{self.class}##{__method__}", "method_name": "GET")
     end
 
     def rest_call(method: :get, body: {},headers: {}, url: rest_endpoint("catalog/products?pageSize=4"), debug: true, errors: [ZuoraAPI::Exceptions::ZuoraAPISessionError, ZuoraAPI::Exceptions::ZuoraAPIError, ZuoraAPI::Exceptions::ZuoraAPIRequestLimit, ZuoraAPI::Exceptions::ZuoraAPILockCompetition], z_session: true, timeout_retry: false, timeout: 120, **keyword_args)
       tries ||= 2
       headers["entityId"] = self.entity_id if !self.entity_id.blank?
       raise "Method not supported, supported methods include: :get, :post, :put, :delete, :patch, :head, :options" if ![:get, :post, :put, :delete, :patch, :head, :options].include?(method)
+
+      error_type = ""
+      start_time = Time.now
       response = HTTParty::Request.new("Net::HTTP::#{method.to_s.capitalize}".constantize, url, body: body, headers: {'Content-Type' => "application/json; charset=utf-8"}.merge(z_session ? {"Authorization" => "ZSession #{self.get_session}"} : {}).merge(headers), timeout: timeout).perform
 
-      Rails.logger.debug('Connect') {"Response Code: #{response.code}" } if debug
       begin
         output_json = JSON.parse(response.body)
       rescue JSON::ParserError => ex
@@ -506,6 +546,7 @@ module ZuoraAPI
       raise_errors(type: :JSON, body: output_json, response: response)
 
     rescue ZuoraAPI::Exceptions::ZuoraAPISessionError => ex
+      error_type = "#{ex.class}"
       if !(tries -= 1).zero? && z_session
         Rails.logger.debug {"Session Invalid"}
         self.new_session
@@ -518,12 +559,14 @@ module ZuoraAPI
         end
       end
     rescue ZuoraAPI::Exceptions::ZuoraAPIError, ZuoraAPI::Exceptions::ZuoraAPIRequestLimit, ZuoraAPI::Exceptions::ZuoraAPILockCompetition  => ex
+      error_type = "#{ex.class}"
       if errors.include?(ex.class)
         raise ex
       else
         return [output_json, response]
       end
     rescue Net::OpenTimeout, Errno::ECONNRESET, Errno::ECONNREFUSED, SocketError => ex
+      error_type = "#{ex.class}"
       if !(tries -= 1).zero? && timeout_retry
         Rails.logger.info {"#{ex.class} Timed out will retry after 5 seconds"}
         sleep(self.timeout_sleep)
@@ -532,9 +575,17 @@ module ZuoraAPI
         raise ex
       end
     rescue => ex
+      error_type = "#{ex.class}"
       raise ex
     else
       return [output_json, response]
+    ensure
+      # Writing to telegraf
+      end_time = Time.now
+      response_time = end_time - start_time
+      status_code = response.code if response
+      endpoint_name = URI(url).host
+      ::MetricsHelpers::MetricsHelpers.write_to_telegraf("response_time": response_time, "status_code": status_code, "endpoint_name": endpoint_name, "direction": "outbound", "error_type": error_type, "function_name": "#{self.class}##{__method__}", "method_name": "#{method.upcase}")
     end
 
     def update_create_tenant
@@ -590,9 +641,12 @@ module ZuoraAPI
       require 'fileutils'
       FileUtils.mkdir_p(file_path) unless File.exists?(file_path)
 
+      error_type = ""
+      start_time = Time.now
+
       begin
+        status_code = nil
         uri = URI.parse(url)
-
         http = Net::HTTP.new(uri.host, uri.port)
         http.read_timeout = timeout #Seconds
         http.use_ssl = true  if uri.scheme.downcase == 'https'
@@ -601,6 +655,8 @@ module ZuoraAPI
         response_save = nil
         http.request_get(uri.path, headers) do |response|
           response_save = response
+          status_code = response.code if response
+
           case response
           when Net::HTTPNotFound
             Rails.logger.fatal("404 - Not Found")
@@ -686,18 +742,27 @@ module ZuoraAPI
 
             file_handle.close
             Rails.logger.info("Filepath: #{file_handle.path} Size: #{File.size(file_handle.path).to_f/1000000} mb")
-            
+
             return file_handle
           end
         end
       rescue Exception => e
+        error_type = "#{e.class}"
         Rails.logger.fatal('GetFile') {"Download Failed: #{response_save} - #{e.class} : #{e.message}"}
         Rails.logger.fatal('GetFile') {"Download Failed: #{e.backtrace.join("\n")}"}
         raise
+      ensure
+        # Writing to telegraf
+        end_time = Time.now
+        response_time = end_time - start_time
+        endpoint_name = URI(url).host
+        ::MetricsHelpers::MetricsHelpers.write_to_telegraf("response_time": response_time, "status_code": status_code, "endpoint_name": endpoint_name, "direction": "outbound", "error_type": error_type, "function_name": "#{self.class}##{__method__}", "method_name": "GET")
       end
     end
 
     def getDataSourceExport(query, extract: true, encrypted: false, zip: true)
+      error_type = ""
+      start_time = Time.now
       Rails.logger.info('Export') {"Build export"}
       Rails.logger.debug('Export query') {"#{query}"}
       request = Nokogiri::XML::Builder.new do |xml|
@@ -720,7 +785,19 @@ module ZuoraAPI
           end
         end
       end
-      response_query = HTTParty.post(self.url, body: request.to_xml(:save_with => Nokogiri::XML::Node::SaveOptions::AS_XML | Nokogiri::XML::Node::SaveOptions::NO_DECLARATION).strip, headers: {'Content-Type' => "application/json; charset=utf-8"}, :timeout => 120)
+
+      begin
+        response_query = HTTParty.post(self.url, body: request.to_xml(:save_with => XML_SAVE_OPTIONS).strip, headers: {'Content-Type' => "application/json; charset=utf-8"}, :timeout => 120)
+      rescue => e
+        error_type = "#{e.class}"
+      ensure
+        end_time = Time.now
+        response_time = end_time - start_time
+        status_code = response_query.code if response_query
+        endpoint_name = URI(url).host
+        ::MetricsHelpers::MetricsHelpers.write_to_telegraf("response_time": response_time, "status_code": status_code, "endpoint_name": endpoint_name, "direction": "outbound", "error_type": error_type, "function_name": "#{self.class}##{__method__}", "method_name": "POST")
+      end
+
       output_xml = Nokogiri::XML(response_query.body)
 
       raise 'Export Creation Unsuccessful : ' + output_xml.xpath('//ns1:Message', 'ns1' =>'http://api.zuora.com/').text if  output_xml.xpath('//ns1:Success', 'ns1' =>'http://api.zuora.com/').text != "true"
@@ -741,15 +818,29 @@ module ZuoraAPI
         end
       end
       result = 'Waiting'
+
+      start_time = Time.now
+      error_type = ""
+
       while result != "Completed"
         sleep 3
-        response_query = HTTParty.post(self.url, body: confirmRequest.to_xml(:save_with => Nokogiri::XML::Node::SaveOptions::AS_XML | Nokogiri::XML::Node::SaveOptions::NO_DECLARATION).strip, headers: {'Content-Type' => "application/json; charset=utf-8"}, :timeout => 120)
+        begin
+          response_query = HTTParty.post(self.url, body: confirmRequest.to_xml(:save_with => XML_SAVE_OPTIONS).strip, headers: {'Content-Type' => "application/json; charset=utf-8"}, :timeout => 120)
+        rescue => e
+          error_type = "#{e.class}"
+        end
         output_xml = Nokogiri::XML(response_query.body)
-
         result = output_xml.xpath('//ns2:Status',  'ns2' =>'http://object.api.zuora.com/').text
+        status_code = response_query.code if response_query
         raise "Export Creation Unsuccessful : #{output_xml.xpath('//ns1:Message', 'ns1' =>'http://api.zuora.com/').text}" if result.blank? || result == "Failed"
       end
 
+      end_time = Time.now
+      response_time = end_time - start_time
+      endpoint_name = URI(url).host
+      ::MetricsHelpers::MetricsHelpers.write_to_telegraf("response_time": response_time, "status_code": status_code, "endpoint_name": endpoint_name, "direction": "outbound", "error_type": error_type, "function_name": "#{self.class}##{__method__}", "method_name": "POST")
+
+
       file_id = output_xml.xpath('//ns2:FileId',  'ns2' =>'http://object.api.zuora.com/').text
       Rails.logger.info('Export') {'=====> Export finished'}
       export_file = get_file(:url => self.fileURL(file_id))
@@ -777,7 +868,7 @@ module ZuoraAPI
         end
       end
       if parse
-        return [] if output_xml.xpath('//ns1:size', 'ns1' =>'http://api.zuora.com/').text == '0' 
+        return [] if output_xml.xpath('//ns1:size', 'ns1' =>'http://api.zuora.com/').text == '0'
         data = output_xml.xpath('//ns1:records', 'ns1' =>'http://api.zuora.com/').map {|record| record.children.map {|element| [element.name, element.text]}.to_h}
         return data
       else
@@ -786,14 +877,29 @@ module ZuoraAPI
     end
 
     def createJournalRun(call)
+      error_type = ""
+      start_time = Time.now
+
       url = rest_endpoint("/journal-runs")
       uri = URI(url)
       req = Net::HTTP::Post.new(uri,initheader = {'Content-Type' =>'application/json'})
       req.basic_auth self.username, self.password
       req.body = call
-      response = Net::HTTP.start(uri.host, uri.port, :use_ssl => true) do |http|
-        http.request req
+
+      begin
+        response = Net::HTTP.start(uri.host, uri.port, :use_ssl => true) do |http|
+          http.request req
+        end
+      rescue => e
+        error_type = "#{e.class}"
+      ensure
+        end_time = Time.now
+        response_time = end_time - start_time
+        status_code = response.code if response
+        endpoint_name = URI(url).host
+        ::MetricsHelpers::MetricsHelpers.write_to_telegraf("response_time": response_time, "status_code": status_code, "endpoint_name": endpoint_name, "direction": "outbound", "error_type": error_type, "function_name": "#{self.class}##{__method__}", "method_name": "POST")
       end
+
       Rails.logger.debug('Journal Run') {"Response #{response.code} #{response.message}:
         #{response.body}"}
 
@@ -806,17 +912,35 @@ module ZuoraAPI
         Rails.logger.debug('Journal Run') {"Journal Run failed with message #{message}"}
         return result
       end
+
     end
 
     def checkJRStatus(jrNumber)
+      error_type = ""
+
       Rails.logger.info('Journal Run') {"Check for completion"}
+
+      start_time = Time.now
+
       url = rest_endpoint("/journal-runs/#{jrNumber}")
       uri = URI(url)
       req = Net::HTTP::Get.new(uri,initheader = {'Content-Type' =>'application/json'})
       req.basic_auth self.username, self.password
-      response = Net::HTTP.start(uri.host, uri.port, :use_ssl => true) do |http|
-        http.request req
+
+      begin
+        response = Net::HTTP.start(uri.host, uri.port, :use_ssl => true) do |http|
+          http.request req
+        end
+      rescue => e
+        error_type = "#{e.class}"
+      ensure
+        end_time = Time.now
+        response_time = end_time - start_time
+        status_code = response.code if response
+        endpoint_name = URI(url).host
+        ::MetricsHelpers::MetricsHelpers.write_to_telegraf("response_time": response_time, "status_code": status_code, "endpoint_name": endpoint_name, "direction": "outbound", "error_type": error_type, "function_name": "#{self.class}##{__method__}", "method_name": "GET")
       end
+
       result = JSON.parse(response.body)
 
       if result["success"]

data/lib/zuora_api/metrics_helper.rb

@@ -0,0 +1,12 @@
+module MetricsHelpers
+
+  class MetricsHelpers
+    def self.write_to_telegraf(response_time: nil, status_code: nil, endpoint_name: nil, direction: nil, error_type: nil, function_name: nil, method_name: nil)
+      if Gem.loaded_specs.has_key?('zuora_connect') && defined?(::ZuoraConnect::AppInstance.write_to_telegraf)
+        Thread.current[:appinstance].present? ? app_instance = Thread.current[:appinstance].id : app_instance = 0
+        ZuoraConnect::AppInstanceBase.write_to_telegraf("response_time": response_time, "status_code": status_code, "endpoint_name": endpoint_name, "direction": "outbound", "error_type": error_type, "app_instance": app_instance, "function_name": function_name, "method_name": method_name)
+      end
+    end
+  end
+
+end

data/lib/zuora_api/version.rb

@@ -1,3 +1,3 @@
 module ZuoraAPI
-  VERSION = "1.4.11"
+  VERSION = "1.4.12a"
 end

data/zuora_api.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency("httparty")
   spec.add_dependency("rubyzip")
   spec.add_dependency("railties", ">= 4.1.0", "< 5.1")
+  spec.add_dependency('telegraf', '~> 0.4.0') # Add dependency for telegraf
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zuora_api
 version: !ruby/object:Gem::Version
-  version: 1.4.11
+  version: 1.4.12a
 platform: ruby
 authors:
 - Zuora Strategic Solutions Group
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-23 00:00:00.000000000 Z
+date: 2018-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -142,6 +142,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: telegraf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
 description: Gem that provides easy integration to Zuora
 email:
 - connect@zuora.com
@@ -163,6 +177,7 @@ files:
 - lib/zuora_api.rb
 - lib/zuora_api/exceptions.rb
 - lib/zuora_api/login.rb
+- lib/zuora_api/metrics_helper.rb
 - lib/zuora_api/version.rb
 - zuora_api.gemspec
 homepage: https://connect.zuora.com
@@ -179,9 +194,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.8