jenkins_api_client 1.5.3 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a4d136e1d892db0bf4411fbaa520ff62efc5162c
-  data.tar.gz: 12dd02a2aefaf038614bb1c2ca74990890730a33
+SHA256:
+  metadata.gz: a499520438bb2fdcedc254768700d30b74c5c083e2557048a97b8a9f9b2e23ea
+  data.tar.gz: cf1d9d37530711baed6c6909ee34077a07c0161c68705ca3c7691d1ac53ba82e
 SHA512:
-  metadata.gz: 639225407882ad7ad86443327ee0de6e9d54df384e068d22dbfeea478e58e96cbc85f18cb5e5138e66beb2b121433a3f71335e641c8b65c8b13c09e2b613b36f
-  data.tar.gz: a5e5b5d15e33dfe19f8b797524d250b2e78422ea41b7e57ee36d32ee7fed273ee32f5c77e0c01fc9b9c6122db7b0b3a48b0423662652024ec282b4dc8091276e
+  metadata.gz: '05659348d3846adbba1bb231ef5e751515d26aff76a2ea16d42ed4973507ca606192bfcd0bc5915d14e636c110d21dd3e2f99e59578f43e110c3f84724a3834f'
+  data.tar.gz: 0ad06756109a85dda032414524752cba25575061afb4f4b030d63d34d62b0d16373048bed46b0b624c4be1b204c858f5ca5b75592302328ea16c5765b4a065e2

data/jenkins_api_client.gemspec

@@ -6,18 +6,15 @@ Gem::Specification.new do |s|
   s.name = "jenkins_api_client"
   s.version = ::JenkinsApi::Client::VERSION
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.require_paths = ["lib"]
   s.authors = ["Kannan Manickam"]
   s.description = "\nThis is a simple and easy-to-use Jenkins Api client with features focused on\nautomating Job configuration programaticaly and so forth"
   s.email = ["arangamani.kannan@gmail.com"]
   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/arangamani/jenkins_api_client'
-  s.required_ruby_version = ::Gem::Requirement.new('~> 2.1')
-  s.rubygems_version = "2.4.5.1"
+  s.required_ruby_version = '>= 2.7'
   s.summary = "Jenkins JSON API Client"
+  s.licenses = ["MIT"]
 
   s.add_dependency 'nokogiri', '~> 1.6'
   s.add_dependency 'thor', '>= 0.16.0'
@@ -25,5 +22,5 @@ Gem::Specification.new do |s|
   s.add_dependency 'mixlib-shellout', '>= 1.1.0'
   s.add_dependency 'socksify', '>= 1.7.0'
   s.add_dependency 'json', '>= 1.0'
+  s.add_dependency 'addressable', '~> 2.7'
 end
-

data/lib/jenkins_api_client/client.rb

@@ -30,6 +30,7 @@ require 'mixlib/shellout'
 require 'uri'
 require 'logger'
 require 'socksify/http'
+require 'open-uri'
 
 # The main module that contains the Client class and all subclasses that
 # communicate with the Jenkins's Remote Access API.
@@ -66,6 +67,9 @@ module JenkinsApi
       "http_open_timeout",
       "http_read_timeout",
       "ssl",
+      "pkcs_file_path",
+      "pass_phrase",
+      "ca_file",
       "follow_redirects",
       "identity_file",
       "cookies"
@@ -91,6 +95,9 @@ module JenkinsApi
     # @option args [String] :proxy_protocol the proxy protocol ('socks' or 'http' (defaults to HTTP)
     # @option args [String] :jenkins_path ("/") the optional context path for Jenkins
     # @option args [Boolean] :ssl (false) indicates if Jenkins is accessible over HTTPS
+    # @option args [String] :pkcs_file_path ("/") the optional context path for pfx or p12 binary certificate file
+    # @option args [String] :pass_phrase password for pkcs_file_path certificate file
+    # @option args [String] :ca_file the path to a PEM encoded file containing trusted certificates used to verify peer certificate
     # @option args [Boolean] :follow_redirects this argument causes the client to follow a redirect (jenkins can
     #   return a 30x when starting a build)
     # @option args [Fixnum] :timeout (120) This argument sets the timeout for operations that take longer (in seconds)
@@ -237,6 +244,14 @@ module JenkinsApi
       JenkinsApi::Client::User.new(self)
     end
 
