jenkins_api_client 0.6.2 → 0.7.0

data/.gitignore

@@ -20,6 +20,9 @@ Gemfile.lock
 # MacOS:
 .DS_Store
 
+# Rubymine
+.idea
+
 # vim, emacs, textmate
 *~
 \#*

data/.jenkins.yml

@@ -0,0 +1,9 @@
+name: jenkins_api_client_func_tests
+git: git://github.com/arangamani/jenkins_api_client.git
+ref: master
+script:
+ - bundle install
+ - rake unit_tests
+ - rake func_tests
+ notification_email: kannan@rightscale.com
+ notification_email_for_every_unstable: true

data/.travis.yml

@@ -1,24 +1,20 @@
 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 `sudo service jenkins status`
-  - cat /var/log/jenkins/jenkins.log
-  - 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
+  - 1.9.2
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode
+  - ruby-head
+  - jruby-head
+  - 1.8.7
+  - ree
+script: bundle exec rake unit_tests
 notifications:
   email: false
   irc:
     on_success: change
     on_failure: always
     channels:
-      - "irc.freenode.org##arangamani"
+      - "irc.freenode.org##jenins-api-client"

data/CHANGELOG.md

@@ -1,6 +1,21 @@
 CHANGELOG
 =========
 
+upcoming
+--------
+
+v0.7.0  [27-JAN-2012]
+---------------------
+* Fixed a bug where the ignorecase was never used in view list
+* Raise an error if the view doesnt exists while listing jobs
+* Added capability to change the mode of a node
+* Added support for giving node to restrict the job during creation
+* Added support for notification_email option when setting up a job
+* Added support for CVS provider in SCM
+* Added `create_dump_slave` and `delete` methods in Node API
+* Added BuildQueue class which is accessible by `@client.queue` method
+* Improvements in all over the code for performance and error handling
+
 v0.6.2  [13-JAN-2013]
 ---------------------
 * Fixed a bug where running job previously aborted was not recognized by the color

data/Gemfile

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

data/README.md

@@ -1,5 +1,8 @@
 Jenkins API Client
 ==================
