jenkins_api_client 0.6.2 → 0.7.0

data/lib/jenkins_api_client/cli/base.rb

@@ -32,12 +32,16 @@ module JenkinsApi
 
     class Base < Thor
 
-      class_option :username,        :aliases => "-u", :desc => "Name of Jenkins user"
-      class_option :password,        :aliases => "-p", :desc => "Password of Jenkins user"
-      class_option :password_base64, :aliases => "-b", :desc => "Base 64 encoded password of Jenkins user"
-      class_option :server_ip,       :aliases => "-s", :desc => "Jenkins server IP address"
-      class_option :server_port,     :aliases => "-o", :desc => "Jenkins server port"
-      class_option :creds_file,      :aliases => "-c", :desc => "Credentials file for communicating with Jenkins server"
+      class_option :username, :aliases => "-u", :desc => "Name of Jenkins user"
+      class_option :password, :aliases => "-p",
+        :desc => "Password of Jenkins user"
+      class_option :password_base64, :aliases => "-b",
+        :desc => "Base 64 encoded password of Jenkins user"
+      class_option :server_ip, :aliases => "-s",
+        :desc => "Jenkins server IP address"
+      class_option :server_port, :aliases => "-o", :desc => "Jenkins port"
+      class_option :creds_file, :aliases => "-c",
+        :desc => "Credentials file for communicating with Jenkins server"
 
 
       map "-v" => :version

data/lib/jenkins_api_client/cli/helper.rb

@@ -26,14 +26,23 @@ module JenkinsApi
   module CLI
     class Helper
       def self.setup(options)
-        if options[:username] && options[:server_ip] && (options[:password] || options[:password_base64])
+        if options[:username] && options[:server_ip] && \
+          (options[:password] || options[:password_base64])
           creds = options
         elsif options[:creds_file]
-          creds = YAML.load_file(File.expand_path(options[:creds_file], __FILE__))
+          creds = YAML.load_file(
+            File.expand_path(options[:creds_file], __FILE__)
+          )
         elsif File.exist?("#{ENV['HOME']}/.jenkins_api_client/login.yml")
-          creds = YAML.load_file(File.expand_path("#{ENV['HOME']}/.jenkins_api_client/login.yml", __FILE__))
+          creds = YAML.load_file(
+            File.expand_path(
+              "#{ENV['HOME']}/.jenkins_api_client/login.yml", __FILE__
+            )
+          )
         else
-          puts "Credentials are not set. Please pass them as parameters or set them in the default credentials file"
+          msg = "Credentials are not set. Please pass them as parameters or"
+          msg << " set them in the default credentials file"
+          puts msg
           exit 1
         end
         JenkinsApi::Client.new(creds)

data/lib/jenkins_api_client/cli/job.rb

@@ -31,7 +31,8 @@ module JenkinsApi
 
       desc "list", "List jobs"
       method_option :status, :aliases => "-t", :desc => "Status to filter"
-      method_option :filter, :aliases => "-f", :desc => "Regular expression to filter jobs"
+      method_option :filter, :aliases => "-f",
+        :desc => "Regular expression to filter jobs"
       def list
         @client = Helper.setup(parent_options)
         if options[:filter] && options[:status]
@@ -64,12 +65,6 @@ module JenkinsApi
         puts @client.job.get_current_build_status(job)
       end
 
-      desc "listrunning", "List running jobs"
-      def listrunning
-        @client =  Helper.setup(parent_options)
-        puts @client.job.list_running
-      end
-
       desc "delete JOB", "Delete the job"
       def delete(job)
         @client = Helper.setup(parent_options)
@@ -77,10 +72,12 @@ module JenkinsApi
       end
 
       desc "console JOB", "Print the progressive console output of a job"
-      method_option :sleep, :aliases => "-z", :desc => "Time to wait between querying the API for console output"
+      method_option :sleep, :aliases => "-z",
+        :desc => "Time to wait between querying the API for console output"
       def console(job)
         @client = Helper.setup(parent_options)
-        # If debug is enabled, disable it. It shouldn't interfere with console output.
+        # If debug is enabled, disable it. It shouldn't interfere
+        # with console output.
         debug_changed = false
         if @client.debug == true
           @client.debug = false

data/lib/jenkins_api_client/cli/node.rb

@@ -28,9 +28,11 @@ module JenkinsApi
   module CLI
     class Node < Thor
       include Thor::Actions
+      include Terminal
 
       desc "list", "List all nodes"
-      method_option :filter, :aliases => "-f", :desc => "Regular expression to filter jobs"
+      method_option :filter, :aliases => "-f",
+        :desc => "Regular expression to filter jobs"
       def list
         @client = Helper.setup(parent_options)
         if options[:filter]
@@ -48,7 +50,7 @@ module JenkinsApi
         general_attributes.each do |attr|
           rows << [attr, @client.node.method("get_#{attr}").call]
         end
