jenkins_api_client 0.14.1 → 1.0.0.alpha.1

data/.travis.yml

@@ -30,4 +30,4 @@ notifications:
     on_success: change
     on_failure: always
     channels:
-      - "irc.freenode.org##jenins-api-client"
+      - "irc.freenode.org##jenkins-api-client"

data/CONTRIBUTORS.md

@@ -11,3 +11,5 @@ Thank you very much to all who contributed to this project.
 * [rubytester](https://github.com/rubytester)
 * [dougforpres](https://github.com/dougforpres)
 * [brettporter](https://github.com/brettporter)
+* [riywo](https://github.com/riywo)
+* [bobbrez](https://github.com/bobbrez)

data/Gemfile

@@ -11,5 +11,6 @@ group :development do
   gem "jeweler", ">= 1.6.4"
   gem "rspec", "~> 2.13.0"
   gem "simplecov"
+  gem "yard-thor"
   gem "yard"
 end

data/README.md

@@ -102,7 +102,7 @@ puts @client.job.list_all
 ### Chaining and Building Jobs
 
 Sometimes we want certain jobs to be added as downstream projects and run them
-sequencially. The following example will explain how this could be done.
+sequentially. The following example will explain how this could be done.
 
 ```ruby
 require 'jenkins_api_client'

data/jenkins_api_client.gemspec

@@ -40,6 +40,7 @@ Gem::Specification.new do |s|
     "lib/jenkins_api_client/exceptions.rb",
     "lib/jenkins_api_client/job.rb",
     "lib/jenkins_api_client/node.rb",
+    "lib/jenkins_api_client/plugin_manager.rb",
     "lib/jenkins_api_client/system.rb",
     "lib/jenkins_api_client/user.rb",
     "lib/jenkins_api_client/version.rb",

data/lib/jenkins_api_client.rb

@@ -28,6 +28,7 @@ require 'jenkins_api_client/node'
 require 'jenkins_api_client/system'
 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/cli/helper'

data/lib/jenkins_api_client/client.rb

@@ -212,6 +212,15 @@ module JenkinsApi
       JenkinsApi::Client::BuildQueue.new(self)
     end
 
+    # Creates an instance to the PluginManager by passing a reference to self
+    #
+    # @return [JenkinsApi::Client::PluginManager] an object to PluginManager
+    #  subclass
+    #
+    def plugin
+      JenkinsApi::Client::PluginManager.new(self)
+    end
+
     # Creates an instance of the User class by passing a reference to self
     #
     # @return [JenkinsApi::Client::User] An object of User subclass
@@ -288,8 +297,8 @@ module JenkinsApi
     # @return [Net::HTTP::Response] Response from Jenkins for "/"
     #
     def get_root
-      @logger.info "GET /"
-      request = Net::HTTP::Get.new("/")
+      @logger.info "GET #{@jenkins_path}/"
+      request = Net::HTTP::Get.new("#{@jenkins_path}/")
       make_http_request(request)
     end
 
@@ -633,7 +642,10 @@ module JenkinsApi
       when 404
         raise Exceptions::NotFound.new @logger
       when 500
-        raise Exceptions::InternalServerError.new @logger
+        matched = response.body.match(/Exception: (.*)<br>/)
+        api_message = matched[1] unless matched.nil?
+        @logger.debug "API message: #{api_message}"
+        raise Exceptions::InternalServerError.new(@logger, api_message)
       when 503
         raise Exceptions::ServiceUnavailable.new @logger
       else

data/lib/jenkins_api_client/exceptions.rb

@@ -41,8 +41,8 @@ module JenkinsApi
     #
     class NothingSubmitted < ApiException
       def initialize(logger, message = "", log_level = Logger::ERROR)
-        msg = "Nothing is submitted. #{message}"
-        super(logger, msg)
+        message = "Nothing is submitted." if message.empty?
+        super(logger, message)
       end
     end
 
@@ -80,8 +80,8 @@ module JenkinsApi
     #
     class Unauthorized < ApiException
       def initialize(logger, message = "", log_level = Logger::ERROR)
-        msg = "Invalid credentials are provided. #{message}"
-        super(logger, msg, Logger::FATAL)
+        message = "Invalid credentials are provided." if message.empty?
+        super(logger, message, Logger::FATAL)
       end
     end
     # Support for backward compatibility
@@ -158,8 +158,8 @@ module JenkinsApi
     #
     class CrumbNotFound < NotFound
       def initialize(logger, message = "", log_level = Logger::ERROR)
-        msg = "No crumb available on the server. #{message}"
-        super(logger, msg)
+        message = "No crumb available on the server." if message.empty?
+        super(logger, message)
       end
     end
     # Support for backward compatibility
@@ -200,10 +200,10 @@ module JenkinsApi
     #
     class InternalServerError < ApiException
       def initialize(logger, message = "", log_level = Logger::ERROR)
-        msg = "Internel Server Error. Perhaps the in-memory configuration of" +
-              " Jenkins is different from the disk configuration." +
-              " Please try to reload the configuration #{message}"
-        super(logger, msg)
+        message = "Internel Server Error. Perhaps the in-memory configuration" +
+          " Jenkins is different from the disk configuration. Please try to" +
+          " reload the configuration" if message.empty?
+        super(logger, message)
       end
     end
     # Support for backward compatibility
@@ -214,10 +214,10 @@ module JenkinsApi
     #
     class ServiceUnavailable < ApiException
       def initialize(logger, message = "", log_level = Logger::ERROR)
-        msg = "Jenkins is being reloaded or restarted. Please wait till" +
-              " Jenkins is completely back online. This can be" +
-              " programatically achieved by System#wait_for_ready #{message}"
-        super(logger, msg)
+        message = "Jenkins is being reloaded or restarted. Please wait till" +
+          " Jenkins is completely back online. This can be" +
+          " programatically achieved by System#wait_for_ready" if message.empty?
+        super(logger, message)
       end
     end
     # Support for backward compatibility
@@ -227,11 +227,20 @@ module JenkinsApi
     #
     class CLIError < ApiException
       def initialize(logger, message = "", log_level = Logger::ERROR)
-        msg = "Execute CLI Error. #{message}"
-        super(logger, msg)
+        message = "Unable to execute the command." if message.empty?
+        super(logger, message)
       end
     end
     # Support for backward compatibility
     CLIException = CLIError
+
+    # Exception when a particular plugin is not found
+    #
+    class PluginNotFound < NotFound
+      def initialize(logger, message = "", log_level = Logger::ERROR)
+        message = "The specified plugin is not found" if message.empty?
+        super(logger, message)
+      end
+    end
   end
 end

data/lib/jenkins_api_client/job.rb

@@ -197,7 +197,7 @@ module JenkinsApi
       # Update a job with params given as a hash instead of the xml. For the
       # parameter description see #create_or_update_freestyle
       #
-      # @param params [Hash]
+      # @param params [Hash] parameters to update a freestyle project
       #
       # @see #create_or_update_freestyle
       # @see #update
@@ -334,7 +334,7 @@ module JenkinsApi
       # @option params [String] :name Name of the job
       # @option params [String] :notification_email Email address to send
       # @option params [Boolean] :notification_email_for_every_unstable
-      # Send email notification email for every unstable build
+      #   Send email notification email for every unstable build
       #
       def add_email_notification(params)
         raise "No job name specified" unless params[:name]
@@ -405,7 +405,9 @@ module JenkinsApi
 
       # Delete a job given the name
       #
-      # @param [String] job_name
+      # @param job_name [String] the name of the job to delete
+      #
+      # @return [String] the response from the HTTP POST request
       #
       def delete(job_name)
         @logger.info "Deleting job '#{job_name}'"
@@ -424,7 +426,9 @@ module JenkinsApi
 
       # Wipe out the workspace for a job given the name
       #
-      # @param [String] job_name
+      # @param job_name [String] the name of the job to wipe out the workspace
+      #
+      # @return [String] response from the HTTP POST request
       #
       def wipe_out_workspace(job_name)
         @logger.info "Wiping out the workspace of job '#{job_name}'"
@@ -436,8 +440,8 @@ module JenkinsApi
       # is specified. The build will be stopped only if it was
       # in 'running' state.
       #
-      # @param [String] job_name
-      # @param [Number] build_number
+      # @param job_name [String] the name of the job to stop the build
+      # @param build_number [Number] the build number to stop
       #
       def stop_build(job_name, build_number = 0)
         build_number = get_current_build_number(job_name) if build_number == 0
@@ -451,11 +455,15 @@ module JenkinsApi
           @client.api_post_request("/job/#{job_name}/#{build_number}/stop")
         end
       end
+      alias_method :stop, :stop_build
+      alias_method :abort, :stop_build
 
       # Re-create the same job
       # This is a hack to clear any existing builds
       #
-      # @param [String] job_name
+      # @param job_name [String] the name of the job to recreate
+      #
+      # @return [String] the response from the HTTP POST request
       #
       def recreate(job_name)
         @logger.info "Recreating job '#{job_name}'"
@@ -466,8 +474,10 @@ module JenkinsApi
 
       # Copy a job
       #
-      # @param [String] from_job_name
-      # @param [String] to_job_name
+      # @param from_job_name [String] the name of the job to copy from
+      # @param to_job_name [String] the name of the job to copy to
+      #
+      # @return [String] the response from the HTTP POST request
       #
       def copy(from_job_name, to_job_name=nil)
         to_job_name = "copy_of_#{from_job_name}" if to_job_name.nil?
@@ -481,7 +491,7 @@ module JenkinsApi
       #
       # @param [String] job_name Name of the Jenkins job
       # @param [Number] build_num Specific build number to obtain the
-      #                 console output from. Default is the recent build
+      #   console output from. Default is the recent build
       # @param [Number] start start offset to get only a portion of the text
       # @param [String] mode Mode of text output. 'text' or 'html'
       #
@@ -520,6 +530,8 @@ module JenkinsApi
 
       # List all jobs on the Jenkins CI server
       #
+      # @return [Array<String>] the names of all jobs in jenkins
+      #
       def list_all
         response_json = @client.api_get_request("", "tree=jobs[name]")["jobs"]
         response_json.map { |job| job["name"] }.sort
@@ -527,7 +539,9 @@ module JenkinsApi
 
       # Checks if the given job exists in Jenkins
       #
-      # @param [String] job_name
+      # @param job_name [String] the name of the job to check
+      #
+      # @return [Boolean] whether the job exists in jenkins or not
       #
       def exists?(job_name)
         list(job_name).include?(job_name)
@@ -536,8 +550,12 @@ module JenkinsApi
       # List all Jobs matching the given status
       # You can optionally pass in jobs list to filter the status from
       #
-      # @param [String] status
-      # @param [Array] jobs
+      # @param status [String] the job status to filter
+      # @param jobs [Array<String>] if specified this array will be used for
+      #   filtering by the status otherwise the filtering will be done using
+      #   all jobs available in jenkins
+      #
+      # @return [Array<String>] filtered jobs
       #
       def list_by_status(status, jobs = [])
         jobs = list_all if jobs.empty?
@@ -555,8 +573,10 @@ module JenkinsApi
 
       # List all jobs that match the given regex
       #
-      # @param [String] filter - a regex
-      # @param [Boolean] ignorecase
+      # @param filter [String] a regular expression or a string to filter jobs
+      # @param ignorecase [Boolean] whether to ignore case or not
+      #
+      # @return [Array<String>] jobs matching the given pattern
       #
       def list(filter, ignorecase = true)
         @logger.info "Obtaining jobs matching filter '#{filter}'"
@@ -574,6 +594,8 @@ module JenkinsApi
 
       # List all jobs on the Jenkins CI server along with their details
       #
+      # @return [Array<Hash>] the details of all jobs in jenkins
+      #
       def list_all_with_details
         @logger.info "Obtaining the details of all jobs"
         response_json = @client.api_get_request("")
@@ -582,7 +604,9 @@ module JenkinsApi
 
       # List details of a specific job
       #
-      # @param [String] job_name
+      # @param job_name [String] the name of the job to obtain the details from
+      #
+      # @return [Hash] the details of the specified job
       #
       def list_details(job_name)
         @logger.info "Obtaining the details of '#{job_name}'"
@@ -591,7 +615,8 @@ module JenkinsApi
 
       # List upstream projects of a specific job
       #
-      # @param [String] job_name
+      # @param job_name [String] the name of the job to obtain upstream
+      #  projects for
       #
       def get_upstream_projects(job_name)
         @logger.info "Obtaining the upstream projects of '#{job_name}'"
@@ -601,7 +626,8 @@ module JenkinsApi
 
       # List downstream projects of a specific job
       #
-      # @param [String] job_name
+      # @param job_name [String] the name of the job to obtain downstream
+      #   projects for
       #
       def get_downstream_projects(job_name)
         @logger.info "Obtaining the down stream projects of '#{job_name}'"
@@ -660,6 +686,7 @@ module JenkinsApi
         response_json = @client.api_get_request("/job/#{job_name}")
         color_to_status(response_json["color"])
       end
+      alias_method :status, :get_current_build_status
 
       # Obtain the current build number of the given job
       # This function returns nil if there were no builds for the given job.
@@ -672,6 +699,7 @@ module JenkinsApi
         @logger.info "Obtaining the current build number of '#{job_name}'"
         @client.api_get_request("/job/#{job_name}")['nextBuildNumber'].to_i - 1
       end
+      alias_method :build_number, :get_current_build_number
 
       # Build a job given the name of the job
       # You can optionally pass in a list of params for Jenkins to use for

data/lib/jenkins_api_client/plugin_manager.rb

@@ -0,0 +1,460 @@
+#
+# Copyright (c) 2012-2013 Kannan Manickam <arangamani.kannan@gmail.com>
+#
+# 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.
+#
+
+module JenkinsApi
+  class Client
+    # This classes communicates with the /pluginManager API for listing
+    # installed plugins, installing new plgins through hacks, and performing a
+    # lot of operations on installed plugins. It also gives the ability to
+    # obtain the details about available plugins in Jenkins update center by
+    # commmunicating with /updateCenter API.
+    #
+    class PluginManager
+
+      # Initializes a new PluginManager object.
+      #
+      # @param [Object] client a reference to Client
+      #
+      def initialize(client)
+        @client = client
+        @logger = @client.logger
+      end
+
+      # Returns a string representation of PluginManager class.
+      #
+      def to_s
+        "#<JenkinsApi::Client::PluginManager>"
+      end
+
+      # Defines a method to perform the given action on plugin(s)
+      #
+      # @param action [Symbol] the action to perform
+      # @param post_endpoint [Symbol] the endpoint in the POST request for the
+      #   action
+      #
+      def self.plugin_action_method(action, post_endpoint)
+        define_method(action) do |plugins|
+          plugins = [plugins] unless plugins.is_a?(Array)
+          @logger.info "Performing '#{action}' on plugins: #{plugins.inspect}"
+          plugins.each do |plugin|
+            @client.api_post_request(
+              "/pluginManager/plugin/#{plugin}/#{post_endpoint}"
+            )
+          end
+        end
+      end
+
+      # Obtains the list of installed plugins from Jenkins along with their
+      # version numbers with optional filters
+      #
+      # @param filters [Hash] optional filters to apply. Use symbols for filter
+      #   keys
+      #
+      # @option filters [Boolean] :active filter active/non-active plugins
+      # @option filters [Boolean] :bundled filter bundled/non-bundled plugins
+      # @option filters [Boolean] :deleted filter deleted/available plugins
+      # @option filters [Boolean] :downgradable filter downgradable plugins
+      # @option filters [Boolean] :enabled filter enabled/disabled plugins
+      # @option filters [Boolean] :hasUpdate filter plugins that has update
+      #   available. Note that 'U' is capitalized in hasUpdate.
+      # @option filters [Boolean] :pinned filter pinned/un-pinned plugins
+      #
+      # @return [Hash<String, String>] installed plugins and their versions
+      #   matching the filter provided. returns an empty hash if there are no
+      #   plugins matched the filters or no plugins are installed in jenkins.
+      #
+      # @example Listing installed plugins from jenkins
+      #   >> @client.plugin.list_installed
+      #   => {
+      #        "mailer" => "1.5",
+      #        "external-monitor-job" => "1.1",
+      #        "ldap" => "1.2"
+      #      }
+      #   >> @client.plugin.list_installed(true)
+      #   => {}
+      #
+      # @example Listing installed plugins based on filters provided
+      #   >> @client.plugin.list_installed(
+      #        :active => true, :deleted => false, :bundled => false
+      #      )
+      #   => {
+      #        "sourcemonitor" => "0.2",
+      #        "sms-notification" => "1.0",
+      #        "jquery" => "1.7.2-1",
+      #        "simple-theme-plugin" => "0.3",
+      #        "jquery-ui" => "1.0.2",
+      #        "analysis-core" => "1.49"
+      #      }
+      #
+      def list_installed(filters = {})
+        supported_filters = [
+          :active, :bundled, :deleted, :downgradable, :enabled, :hasUpdate,
+          :pinned
+        ]
+        unless filters.keys.all? { |filter| supported_filters.include?(filter) }
+          raise ArgumentError, "Unsupported filters specified." +
+            " Supported filters: #{supported_filters.inspect}"
+        end
+        tree_filters = filters.empty? ? "" : ",#{filters.keys.join(",")}"
+        plugins = @client.api_get_request(
+          "/pluginManager",
+          "tree=plugins[shortName,version#{tree_filters}]"
+        )["plugins"]
+        installed = Hash[plugins.map do |plugin|
+          if filters.keys.all? { |key| plugin[key.to_s] == filters[key] }
+            [plugin["shortName"], plugin["version"]]
+          end
+        end]
+        installed
+      end
+
+      # Obtains the details of a single installed plugin
+      #
+      # @param plugin [String] the plugin ID of the desired plugin
+      #
+      # @return [Hash] the details of the given installed plugin
+      #
+      # @example Obtain the information of an installed plugin
+      #   >> @client.plugin.get_installed_info "ldap"
+      #   => {
+      #        "active"=>false,
+      #        "backupVersion"=>"1.2",
+      #        "bundled"=>true,
+      #        "deleted"=>false,
+      #        "dependencies"=>[],
+      #        "downgradable"=>true,
+      #        "enabled"=>false,
+      #        "hasUpdate"=>false,
+      #        "longName"=>"LDAP Plugin",
+      #        "pinned"=>true,
+      #        "shortName"=>"ldap",
+      #        "supportsDynamicLoad"=>"MAYBE",
+      #        "url"=>"http://wiki.jenkins-ci.org/display/JENKINS/LDAP+Plugin",
+      #        "version"=>"1.5"
+      #      }
+      #
+      def get_installed_info(plugin)
+        @logger.info "Obtaining the details of plugin: #{plugin}"
+        plugins = @client.api_get_request(
+          "/pluginManager",
+          "depth=1"
+        )["plugins"]
+        matched_plugin = plugins.select do |a_plugin|
+          a_plugin["shortName"] == plugin
+        end
+        if matched_plugin.empty?
+          raise Exceptions::PluginNotFound.new(
+            @logger,
+            "Plugin '#{plugin}' is not found"
+          )
+        else
+          matched_plugin.first
+        end
+      end
+
+      # List the available plugins from jenkins update center along with their
+      # version numbers
+      #
+      # @param filters [Hash] optional filters to filter available plugins.
+      #
+      # @option filters [Array] :category the category of the plugin to
+      #   filter
+      # @option filters [Array] :dependency the dependency of the plugin to
+      #   filter
+      #
+      # @return [Hash<String, String>] available plugins and their versions.
+      #   returns an empty if no plugins are available.
+      #
+      # @example Listing available plugins from jenkins
+      #   >> @client.plugin.list_available
+      #   => {
+      #        "accurev" => "0.6.18",
+      #        "active-directory" => "1.33",
+      #        "AdaptivePlugin" => "0.1",
+      #        ...
+      #        "zubhium" => "0.1.6"
+      #      }
+      #
+      # @example Listing available plugins matching a particular category
+      #   >> pp @client.plugin.list_available(:category => "ui")
+      #   => {
+      #        "all-changes"=>"1.3",
+      #        "bruceschneier"=>"0.1",
+      #        ...
+      #        "xfpanel"=>"1.2.2"
+      #      }
+      #
+      # @example Listing available plugins matching a particular dependency
+      #   >> pp @client.plugin.list_available(:dependency => "git")
+      #   => {
+      #        "build-failure-analyzer"=>"1.5.0",
+      #        "buildheroes"=>"0.2",
+      #        ...
+      #        "xpdev"=>"1.0"
+      #      }
+      #
+      def list_available(filters = {})
+        supported_filters = [:category, :dependency]
+        filter_plural_map = {
+          :dependency => "dependencies",
+          :category => "categories"
+        }
+        unless filters.keys.all? { |filter| supported_filters.include?(filter) }
+          raise ArgumentError, "Unsupported filters specified." +
+            " Supported filters: #{supported_filters.inspect}"
+        end
+        # Compute the filters to be passed to the JSON tree parameter
+        tree_filters =
+          if filters.empty?
+            ""
+          else
+            ",#{filters.keys.map{ |key| filter_plural_map[key] }.join(",")}"
+          end
+
+        availables = @client.api_get_request(
+          "/updateCenter/coreSource",
+          "tree=availables[name,version#{tree_filters}]"
+        )["availables"]
+        Hash[availables.map do |plugin|
+          if filters.keys.all? do |key|
+            !plugin[filter_plural_map[key]].nil? &&
+              plugin[filter_plural_map[key]].include?(filters[key])
+          end
+            [plugin["name"], plugin["version"]]
+          end
+        end]
+      end
+
+      # Obtains the information about a plugin that is available in the Jenkins
+      # update center
+      #
+      # @param plugin [String] the plugin ID to obtain information for
+      #
+      # @return [Hash] the details of the given plugin
+      #
+      # @example Obtaining the details of a plugin available in jenkins
+      #   >> @client.plugin.get_available_info "status-view"
+      #   => {
+      #        "name"=>"status-view",
+      #        "sourceId"=>"default",
+      #        "url"=>"http://updates.jenkins-ci.org/download/plugins/status-view/1.0/status-view.hpi",
+      #        "version"=>"1.0",
+      #        "categories"=>["ui"],
+      #        "compatibleSinceVersion"=>nil,
+      #        "compatibleWithInstalledVersion"=>true,
+      #        "dependencies"=>{},
+      #        "excerpt"=>"View type to show jobs filtered by the status of the last completed build.",
+      #        "installed"=>nil, "neededDependencies"=>[],
+      #        "requiredCore"=>"1.342",
+      #        "title"=>"Status View Plugin",
+      #        "wiki"=>"https://wiki.jenkins-ci.org/display/JENKINS/Status+View+Plugin"
+      #      }
+      #
+      def get_available_info(plugin)
+        plugins = @client.api_get_request(
+          "/updateCenter/coreSource",
+          "depth=1"
+        )["availables"]
+        matched_plugin = plugins.select do |a_plugin|
+          a_plugin["name"] == plugin
+        end
+        if matched_plugin.empty?
+          raise Exceptions::PluginNotFound.new(
+            @logger,
+            "Plugin '#{plugin}' is not found"
+          )
+        else
+          matched_plugin.first
+        end
+      end
+
+      # List the available updates for plugins from jenkins update center
+      # along with their version numbers
+      #
+      # @return [Hash<String, String>] available plugin updates and their
+      #   versions. returns an empty if no plugins are available.
+      #
+      # @example Listing available plugin updates from jenkins
+      #   >> @client.plugin.list_updates
+      #   => {
+      #        "ldap" => "1.5",
+      #        "ssh-slaves" => "0.27",
+      #        "subversion" => "1".50
+      #      }
+      #
+      def list_updates
+        updates = @client.api_get_request(
+          "/updateCenter/coreSource",
+          "tree=updates[name,version]"
+        )["updates"]
+        Hash[updates.map { |plugin| [plugin["name"], plugin["version"]] }]
+      end
+
+      # Installs a specific plugin or list of plugins. This method will install
+      # the latest available plugins that jenkins reports. The installation
+      # might not take place right away for some plugins and they might require
+      # restart of jenkins instances. This method makes a single POST request
+      # for the installation of multiple plugins. Updating plugins can be done
+      # the same way. When the install action is issued, it gets the latest
+      # version of the plugin if the plugin is outdated.
+      #
+      # @see Client#api_post_request
+      # @see #restart_required?
+      # @see System#restart
+      # @see #uninstall
+      #
+      # @param plugins [String, Array] a single plugin or a list of plugins to
+      #   be installed
+      #
+      # @return [String] the HTTP code from the plugin install POST request
+      #
+      # @example Installing a plugin and restart jenkins if required
+      #   >> @client.plugin.install "s3"
+      #   => "302" # Response code from plugin installation POST
+      #   >> @client.plugin.restart_required?
+      #   => true # A restart is required for the installation completion
+      #   >> @client.system.restart(true)
+      #   => "302" # A force restart is performed
+      #
+      def install(plugins)
+        # Convert the input argument to an array if it is not already an array
+        plugins = [plugins] unless plugins.is_a?(Array)
+        @logger.info "Installing plugins: #{plugins.inspect}"
+
+        # Build the form data to post to jenkins
+        form_data = {}
+        plugins.each { |plugin| form_data["plugin.#{plugin}.default"] = "on" }
+        @client.api_post_request("/pluginManager/install", form_data)
+      end
+      alias_method :update, :install
+
+
+      # @!method uninstall(plugins)
+      #
+      # Uninstalls the specified plugin or list of plugins. Only the user
+      # installed plugins can be uninstalled. The plugins installed by default
+      # by jenkins (also known as bundled plugins) cannot be uninstalled. The
+      # call will succeed but the plugins wil still remain in jenkins installed.
+      # This method makes a POST request for every plugin requested - so it
+      # might lead to some delay if a big list is provided.
+      #
+      # @see Client#api_post_request
+      # @see #restart_required?
+      # @see System#restart
+      # @see #install
+      #
+      # @param plugins [String, Array] a single plugin or list of plugins to be
+      #   uninstalled
+      #
+      plugin_action_method :uninstall, :doUninstall
+
+      # @!method downgrade(plugins)
+      #
+      # Downgrades the specified plugin or list of plugins. This method makes s
+      # POST request for every plugin specified - so it might lead to some
+      # delay if a big list is provided.
+      #
+      # @see Client#api_post_request
+      # @see #restart_required?
+      # @see System#restart
+      # @see #install
+      #
+      # @param [String, Array] a single plugin or list of plugins to be
+      #   downgraded
+      #
+      plugin_action_method :downgrade, :downgrade
+
+      # @!method unpin(plugins)
+      #
+      # Unpins the specified plugin or list of plugins. This method makes a
+      # POST request for every plugin specified - so it might lead to some
+      # delay if a big list is provided.
+      #
+      # @see Client#api_post_request
+      # @see #restart_required?
+      # @see System#restart
+      #
+      # @param plugins [String, Array] a single plugin or list of plugins to be
+      #   uninstalled
+      #
+      plugin_action_method :unpin, :unpin
+
+      # @!method enable(plugins)
+      #
+      # Enables the specified plugin or list of plugins. This method makes a
+      # POST request for every plugin specified - so it might lead to some
+      # delay if a big list is provided.
+      #
+      # @see Client#api_post_request
+      # @see #restart_required?
+      # @see System#restart
+      # @see #disable
+      #
+      # @param plugins [String, Array] a single plugin or list of plugins to be
+      #   uninstalled
+      #
+      plugin_action_method :enable, :makeEnabled
+
+      # @!method disable(plugins)
+      #
+      # Disables the specified plugin or list of plugins. This method makes a
+      # POST request for every plugin specified - so it might lead to some
+      # delay if a big list is provided.
+      #
+      # @see Client#api_post_request
+      # @see #restart_required?
+      # @see System#restart
+      # @see #enable
+      #
+      # @param plugins [String, Array] a single plugin or list of plugins to be
+      #   uninstalled
+      #
+      plugin_action_method :disable, :makeDisabled
+
+      # Requests the Jenkins plugin manager to check for updates by connecting
+      # to the update site.
+      #
+      # @see #list_updates
+      #
+      def check_for_updates
+        @client.api_post_request("/pluginManager/checkUpdates")
+      end
+
+      # Whether restart required for the completion of plugin
+      # installations/uninstallations
+      #
+      # @see Client#api_get_request
+      #
+      # @return [Boolean] whether restart is required for the completion for
+      #   plugin installations/uninstallations.
+      #
+      def restart_required?
+        response = @client.api_get_request(
+          "/updateCenter",
+          "tree=restartRequiredForCompletion"
+        )
+        response["restartRequiredForCompletion"] ||
+          !list_installed(:deleted => true).empty?
+      end
+    end
+  end
+end