improved_jenkins_client 1.6.0 → 1.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19904a21383083aac042b3519246181d77b42a0dd70a9d24681c3f1b1f4107eb
-  data.tar.gz: 59edb7776fff8d492802d16cbc098af2b7caf6143c98f9126a480050fc5aa510
+  metadata.gz: 26e682d2f9c008a0943a3ff4d76fdc5a9ea614135eef5ed6f8dfc20c692c1c3d
+  data.tar.gz: 4ee3bc91c1cc3e7c86601012de333e79fde95b73e4b828a7c2e899dd28abd3c1
 SHA512:
-  metadata.gz: 612ea06785632e4b6392bcd2b8ee6250945f3baa59f96cae4c08fe1b28dbc4d5169ab25a3fb645d857cbac1e59e8561e6617b32625aea626ab505d7a87ce8aa9
-  data.tar.gz: 7f60050161fb200ef85ecb5d6304830dd6c9f7b339ee4fc16a727b1bcdab75efe4474cdce6181e8bc3d89428c663e77c88fd7acb6247ea53e29f91dc2ca6db20
+  metadata.gz: 2c2c4e95a00b51edd873288112253bcba265475e7dcb50466d0f6d5629850adefb1c9b9ce983cbb4f2ad3b5160a7f1be22827fcf12b4fccb105e060bdd0e3651
+  data.tar.gz: 9053180465db13e212f82b6889a0c9012f52f28dba300b7eb06eae362728120ffd5e43251bd5909bc0633664e7a34286c69b7d88264a3f75807fab9a1e2dc33f

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/job.rb

@@ -731,6 +731,65 @@ module JenkinsApi
         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

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    = 2
     # 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.2
 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: {}