zuora_api 1.6.25 → 1.6.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e550dd86e9507f9652c0523af913d907dfefa22f
-  data.tar.gz: 66c1f11eda0adab384baf5d2a970ccf72163fe25
+  metadata.gz: e86b5da627b9f51c342da05d5e4110e3385a35a4
+  data.tar.gz: 9ccf40e8d6dfca789d16207421dc07352ad8c921
 SHA512:
-  metadata.gz: adedd68525df111f61712740df8d292578e883320e4b15f508087dea1e684d59eebd8eb09ff45e2fed64d7da277e73f1dad3d3182eb40a9164b465320fdfdbd1
-  data.tar.gz: 260d9b579be019134023fd270003341ed471f6d2897a02d2cae100fe8dcfc306b2723dc5793a0dec2be4e5d1e9235eeaa5c064764394a16729f8e3fc2c86e87e
+  metadata.gz: 35a3fb0d447a8a52d11762133e0fe11cccea7e5970c74aa31bc121153dc62d3aece97adaf08fa1a8cc6562c5eee2b74c9c24144ff981d503083530b10c1e3bb3
+  data.tar.gz: ef0b5f9af4d236df06de046d3afd6e8e649a007281036c9770df4cb289d31df99f3f1ae535eae55ff28154b6f098b60e0e46f90724b894d0b1dc27a0743b3795

data/CHANGELOG.md

@@ -11,12 +11,6 @@ All notable changes to this project will be documented in this file.
 ### Removed
 - Example
 
-## [1.6.22] - 2019-01-03
-
-### Changed
-- get_identity method - supports ZSession auth now
-- updated rspecs accordingly
-
 ## [1.6.18] - 2018-12-06
 ### Added
 - zconnect_provider attribute accessor for identifying ZConnect cookies
@@ -30,4 +24,15 @@ All notable changes to this project will be documented in this file.
 ### Changed
 - The way environment and region are set
 
+## [1.6.22] - 2019-01-03
 
+### Changed
+- get_identity method - supports ZSession auth now
+- updated rspecs accordingly
+
+## [1.6.26] - 2019-03-04
+
+### Changed
+- fixed get_oauth_client for non-staging environments
+- fixed to use correct rest endpoint without version for oauth creation api
+- changed get_oauth_client to no longer accept client id and secret as parameters

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    zuora_api (1.6.25)
+    zuora_api (1.6.26)
       httparty
       nokogiri
       railties (>= 4.1.0, < 5.2)
@@ -42,7 +42,7 @@ GEM
     httparty (0.16.4)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
-    i18n (1.5.3)
+    i18n (1.6.0)
       concurrent-ruby (~> 1.0)
     json (2.1.0)
     loofah (2.2.3)

data/lib/zuora_api/login.rb

@@ -156,13 +156,11 @@ module ZuoraAPI
     end
 
     # There are two ways to call this method. The first way is best.
-    # 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
+    # 1. Pass in cookies, name, and description
+    # 2. Pass in user_id, entity_ids, an existing client_id and client_secret, 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 (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, cookies: nil)
       authorization = ""
-      new_client_id = SecureRandom.uuid if new_client_id.blank?
-      new_client_secret = SecureRandom.hex(10) if new_client_secret.blank?
 
       if !cookies.nil?
         authorization = cookies["ZSession"]
@@ -178,18 +176,18 @@ module ZuoraAPI
           raise ZuoraAPI::Exceptions::ZuoraAPIError.new("Zuora User ID not provided", {}, 400)
         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'})
