improved_jenkins_client 1.6.3 → 1.6.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3bd76b52cc0145e53f5fff5e80ff895350f890c84a284ffad8362c574804533f
-  data.tar.gz: 11589a77612dd8caef6da7a762a3e5626d0cbaa3b283ec73ce37d23398d87d9d
+  metadata.gz: d0b836a0050b0fac502e19aaa527a175e98cd33f92f3c1b450f9616136140c08
+  data.tar.gz: 4b49c8cd16ba499e768fbdea346ff08e607597012de67c226cc3b515e4bfa729
 SHA512:
-  metadata.gz: 4a5af1612b767ec3a8fa2321f0f81a2b3b3e41881f2c99d272db0aa77b9a3e3262648bab9a86b47a70bade5f5188a5f5465968185a9512b6755864e7341b3ec0
-  data.tar.gz: cc0e7ad61dc9849bf93f41083bb255e52e26d0a641472cd4fdfd412fa0bca52b61b14de265d52912591cce9496a4336ef526c4a094e0ade26625567f67e9d561
+  metadata.gz: 2e4f9929f81880760be739a58ddda8475d70caa1a330c896aedd5cdef80ce53e464c0556843fa33fc7d4f1d9e353bf05d18e021cef68c1032ed99577bbe60e69
+  data.tar.gz: 29a6315717c1e4f57d6eaae520a37a6b804aea07c990cc7751030113615e409800a0a672b790024bcb0bf2dfac33bfb9c8739b17a1e6e2051e0b9d0d6627d26c

data/improved_jenkins_client.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
   s.files         = `git ls-files -z`.split("\x0").select { |f| f.match(%r{lib/|bin/|java_deps/|gemspec}) }
   s.require_paths = ['lib']
   s.homepage = 'https://github.com/yugabyte-db/improved_jenkins_client'
-  s.required_ruby_version = ::Gem::Requirement.new('~> 2.1')
+  s.required_ruby_version = ::Gem::Requirement.new('>= 2.1')
   s.rubygems_version = "2.4.5.1"
   s.summary = "Improved Jenkins JSON API Client"
   s.licenses = ["MIT"]

data/lib/improved_jenkins_client/build_queue.rb

@@ -257,6 +257,13 @@ module JenkinsApi
         stuck
       end
 
+      # Cancel the given task
+      #
+      # @param [String] task_id the task id
+      def cancel_item(task_id)
+        @client.api_post_request("/queue/cancelItem?id=#{task_id}")
+      end
+
     end
   end
 end

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,14 +807,25 @@ 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.
-      when 200, 201, 302
+      #
+      when 200, 201, 204, 302
         if to_send == "body" && send_json
           return JSON.parse(response.body)
         elsif to_send == "body"
@@ -817,7 +838,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 +860,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,7 +723,7 @@ 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]

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    = 3
+    TINY    = 7
     # 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.3
+  version: 1.6.7
 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-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -156,7 +156,7 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -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