jenkins_api_client 0.2.1 → 0.3.0

data/.travis.yml

@@ -0,0 +1,23 @@
+language: ruby
+rvm:
+  - 1.9.3
+before_install:
+  - wget -q -O - http://pkg.jenkins-ci.org/debian/jenkins-ci.org.key | sudo apt-key add -
+  - sudo sh -c 'echo deb http://pkg.jenkins-ci.org/debian binary/ > /etc/apt/sources.list.d/jenkins.list'
+  - sudo apt-get update -qq
+  - sudo apt-get install -qq jenkins
+  - echo `service jenkins status`
+  - echo `curl 10.0.2.15:8080`
+  - echo `curl 10.0.2.15`
+  - echo `curl localhost:8080`
+  - echo `ifconfig`
+  - echo `hostname`
+  - echo `netstat -an`
+script: bundle exec rspec
+notifications:
+  email: false
+  irc:
+    on_success: change
+    on_failure: always
+    channels:
+      - "irc.freenode.org##arangamani"

data/CHANGELOG.rdoc

@@ -1,6 +1,12 @@
 = CHANGELOG
 
-===== v0.2.0  [02-NOV-2012]
+===== v0.3.0  [11-NOV-2012]
+* Added System class to support quietdown and restart functionality.
+* Added Node class to query the node interface of Jenkins server.
+* Added Command line interface for System and Node class.
+* Introduced terminal tables for displaying attributes in command line.
+
+===== v0.2.1  [02-NOV-2012]
 * Added command line interface for basic operations
 
 ===== v0.1.1  [30-OCT-2012]

data/Gemfile

@@ -1,13 +1,15 @@
 source "http://rubygems.org"
 
-gem "nokogiri", "~> 1.5.5"
+gem "nokogiri"
 gem "activesupport", "~> 3.2.8"
 gem "thor", "~> 0.16.0"
 gem "json", ">= 0"
+gem "terminal-table", ">= 1.4.0"
 
 group :development do
-  gem "bundler", "~> 1.2.1"
-  gem "jeweler", "~> 1.6.4"
+  gem "bundler", ">= 1.0"
+  gem "jeweler", ">= 1.6.4"
   gem "builder", "~> 3.1.3"
   gem "simplecov"
+  gem "rspec"
 end

data/{README.rdoc → README.md}

@@ -1,8 +1,12 @@
-= Jenkins API Client
+Jenkins API Client
+==================
+
+Copyright © 2012, Kannan Manickam.
 
 Client libraries for communicating with a Jenkins CI server and programatically managing jobs.
 
-== OVERVIEW:
+OVERVIEW:
+---------
 This project is a simple API client for interacting with Jenkins Continuous Integration server.
 Jenkins provides three kinds of remote access API. 1. XML API, 2. JSON API, and 3. Python API.
 This project aims at consuming the JSON API and provides some useful functions for controlling
@@ -10,23 +14,32 @@ jobs on the Jenkins programatically. Even though Jenkins provides an awesome UI
 jobs, it would be nice and helpful to have a programmable interface so we can dynamically and
 automatically manage jobs and other artifacts.
 
-== DETAILS:
-This projects currently only provides functionality for the <tt>jobs</tt> interface. This is
-still a work-in-progress project. I mainly use the functionality of this project for my autmation
+DETAILS:
+--------
+This projects currently only provides functionality for the <tt>jobs, node, and system</tt> interfaces. 
+This is still a work-in-progress project. I mainly use the functionality of this project for my autmation
 work and the functionality mainly focussed on my usage and I believe others might find it useful
 too. I would love to add more features to it and I will continue working on improving existing
 features and add more interfaces such as nodes, views, build queue, etc,.
 