-        table = Terminal::Table.new :headings => ['Attribute', 'Value'], :rows => rows
+        table = Table.new :headings => ['Attribute', 'Value'], :rows => rows
         puts table
       end
 
@@ -60,7 +62,7 @@ module JenkinsApi
         node_attributes.each do |attr|
           rows << [attr, @client.node.method("get_node_#{attr}").call(node)]
         end
-        table = Terminal::Table.new :headings => ['Attribute', 'Value'], :rows => rows
+        table = Table.new :headings => ['Attribute', 'Value'], :rows => rows
         puts "Node: #{node}"
         puts table
       end
@@ -73,7 +75,7 @@ module JenkinsApi
         node_properties.each do |property|
           rows << [property, @client.node.method("is_#{property}?").call(node)]
         end
-        table = Terminal::Table.new :headings => ['Property', 'Value'], :rows => rows
+        table = Table.new :headings => ['Property', 'Value'], :rows => rows
         puts "Node: #{node}"
         puts table
       end

data/lib/jenkins_api_client/cli/system.rb

@@ -41,7 +41,8 @@ module JenkinsApi
       end
 
       desc "restart", "Restarts the Jenkins server"
-      method_option :force, :type => :boolean, :aliases => "-s", :desc => "Force restart"
+      method_option :force, :type => :boolean, :aliases => "-s",
+        :desc => "Force restart"
       def restart
         @client = Helper.setup(parent_options)
         force = options[:force] ? true : false

data/lib/jenkins_api_client/client.rb

@@ -28,38 +28,34 @@ require 'active_support/core_ext'
 require 'active_support/builder'
 require 'base64'
 
-require File.expand_path('../version', __FILE__)
-require File.expand_path('../exceptions', __FILE__)
-require File.expand_path('../job', __FILE__)
-require File.expand_path('../system', __FILE__)
-require File.expand_path('../node', __FILE__)
-
 module JenkinsApi
   class Client
     attr_accessor :debug
-    @debug = false
     DEFAULT_SERVER_PORT = 8080
     VALID_PARAMS = %w(server_ip server_port username password debug)
 
-    # Initialize a Client object with Jenkins CI server information and credentials
+    # Initialize a Client object with Jenkins CI server credentials
     #
     # @param [Hash] args
     #  * the +:server_ip+ param is the IP address of the Jenkins CI server
-    #  * the +:server_port+ param is the port on which the Jenkins server listens
-    #  * the +:username+ param is the username used for connecting to the CI server
+    #  * the +:server_port+ param is the port on which the Jenkins listens
+    #  * the +:username+ param is the username used for connecting to the server
     #  * the +:password+ param is the password for connecting to the CI server
     #
     def initialize(args)
-      args.each { |key, value|
+      args.each do |key, value|
         instance_variable_set("@#{key}", value) if value
-      } if args.is_a? Hash
-     raise "Server IP is required to connect to Jenkins Server" unless @server_ip
-     raise "Credentials are required to connect to te Jenkins Server" unless @username && (@password || @password_base64)
+      end if args.is_a? Hash
+     raise "Server IP is required to connect to Jenkins" unless @server_ip
+     unless @username && (@password || @password_base64)
+       raise "Credentials are required to connect to te Jenkins Server"
+     end
      @server_port = DEFAULT_SERVER_PORT unless @server_port
+     @debug = false unless @debug
 
-     # Base64 decode inserts a newline character at the end. As a workaround added chomp
-     # to remove newline characters. I hope nobody uses newline characters at the end of
-     # their passwords :)
+     # Base64 decode inserts a newline character at the end. As a workaround
+     # added chomp to remove newline characters. I hope nobody uses newline
+     # characters at the end of their passwords :)
      @password = Base64.decode64(@password_base64).chomp if @password_base64
     end
 
@@ -93,6 +89,12 @@ module JenkinsApi
       JenkinsApi::Client::View.new(self)
     end
 
+    # Creates an instance to the BuildQueue by passing a reference to self
+    #
+    def queue
+      JenkinsApi::Client::BuildQueue.new(self)
+    end
+
     # Returns a string representing the class name
     #
     def to_s
@@ -119,6 +121,7 @@ module JenkinsApi
       request = Net::HTTP::Get.new("#{url_prefix}#{url_suffix}?#{tree}") if tree
       request.basic_auth @username, @password
       response = http.request(request)
+      msg = "HTTP Code: #{response.code}, Response Body: #{response.body}"
       case response.code.to_i
       when 200
         if url_suffix =~ /json/
@@ -127,36 +130,39 @@ module JenkinsApi
           return response
         end
       when 401
-        raise Exceptions::UnautherizedException.new("HTTP Code: #{response.code.to_s}, Response Body: #{response.body}")
+        raise Exceptions::UnautherizedException.new(msg)
       when 404