+    # Creates an instance of the Root class by passing a reference to self
+    #
+    # @return [JenkinsApi::Client::Root] An object of Root subclass
+    #
+    def root
+      JenkinsApi::Client::Root.new(self)
+    end
+
     # Returns a string representing the class name
     #
     # @return [String] string representation of class name
@@ -252,6 +267,7 @@ module JenkinsApi
     def inspect
       "#<JenkinsApi::Client:0x#{(self.__id__ * 2).to_s(16)}" +
         " @ssl=#{@ssl.inspect}," +
+        " @ca_file=#{@ca_file.inspect}," +
         " @log_location=#{@log_location.inspect}," +
         " @log_level=#{@log_level.inspect}," +
         " @crumbs_enabled=#{@crumbs_enabled.inspect}," +
@@ -269,13 +285,7 @@ module JenkinsApi
     #
     def get_artifact(job_name,filename)
       @artifact = job.find_artifact(job_name)
-      uri = URI.parse(@artifact)
-      http = Net::HTTP.new(uri.host, uri.port)
-      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-      http.use_ssl = @ssl
-      request = Net::HTTP::Get.new(uri.request_uri)
-      request.basic_auth(@username, @password)
-      response = http.request(request)
+      response = make_http_request(Net::HTTP::Get.new(@artifact))
       if response.code == "200"
         File.write(File.expand_path(filename), response.body)
       else
@@ -283,6 +293,41 @@ module JenkinsApi
       end
     end
 
+    # Connects to the server and download all artifacts of a build to a specified location
+    #
+    # @param [String] job_name
+    # @param [String] dldir location to save artifacts
+    # @param [Integer] build_number optional, defaults to current build
+    # @returns [String, Array] list of retrieved artifacts
+    #
+    def get_artifacts(job_name, dldir, build_number = nil)
+      @artifacts = job.find_artifacts(job_name,build_number)
+      results = []
+      @artifacts.each do |artifact|
+        uri = URI.parse(artifact)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        http.use_ssl = @ssl
+        request = Net::HTTP::Get.new(uri.request_uri)
+        request.basic_auth(@username, @password)
+        response = http.request(request)
+        # we want every thing after the last 'build' in the path to become the filename
+        if artifact.include?('/build/')
+          filename = artifact.split("/build/").last.gsub('/','-')
+        else
+          filename = File.basename(artifact)
+        end
+        filename = File.join(dldir, filename)
+        results << filename
+        if response.code == "200"
+          File.write(File.expand_path(filename), response.body)
+        else
+          raise "Couldn't get the artifact #{artifact} for job #{job}"
+        end
+      end
+      results
+    end
+
     # Connects to the Jenkins server, sends the specified request and returns
     # the response.
     #
@@ -300,19 +345,26 @@ module JenkinsApi
         when 'http'
           http = Net::HTTP::Proxy(@proxy_ip, @proxy_port).new(@server_ip, @server_port)
         when 'socks'
-          http = Net::HTTP::SOCKSProxy(@proxy_ip, @proxy_port).start(@server_ip, @server_port)
+          http = Net::HTTP::SOCKSProxy(@proxy_ip, @proxy_port).new(@server_ip, @server_port)
         else
-          raise "unknwon proxy protocol: '#{@proxy_protocol}'"
+          raise "unknown proxy protocol: '#{@proxy_protocol}'"
         end
       else
         http = Net::HTTP.new(@server_ip, @server_port)
       end
 
-      if @ssl
+      if @ssl && @pkcs_file_path
         http.use_ssl = true
+        pkcs12 =OpenSSL::PKCS12.new(File.binread(@pkcs_file_path), @pass_phrase!=nil ? @pass_phrase : "")
+        http.cert = pkcs12.certificate
+        http.key = pkcs12.key
         http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-      end
+      elsif @ssl
+        http.use_ssl = true
 
+        http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+        http.ca_file = @ca_file if @ca_file
+      end
       http.open_timeout = @http_open_timeout
       http.read_timeout = @http_read_timeout
 
@@ -490,7 +542,7 @@ module JenkinsApi
       @logger.info "Initializing Jenkins Update Center..."
       @logger.debug "Obtaining the JSON data for Update Center..."
       # TODO: Clean me up
-      update_center_data = open("http://updates.jenkins-ci.org/update-center.json").read
+      update_center_data = open("https://updates.jenkins.io/current/update-center.json").read
       # The Jenkins mirror returns the data in the following format
       #   updateCenter.post(
       #     {.. JSON data...}