-== USAGE:
+CODE STATUS:
+------------
+
+* Gemnasium: [![Dependency Status](https://gemnasium.com/arangamani/jenkins_api_client.png)](https://gemnasium.com/arangamani/jenkins_api_client)
+
+* Code Climate: [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/arangamani/jenkins_api_client)
+
+USAGE:
+------
 
-=== Installation
+### Installation
 
 Install jenkins_api_client by <tt>sudo gem install jenkins_api_client</tt>
 Include this gem in your code as a require statement.
 
-  require 'jenkins_api_client'
+    require 'jenkins_api_client'
 
-=== Using with IRB
+### Using with IRB
 
 If you want to just play with it and not actually want to write a script, you can just use the
 irb launcher script which is available in <tt>scripts/login_with_irb.rb</tt>. But make sure that
@@ -35,62 +48,68 @@ you have your credentials file in <tt>~/.jenkins_api_client/login.yml</tt>. If y
 location and would like to use a different location, just modify that script to point to the
 location where the credentials file exists.
 
-  ruby scripts/login_with_irb.rb
+    ruby scripts/login_with_irb.rb
 
 You will see the that it entered IRB session and you can play with the API client with the
 <tt>@client</tt> object that it has returned.
 
-=== Authentication
+### Authentication
 
 This project supports two types of password-based authentication. You can just you the plain
 password by using <tt>password</tt> parameter. If you don't prefer leaving plain passwords in the
 credentials file, you can encode your password in base64 format and use <tt>password_base64</tt>
 parameter to specify the password either in the arguments or in the credentials file.
 
-=== Basic Usage
+### Basic Usage
 
 As discussed earlier, you can either specify all the credentials and server information as
 parameters to the Client or have a credentials file and just parse the yaml file and pass it in.
 The following call just passes the information as parameters
 
-  @client = JenkinsApi::Client.new(:server_ip => '0.0.0.0', 
-           :username => 'somename', :password => 'secret password')
-  # The following call will return all jobs matching 'Testjob'
-  puts @client.job.list("^Testjob")
+```ruby
+@client = JenkinsApi::Client.new(:server_ip => '0.0.0.0', 
+         :username => 'somename', :password => 'secret password')
+# The following call will return all jobs matching 'Testjob'
+puts @client.job.list("^Testjob")
+```
 
 The following example passes the YAML file contents. An example yaml file is located in
 <tt>config/login.yml.example</tt>.
 
-  @client = JenkinsApi::Client.new(YAML.Load_file(File.expand_path('~/.jenkins_api_client/login.yml', __FILE__)))
-  # The following call lists all jobs
-  puts @client.job.list_all
+```ruby
+@client = JenkinsApi::Client.new(YAML.Load_file(File.expand_path('~/.jenkins_api_client/login.yml', __FILE__)))
+# The following call lists all jobs
+puts @client.job.list_all
+```
 
-=== Chaining and Building Jobs
+### 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.
 
-  require 'jenkins_api_client'
+```ruby
+require 'jenkins_api_client'
 
-  # We want to filter all jobs that start with 'test_job'
-  # Just write a regex to match all the jobs that start with 'test_job'
-  jobs_to_filter = "^test_job.*"
+# We want to filter all jobs that start with 'test_job'
+# Just write a regex to match all the jobs that start with 'test_job'
+jobs_to_filter = "^test_job.*"
 
-  # Create an instance to jenkins_api_client
-  @client = JenkinsApi::Client.new(YAML.load_file(File.expand_path('~/.jenkins_api_client/login.yml', __FILE__)))
+# Create an instance to jenkins_api_client
+@client = JenkinsApi::Client.new(YAML.load_file(File.expand_path('~/.jenkins_api_client/login.yml', __FILE__)))
 
-  # Get a filtered list of jobs from the server
-  jobs = @client.job.list(jobs_to_filter)
+# Get a filtered list of jobs from the server
+jobs = @client.job.list(jobs_to_filter)
 
-  # Chain all the jobs with 'success' as the threshold
-  # The chain method will return the jobs that is in the head of the sequence
-  # This method will also remove any existing chaining
-  initial_jobs = @client.job.chain(jobs, 'success', ["all"])
+# Chain all the jobs with 'success' as the threshold
+# The chain method will return the jobs that is in the head of the sequence
+# This method will also remove any existing chaining
+initial_jobs = @client.job.chain(jobs, 'success', ["all"])
 
-  # Now that we have the initial job(s) we can build them
-  # The build function returns a code from the API which should be 302 if the build was successful
-  code = @client.job.build(initial_jobs[0])
-  raise "Could not build the job specified" unless code == 302
+# Now that we have the initial job(s) we can build them
+# The build function returns a code from the API which should be 302 if the build was successful
+code = @client.job.build(initial_jobs[0])
+raise "Could not build the job specified" unless code == 302
+```
 
 In the above example, you might have noticed that the chain method returns an array instead of a
 single job. There is a reason behind it. In simple chain, such as the one in the example above, all
@@ -115,14 +134,16 @@ fails, and <tt>unstable</tt> will move to the job even if the build is unstable.
 The following call to the <tt>chain</tt> method will consider only failed and unstable jobs, chain then
 with 'failure' as the threshold, and also chain three jobs in parallel.
 
-  initial_jobs = @client.job.chain(jobs, 'failure', ["failure", "unstable"], 3)
-  # We will receive three jobs as a result and we can build them all
-  initial_jobs.each { |job|
-    code = @client.job.build(job)
-    raise "Unable to build job: #{job}" unless code == 302
-  }
+```ruby
+initial_jobs = @client.job.chain(jobs, 'failure', ["failure", "unstable"], 3)
+# We will receive three jobs as a result and we can build them all
+initial_jobs.each { |job|
+  code = @client.job.build(job)
+  raise "Unable to build job: #{job}" unless code == 302
+}
+```
 
-=== Using with command line
+### Using with command line
 Command line interface is supported only from version 0.2.0.
 See help using <tt>jenkinscli help</tt>
 
@@ -131,12 +152,13 @@ There are three ways for authentication using command line interface
 2. Passing the credentials file as the command line parameter
 3. Having the credentials file in the default location <tt>HOME/.jenkins_api_client/login.yml</tt>
 
-=== Debug
+### Debug
 
 The call to client initialization accepts a debug parameter. If it is set to <tt>true</tt> it will print
 some debug information to the console. By default it is set to false.
 
-== CONTRIBUTING:
+CONTRIBUTING:
+-------------
 
 If you would like to contribute to this project, just do the following:
 
@@ -147,7 +169,8 @@ If you would like to contribute to this project, just do the following:
 5. Once changes are done or no changes are required, pull request will be merged.
 6. The next release will have your changes in it.
 
-== FEATURE REQUEST:
+FEATURE REQUEST:
+----------------
 
 If you use this gem for your project and you think it would be nice to have a particular feature
 that is presently not implemented, I would love to hear that and consider working on it.

data/lib/jenkins_api_client/cli/base.rb

@@ -23,27 +23,51 @@
 require 'thor'
 require 'thor/group'
 require "#{File.dirname(__FILE__)}/../client.rb"
+require "#{File.dirname(__FILE__)}/node.rb"
 require "#{File.dirname(__FILE__)}/job.rb"
+require "#{File.dirname(__FILE__)}/system.rb"
 
 module JenkinsApi
   module CLI
 
     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"
+
+
       map "-v" => :version
 
       desc "version", "Shows current version"
       def version
         puts JenkinsApi::Client::VERSION
       end
-    end
 
-  end
-end
+      register(
+        CLI::Node,
+        'node',
+        'node [subcommand]',
+        'Provides functions to access the node interface of Jenkins CI server'
+      )
+
+      register(
+        CLI::Job,
+        'job',
+        'job [subcommand]',
+        'Provides functions to access the job interface of Jenkins CI server'
+      )
 
-JenkinsApi::CLI::Base.register(
-  JenkinsApi::CLI::Job,
-  'job',
-  'job [subcommand]',
-  'Provides functions to access the job interface of Jenkins CI server'
-)
+      register(
+        CLI::System,
+        'system',
+        'system [subcommand]',
+        'Provides functions to access system functions of the Jenkins CI server'
+      )
 
+    end
+  end
+end

data/lib/jenkins_api_client/cli/helper.rb

@@ -0,0 +1,43 @@
+#
+# Copyright (c) 2012 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.
+#
+
+require 'fileutils'
+
+module JenkinsApi
+  module CLI
+    class Helper
+      def self.setup(options)
+        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__))
+        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__))
+        else
+          puts "Credentials are not set. Please pass them as parameters or set them in the default credentials file"
+          exit 1
+        end
+        JenkinsApi::Client.new(creds)
+      end
+    end
+  end
+end