-        raise Exceptions::NotFoundException.new("HTTP Code: #{response.code.to_s}, Response Body: #{response.body}")
+        raise Exceptions::NotFoundException.new(msg)
       when 500
-        raise Exceptions::InternelServerErrorException.new("HTTP Code: #{response.code.to_s}, Response Body: #{response.body}")
+        raise Exceptions::InternelServerErrorException.new(msg)
       else
-        raise Exceptions::ApiException.new("HTTP Code: #{response.code.to_s}, Response body: #{response.body}")
+        raise Exceptions::ApiException.new(msg)
       end
     end
 
     # Sends a POST message to the Jenkins CI server with the specified URL
     #
     # @param [String] url_prefix
+    # @param [Hash] form_data form data to send with POST request
     #
-    def api_post_request(url_prefix)
+    def api_post_request(url_prefix, form_data = nil)
       http = Net::HTTP.start(@server_ip, @server_port)
       request = Net::HTTP::Post.new("#{url_prefix}")
       puts "[INFO] PUT #{url_prefix}" if @debug
       request.basic_auth @username, @password
       request.content_type = 'application/json'
+      request.set_form_data(form_data) unless form_data.nil?
       response = http.request(request)
+      msg = "HTTP Code: #{response.code}, Response Body: #{response.body}"
       case response.code.to_i
       when 200, 302
         return response.code
       when 404
-        raise Exceptions::NotFoundException.new("HTTP Code: #{response.code.to_s}, Response Body: #{response.body}")
+        raise Exceptions::NotFoundException.new(msg)
       when 500
-        raise Exceptions::InternelServerErrorException.new("HTTP Code: #{response.code.to_s}, Response Body: #{response.body}")
+        raise Exceptions::InternelServerErrorException.new(msg)
       else
-        raise Exceptions::ApiException.new("HTTP Code: #{response.code.to_s}, Response body: #{response.body}")
+        raise Exceptions::ApiException.new(msg)
       end
     end
 

data/lib/jenkins_api_client/job.rb

@@ -46,8 +46,8 @@ module JenkinsApi
       end
 
       # Create a job with params given as a hash instead of the xml
-      # This gives some flexibility for creating simple jobs so the user doesn't have to
-      # learn about handling xml.
+      # This gives some flexibility for creating simple jobs so the user
+      # doesn't have to learn about handling xml.
       #
       # @param [Hash] params
       #  * +:name+ name of the job
@@ -55,33 +55,61 @@ module JenkinsApi
       #  * +:block_build_when_downstream_building+ true or false
       #  * +:block_build_when_upstream_building+ true or false
       #  * +:concurrent_build+ true or false
-      #  * +:scm_provider+ type of source control system. Supported: git, subversion
+      #  * +:scm_provider+ type of source control system. Supported: Git, SVN
       #  * +:scm_url+ remote url for scm
+      #  * +:scm_module+ Module to download. Only for CVS.
       #  * +:scm_branch+ branch to use in scm. Uses master by default
+      #  * +:scm_tag+ tag to download from scm. Only for CVS.
+      #  * +:scm_use_head_if_tag_not_found+ Only for CVS.
       #  * +:shell_command+ command to execute in the shell
       #  * +:child_projects+ projects to add as downstream projects
-      #  * +:child_threshold+ threshold for child projects. success, failure, or unstable. Default: failure.
+      #  * +:child_threshold+ threshold for child projects.
+      #      success, failure, or unstable. Default: failure.
       #
       def create_freestyle(params)
-        # TODO: Add support for all SCM providers supported by Jenkins
-        supported_scm_providers = ['git', 'subversion']
+        # Supported SCM providers
+        supported_scm = ["git", "subversion", "cvs"]
 
-        # Set default values for params that are not specified and Error handling.
+        # Set default values for params that are not specified.
         raise 'Job name must be specified' unless params[:name]
-        params[:keep_dependencies] = false if params[:keep_dependencies].nil?
-        params[:block_build_when_downstream_building] = false if params[:block_build_when_downstream_building].nil?
-        params[:block_build_when_upstream_building] = false if params[:block_build_when_upstream_building].nil?
+        if params[:keep_dependencies].nil?
+          params[:keep_dependencies] = false
+        end
+        if params[:block_build_when_downstream_building].nil?
+          params[:block_build_when_downstream_building] = false
+        end
+        if params[:block_build_when_upstream_building].nil?
+          params[:block_build_when_upstream_building] = false
+        end
         params[:concurrent_build] = false if params[:concurrent_build].nil?
+        if params[:notification_email]
+          if params[:notification_email_for_every_unstable_build].nil?
+            params[:notification_email_for_every_unstable] = false
+          end
+          if params[:notification_email_send_to_individuals].nil?
+            params[:notification_email_send_to_individuals] ||= false
+          end
+        end
 
-        # SCM configurations and Error handling. Presently only Git plugin is supported.
-        unless supported_scm_providers.include?(params[:scm_provider]) || params[:scm_provider].nil?
+        # SCM configurations and Error handling.
+        unless supported_scm.include?(params[:scm_provider]) ||
+          params[:scm_provider].nil?
           raise "SCM #{params[:scm_provider]} is currently not supported"
         end
-        raise 'SCM URL must be specified' if params[:scm_url].nil? && !params[:scm_provider].nil?
-        params[:scm_branch] = "master" if params[:scm_branch].nil? && !params[:scm_provider].nil?
+        if params[:scm_url].nil? && !params[:scm_provider].nil?
+          raise 'SCM URL must be specified'
+        end
+        if params[:scm_branch].nil? && !params[:scm_provider].nil?
+          params[:scm_branch] = "master"
+        end
+        if params[:scm_use_head_if_tag_not_found].nil?
+          params[:scm_use_head_if_tag_not_found] = false
+        end
 
         # Child projects configuration and Error handling
-        params[:child_threshold] = 'failure' if params[:child_threshold].nil? && !params[:child_projects].nil?
+        if params[:child_threshold].nil? && !params[:child_projects].nil?
+          params[:child_threshold] = 'failure'
+        end
 
         # Build the Job xml file based on the parameters given
         builder = Nokogiri::XML::Builder.new(:encoding => 'UTF-8') { |xml|
@@ -92,7 +120,8 @@ module JenkinsApi
             xml.properties
             # SCM related stuff
             if params[:scm_provider] == 'subversion'
-              xml.scm(:class => "hudson.scm.SubversionSCM", :plugin => "subversion@1.39") {
+              xml.scm(:class => "hudson.scm.SubversionSCM",
+                      :plugin => "subversion@1.39") {
                 xml.locations {
                   xml.send("hudson.scm.SubversionSCM_-ModuleLocation") {
                     xml.remote "#{params[:scm_url]}"
@@ -104,9 +133,31 @@ module JenkinsApi
                 xml.excludedUsers
                 xml.excludedRevprop
                 xml.excludedCommitMessages
-                xml.workspaceUpdater(:class => "hudson.scm.subversion.UpdateUpdater")
+                xml.workspaceUpdater(:class =>
+                                     "hudson.scm.subversion.UpdateUpdater")
+              }
+            elsif params[:scm_provider] == "cvs"
+              xml.scm(:class => "hudson.scm.CVSSCM",
+                      :plugin => "cvs@1.6") {
+                xml.cvsroot "#{params[:scm_url]}"
+                xml.module "#{params[:scm_module]}"
+                if params[:scm_branch]
+                  xml.branch "#{params[:scm_branch]}"
+                else
+                  xml.branch "#{params[:scm_tag]}"
+                end
+                xml.canUseUpdate true
+                xml.useHeadIfNotFound(
+                  "#{params[:scm_use_head_if_tag_not_found]}")
+                xml.flatten true
+                if params[:scm_tag]
+                  xml.isTag true
+                else
+                  xml.isTag false
+                end
+                xml.excludedRegions
               }
-            elsif params[:scm_provider] == 'git'
+            elsif params[:scm_provider] == "git"
               xml.scm(:class => "hudson.plugins.git.GitSCM") {
                 xml.configVersion "2"
                 xml.userRemoteConfigs {
@@ -131,7 +182,8 @@ module JenkinsApi
                 xml.remotePoll "false"
                 xml.ignoreNotifyCommit "false"
                 xml.useShallowClone "false"
-                xml.buildChooser(:class => "hudson.plugins.git.util.DefaultBuildChooser")
+                xml.buildChooser(:class =>
+                                 "hudson.plugins.git.util.DefaultBuildChooser")
                 xml.gitTool "Default"
                 xml.submoduleCfg(:class => "list")
                 xml.relativeTargetDir
@@ -147,10 +199,18 @@ module JenkinsApi
             else
               xml.scm(:class => "hudson.scm.NullSCM")
             end
-            xml.canRoam "true"
+            # Restrict job to run in a specified node
+            if params[:restricted_node]
+              xml.assignedNode "#{params[:restricted_node]}"
+              xml.canRoam "false"
+            else
+              xml.canRoam "true"
+            end
             xml.disabled "false"
-            xml.blockBuildWhenDownstreamBuilding "#{params[:block_build_when_downstream_building]}"
-            xml.blockBuildWhenUpstreamBuilding "#{params[:block_build_when_upstream_building]}"
+            xml.blockBuildWhenDownstreamBuilding(
+              "#{params[:block_build_when_downstream_building]}")
+            xml.blockBuildWhenUpstreamBuilding(
+              "#{params[:block_build_when_upstream_building]}")
             xml.triggers.vector
             xml.concurrentBuild "#{params[:concurrent_build]}"
             # Shell command stuff
@@ -165,8 +225,9 @@ module JenkinsApi
             xml.publishers {
               if params[:child_projects]
                 xml.send("hudson.tasks.BuildTrigger") {
-                  xml.childProjects"#{params[:child_projects]}"
-                  name, ordinal, color = get_threshold_params(params[:child_threshold])
+                  xml.childProjects "#{params[:child_projects]}"
+                  threshold = params[:child_threshold]
+                  name, ordinal, color = get_threshold_params(threshold)
                   xml.threshold {
                     xml.name "#{name}"
                     xml.ordinal "#{ordinal}"
@@ -174,6 +235,15 @@ module JenkinsApi
                   }
                 }
               end
+              if params[:notification_email]
+                xml.send("hudson.tasks.Mailer") {
+                  xml.recipients "#{params[:notification_email]}"
+                  xml.dontNotifyEveryUnstableBuild(
+                    "#{params[:notification_email_for_every_unstable]}")
+                  xml.sendToIndividuals(
+                    "#{params[:notification_email_send_to_individuals]}")
+                }
+              end
             }
             xml.buildWrappers
           }
@@ -191,7 +261,8 @@ module JenkinsApi
 
       # Stops a running build of a job
       # This method will stop the current/most recent build if no build number
-      # is specified. The build will be stopped only if it was in 'running' state.
+      # is specified. The build will be stopped only if it was
+      # in 'running' state.
       #
       # @param [String] job_name
       # @param [Number] build_number
@@ -200,8 +271,12 @@ module JenkinsApi
         build_number = get_current_build_number(job_name) if build_number == 0
         raise "No builds for #{job_name}" unless build_number
         # Check and see if the build is running
-        is_building = @client.api_get_request("/job/#{job_name}/#{build_number}")["building"]
-        @client.api_post_request("/job/#{job_name}/#{build_number}/stop") if is_building
+        is_building = @client.api_get_request(
+          "/job/#{job_name}/#{build_number}"
+        )["building"]
+        if is_building
+          @client.api_post_request("/job/#{job_name}/#{build_number}/stop")
+        end
       end
 
       # Re-create the same job
@@ -218,18 +293,21 @@ module JenkinsApi
       # Get progressive console output from Jenkins server for a job
       #
       # @param [String] job_name Name of the Jenkins job
-      # @param [Number] build_number Specific build number to obtain the console output from. Default is the recent build
+      # @param [Number] build_number Specific build number to obtain the
+      #                 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'
       #
       # @return [Hash] response
       #   * +output+ Console output of the job
-      #   * +size+ Size of the text. This can be used as 'start' for the next call to get progressive output
-      #   * +more+ More data available for the job. 'true' if available and nil otherwise
-      #
-      def get_console_output(job_name, build_number = 0, start = 0, mode = 'text')
-        build_number = get_current_build_number(job_name) if build_number == 0
-        if build_number == 0
+      #   * +size+ Size of the text. This can be used as 'start' for the
+      #            next call to get progressive output
+      #   * +more+ More data available for the job. 'true' if available
+      #            and nil otherwise
+      #
+      def get_console_output(job_name, build_num = 0, start = 0, mode = 'text')
+        build_num = get_current_build_number(job_name) if build_num == 0
+        if build_num == 0
           puts "No builds for this job '#{job_name}' yet."
           return nil
         end
@@ -240,7 +318,9 @@ module JenkinsApi
         else
           raise "Mode should either be 'text' or 'html'. You gave: #{mode}"
         end
-        api_response = @client.api_get_request("/job/#{job_name}/#{build_number}/logText/progressive#{mode}?start=#{start}", nil, nil)
+        get_msg = "/job/#{job_name}/#{build_num}/logText/progressice#{mode}?"
+        get_msg << "start=#{start}"
+        api_response = @client.api_get_request(get_msg, nil, nil)
         #puts "Response: #{api_response.header['x-more-data']}"
         response = {}
         response['output'] = api_response.body
@@ -278,7 +358,10 @@ module JenkinsApi
         xml_response = @client.api_get_request("", "tree=jobs[name,color]")
         filtered_jobs = []
         xml_response["jobs"].each do |job|
-          filtered_jobs << job["name"] if color_to_status(job["color"]) == status && jobs.include?(job["name"])
+          if color_to_status(job["color"]) == status &&
+             jobs.include?(job["name"])
+            filtered_jobs << job["name"]
+          end
         end
         filtered_jobs
       end
@@ -347,6 +430,8 @@ module JenkinsApi
       #
       # @param [String] color color given by the API for a job
       #
+      # @return [String] status status of the given job matching the color
+      #
       def color_to_status(color)
         case color
         when "blue"
@@ -372,37 +457,30 @@ module JenkinsApi
       #
       # @param [String] job_name
       #
+      # @return [String] status current status of the given job
+      #
       def get_current_build_status(job_name)
         response_json = @client.api_get_request("/job/#{job_name}")
         color_to_status(response_json["color"])
       end
 
       # Obtain the current build number of the given job
-      # This function returns nil if there were no builds for the given job name.
+      # This function returns nil if there were no builds for the given job.
       #
       # @param [String] job_name
       #
-      def get_current_build_number(job_name)
-        @client.api_get_request("/job/#{job_name}")['nextBuildNumber'] - 1
-      end
-
-      # This functions lists all jobs that are currently running on the Jenkins CI server
-      # This method is deprecated. Please use list_by_status instead.
+      # @return [Number] build_unumber current build number of the given job
       #
-      def list_running
-        puts "[WARN] list_running is deprecated. Please use list_by_status('running') instead."
-        xml_response = @client.api_get_request("", "tree=jobs[name,color]")
-        running_jobs = []
-        xml_response["jobs"].each { |job|
-          running_jobs << job["name"] if color_to_status(job["color"]) == "running"
-        }
-        running_jobs
+      def get_current_build_number(job_name)
+        @client.api_get_request("/job/#{job_name}")['nextBuildNumber'].to_i - 1
       end
 
       # Build a job given the name of the job
       #
       # @param [String] job_name
       #
+      # @return [String] response_code return code from HTTP POST
+      #
       def build(job_name)
         @client.api_post_request("/job/#{job_name}/build")
       end
@@ -411,6 +489,8 @@ module JenkinsApi
       #
       # @param [String] job_name
       #
+      # @return [String] XML Config.xml of the job
+      #
       def get_config(job_name)
         @client.get_config("/job/#{job_name}")
       end
@@ -420,6 +500,8 @@ module JenkinsApi
       # @param [String] job_name
       # @param [String] xml
       #
+      # @return [String] response_code return code from HTTP POST
+      #
       def post_config(job_name, xml)
         @client.post_config("/job/#{job_name}/config.xml", xml)
       end
@@ -429,6 +511,8 @@ module JenkinsApi
       # @param [String] job_name
       # @param [String] description
       #
+      # @return [String] response_code return code from HTTP POST
+      #
       def change_description(job_name, description)
         xml = get_config(job_name)
         n_xml = Nokogiri::XML(xml)
@@ -442,6 +526,8 @@ module JenkinsApi
       #
       # @param [String] job_name
       #
+      # @return [String] response_code return code from HTTP POST
+      #
       def block_build_when_downstream_building(job_name)
         xml = get_config(job_name)
         n_xml = Nokogiri::XML(xml)
@@ -457,6 +543,8 @@ module JenkinsApi
       #
       # @param [String] job_name
       #
+      # @return [String] response_code return code from HTTP POST
+      #
       def unblock_build_when_downstream_building(job_name)
         xml = get_config(job_name)
         n_xml = Nokogiri::XML(xml)
@@ -472,6 +560,8 @@ module JenkinsApi
       #
       # @param [String] job_name
       #
+      # @return [String] response_code return code from HTTP POST
+      #
       def block_build_when_upstream_building(job_name)
         xml = get_config(job_name)
         n_xml = Nokogiri::XML(xml)
@@ -487,6 +577,8 @@ module JenkinsApi
       #
       # @param [String] job_name
       #
+      # @return [String] response_code return code from HTTP POST
+      #
       def unblock_build_when_upstream_building(job_name)
         xml = get_config(job_name)
         n_xml = Nokogiri::XML(xml)
@@ -498,11 +590,13 @@ module JenkinsApi
         end
       end
 
-      # Allow to either execute concurrent builds or disable concurrent execution
+      # Allow or disable concurrent build execution
       #
       # @param [String] job_name
       # @param [Bool] option true or false
       #
+      # @return [String] response_code return code from HTTP POST
+      #
       def execute_concurrent_builds(job_name, option)
         xml = get_config(job_name)
         n_xml = Nokogiri::XML(xml)
@@ -519,7 +613,7 @@ module JenkinsApi
       #
       # @param [String] job_name
       #
-      # @return [Array] params_array
+      # @return [Array] params_array Array of parameters for the given job
       #
       def get_build_params(job_name)
         xml = get_config(job_name)
@@ -530,39 +624,58 @@ module JenkinsApi
           params.children.each do |param|
             param_hash = {}
             case param.name
-            when "hudson.model.StringParameterDefinition", "hudson.model.BooleanParameterDefinition", "hudson.model.TextParameterDefinition", "hudson.model.PasswordParameterDefinition"
+            when "hudson.model.StringParameterDefinition",
+                 "hudson.model.BooleanParameterDefinition",
+                 "hudson.model.TextParameterDefinition",
+                 "hudson.model.PasswordParameterDefinition"
               param_hash[:type] = 'string' if param.name =~ /string/i
               param_hash[:type] = 'boolean' if param.name =~ /boolean/i
               param_hash[:type] = 'text' if param.name =~ /text/i
               param_hash[:type] = 'password' if param.name =~ /password/i
               param.children.each do |value|
                 param_hash[:name] = value.content if value.name == "name"
-                param_hash[:description] = value.content if value.name == "description"
-                param_hash[:default] = value.content if value.name == "defaultValue"
+                if value.name == "description"
+                  param_hash[:description] = value.content
+                end
+                if value.name == "defaultValue"
+                  param_hash[:default] = value.content
+                end
               end
             when "hudson.model.RunParameterDefinition"
               param_hash[:type] = 'run'
               param.children.each do |value|
                 param_hash[:name] = value.content if value.name == "name"
-                param_hash[:description] = value.content if value.name == "description"
-                param_hash[:project] = value.content if value.name == "projectName"
+                if value.name == "description"
+                  param_hash[:description] = value.content
+                end
+                if value.name == "projectName"
+                  param_hash[:project] = value.content
+                end
               end
             when "hudson.model.FileParameterDefinition"
               param_hash[:type] = 'file'
               param.children.each do |value|
                 param_hash[:name] = value.content if value.name == "name"
-                param_hash[:description] = value.content if value.name == "description"
+                param_hash[:description] = value.content \
+                  if value.name == "description"
               end
             when "hudson.scm.listtagsparameter.ListSubversionTagsParameterDefinition"
               param_hash[:type] = 'list_tags'
               param.children.each do |value|
-                param_hash[:name] = value.content if value.name == "name"
-                param_hash[:description] = value.content if value.name == "description"
-                param_hash[:tags_dir] = value.content if value.name == "tagsDir"
-                param_hash[:tags_filter] = value.content if value.name == "tagsFilter"
-                param_hash[:reverse_by_date] = value.content if value.name == "reverseByDate"
-                param_hash[:reverse_by_name] = value.content if value.name == "reverseByName"
-                param_hash[:default] = value.content if value.name == "defaultValue"
+                param_hash[:name] = value.content \
+                  if value.name == "name"
+                param_hash[:description] = value.content \
+                  if value.name == "description"
+                param_hash[:tags_dir] = value.content \
+                  if value.name == "tagsDir"
+                param_hash[:tags_filter] = value.content \
+                  if value.name == "tagsFilter"
+                param_hash[:reverse_by_date] = value.content \
+                  if value.name == "reverseByDate"
+                param_hash[:reverse_by_name] = value.content \
+                  if value.name == "reverseByName"
+                param_hash[:default] = value.content \
+                  if value.name == "defaultValue"
                 param_hash[:max_tags] = value.content if value.name == "maxTags"
                 param_hash[:uuid] = value.content if value.name == "uuid"
               end
@@ -570,13 +683,15 @@ module JenkinsApi
               param_hash[:type] = 'choice'
               param.children.each do |value|
                 param_hash[:name] = value.content if value.name == "name"
-                param_hash[:description] = value.content if value.name == "description"
+                param_hash[:description] = value.content \
+                  if value.name == "description"
                 choices = []
                 if value.name == "choices"
                   value.children.each do |value_child|
                     if value_child.name == "a"
                       value_child.children.each do |choice_child|
-                        choices << choice_child.content.strip unless choice_child.content.strip.empty?
+                        choices << choice_child.content.strip \
+                          unless choice_child.content.strip.empty?
                       end
                     end
                   end
@@ -585,15 +700,18 @@ module JenkinsApi
               end
             end
             params_array << param_hash unless param_hash.empty?
-         end
-       end
-       params_array
+          end
+        end
+        params_array
       end
 
-      # Obtains the threshold params used by jenkins in the XML file given the threshold
+      # Obtains the threshold params used by jenkins in the XML file
+      # given the threshold
       #
       # @param [String] threshold success, failure, or unstable
       #
+      # @return [String] status readable status matching the color
+      #
       def get_threshold_params(threshold)
         case threshold
         when 'success'
@@ -612,16 +730,20 @@ module JenkinsApi
         return name, ordinal, color
       end
 
-      # Add downstream projects to a specific job given the job name, projects to be
-      # added as downstream projects, and the threshold
+      # Add downstream projects to a specific job given the job name,
+      # projects to be added as downstream projects, and the threshold
       #
       # @param [String] job_name
       # @param [String] downstream_projects
       # @param [String] threshold - failure, success, or unstable
       # @param [Bool] overwrite - true or false
       #
-      def add_downstream_projects(job_name, downstream_projects, threshold, overwrite = false)
-        name, ordinal, color = get_threshold_params(threshold)
+      # @return [String] response_code return code from HTTP POST
+      #
+      def add_downstream_projects(job_name,
+                                  downstream_projects,
+                                  threshold, overwrite = false)
+        name, ord, col = get_threshold_params(threshold)
         xml = get_config(job_name)
         n_xml = Nokogiri::XML(xml)
         child_projects_node = n_xml.xpath("//childProjects").first
@@ -629,14 +751,24 @@ module JenkinsApi
           if overwrite
             child_projects_node.content = "#{downstream_projects}"
           else
-            child_projects_node.content = child_projects_node.content + ", #{downstream_projects}"
+            to_replace = child_projects_node.content +
+              ", #{downstream_projects}"
+            child_projects_node.content = to_replace
           end
         else
           publisher_node = n_xml.xpath("//publishers").first
-          build_trigger_node = publisher_node.add_child("<hudson.tasks.BuildTrigger/>")
-          child_project_node = build_trigger_node.first.add_child("<childProjects>#{downstream_projects}</childProjects>")
-          threshold_node = child_project_node.first.add_next_sibling("<threshold/>")
-          threshold_node.first.add_child("<name>#{name}</name><ordinal>#{ordinal}</ordinal><color>#{color}</color>")
+          build_trigger_node = publisher_node.add_child(
+            "<hudson.tasks.BuildTrigger/>"
+          )
+          child_project_node = build_trigger_node.first.add_child(
+            "<childProjects>#{downstream_projects}</childProjects>"
+          )
+          threshold_node = child_project_node.first.add_next_sibling(
+            "<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)
@@ -646,6 +778,8 @@ module JenkinsApi
       #
       # @param [String] job_name
       #
+      # @return [String] response_code return code from HTTP POST
+      #
       def remove_downstream_projects(job_name)
         xml = get_config(job_name)
         n_xml = Nokogiri::XML(xml)
@@ -678,6 +812,8 @@ module JenkinsApi
       # @param [String] job_name
       # @param [String] node_name
       #
+      # @return [String] response_code return code from HTTP POST
+      #
       def restrict_to_node(job_name, node_name)
         xml = get_config(job_name)
         n_xml = Nokogiri::XML(xml)
@@ -685,7 +821,7 @@ module JenkinsApi
           node.content = node_name
         else
           project = n_xml.xpath("//scm").first
-          child_node = project.add_next_sibling("<assignedNode>#{node_name}</assignedNode>")
+          project.add_next_sibling("<assignedNode>#{node_name}</assignedNode>")
           roam_node = n_xml.xpath("//canRoam").first
           roam_node.content = "false"
         end
@@ -698,37 +834,54 @@ module JenkinsApi
       # @param [Array] job_names Array of job names to be unchained
       #
       def unchain(job_names)
-        job_names.each { |job|
-          puts "[INFO] Removing downstream projects for <#{job}>" if @client.debug
-          @client.job.remove_downstream_projects(job)
-        }
+        job_names.each do |job|
+          log_msg = "[INFO] Removing downstream projects for <#{job}>"
+          puts log_msg if @client.debug
+          remove_downstream_projects(job)
+        end
       end
 
       # Chain the jobs given based on specified criteria
       #
       # @param [Array] job_names Array of job names to be chained
-      # @param [String] threshold what should be the threshold for running the next job
-      # @param [Array] criteria criteria which should be applied for picking the jobs for the chain
-      # @param [Integer] parallel Number of jobs that should be considered for parallel run
-      #
+      # @param [String] threshold threshold for running the next job
+      # @param [Array] criteria criteria which should be applied for
+      #                picking the jobs for the chain
+      # @param [Integer] parallel Number of jobs that should be considered
+      #                  for parallel run
+      #
+      # @return [Array] job_names Names of jobs that are in the top of the
+      #                 chain
       def chain(job_names, threshold, criteria, parallel = 1)
         raise "Parallel jobs should be at least 1" if parallel < 1
         unchain(job_names)
+
         filtered_job_names = []
         if criteria.include?("all") || criteria.empty?
           filtered_job_names = job_names
         else
-          puts "[INFO] Criteria is specified. Filtering jobs..." if @client.debug
+          log_msg = "[INFO] Criteria is specified. Filtering jobs..."
+          puts log_msg if @client.debug
           job_names.each do |job|
-            filtered_job_names << job if criteria.include?(@client.job.get_current_build_status(job))
+            filtered_job_names << job if criteria.include?(
+              @client.job.get_current_build_status(job)
+            )
           end
         end
+
         filtered_job_names.each_with_index do |job_name, index|
           break if index >= (filtered_job_names.length - parallel)
-          puts "[INFO] Adding <#{filtered_job_names[index+1]}> as a downstream project to <#{job_name}> with <#{threshold}> as the threshold" if @client.debug
-          @client.job.add_downstream_projects(job_name, filtered_job_names[index + parallel], threshold, true)
+          msg = "[INFO] Adding <#{filtered_job_names[index+1]}> as a"
+          msg << " downstream project to <#{job_name}> with <#{threshold}> as"
+          msg << " the threshold"
+          puts msg if @client.debug
+          @client.job.add_downstream_projects(
+            job_name, filtered_job_names[index + parallel], threshold, true
+          )
+        end
+        if parallel > filtered_job_names.length
+          parallel = filtered_job_names.length
         end
-        parallel = filtered_job_names.length if parallel > filtered_job_names.length
         filtered_job_names[0..parallel-1]
       end