@@ -754,7 +806,7 @@ module JenkinsApi
       # the queue.
       when 200, 201, 302
         if to_send == "body" && send_json
-          return JSON.parse(response.body)
+          return JSON.parse(response.body, max_nesting: false)
         elsif to_send == "body"
           return response.body
         elsif to_send == "code"

data/lib/jenkins_api_client/job.rb

@@ -299,6 +299,16 @@ module JenkinsApi
             xml.description
             xml.keepDependencies "#{params[:keep_dependencies]}"
             xml.properties
+            #buildlogs related stuff
+            if params[:discard_old_builds]
+              xml.logRotator(:class => 'hudson.tasks.LogRotator') do
+                xml.daysToKeep params[:discard_old_builds][:daysToKeep] || -1
+                xml.numToKeep params[:discard_old_builds][:numToKeep] || -1
+                xml.artifactDaysToKeep params[:discard_old_builds][:artifactDaysToKeep] || -1
+                xml.artifactNumToKeep params[:discard_old_builds][:artifactNumToKeep] || -1
+              end
+            end
+
             # SCM related stuff
             if params[:scm_provider] == 'subversion'
               # Build subversion related XML portion
@@ -744,13 +754,30 @@ module JenkinsApi
           "not_run"
         when "aborted"
           "aborted"
+        when "disabled"
+          "disabled"
         else
           "invalid"
         end
       end
 
+      # Determine if the build is queued
+      #
+      # @param [String] job_name
+      #
+      # @return [Integer] build number if queued, or [Boolean] false if not queued
+      #
+      def queued?(job_name)
+        queue_result = @client.api_get_request("/job/#{path_encode job_name}")['inQueue']
+        if queue_result
+          return @client.api_get_request("/job/#{path_encode job_name}")['nextBuildNumber']
+        else
+          return queue_result
+        end
+      end
+
       # Obtain the current build status of the job
-      # By defaule Jenkins returns the color of the job status icon
+      # By default Jenkins returns the color of the job status icon
       # This function translates the color into a meaningful status
       #
       # @param [String] job_name
@@ -1086,6 +1113,23 @@ module JenkinsApi
         nil
       end
 
+      # Obtain the plugin results for a specific build of a job
+      #
+      # @param [String] job_name
+      # @param [Number] build_num
+      # @param [String] plugin_name
+      #
+      def get_plugin_results(job_name, build_num, plugin_name)
+        build_num = get_current_build_number(job_name) if build_num == 0
+        @logger.info "Obtaining the '#{plugin_name}' plugin results of '#{job_name}'" +
+          " Build ##{build_num}"
+        @client.api_get_request("/job/#{path_encode job_name}/#{build_num}/#{plugin_name}Result")
+      rescue Exceptions::NotFound
+        # Not found is acceptable, as not all builds will have plugin results
+        # and this is what jenkins throws at us in that case
+        nil
+      end
+
       # Obtain detailed build info for a job
       #
       # @param [String] job_name
@@ -1399,6 +1443,71 @@ module JenkinsApi
         post_config(job_name, xml_modified)
       end
 