data/lib/jenkins_api_client/cli/job.rb

@@ -20,48 +20,19 @@
 # THE SOFTWARE.
 #
 
-require File.expand_path('../base', __FILE__)
-require 'fileutils'
+require 'thor'
+require 'thor/group'
 
 module JenkinsApi
   module CLI
 
     class Job < Thor
       include Thor::Actions
-      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"
-
-      no_tasks {
-        def setup
-          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__))
-          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__))
-          else
-            say "Credentials are not set. Please pass them as parameters or set them in the default credentials file", :red
-          end
-           JenkinsApi::Client.new(creds)
-        end
-      }
-
-      desc "test", "Test job"
-      def test
-        #invoke :creds
-        setup
-        puts "test: #{options[:username]}"
-        #puts self.options[:username] if self.options[:username]
-      end
 
       desc "list", "List jobs"
       method_option :filter, :aliases => "-f", :desc => "Regular expression to filter jobs"
       def list
-        @client = setup
+        @client = Helper.setup(parent_options)
         if options[:filter]
           puts @client.job.list(options[:filter])
         else
@@ -71,32 +42,32 @@ module JenkinsApi
 
       desc "build JOB", "Build a job"
       def build(job)
-        @client = setup
+        @client = Helper.setup(parent_options)
         @client.job.build(job)
       end
 
       desc "status JOB", "Get the current build status of a job"
       def status(job)
-        @client = setup
+        @client = Helper.setup(parent_options)
         puts @client.job.get_current_build_status(job)
       end
 
       desc "listrunning", "List running jobs"
       def listrunning
-        @client =  setup
+        @client =  Helper.setup(parent_options)
         puts @client.job.list_running
       end
 
       desc "delete JOB", "Delete the job"
       def delete(job)
-        @client = setup
+        @client = Helper.setup(parent_options)
         puts @client.job.delete(job)
       end
 
       desc "restrict JOB", "Restricts a job to a specific node"
       method_option :node, :aliases => "-n", :desc => "Node to be restricted to"
       def restrict(job)
-        @client = setup
+        @client = Helper.setup(parent_options)
         if options[:node]
           @client.job.restrict_to_node(job, options[:node])
         else