+        endpoint = self.rest_endpoint("oauth/token").gsub("v1/", "")
+        bearer_response = HTTParty.post(endpoint, :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_hash = JSON.parse(bearer_response.body)
         bearer_token = bearer_hash["access_token"]
         authorization = "Bearer #{bearer_token}"
       end
 
       if !authorization.blank? && !user_id.blank? && !entity_ids.blank?
-        endpoint = 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)
+        endpoint = self.rest_endpoint("genesis/clients").gsub("v1/", "")
+        oauth_response = HTTParty.post(endpoint, :headers => {'authorization' => authorization, 'Content-Type' => 'application/json'}, :body => {'userId' => user_id, 'entityIds' => entity_ids, '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
           return output_json
         elsif oauth_response.code == 401 && !oauth_response.message.blank?
           raise ZuoraAPI::Exceptions::ZuoraAPIError.new(output_json["message"], {}, oauth_response.code)
@@ -529,6 +527,7 @@ module ZuoraAPI
         end
 
       when :JSON
+        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["reasons"] || []).map {|error| error['message']}.compact
           codes_array = (body["reasons"] || []).map {|error| error['code']}.compact
@@ -599,7 +598,7 @@ module ZuoraAPI
           end
         end
 
-        #Zuora REST Actions error (Create, Update, Delete)
+        #Zuora REST Actions error (Create, Update, Delete, Amend)
         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
@@ -863,110 +862,116 @@ module ZuoraAPI
         end
 
         response_save = nil
-        http.request_get(uri.request_uri, headers) do |response|
-          response_save = response
-          status_code = response.code if response
-
-          case response
-          when Net::HTTPNotFound
-            Rails.logger.fatal("404 - Not Found")
-            raise
-
-          when Net::HTTPUnauthorized
-            if count <= 0
-              if z_session
-                raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new(self.current_error)
-              else
-                raise
+        begin
+          http.request_get(uri.request_uri, headers) do |response|
+            response_save = response
+            status_code = response.code if response
+
+            case response
+            when Net::HTTPNotFound
+              Rails.logger.fatal("404 - Not Found")
+              raise
+
+            when Net::HTTPUnauthorized
+              if count <= 0
+                if z_session
+                  raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new(self.current_error)
+                else
+                  raise
+                end
               end
-            end
-            Rails.logger.fatal("Unauthorized: Retry")
-            self.new_session if z_session
-            return get_file(:url => url, :headers => headers, :count => count - 1, :z_session => z_session, :tempfile => tempfile, :file_path => file_path, :timeout_retries => timeout_retries, :timeout => timeout)
+              Rails.logger.fatal("Unauthorized: Retry")
+              self.new_session if z_session
+              return get_file(:url => url, :headers => headers, :count => count - 1, :z_session => z_session, :tempfile => tempfile, :file_path => file_path, :timeout_retries => timeout_retries, :timeout => timeout)
 
-          when *(CONNECTION_EXCEPTIONS).concat(CONNECTION_READ_EXCEPTIONS)
-            Rails.logger.fatal("#{response.class} timeout - retry")
-            return get_file(:url => url, :headers => headers, :count => count, :z_session => z_session, :tempfile => tempfile, :file_path => file_path, :timeout_retries => timeout_retries - 1, :timeout => timeout)
+            when Net::HTTPClientError
+              raise
 
-          when Net::HTTPClientError
-            raise
+            when Net::HTTPOK
+              headers = {}
+              response.each_header do |k,v|
+                headers[k] = v
+              end
+              Rails.logger.debug("Headers: #{headers.to_s}")
 
-          when Net::HTTPOK
-            headers = {}
-            response.each_header do |k,v|
-              headers[k] = v
-            end
-            Rails.logger.debug("Headers: #{headers.to_s}")
+              if output_file_name.present?
+                file_ending ||= output_file_name.end_with?(".csv.zip") ? ".csv.zip" : File.extname(output_file_name)
+                filename ||= File.basename(output_file_name, file_ending)
+              end
 
-            if output_file_name.present?
-              file_ending ||= output_file_name.end_with?(".csv.zip") ? ".csv.zip" : File.extname(output_file_name)
-              filename ||= File.basename(output_file_name, file_ending)
-            end
+              size, export_progress = [0, 0]
+              encoding, type, full_filename = [nil, nil, nil]
+              if response.header["Content-Disposition"].present?
+                case response.header["Content-Disposition"]
+                when /.*; filename\*=.*/
+                  full_filename ||= /.*; filename\*=(.*)''(.*)/.match(response.header["Content-Disposition"])[2].strip
+                  encoding = /.*; filename\*=(.*)''(.*)/.match(response.header["Content-Disposition"])[1].strip
+                when /.*; filename=/
+                  full_filename ||= /.*; filename=(.*)/.match(response.header["Content-Disposition"])[1].strip
+                else
+                  raise "Can't parse Content-Disposition header: #{response.header["Content-Disposition"]}"
+                end
+                file_ending ||= full_filename.end_with?(".csv.zip") ? ".csv.zip" : File.extname(full_filename)
+                filename ||= File.basename(full_filename, file_ending)
+              end
 
-            size, export_progress = [0, 0]
-            encoding, type, full_filename = [nil, nil, nil]
-            if response.header["Content-Disposition"].present?
-              case response.header["Content-Disposition"]
-              when /.*; filename\*=.*/
-                full_filename ||= /.*; filename\*=(.*)''(.*)/.match(response.header["Content-Disposition"])[2].strip
-                encoding = /.*; filename\*=(.*)''(.*)/.match(response.header["Content-Disposition"])[1].strip
-              when /.*; filename=/
-                full_filename ||= /.*; filename=(.*)/.match(response.header["Content-Disposition"])[1].strip
-              else
-                raise "Can't parse Content-Disposition header: #{response.header["Content-Disposition"]}"
+              #If user supplied a filename use it, else default to content header filename, else default to uri pattern
+              file_ending ||= uri.path.end_with?(".csv.zip") ? ".csv.zip" : File.extname(uri.path)
+              filename ||= File.basename(uri.path, file_ending)
+
+              if response.header["Content-Type"].present?
+                case response.header["Content-Type"]
+                when /.*;charset=.*/
+                  type = /(.*);charset=(.*)/.match(response.header["Content-Type"])[1]
+                  encoding = /(.*);charset=(.*)/.match(response.header["Content-Type"])[2]
+                else
+                  type = response.header["Content-Type"]
+                  encoding ||= 'UTF-8'
+                end
               end
-              file_ending ||= full_filename.end_with?(".csv.zip") ? ".csv.zip" : File.extname(full_filename)
-              filename ||= File.basename(full_filename, file_ending)
-            end
+              Rails.logger.info("File: #{filename}#{file_ending}  #{encoding}  #{type}")
 
-            #If user supplied a filename use it, else default to content header filename, else default to uri pattern
-            file_ending ||= uri.path.end_with?(".csv.zip") ? ".csv.zip" : File.extname(uri.path)
-            filename ||= File.basename(uri.path, file_ending)
+              if response.header["Content-Length"].present?
+                export_size = response.header["Content-Length"].to_i
+              elsif response.header["ContentLength"].present?
+                export_size = response.header["ContentLength"].to_i
+              end
 
-            if response.header["Content-Type"].present?
-              case response.header["Content-Type"]
-              when /.*;charset=.*/
-                type = /(.*);charset=(.*)/.match(response.header["Content-Type"])[1]
-                encoding = /(.*);charset=(.*)/.match(response.header["Content-Type"])[2]
+              file_prefix = add_timestamp ? "#{filename}_#{Time.now.to_i}" : filename
+              if tempfile
+                require 'tempfile'
+                file_handle = ::Tempfile.new([file_prefix, "#{file_ending}"], file_path)
               else
-                type = response.header["Content-Type"]
-                encoding ||= 'UTF-8'
+                file_handle = File.new(file_path.join("#{file_prefix}#{file_ending}"), "w+")
               end
-            end
-            Rails.logger.info("File: #{filename}#{file_ending}  #{encoding}  #{type}")
-
-            if response.header["Content-Length"].present?
-              export_size = response.header["Content-Length"].to_i
-            elsif response.header["ContentLength"].present?
-              export_size = response.header["ContentLength"].to_i
-            end
-
-            file_prefix = add_timestamp ? "#{filename}_#{Time.now.to_i}" : filename
-            if tempfile
-              require 'tempfile'
-              file_handle = ::Tempfile.new([file_prefix, "#{file_ending}"], file_path)
-            else
-              file_handle = File.new(file_path.join("#{file_prefix}#{file_ending}"), "w+")
-            end
-            file_handle.binmode
-
-            response.read_body do |chunk|
-              file_handle << chunk.force_encoding(encoding)
-
-              if defined?(export_size) && export_size != 0  && export_size.class == Integer
-                size += chunk.size
-                new_progress = (size * 100) / export_size
-                unless new_progress == export_progress
-                  Rails.logger.debug("Login: Export Downloading %s (%3d%%)" % [filename, new_progress])
+              file_handle.binmode
+
+              response.read_body do |chunk|
+                file_handle << chunk.force_encoding(encoding)
+
+                if defined?(export_size) && export_size != 0  && export_size.class == Integer
+                  size += chunk.size
+                  new_progress = (size * 100) / export_size
+                  unless new_progress == export_progress
+                    Rails.logger.debug("Login: Export Downloading %s (%3d%%)" % [filename, new_progress])
+                  end
+                  export_progress = new_progress
                 end
-                export_progress = new_progress
               end
-            end
 
-            file_handle.close
-            Rails.logger.debug("Filepath: #{file_handle.path} Size: #{File.size(file_handle.path).to_f/1000000} mb")
+              file_handle.close
+              Rails.logger.debug("Filepath: #{file_handle.path} Size: #{File.size(file_handle.path).to_f/1000000} mb")
 
-            return file_handle
+              return file_handle
+            end
+          end
+        rescue *(CONNECTION_EXCEPTIONS).concat(CONNECTION_READ_EXCEPTIONS) => e
+          sleep(5)
+          if (timeout_retries -= 1) >= 0
+            Rails.logger.warn("Download Failed: #{e.class} : #{e.message}")
+            retry
+          else
+            raise
           end
         end
       rescue Exception => e

data/lib/zuora_api/logins/basic.rb

@@ -27,11 +27,11 @@ module ZuoraAPI
       
       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 => XML_SAVE_OPTIONS).strip}"} if debug