+      # Add upstream projects to a specific job given the job name,
+      # projects to be added as upstream projects, and the threshold
+      #
+      # @param [String] job_name
+      # @param [String] upstream_projects - separated with comma
+      # @param [String] threshold - failure, success, or unstable
+      # @param [Boolean] overwrite - true or false
+      #
+      # @return [String] response_code return code from HTTP POST
+      #
+      def add_upstream_projects(job_name,
+                                upstream_projects,
+                                threshold, overwrite = false)
+        @logger.info "Adding #{upstream_projects.inspect} as upstream" +
+                         " projects for '#{job_name}' with the threshold of '#{threshold}'" +
+                         " and overwrite option of '#{overwrite}'"
+        name, ord, col = get_threshold_params(threshold)
+        xml = get_config(job_name)
+        n_xml = Nokogiri::XML(xml)
+        upstream_projects_node = n_xml.xpath("//upstreamProjects").first
+        if upstream_projects_node
+          if overwrite
+            upstream_projects_node.content = "#{upstream_projects}"
+          else
+            to_replace = upstream_projects_node.content +
+                ", #{upstream_projects}"
+            upstream_projects_node.content = to_replace
+          end
+        else
+          triggers_node = n_xml.xpath("//triggers").first
+          reverse_build_trigger_node = triggers_node.add_child(
+              "<jenkins.triggers.ReverseBuildTrigger/>"
+          )
+          reverse_build_trigger_node.first.add_child(
+              "<spec/>"
+          )
+          reverse_build_trigger_node.first.add_child(
+              "<upstreamProjects>#{upstream_projects}</upstreamProjects>"
+          )
+          threshold_node = reverse_build_trigger_node.first.add_child(
+              "<threshold/>"
+          )
+          threshold_node.first.add_child(
+              "<name>#{name}</name><ordinal>#{ord}</ordinal><color>#{col}</color>"
+          )
+        end
+        xml_modified = n_xml.to_xml
+        post_config(job_name, xml_modified)
+      end
+
+      # Remove all upstream projects of a specific job
+      #
+      # @param [String] job_name
+      #
+      # @return [String] response_code return code from HTTP POST
+      #
+      def remove_upstream_projects(job_name)
+        @logger.info "Removing the upstream projects of '#{job_name}'"
+        xml = get_config(job_name)
+        n_xml = Nokogiri::XML(xml)
+        n_xml.search("//jenkins.triggers.ReverseBuildTrigger").remove
+        xml_modified = n_xml.to_xml
+        post_config(job_name, xml_modified)
+      end
+
       # Resctrict the given job to a specific node
       #
       # @param [String] job_name
@@ -1546,15 +1655,49 @@ module JenkinsApi
       #A Method to find artifacts path from the Current Build
       #
       # @param [String] job_name
+      # @param [Integer] build_number
+      #   defaults to latest build
       #
-      def find_artifact(job_name)
-        current_build_number  = get_current_build_number(job_name)
-        job_path              = "job/#{path_encode job_name}/"
-        response_json         = @client.api_get_request("/#{job_path}#{current_build_number}")
-        relative_build_path   = response_json['artifacts'][0]['relativePath']
-        jenkins_path          = response_json['url']
-        artifact_path         = URI.escape("#{jenkins_path}artifact/#{relative_build_path}")
-        return artifact_path
+      def find_artifact(job_name, build_number = 0)
+        find_artifacts(job_name, build_number).first
+      end
+
+      #A Method to check artifact exists path from the Current Build
+      #
+      # @param [String] job_name
+      # @param [Integer] build_number
+      #   defaults to latest build
+      #
+      def artifact_exists?(job_name, build_number = 0)
+        begin
+          artifact_path(job_name: job_name, build_number: build_number)
+
+          return true
+        rescue Exception => e
+          return false
+        end
+      end
+
+      # Find the artifacts for build_number of job_name, defaulting to current job
+      #
+      # @param [String] job_name
+      # @param [Integer] build_number Optional build number
+      # @return [String, Hash] JSON response from Jenkins
+      #
+      def find_artifacts(job_name, build_number = nil)
+        response_json       = get_build_details(job_name, build_number)
+        artifact_path(build_details: response_json).map do |p|
+          path_encode("#{response_json['url']}artifact/#{p['relativePath']}")
+        end
+      end
+
+      # Find the artifacts for the current job
+      #
+      # @param [String] job_name
+      # @return [String, Hash] JSON response from Jenkins
+      #
+      def find_latest_artifacts(job_name)
+        find_artifacts(job_name)
       end
 
       private
@@ -1795,6 +1938,29 @@ module JenkinsApi
         return nil unless tree_value
         "tree=#{tree_value}"
       end
+
+      # This private method gets the artifact path or throws an exception
+      #
+      # @param [Hash] job_name, build_number or build_details object
+      #
+      def artifact_path(params)
+        job_name      = params[:job_name]
+        build_number  = params[:build_number] || 0
+        build_details = params[:build_details]
+
+        build_details = get_build_details(job_name, build_number) if build_details.nil?
+        artifacts     = build_details['artifacts']
+        artifact_paths = []
+
+        if artifacts && artifacts.any?
+          artifact_paths = artifacts.find_all{ |a| a.key?('relativePath') }
+        end
+
+        if artifact_paths.empty?
+          raise "No artifacts found."
+        end
+        artifact_paths
+      end
     end
   end
 end

data/lib/jenkins_api_client/node.rb

@@ -211,18 +211,42 @@ module JenkinsApi
         list.each { |node| delete(node) unless node == "master" }
       end
 
