improved_jenkins_client 1.6.2 → 1.6.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26e682d2f9c008a0943a3ff4d76fdc5a9ea614135eef5ed6f8dfc20c692c1c3d
-  data.tar.gz: 4ee3bc91c1cc3e7c86601012de333e79fde95b73e4b828a7c2e899dd28abd3c1
+  metadata.gz: f381907a06146eab9fc814b98a7233a8981a570e2f5f812936f22d5d745844f5
+  data.tar.gz: 8f2011c9223b397e8d3045d259f715f3e346fa4bad1f24d778cb743699781a92
 SHA512:
-  metadata.gz: 2c2c4e95a00b51edd873288112253bcba265475e7dcb50466d0f6d5629850adefb1c9b9ce983cbb4f2ad3b5160a7f1be22827fcf12b4fccb105e060bdd0e3651
-  data.tar.gz: 9053180465db13e212f82b6889a0c9012f52f28dba300b7eb06eae362728120ffd5e43251bd5909bc0633664e7a34286c69b7d88264a3f75807fab9a1e2dc33f
+  metadata.gz: f9df1bcd1a5b4e9db2ac14074f20d36082d60ce9f7f3132b896df69ca79a8fce2fe3649d0bcc62284480c754ad9db72135fb88523b29f5be1678b43eb14a4527
+  data.tar.gz: 647de6de4983fc9138dcbe815f37d2c8f7dcc0cfa879d16edf3ee6c0f1296d4dbf0621a9d75b18693674e7571fe238ee170f40ba3074813479ec2cf6decc30bd

data/lib/improved_jenkins_client/client.rb

@@ -72,7 +72,8 @@ module JenkinsApi
       "ca_file",
       "follow_redirects",
       "identity_file",
-      "cookies"
+      "cookies",
+      "pretty_json_responses"
     ].freeze
 
     # Initialize a Client object with Jenkins CI server credentials
@@ -106,6 +107,7 @@ module JenkinsApi
     # @option args [Fixnum] :log_level (Logger::INFO) The level for messages to be logged. Should be one of:
     #   Logger::DEBUG (0), Logger::INFO (1), Logger::WARN (2), Logger::ERROR (2), Logger::FATAL (3)
     # @option args [String] :cookies Cookies to be sent with all requests in the format: name=value; name2=value2
+    # @option args [Boolean] :pretty_json_responses Whether to append pretty=true to most JSON GET requests.
     #
     # @return [JenkinsApi::Client] a client object to Jenkins API
     #
@@ -415,18 +417,26 @@ module JenkinsApi
                         raw_response = false)
       url_prefix = "#{@jenkins_path}#{url_prefix}"
       to_get = ""
+
+
       if tree
         to_get = "#{url_prefix}#{url_suffix}?#{tree}"
+        query_param_separator = "&"
       else
         to_get = "#{url_prefix}#{url_suffix}"
+        query_param_separator = "?"
+      end
+      if @pretty_json_responses && url_suffix == "/api/json"
+        to_get += query_param_separator
+        to_get += "pretty=true"
       end
       request = Net::HTTP::Get.new(to_get)
       @logger.debug "GET #{to_get}"
       response = make_http_request(request)
       if raw_response
-        handle_exception(response, "raw")
+        handle_exception(response, "raw", full_url: to_get)
       else
-        handle_exception(response, "body", url_suffix =~ /json/)
+        handle_exception(response, "body", url_suffix =~ /json/, full_url: to_get)
       end
     end
 
@@ -797,10 +807,20 @@ module JenkinsApi
     # @raise [Exceptions::ApiException] Any other exception returned from
     #   Jenkins that are not categorized in the API Client.
     #
-    def handle_exception(response, to_send = "code", send_json = false)
-      msg = "HTTP Code: #{response.code}, Response Body: #{response.body}"
-      @logger.debug msg
-      case response.code.to_i
+    def handle_exception(response, to_send = "code", send_json = false, full_url: nil)
+      msg = "HTTP Code: #{response.code} "
+
+      msg += ", URL: #{full_url}" unless full_url.nil?
+
+      if @logger.level <= Logger::DEBUG
+        @logger.debug "#{msg}; Response Body: #{response.body}"
+      end
+      response_code = response.code.to_i
+      if response_code >= 400
+        @logger.warn msg
+      end
+
+      case response_code
       # As of Jenkins version 1.519, the job builds return a 201 status code
       # with a Location HTTP header with the pointing the URL of the item in
       # the queue.
@@ -817,7 +837,7 @@ module JenkinsApi
       when 400
         matched = response.body.match(/<p>(.*)<\/p>/)
         api_message = matched[1] unless matched.nil?
-        @logger.debug "API message: #{api_message}"
+        @logger.warn "API message: #{api_message}"
         case api_message
         when /A job already exists with the name/
           raise Exceptions::JobAlreadyExists.new(@logger, api_message)
@@ -839,7 +859,7 @@ module JenkinsApi
       when 500
         matched = response.body.match(/Exception: (.*)<br>/)
         api_message = matched[1] unless matched.nil?
-        @logger.debug "API message: #{api_message}"
+        @logger.warn "API message: #{api_message}"
         raise Exceptions::InternalServerError.new(@logger, api_message)
       when 503
         raise Exceptions::ServiceUnavailable.new @logger

data/lib/improved_jenkins_client/job.rb

@@ -723,10 +723,10 @@ module JenkinsApi
       # @param [String] job_name
       #
       def get_builds(job_name, options = {})
-        @logger.info "Obtaining the build details of '#{job_name}'"
+        @logger.info "Obtaining the builds of job '#{job_name}'"
         url = "/job/#{path_encode job_name}"
 
-        tree = options[:tree] || nil
+        tree = options[:tree]
         response_json = @client.api_get_request url, tree_string(tree)
         response_json["builds"]
       end
@@ -1193,13 +1193,14 @@ module JenkinsApi
       #
       # @param [String] job_name
       # @param [Number] build_num
+      # @param [String] tree
       #
-      def get_build_details(job_name, build_num)
+      def get_build_details(job_name, build_num, tree: nil)
         build_num = get_current_build_number(job_name) if build_num == 0
-        @logger.info "Obtaining the build details of '#{job_name}'" +
-          " Build ##{build_num}"
+        log_msg = "Obtaining the build details of '#{job_name}' Build ##{build_num}"
+        log_msg += " (with tree=...)" unless tree.nil?
 
-        @client.api_get_request("/job/#{path_encode job_name}/#{build_num}/")
+        @client.api_get_request("/job/#{path_encode job_name}/#{build_num}/", tree_string(tree))
       end
 
       # Change the description of a specific job

data/lib/improved_jenkins_client/version.rb

@@ -27,7 +27,7 @@ module JenkinsApi
     # Minor version of the gem
     MINOR   = 6
     # Tiny version of the gem used for patches
-    TINY    = 2
+    TINY    = 6
     # Used for pre-releases
     PRE     = nil
     # Version String of Jenkins API Client.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: improved_jenkins_client
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.6.6
 platform: ruby
 authors:
 - Kannan Manickam (the original jenkins_api_client gem)
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-22 00:00:00.000000000 Z
+date: 2021-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -165,7 +165,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubyforge_project: 
+rubygems_version: 2.7.6.3
 signing_key: 
 specification_version: 4
 summary: Improved Jenkins JSON API Client