improved_jenkins_client 1.6.0 → 1.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19904a21383083aac042b3519246181d77b42a0dd70a9d24681c3f1b1f4107eb
-  data.tar.gz: 59edb7776fff8d492802d16cbc098af2b7caf6143c98f9126a480050fc5aa510
+  metadata.gz: 6d924687d191c069d05698fc954924efa40f1024ab280be5d7d13f434c20b680
+  data.tar.gz: 760ca0221281fec74064f4f151927ff765dc2f0024c155ed0bdf154f02346f9a
 SHA512:
-  metadata.gz: 612ea06785632e4b6392bcd2b8ee6250945f3baa59f96cae4c08fe1b28dbc4d5169ab25a3fb645d857cbac1e59e8561e6617b32625aea626ab505d7a87ce8aa9
-  data.tar.gz: 7f60050161fb200ef85ecb5d6304830dd6c9f7b339ee4fc16a727b1bcdab75efe4474cdce6181e8bc3d89428c663e77c88fd7acb6247ea53e29f91dc2ca6db20
+  metadata.gz: 4f46f6c49204c1ac5562d2dad223eec0411e622404f0fe6db4824a792367809b1237b202db9d6951037d4271f4434adf8c90e13dcd0d742bf428c09fc4c70f6d
+  data.tar.gz: c54d3c43bc7ddc242bf63081f4bde37e7b3e9700f73badbcac2681e2dbbd89e95d21eb5192b80a46aca1ad833d5bd1875c02dc6bfa12920bde4877c7b4d3d81e

data/improved_jenkins_client.gemspec

@@ -8,7 +8,8 @@ Gem::Specification.new do |s|
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
-  s.authors = ["Kannan Manickam", "Yugabyte engineering team"]
+  s.authors = ["Kannan Manickam (the original jenkins_api_client gem)", 
+               "Yugabyte Engineering Team (improvements)"]
   s.description = 
       "\nThis is a simple and easy-to-use Jenkins Api client with features focused on" +
       "\nautomating Job configuration programaticaly. Based on the improved_jenkins_client with" +
@@ -18,7 +19,7 @@ Gem::Specification.new do |s|
   s.executables = ['jenkinscli']
   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-ruby-jenkins-client'
+  s.homepage = 'https://github.com/yugabyte-db/improved_jenkins_client'
   s.required_ruby_version = ::Gem::Requirement.new('~> 2.1')
   s.rubygems_version = "2.4.5.1"
   s.summary = "Improved Jenkins JSON API Client"

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,8 +807,11 @@ 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)
+    def handle_exception(response, to_send = "code", send_json = false, full_url: nil)
       msg = "HTTP Code: #{response.code}, Response Body: #{response.body}"
+      unless full_url.nil?
+        msg += " URL: #{full_url}"
+      end
       @logger.debug msg
       case response.code.to_i
       # As of Jenkins version 1.519, the job builds return a 201 status code

data/lib/improved_jenkins_client/job.rb

@@ -723,14 +723,73 @@ 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
 
+      # Yields all builds using the allBuilds API endpoint.
+      #
+      # @param job_name [String] the job to retrieve builds for
+      # @param fields [Array] the fields to retrieve from each build. ['*'] by default, meaning all 
+      #   fields
+      # @param limit [Integer] the maximum total number of builds to retrieve 
+      # @param page_size [Integer] the number of builds to retrieve at once
+      #
+      def each_build(
+          job_name,
+          fields: ['*'],
+          start_index: 0,
+          limit: nil,
+          page_size: 100)
+        unless page_size.is_a?(Integer) && page_size >= 1
+          raise "Invalid page size: #{page_size} (#{page_size.class}) -- must be at least one"
+        end
+        unless start_index.is_a?(Integer) && start_index >= 0
+          raise "Invalid start index: #{start_index} (#{start_index.class}), must be a " +
+                "nonnegative integer"
+        end
+        unless limit.nil? || limit.is_a?(Integer) && limit >= 0
+          raise "Invalid limit: #{limit} (#{limit.class}) -- must be nil or a non-negative integer"
+        end
+        unless fields.is_a?(Array) && fields.size >= 1
+          raise "Invalid array of fields to retrieve: #{fields} (#{fields.class}), must have at " +
+                "least one element"
+        end
+
+        start_index = 0
+        url = "/job/#{path_encode job_name}"
+        fields_str = fields.join(',')
+        while limit.nil? || start_index < limit do
+          @logger.info(
+              "Obtaining the build details of '#{job_name}' (fields: #{fields}) starting at " +
+              "index #{start_index} with page size #{page_size}")
+
+          end_index = start_index + page_size
+          end_index = limit if !limit.nil? && end_index > limit
+
+          break if start_index >= end_index
+
+          tree = "allBuilds[#{fields_str}]{#{start_index},#{end_index}}"
+          response_json = @client.api_get_request(url, tree_string(tree))
+          build_range = response_json["allBuilds"]
+
+          break if build_range.size == 0  # End of results.
+
+          build_range.each do |result|
+            yield result
+          end
+
+          # We got some results but less than what we asked for. This must be the last page.
+          break if build_range.size < end_index - start_index
+
+          start_index += page_size
+        end
+      end
+
       # This method maps the color to status of a job
       #
       # @param [String] color color given by the API for a job
@@ -1134,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    = 0
+    TINY    = 5
     # Used for pre-releases
     PRE     = nil
     # Version String of Jenkins API Client.

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: improved_jenkins_client
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.6.5
 platform: ruby
 authors:
-- Kannan Manickam
-- Yugabyte engineering team
+- Kannan Manickam (the original jenkins_api_client gem)
+- Yugabyte Engineering Team (improvements)
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -146,7 +146,7 @@ files:
 - lib/improved_jenkins_client/user.rb
 - lib/improved_jenkins_client/version.rb
 - lib/improved_jenkins_client/view.rb
-homepage: https://github.com/yugabyte-db/improved-ruby-jenkins-client
+homepage: https://github.com/yugabyte-db/improved_jenkins_client
 licenses:
 - MIT
 metadata: {}
@@ -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