+      # This method returns two lists 1) nodes online 2) nodes offline
+      #
+      # @param [String] filter a regex to filter node names
+      # @param [Bool] ignorecase whether to be case sensitive or not
+      #
+      def online_offline_lists(filter = nil, ignorecase = true)
+        @logger.info "Obtaining nodes from jenkins matching filter '#{filter}'"
+        offline_node_names = []
+        online_node_names = []
+        response_json = @client.api_get_request("/computer")
+        response_json["computer"].each do |computer|
+            if computer["displayName"] =~ /#{filter}/i
+              if computer["offline"] == true
+                offline_node_names << computer["displayName"]
+              else
+                online_node_names << computer["displayName"]
+              end
+            end
+        end
+        return online_node_names, offline_node_names
+      end
+
       # This method lists all nodes
       #
       # @param [String] filter a regex to filter node names
       # @param [Bool] ignorecase whether to be case sensitive or not
       #
-      def list(filter = nil, ignorecase = true)
+      def list(filter = nil, ignorecase = true, slaveonly = false)
         @logger.info "Obtaining nodes from jenkins matching filter '#{filter}'"
         node_names = []
         response_json = @client.api_get_request("/computer")
         response_json["computer"].each do |computer|
             if computer["displayName"] =~ /#{filter}/i
-              node_names << computer["displayName"]
+              unless slaveonly && computer["displayName"] == "master"
+                node_names << computer["displayName"]
+              end
             end
         end
         node_names

data/lib/jenkins_api_client/plugin_manager.rb

@@ -148,7 +148,7 @@ module JenkinsApi
       #        "pinned"=>true,
       #        "shortName"=>"ldap",
       #        "supportsDynamicLoad"=>"MAYBE",
-      #        "url"=>"http://wiki.jenkins-ci.org/display/JENKINS/LDAP+Plugin",
+      #        "url"=>"https://wiki.jenkins.io/display/JENKINS/LDAP+Plugin",
       #        "version"=>"1.5"
       #      }
       #
@@ -256,7 +256,7 @@ module JenkinsApi
       #   => {
       #        "name"=>"status-view",
       #        "sourceId"=>"default",
-      #        "url"=>"http://updates.jenkins-ci.org/download/plugins/status-view/1.0/status-view.hpi",
+      #        "url"=>"https://updates.jenkins.io/download/plugins/status-view/1.0/status-view.hpi",
       #        "version"=>"1.0",
       #        "categories"=>["ui"],
       #        "compatibleSinceVersion"=>nil,
@@ -266,7 +266,7 @@ module JenkinsApi
       #        "installed"=>nil, "neededDependencies"=>[],
       #        "requiredCore"=>"1.342",
       #        "title"=>"Status View Plugin",
-      #        "wiki"=>"https://wiki.jenkins-ci.org/display/JENKINS/Status+View+Plugin"
+      #        "wiki"=>"https://wiki.jenkins.io/display/JENKINS/Status+View+Plugin"
       #      }
       #
       def get_available_info(plugin)

data/lib/jenkins_api_client/root.rb

@@ -0,0 +1,67 @@
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+
+require 'jenkins_api_client/urihelper'
+
+module JenkinsApi
+  class Client
+    # This class communicates with Jenkins API at the root address to obtain details
+    # on the page displayed to users on the Jenkins' 'homepage,' and other
+    # data items such as quietingDown
+    class Root
+      include JenkinsApi::UriHelper
+
+      # Initializes a new root object
+      #
+      # @param client [Client] the client object
+      #
+      # @return [Root] the root object
+      #
+      def initialize(client)
+        @client = client
+        @logger = @client.logger
+      end
+
+      # Return a string representation of the object
+      #
+      def to_s
+        "#<JenkinsApi::Client::Root>"
+      end
+
+      # Check if Jenkins is in shutdown mode
+      #
+      # @return [Boolean] true if server in shutdown mode
+      #
+      def quieting_down?
+        response_json = @client.api_get_request('', 'tree=quietingDown')
+        response_json['quietingDown']
+      end
+
+      # Get message displayed to users on the homepage
+      #
+      # @return [String] description - message displayed to users
+      #
+      def description
+        response_json = @client.api_get_request('', 'tree=description')
+        response_json['description']
+      end
+    end
+  end
+end

data/lib/jenkins_api_client/system.rb

@@ -54,13 +54,20 @@ module JenkinsApi
         @client.api_post_request("/quietDown")
       end
 