+      Rails.logger.debug('Connect') {"Request Code: #{@response_query.code} 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 => XML_SAVE_OPTIONS).strip}"} if debug   
+      Rails.logger.debug('Connect') {"Response Code: #{@response_query.code} SOAP XML: #{@output_xml.to_xml(:save_with => XML_SAVE_OPTIONS).strip}"} if debug   
 
       if !@response_query.success?
         self.current_session = nil
@@ -88,6 +88,7 @@ module ZuoraAPI
         #Username & password combo
         retrieved_session = @output_xml.xpath('//ns1:Session', 'ns1' =>'http://api.zuora.com/').text
         raise ZuoraAPI::Exceptions::ZuoraAPISessionError.new("No session found for api call.") if retrieved_session.blank?
+        self.status = 'Active'
         self.current_session = retrieved_session
       end
       return self.status
@@ -101,6 +102,12 @@ module ZuoraAPI
         self.status = 'Timeout'
         return self.status
       end
+    rescue EOFError
+      if self.url.match?(/.*services\d{1,}.zuora.com*/)
+        self.current_error = "Services tenant '#{self.url.scan(/.*\/\/(services\d{1,}).zuora.com*/).last.first}' is no longer available."
+        self.status = 'Not Available'
+        return self.status
+      end
     end
   end
 end

data/lib/zuora_api/version.rb

@@ -1,3 +1,3 @@
 module ZuoraAPI
-  VERSION = "1.6.25"
+  VERSION = "1.6.26"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zuora_api
 version: !ruby/object:Gem::Version
-  version: 1.6.25
+  version: 1.6.26
 platform: ruby
 authors:
 - Zuora Strategic Solutions Group
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-07 00:00:00.000000000 Z
+date: 2019-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler