jenkins_api_client 0.9.1 → 0.10.0

data/.travis.yml

@@ -10,6 +10,13 @@ rvm:
   - ruby-head
   - jruby-head
   - 1.8.7
+  - ree
+matrix:
+  allow_failures:
+    - rvm: jruby-18mode
+    - rvm: jruby-19mode
+    - rvm: jruby-head
+    - rvm: ree
 script: bundle exec rake unit_tests
 notifications:
   email: false

data/CHANGELOG.md

@@ -4,10 +4,17 @@ CHANGELOG
 upcoming
 --------
 
+v0.10.0  [24-APR-2013]
+----------------------
+* new function to execute jenkins CLI `cli_exec`. Credit: @missedone
+* Add ability to use http proxy. Credit: @woodbusy
+* prompt the user for credentials when using irb login script. @woodbusy
+* bugfix for job.console_output. Credit: @drnic
+* add ssl support. Credit: @madisp
+
 v0.9.1  [01-APR-2013]
 ---------------------
-* Removed the dependency of ActiveSupport and Builder as they were not being
-* used.
+* Removed the dependency of ActiveSupport and Builder as they were not being used.
 
 v0.9.0  [10-MAR-2013]
 ---------------------

data/Gemfile

@@ -4,6 +4,7 @@ gem "nokogiri"
 gem "thor", ">= 0.16.0"
 gem "json", ">= 0"
 gem "terminal-table", ">= 1.4.0"
+gem "mixlib-shellout", "~> 1.1.0"
 
 group :development do
   gem "bundler", ">= 1.0"

data/README.md

@@ -147,6 +147,21 @@ initial_jobs.each do |job|
 end
 ```
 
+### Running Jenkins CLI
+To running [Jenkins CLI](https://wiki.jenkins-ci.org/display/JENKINS/Jenkins+CLI)
+
+```ruby
+@client = JenkinsApi::Client.new(:server_ip => '0.0.0.0',
+         :username => 'somename', :password => 'secret password')
+# The following call will return the version of Jenkins instance
+puts @client.exec_cli("version")
+```
+
+Before you run the CLI, please make sure the following requirements are fulfilled:
+* JRE/JDK 6 (or above) is installed, and 'java' is on the $PATH environment variable
+* The ```jenkins_api_client/java_deps/jenkins-cli.jar``` is required as the client to run the CLI. You can retrieve the available commands via accessing the URL: ```http://<server>:<port>/cli```
+* (Optional) required if you run the Groovy Script through CLI, make sure the *user* have the privilige to run script
+
 ### Using with command line
 Command line interface is supported only from version 0.2.0.
 See help using <tt>jenkinscli help</tt>

data/Rakefile

@@ -40,3 +40,5 @@ RSpec::Core::RakeTask.new(:test) do |spec|
   spec.pattern = FileList['spec/*/*.rb']
   spec.rspec_opts = ['--color', '--format documentation']
 end
+
+task :default => [:unit_tests]

data/jenkins_api_client.gemspec

@@ -0,0 +1,100 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "jenkins_api_client"
+  s.version = "0.9.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kannan Manickam"]
+  s.date = "2013-04-16"
+  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 = [
+    ".gitignore",
+    ".jenkins.yml",
+    ".travis.yml",
+    "CHANGELOG.md",
+    "Gemfile",
+    "LICENCE",
+    "README.md",
+    "Rakefile",
+    "bin/jenkinscli",
+    "config/login.yml.example",
+    "java_deps/jenkins-cli.jar",
+    "lib/jenkins_api_client.rb",
+    "lib/jenkins_api_client/build_queue.rb",
+    "lib/jenkins_api_client/cli/base.rb",
+    "lib/jenkins_api_client/cli/helper.rb",
+    "lib/jenkins_api_client/cli/job.rb",
+    "lib/jenkins_api_client/cli/node.rb",
+    "lib/jenkins_api_client/cli/system.rb",
+    "lib/jenkins_api_client/client.rb",
+    "lib/jenkins_api_client/exceptions.rb",
+    "lib/jenkins_api_client/job.rb",
+    "lib/jenkins_api_client/node.rb",
+    "lib/jenkins_api_client/system.rb",
+    "lib/jenkins_api_client/version.rb",
+    "lib/jenkins_api_client/view.rb",
+    "scripts/login_with_irb.rb",
+    "spec/func_tests/client_spec.rb",
+    "spec/func_tests/job_spec.rb",
+    "spec/func_tests/node_spec.rb",
+    "spec/func_tests/spec_helper.rb",
+    "spec/func_tests/system_spec.rb",
+    "spec/func_tests/view_spec.rb",
+    "spec/unit_tests/build_queue_spec.rb",
+    "spec/unit_tests/client_spec.rb",
+    "spec/unit_tests/fixtures/files/computer_sample.xml",
+    "spec/unit_tests/fixtures/files/job_sample.xml",
+    "spec/unit_tests/job_spec.rb",
+    "spec/unit_tests/node_spec.rb",
+    "spec/unit_tests/spec_helper.rb",
+    "spec/unit_tests/system_spec.rb",
+    "spec/unit_tests/view_spec.rb"
+  ]
+  s.homepage = "https://github.com/arangamani/jenkins_api_client"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.25"
+  s.summary = "Jenkins JSON API Client"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
+      s.add_runtime_dependency(%q<thor>, [">= 0.16.0"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_runtime_dependency(%q<terminal-table>, [">= 1.4.0"])
+      s.add_runtime_dependency(%q<mixlib-shellout>, ["~> 1.1.0"])
+      s.add_development_dependency(%q<bundler>, [">= 1.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 1.6.4"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+      s.add_dependency(%q<thor>, [">= 0.16.0"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<terminal-table>, [">= 1.4.0"])
+      s.add_dependency(%q<mixlib-shellout>, ["~> 1.1.0"])
+      s.add_dependency(%q<bundler>, [">= 1.0"])
+      s.add_dependency(%q<jeweler>, [">= 1.6.4"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+    s.add_dependency(%q<thor>, [">= 0.16.0"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<terminal-table>, [">= 1.4.0"])
+    s.add_dependency(%q<mixlib-shellout>, ["~> 1.1.0"])
+    s.add_dependency(%q<bundler>, [">= 1.0"])
+    s.add_dependency(%q<jeweler>, [">= 1.6.4"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+  end
+end
+

data/lib/jenkins_api_client/build_queue.rb

@@ -22,6 +22,9 @@
 
 module JenkinsApi
   class Client
+    # This classes communicates with the Build Queue API exposed by Jenkins at
+    # "/queue" that gives information about jobs/tasks in the queue and their
+    # details.
     class BuildQueue
 
       # Initializes a new BuildQueue object.

data/lib/jenkins_api_client/cli/base.rb

@@ -27,8 +27,10 @@ require "#{File.dirname(__FILE__)}/job.rb"
 require "#{File.dirname(__FILE__)}/system.rb"
 
 module JenkinsApi
+  # This is the base module for all command line interface for Jenkins API.
   module CLI
-
+    # This is the base class for the command line interface which adds other
+    # classes as subcommands to the CLI.
     class Base < Thor
 
       class_option :username, :aliases => "-u", :desc => "Name of Jenkins user"
@@ -46,10 +48,12 @@ module JenkinsApi
       map "-v" => :version
 
       desc "version", "Shows current version"
+      # CLI command that returns the version of Jenkins API Client
       def version
         puts JenkinsApi::Client::VERSION
       end
 
+      # Register the CLI::Node class as "node" subcommand to CLI
       register(
         CLI::Node,
         'node',
@@ -57,6 +61,7 @@ module JenkinsApi
         'Provides functions to access the node interface of Jenkins CI server'
       )
 
+      # Register the CLI::Job class as "job" subcommand to CLI
       register(
         CLI::Job,
         'job',
@@ -64,6 +69,7 @@ module JenkinsApi
         'Provides functions to access the job interface of Jenkins CI server'
       )
 
+      # Register the CLI::System class as "system" subcommand to CLI
       register(
         CLI::System,
         'system',

data/lib/jenkins_api_client/cli/helper.rb

@@ -24,7 +24,15 @@ require 'fileutils'
 
 module JenkinsApi
   module CLI
+    # This is the helper class that sets up the credentials from the command
+    # line parameters given and initializes the Jenkins API Client.
     class Helper
+      # Sets up the credentials and initializes the Jenkins API Client
+      #
+      # @param [Hash] options Options obtained from the command line
+      #
+      # @return [JenkinsApi::Client] A new Client object
+      #
       def self.setup(options)
         if options[:username] && options[:server_ip] && \
           (options[:password] || options[:password_base64])

data/lib/jenkins_api_client/cli/job.rb

@@ -25,7 +25,7 @@ require 'thor/group'
 
 module JenkinsApi
   module CLI
-
+    # This class provides various command line operations related to jobs.
     class Job < Thor
       include Thor::Actions
 
@@ -33,6 +33,8 @@ module JenkinsApi
       method_option :status, :aliases => "-t", :desc => "Status to filter"
       method_option :filter, :aliases => "-f",
         :desc => "Regular expression to filter jobs"
+      # CLI command to list all jobs in Jenkins or the ones matched by status
+      # or a regular expression
       def list
         @client = Helper.setup(parent_options)
         if options[:filter] && options[:status]
@@ -48,24 +50,37 @@ module JenkinsApi
       end
 
       desc "recreate JOB", "Recreate a specified job"
+      # CLI command to recreate a job on Jenkins
       def recreate(job)
         @client = Helper.setup(parent_options)
         @client.job.recreate(job)
       end
 
       desc "build JOB", "Build a job"
+      # CLI command to build a job given the name of the job
+      #
+      # @param [String] job Name of the job
+      #
       def build(job)
         @client = Helper.setup(parent_options)
         @client.job.build(job)
       end
 
       desc "status JOB", "Get the current build status of a job"
+      # CLI command to get the status of a job
+      #
+      # @param [String] job Name of the job
+      #
       def status(job)
         @client = Helper.setup(parent_options)
         puts @client.job.get_current_build_status(job)
       end
 
       desc "delete JOB", "Delete the job"
+      # CLI command to delete a job
+      #
+      # @param [String] job Name of the job
+      #
       def delete(job)
         @client = Helper.setup(parent_options)
         puts @client.job.delete(job)
@@ -74,6 +89,10 @@ module JenkinsApi
       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"
+      # CLI command to obtain console output for a job
+      #
+      # @param [String] job Name of the job
+      #
       def console(job)
         @client = Helper.setup(parent_options)
         # If debug is enabled, disable it. It shouldn't interfere
@@ -101,6 +120,10 @@ module JenkinsApi
 
       desc "restrict JOB", "Restricts a job to a specific node"
       method_option :node, :aliases => "-n", :desc => "Node to be restricted to"
+      # CLI command to restrict a job to a node
+      #
+      # @param [String] job Name of the job
+      #
       def restrict(job)
         @client = Helper.setup(parent_options)
         if options[:node]

data/lib/jenkins_api_client/cli/node.rb

@@ -26,6 +26,7 @@ require 'terminal-table'
 
 module JenkinsApi
   module CLI
+    # This class provides various command line operations for the Node class.
     class Node < Thor
       include Thor::Actions
       include Terminal
@@ -33,6 +34,8 @@ module JenkinsApi
       desc "list", "List all nodes"
       method_option :filter, :aliases => "-f",
         :desc => "Regular expression to filter jobs"
+      # CLI command that lists all nodes/slaves available in Jenkins or the
+      # ones matching the filter provided
       def list
         @client = Helper.setup(parent_options)
         if options[:filter]
@@ -43,6 +46,7 @@ module JenkinsApi
       end
 
       desc "print_general_attributes", "Prints general attributes of nodes"
+      # CLI command that prints the general attribtues of nodes
       def print_general_attributes
         @client = Helper.setup(parent_options)
         general_attributes = Client::Node::GENERAL_ATTRIBUTES
@@ -55,6 +59,10 @@ module JenkinsApi
       end
 
       desc "print_node_attributes NODE", "Prints attributes specific to a node"
+      # CLI command to print the attributes specific to a node
+      #
+      # @param [String] node Name of the node
+      #
       def print_node_attributes(node)
         @client = Helper.setup(parent_options)
         node_attributes = Client::Node::NODE_ATTRIBUTES
@@ -68,6 +76,10 @@ module JenkinsApi
       end
 
       desc "print_node_properties NODE", "Prints properties of a node"
+      # CLI command to print the properties of a specific node
+      #
+      # @param [String] node Name of the node
+      #
       def print_node_properties(node)
         @client = Helper.setup(parent_options)
         node_properties = Client::Node::NODE_PROPERTIES

data/lib/jenkins_api_client/cli/system.rb

@@ -25,22 +25,26 @@ require 'thor/group'
 
 module JenkinsApi
   module CLI
+    # This class provides various command line operations to System class.
     class System < Thor
       include Thor::Actions
 
       desc "quietdown", "Puts the Jenkins server in Quiet down mode"
+      # CLI command that puts Jenkins in Quiet Down mode
       def quietdown
         @client = Helper.setup(parent_options)
         @client.system.quiet_down
       end
 
       desc "cancel_quietdown", "Cancels the Quiet down mode of Jenkins server"
+      # CLI command that cancels Jenkins from Quiet Down mode
       def cancel_quietdown
         @client = Helper.setup(parent_options)
         @client.system.cancel_quiet_down
       end
 
       desc "reload", "Reload Jenkins server"
+      # CLI command to reload Jenkins configuration from disk
       def reload
         @client = Helper.setup(parent_options)
         @client.system.reload
@@ -49,6 +53,7 @@ module JenkinsApi
       desc "restart", "Restarts the Jenkins server"
       method_option :force, :type => :boolean, :aliases => "-s",
         :desc => "Force restart"
+      # CLI command to (force) restart Jenkins
       def restart
         @client = Helper.setup(parent_options)
         force = options[:force] ? true : false

data/lib/jenkins_api_client/client.rb

@@ -24,24 +24,34 @@ require 'rubygems'
 require 'json'
 require 'net/http'
 require 'nokogiri'
-#require 'active_support/core_ext'
-#require 'active_support/builder'
 require 'base64'
+require "mixlib/shellout"
 
+# The main module that contains the Client class and all subclasses that
+# communicate with the Jenkins's Remote Access API.
 module JenkinsApi
+  # This is the client class that acts as the bridge between the subclasses and
+  # Jnekins. This class contains methods that performs GET and POST requests
+  # for various operations.
   class Client
     attr_accessor :debug, :timeout
+    # Default port to be used to connect to Jenkins
     DEFAULT_SERVER_PORT = 8080
+    # Default timeout in seconds to be used while performing operations
     DEFAULT_TIMEOUT = 120
+    # Parameters that are permitted as options while initializing the client
     VALID_PARAMS = [
       "server_ip",
       "server_port",
+      "proxy_ip",
+      "proxy_port",
       "jenkins_path",
       "username",
       "password",
       "password_base64",
       "debug",
-      "timeout"
+      "timeout",
+      "ssl"
     ].freeze
 
     # Initialize a Client object with Jenkins CI server credentials
@@ -51,6 +61,12 @@ module JenkinsApi
     #  * 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
+    #  * the +:ssl+ param indicates if Jenkins is accessible over HTTPS
+    #    (defaults to false)
+    #
+    # @return [JenkinsApi::Client] a client object to Jenkins API
+    #
+    # @raise [ArgumentError] when required options are not provided.
     #
     def initialize(args)
       args.each do |key, value|
@@ -58,18 +74,25 @@ module JenkinsApi
           instance_variable_set("@#{key}", value)
         end
       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
-     @timeout = DEFAULT_TIMEOUT unless @timeout
-     @debug = false unless @debug
+      unless @server_ip
+        raise ArgumentError, "Server IP is required to connect to Jenkins"
+      end
+      unless @username && (@password || @password_base64)
+        raise ArgumentError, "Credentials are required to connect to Jenkins"
+      end
+      if @proxy_ip.nil? ^ @proxy_port.nil?
+        raise ArgumentError, "Proxy IP and port must both be specified or" +
+          " both left nil"
+      end
+      @server_port = DEFAULT_SERVER_PORT unless @server_port
+      @timeout = DEFAULT_TIMEOUT unless @timeout
+      @ssl ||= false
+      @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 :)
-     @password = Base64.decode64(@password_base64).chomp if @password_base64
+      # 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
 
     # This method toggles the debug parameter in run time
@@ -80,56 +103,91 @@ module JenkinsApi
 
     # Creates an instance to the Job class by passing a reference to self
     #
+    # @return [JenkinsApi::Client::Job] An object to Job subclass
+    #
     def job
       JenkinsApi::Client::Job.new(self)
     end
 
     # Creates an instance to the System class by passing a reference to self
     #
+    # @return [JenkinsApi::Client::System] An object to System subclass
+    #
     def system
       JenkinsApi::Client::System.new(self)
     end
 
     # Creates an instance to the Node class by passing a reference to self
     #
+    # @return [JenkinsApi::Client::Node] An object to Node subclass
+    #
     def node
       JenkinsApi::Client::Node.new(self)
     end
 
     # Creates an instance to the View class by passing a reference to self
     #
+    # @return [JenkinsApi::Client::View] An object to View subclass
+    #
     def view
       JenkinsApi::Client::View.new(self)
     end
 
     # Creates an instance to the BuildQueue by passing a reference to self
     #
+    # @return [JenkinsApi::Client::BuildQueue] An object to BuildQueue subclass
+    #
     def queue
       JenkinsApi::Client::BuildQueue.new(self)
     end
 
     # Returns a string representing the class name
     #
+    # @return [String] string representation of class name
+    #
     def to_s
       "#<JenkinsApi::Client>"
     end
 
+    # Connects to the Jenkins server, sends the specified request and returns
+    # the response.
+    #
+    # @param [Net::HTTPRequest] request The request object to send
+    #
+    # @return [Net::HTTPResponse] Response from Jenkins
+    def make_http_request( request )
+      Net::HTTP.start(
+        @server_ip, @server_port, @proxy_ip, @proxy_port, :use_ssl => @ssl
+      ) do |http|
+        return http.request(request)
+      end
+    end
+    protected :make_http_request
+
     # Obtains the root of Jenkins server. This function is used to see if
     # Jenkins is running
+    #
+    # @return [Net::HTTP::Response] Response from Jenkins for "/"
+    #
     def get_root
-      http = Net::HTTP.start(@server_ip, @server_port)
       request = Net::HTTP::Get.new("/")
       request.basic_auth @username, @password
-      http.request(request)
+      make_http_request(request)
     end
 
     # Sends a GET request to the Jenkins CI server with the specified URL
     #
-    # @param [String] url_prefix
+    # @param [String] url_prefix The prefix to use in the URL
+    # @param [String] tree A specific JSON tree to optimize the API call
+    # @param [String] url_suffix The suffix to be used in the URL
+    # @param [Boolean] raw_response Return complete Response object instead of
+    #   JSON body of response
+    #
+    # @return [String, JSON] JSON response from Jenkins
     #
-    def api_get_request(url_prefix, tree = nil, url_suffix ="/api/json")
+    def api_get_request(url_prefix, tree = nil, url_suffix ="/api/json",
+                        raw_response = false)
       url_prefix = "#{@jenkins_path}#{url_prefix}"
-      http = Net::HTTP.start(@server_ip, @server_port)
       to_get = ""
       if tree
         to_get = "#{url_prefix}#{url_suffix}?#{tree}"
@@ -140,55 +198,62 @@ module JenkinsApi
       request = Net::HTTP::Get.new(to_get)
       puts "[INFO] GET #{to_get}" if @debug
       request.basic_auth @username, @password
-      response = http.request(request)
-      handle_exception(response, "body", url_suffix =~ /json/)
+      response = make_http_request(request)
+      if raw_response
+        response
+      else
+        handle_exception(response, "body", url_suffix =~ /json/)
+      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
+    # @param [String] url_prefix The prefix to be used in the URL
+    # @param [Hash] form_data Form data to send with POST request
+    #
+    # @return [String] Response code form Jenkins Response
     #
     def api_post_request(url_prefix, form_data = nil)
       url_prefix = URI.escape("#{@jenkins_path}#{url_prefix}")
-      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)
+      response = make_http_request(request)
       handle_exception(response)
     end
 
     # Obtains the configuration of a component from the Jenkins CI server
     #
-    # @param [String] url_prefix
+    # @param [String] url_prefix The prefix to be used in the URL
+    #
+    # @return [String] XML configuration obtained from Jenkins
     #
     def get_config(url_prefix)
       url_prefix = URI.escape("#{@jenkins_path}#{url_prefix}")
-      http = Net::HTTP.start(@server_ip, @server_port)
       request = Net::HTTP::Get.new("#{url_prefix}/config.xml")
       puts "[INFO] GET #{url_prefix}/config.xml" if @debug
       request.basic_auth @username, @password
-      response = http.request(request)
+      response = make_http_request(request)
       handle_exception(response, "body")
     end
 
     # Posts the given xml configuration to the url given
     #
-    # @param [String] url_prefix
-    # @param [String] xml
+    # @param [String] url_prefix The prefix to be used in the URL
+    # @param [String] xml The XML configuration to be sent to Jenkins
+    #
+    # @return [String] Response code returned from Jenkins
     #
     def post_config(url_prefix, xml)
       url_prefix = URI.escape("#{@jenkins_path}#{url_prefix}")
-      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.body = xml
       request.content_type = 'application/xml'
-      response = http.request(request)
+      response = make_http_request(request)
       handle_exception(response)
     end
 
@@ -219,8 +284,61 @@ module JenkinsApi
       response["Date"]
     end
 
+    # Execute the Jenkins CLI
+    #
+    # @param command [String] command name
+    # @param args [Array] the arguments for the command
+    #
+    # @return [String] command output from the CLI
+    #
+    # @raise [Exceptions::CLIException] if there are issues in running the
+    #   commands using CLI
+    #
+    def exec_cli(command, args = [])
+      base_dir = File.dirname(__FILE__)
+      server_url = "http://#{@server_ip}:#{@server_port}/#{@jenkins_path}"
+      cmd = "java -jar #{base_dir}/../../java_deps/jenkins-cli.jar" +
+        " -s #{server_url} #{command}" +
+        " --username #{@username} --password #{@password} " +
+        args.join(' ')
+      java_cmd = Mixlib::ShellOut.new(cmd)
+
+      # Run the command
+      java_cmd.run_command
+      if java_cmd.stderr.empty?
+        java_cmd.stdout.chomp
+      else
+        # The stderr has a stack trace of the Java program. We'll already have
+        # a stack trace for Ruby. So just display a descriptive message for the
+        # error thrown by the CLI.
+        raise Exceptions::CLIException.new(java_cmd.stderr.split("\n").first)
+      end
+    end
+
     private
 
+    # Private method that handles the exception and raises with proper error
+    # message with the type of exception and returns the required values if no
+    # exceptions are raised.
+    #
+    # @param [Net::HTTP::Response] response Response from Jenkins
+    # @param [String] to_send What should be returned as a response. Allowed
+    # values: "code" and "body".
+    # @param [Boolean] send_json Boolean value used to determine whether to
+    # load the JSON or send the response as is.
+    #
+    # @return [String, JSON] Response returned whether loaded JSON or raw
+    # string
+    #
+    # @raise [Exceptions::UnauthorizedException] When invalid credentials are
+    # provided to connect to Jenkins
+    # @raise [Exceptions::NotFoundException] When the requested page on Jenkins
+    # is found
+    # @raise [Exceptions::InternelServerErrorException] When Jenkins returns a
+    # 500 Internel Server Error
+    # @raise [Exceptions::ApiException] Any other exception returned from
+    # Jenkins that are not categorized in the API Client.
+    #
     def handle_exception(response, to_send = "code", send_json = false)
       msg = "HTTP Code: #{response.code}, Response Body: #{response.body}"
       case response.code.to_i