-      # Cancels the quiet doen request sent to the server.
+      # Cancels the quiet down request sent to the server.
       #
       def cancel_quiet_down
         @logger.info "Cancelling jenkins form quiet down..."
         @client.api_post_request("/cancelQuietDown")
       end
 
+      # Checks if server is in quiet down mode.
+      #
+      def check_quiet_down?
+        @logger.info "Checking if jenkins is in quiet down mode..."
+        @client.root.quieting_down?
+      end
+
       # Restarts the Jenkins server
       #
       # @param [Boolean] force whether to force restart or wait till all

data/lib/jenkins_api_client/urihelper.rb

@@ -1,4 +1,5 @@
 require 'uri'
+require 'addressable/uri'
 
 module JenkinsApi
   module UriHelper
@@ -11,7 +12,7 @@ module JenkinsApi
     # Encode a string for use in the hiearchical part of an URL
     #
     def path_encode(path)
-      URI.escape(path.encode(Encoding::UTF_8))
+      Addressable::URI.escape(path.encode(Encoding::UTF_8))
     end
   end
 end

data/lib/jenkins_api_client/version.rb

@@ -22,15 +22,7 @@
 
 module JenkinsApi
   class Client
-    # Major version of the gem
-    MAJOR   = 1
-    # Minor version of the gem
-    MINOR   = 5
-    # Tiny version of the gem used for patches
-    TINY    = 3
-    # Used for pre-releases
-    PRE     = nil
     # Version String of Jenkins API Client.
-    VERSION = [MAJOR, MINOR, TINY, PRE].compact.join('.')
+    VERSION = "2.1.0"
   end
 end

data/lib/jenkins_api_client/view.rb

@@ -257,6 +257,38 @@ module JenkinsApi
         @client.api_post_request(post_msg)
       end
 
+      # List (sub-)views in a view
+      #
+      # @param [String] view_name
+      #
+      # @return [Array] view_names list of (sub-)views in the specified view
+      #
+      def list_views(view_name)
+        @logger.info "Obtaining the views present in view '#{view_name}'"
+        view_names = []
+        raise "The view #{view_name} doesn't exists on the server"\
+          unless exists?(view_name)
+        response_json = @client.api_get_request("/view/#{path_encode view_name}")
+        response_json["views"].each do |view|
+          view_names << view["name"]
+        end
+        view_names
+      end
+
+      # List (sub-)views in view along with their details
+      #
+      # @param [String] view_name
+      #
+      # @return [Array<Hash>] the details of (sub-)views in the specified view
+      #
+      def list_views_with_details(view_name)
+        @logger.info "Obtaining the views present in view '#{view_name}'"
+        raise "The view #{view_name} doesn't exists on the server"\
+          unless exists?(view_name)
+        response_json = @client.api_get_request("/view/#{path_encode view_name}")
+        response_json["views"]
+      end
+
       # Obtain the configuration stored in config.xml of a specific view
       #
       # @param [String] view_name

data/lib/jenkins_api_client.rb

@@ -30,6 +30,7 @@ require 'jenkins_api_client/view'
 require 'jenkins_api_client/build_queue'
 require 'jenkins_api_client/plugin_manager'
 require 'jenkins_api_client/user'
+require 'jenkins_api_client/root'
 
 require 'jenkins_api_client/cli/helper'
 require 'jenkins_api_client/cli/base'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jenkins_api_client
 version: !ruby/object:Gem::Version
-  version: 1.5.3
+  version: 2.1.0
 platform: ruby
 authors:
 - Kannan Manickam
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-03-30 00:00:00.000000000 Z
+date: 2023-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
 description: |2-
 
   This is a simple and easy-to-use Jenkins Api client with features focused on
@@ -124,32 +138,33 @@ files:
 - lib/jenkins_api_client/plugin_settings/collection.rb
 - lib/jenkins_api_client/plugin_settings/hipchat.rb
 - lib/jenkins_api_client/plugin_settings/workspace_cleanup.rb
+- lib/jenkins_api_client/root.rb
 - lib/jenkins_api_client/system.rb
 - lib/jenkins_api_client/urihelper.rb
 - lib/jenkins_api_client/user.rb
 - lib/jenkins_api_client/version.rb
 - lib/jenkins_api_client/view.rb
 homepage: https://github.com/arangamani/jenkins_api_client
-licenses: []
+licenses:
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.5
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: Jenkins JSON API Client
 test_files: []