+[![Build Status](https://travis-ci.org/arangamani/jenkins_api_client.png?branch=master)](https://travis-ci.org/arangamani/jenkins_api_client)
+[![Dependency Status](https://gemnasium.com/arangamani/jenkins_api_client.png)](https://gemnasium.com/arangamani/jenkins_api_client)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/arangamani/jenkins_api_client)
 
 Copyright © 2012, Kannan Manickam [![endorse](http://api.coderwall.com/arangamani/endorsecount.png)](http://coderwall.com/arangamani)
 
@@ -7,6 +10,8 @@ Client libraries for communicating with a Jenkins CI server and programatically
 
 IRC Channel: ##jenkins-api-client
 
+Mailing list: jenkins.api.client@librelist.com
+
 OVERVIEW:
 ---------
 This project is a simple API client for interacting with Jenkins Continuous Integration server.
@@ -18,19 +23,12 @@ automatically manage jobs and other artifacts.
 
 DETAILS:
 --------
-This projects currently only provides functionality for the <tt>jobs, node, and system</tt> interfaces. 
+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,.
 
-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:
 ------
 
@@ -69,7 +67,7 @@ parameters to the Client or have a credentials file and just parse the yaml file
 The following call just passes the information as parameters
 
 ```ruby
-@client = JenkinsApi::Client.new(:server_ip => '0.0.0.0', 
+@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")

data/Rakefile

@@ -1,24 +1,37 @@
-require File.expand_path('../lib/jenkins_api_client', __FILE__)
-require File.expand_path('../lib/jenkins_api_client/version', __FILE__)
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jenkins_api_client/version'
 require 'rake'
 require 'jeweler'
 
 Jeweler::Tasks.new do |gemspec|
-  gemspec.name         = 'jenkins_api_client'
-  gemspec.version      = JenkinsApi::Client::VERSION
-  gemspec.platform     = Gem::Platform::RUBY
-  gemspec.date         = Time.now.utc.strftime("%Y-%m-%d")
-  gemspec.require_path = 'lib'
-  gemspec.executables  = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
-  gemspec.files        = `git ls-files`.split("\n")
+  gemspec.name             = 'jenkins_api_client'
+  gemspec.version          = JenkinsApi::Client::VERSION
+  gemspec.platform         = Gem::Platform::RUBY
+  gemspec.date             = Time.now.utc.strftime("%Y-%m-%d")
+  gemspec.require_paths    = ["lib"]
+  gemspec.executables      = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
+  gemspec.files            = `git ls-files`.split("\n")
   gemspec.extra_rdoc_files = ['CHANGELOG.rdoc', 'LICENSE', 'README.rdoc']
-  gemspec.authors      = [ 'Kannan Manickam' ]
-  gemspec.email        = [ 'arangamani.kannan@gmail.com' ]
-  gemspec.homepage     = 'https://github.com/arangamani/jenkins_api_client'
-  gemspec.summary      = 'Jenkins JSON API Client'
-  gemspec.description  = %{
+  gemspec.authors          = [ 'Kannan Manickam' ]
+  gemspec.email            = [ 'arangamani.kannan@gmail.com' ]
+  gemspec.homepage         = 'https://github.com/arangamani/jenkins_api_client'
+  gemspec.summary          = 'Jenkins JSON API Client'
+  gemspec.description      = %{
 This is a simple and easy-to-use Jenkins Api client with features focused on
 automating Job configuration programaticaly and so forth}
   gemspec.test_files = `git ls-files -- {spec}/*`.split("\n")
   gemspec.rubygems_version = '1.8.17'
 end
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:unit_tests) do |spec|
+  spec.pattern = FileList['spec/unit_tests/*_spec.rb']
+  spec.rspec_opts = ['--color', '--format documentation']
+end
+
+RSpec::Core::RakeTask.new(:func_tests) do |spec|
+  spec.pattern = FileList['spec/func_tests/*_spec.rb']
+  spec.rspec_opts = ['--color', '--format documentation']
+end

data/lib/jenkins_api_client.rb

@@ -1,6 +1,36 @@
-Dir[File.dirname(__FILE__) + '/jenkins_api_client/*.rb'].each do |file|
-  require file
-end
-Dir[File.dirname(__FILE__) + '/jenkins_api_client/cli/*.rb'].each do |file|
-  require file
-end
+#
+# 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 'jenkins_api_client/version'
+require 'jenkins_api_client/exceptions'
+require 'jenkins_api_client/client'
+require 'jenkins_api_client/job'
+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/cli/helper'
+require 'jenkins_api_client/cli/base'
+require 'jenkins_api_client/cli/job'
+require 'jenkins_api_client/cli/node'
+require 'jenkins_api_client/cli/system'

data/lib/jenkins_api_client/build_queue.rb

@@ -0,0 +1,213 @@
+#
+# Copyright (c) 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
+    class BuildQueue
+
+      # Initializes a new BuildQueue object.
+      #
+      # @param [Object] client a reference to Client
+      #
+      def initialize(client)
+        @client = client
+      end
+
+      # Returns a string representation of BuildQueue class.
+      #
+      def to_s
+        "#<JenkinsApi::Client::BuildQueue>"
+      end
+
+      # Gives the number of jobs currently in the build queue
+      #
+      def size
+        response_json = @client.api_get_request("/queue")
+        response_json["items"].size
+      end
+
+      # Lists all tasks currently in the build queue
+      #
+      def list
+        response_json = @client.api_get_request("/queue")
+        tasks = []
+        response_json["items"].each do |item|
+          tasks << item["task"]["name"]
+        end
+        tasks
+      end
+
+      # Gets the time number of seconds the task is in the queue
+      #
+      # @param [String] task_name Name of the task/job
+      #
+      # @return [FixNum] age in seconds
+      #
+      def get_age(task_name)
+        age = nil
+        details = get_details(task_name)
+        unless details.empty?
+          age = Time.now - Time.at(details["inQueueSince"].to_i/1000)
+        end
+        age
+      end
+
+      # Obtains the detail Hash from the API response
+      #
+      # @param [String] task_name Name of the task/job
+      #
+      # @return [Hash] Queue details of the specified task/job
+      #
+      def get_details(task_name)
+        response_json = @client.api_get_request("/queue")
+        details = {}
+        response_json["items"].each do |item|
+          details = item if item["task"]["name"]
+        end
+        details
+      end
+
+      # Obtains the causes from the build queue for the specified task
+      #
+      # @param [String] task_name
+      #
+      # @return [Array] causes for the task to be in queue
+      #
+      def get_causes(task_name)
+        causes = nil
+        details = get_details(task_name)
+        unless details.empty?
+          causes = details["actions"]["causes"]
+        end
+        causes
+      end
+
+      # Obtains the reason why the task is in queue
+      #
+      # @param [String] task_name name of the task
+      #
+      # @return [String] reason for being in queue, nil if no task found
+      #
+      def get_reason(task_name)
+        reason = nil
+        details = get_details(task_name)
+        unless details.empty?
+          reason = details["why"]
+        end
+        reason
+      end
+
+      # Obtains the ETA given by Jenkins if any
+      #
+      # @param[String] task_name name of the task
+      #
+      # @return [String] ETA for the task, nil if no task found or ETA is
+      #                  not available
+      #
+      def get_eta(task_name)
+        eta = nil
+        details = get_details(task_name)
+        unless details.empty?
+          matched = details["why"].match(/.*\(ETA:(.*)\)/)
+          eta = matched[1].strip unless matched.nil?
+        end
+        eta
+      end
+
+      # Obtains the ID of the task from the queue
+      #
+      # @param [String] task_name name of the task
+      #
+      # @return [String] ID of the task, nil of no task is found
+      #
+      def get_id(task_name)
+        id = nil
+        details = get_details(task_name)
+        unless details.empty?
+          id = details["id"]
+        end
+        id
+      end
+
+      # Obtains the params from the build queue
+      #
+      # @param [String] task_name name of the task
+      #
+      # @return [String] params, nil if the no task is found
+      #
+      def get_params(task_name)
+        params = nil
+        details = get_details(task_name)
+        unless details.empty?
+          params = details["params"]
+        end
+        params
+      end
+
+      # Obtains whether the task is buildable
+      #
+      # @param [String] task_name name of the task
+      #
+      # @return [TrueClass|FalseClass] buildable or not
+      #
+      def is_buildable?(task_name)
+        buildable = nil
+        details = get_details(task_name)
+        unless details.empty?
+          buildable = details["buildable"] == "true" ? true : false
+        end
+        buildable
+      end
+
+      # Obtains whether the task is blocked
+      #
+      # @param [String] task_name name of the task
+      #
+      # @return [TrueClass|FalseClass] blocked or not
+      #
+      def is_blocked?(task_name)
+        blocked = nil
+        details = get_details(task_name)
+        unless details.empty?
+          blocked = details["blocked"] == "true" ? true : false
+        end
+        blocked
+      end
+
+      # Obtains whether the task is stuck
+      #
+      # @param [String] task_name name of the task
+      #
+      # @return [TrueClass|FalseClass] stuck or not
+      #
+      def is_stuck?(task_name)
+        stuck = nil
+        details = get_details(task_name)
+        unless details.empty?
+          stuck = details["stuck"] == "true" ? true : false
+        end
+        stuck
+      end
+
+    end
+  end
+end