jenkins_api_client 0.7.3 → 0.8.0

data/CHANGELOG.md

@@ -4,6 +4,18 @@ CHANGELOG
 upcoming
 --------
 
+v0.8.0  [14-FEB-2013]
+---------------------
+* Added capability to send timer trigger while creating a job
+* Added rename feature for jobs
+* Added support for sending skype notification in job creation and on existing jobs
+* Added support for sending Jenkins root URL configuration. Credit: @kevinhcross
+* Added `delete_all!` methods for Job, View, and Node.
+* `get_eta` in BuildQueue will return "N/A" if the ETA is not given by Jenkins
+* Creating view accepts params Hash and more configuration through the API
+* Spaces are allowed in Job, Node, and View names. Credit: @kevinhcross
+* Support has been added to build a job with parameters. Credit: @tjhanley
+
 v0.7.3  [05-FEB-2013]
 ---------------------
 * Fixed #27 with a bug in create_view including extra character in the end of the name
@@ -86,7 +98,7 @@ v0.1.0  [26-OCT-2012]
 v0.0.2  [16-OCT-2012]
 ---------------------
 * Added documentation
-* Added some more smal features to Job class
+* Added some more small features to Job class
 
 v0.0.1  [15-OCT-2012]
 ---------------------

data/README.md

@@ -1,8 +1,9 @@
 Jenkins API Client
 ==================
+[![Gem Version](https://badge.fury.io/rb/jenkins_api_client.png)](http://rubygems.org/gems/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)
+[![Code Climate](https://codeclimate.com/github/arangamani/jenkins_api_client.png)](https://codeclimate.com/github/arangamani/jenkins_api_client)
 
 Copyright © 2012-2013, Kannan Manickam [![endorse](http://api.coderwall.com/arangamani/endorsecount.png)](http://coderwall.com/arangamani)
 
@@ -77,7 +78,8 @@ The following example passes the YAML file contents. An example yaml file is loc
 <tt>config/login.yml.example</tt>.
 
 ```ruby
-@client = JenkinsApi::Client.new(YAML.Load_file(File.expand_path('~/.jenkins_api_client/login.yml', __FILE__)))
+@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
 ```
@@ -95,7 +97,8 @@ require 'jenkins_api_client'
 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__)))
+@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)
@@ -106,7 +109,8 @@ jobs = @client.job.list(jobs_to_filter)
 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
+# 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
 ```
@@ -137,10 +141,10 @@ with 'failure' as the threshold, and also chain three jobs in parallel.
 ```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|
+initial_jobs.each do |job|
   code = @client.job.build(job)
   raise "Unable to build job: #{job}" unless code == 302
-}
+end
 ```
 
 ### Using with command line
@@ -169,6 +173,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.
 
+Please take a look at the issues page if you want to get started.
+
 FEATURE REQUEST:
 ----------------
 

data/config/login.yml.example

@@ -12,6 +12,10 @@
 
 :server_port: 8080
 
+# If there is a web server routing your Jenkins requests you might need this
+
+:jenkins_path: ""
+
 # The username and password to authenticate to the server
 
 :username: my_username

data/lib/jenkins_api_client/build_queue.rb

@@ -120,15 +120,21 @@ module JenkinsApi
       #
       # @param[String] task_name name of the task
       #
-      # @return [String] ETA for the task, nil if no task found or ETA is
-      #                  not available
+      # @return [String] ETA for the task, nil if no task found and N/A for
+      #                  tasks with no ETA info.
       #
       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?
+          if matched.nil?
+            # Task is found, but ETA information is not available
+            eta = "N/A"
+          else
+            # ETA information is available
+            eta = matched[1].strip
+          end
         end
         eta
       end

data/lib/jenkins_api_client/client.rb

@@ -32,7 +32,7 @@ module JenkinsApi
   class Client
     attr_accessor :debug
     DEFAULT_SERVER_PORT = 8080
-    VALID_PARAMS = %w(server_ip server_port username password debug)
+    VALID_PARAMS = %w(server_ip server_port jenkins_path username password debug)
 
     # Initialize a Client object with Jenkins CI server credentials
     #
@@ -115,10 +115,17 @@ module JenkinsApi
     # @param [String] url_prefix
     #
     def api_get_request(url_prefix, tree = nil, url_suffix ="/api/json")
+      url_prefix = "#{@jenkins_path}#{url_prefix}"
       http = Net::HTTP.start(@server_ip, @server_port)
-      request = Net::HTTP::Get.new("#{url_prefix}#{url_suffix}")
-      puts "[INFO] GET #{url_prefix}#{url_suffix}" if @debug
-      request = Net::HTTP::Get.new("#{url_prefix}#{url_suffix}?#{tree}") if tree
+      to_get = ""
+      if tree
+        to_get = "#{url_prefix}#{url_suffix}?#{tree}"
+      else
+        to_get = "#{url_prefix}#{url_suffix}"
+      end
+      to_get = URI.escape(to_get)
+      request = Net::HTTP::Get.new(to_get)
+      puts "[INFO] GET #{to_get}" if @debug
       request.basic_auth @username, @password
       response = http.request(request)
       msg = "HTTP Code: #{response.code}, Response Body: #{response.body}"
@@ -146,6 +153,7 @@ module JenkinsApi
     # @param [Hash] form_data form data to send with POST request
     #
     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
@@ -156,7 +164,7 @@ module JenkinsApi
       msg = "HTTP Code: #{response.code}, Response Body: #{response.body}"
       case response.code.to_i
       when 200, 302
-        return response.code
+        return response.body
       when 404
         raise Exceptions::NotFoundException.new(msg)
       when 500
@@ -171,6 +179,7 @@ module JenkinsApi
     # @param [String] url_prefix
     #
     def get_config(url_prefix)
+      url_prefix = URI.escape(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
@@ -185,6 +194,7 @@ module JenkinsApi
     # @param [String] xml
     #
     def post_config(url_prefix, xml)
+      url_prefix = URI.escape(url_prefix)
       http = Net::HTTP.start(@server_ip, @server_port)
       request = Net::HTTP::Post.new("#{url_prefix}")
       puts "[INFO] PUT #{url_prefix}" if @debug
@@ -192,7 +202,7 @@ module JenkinsApi
       request.body = xml
       request.content_type = 'application/xml'
       response = http.request(request)
-      response.code
+      response.body
     end
 
   end

data/lib/jenkins_api_client/job.rb

@@ -61,10 +61,38 @@ module JenkinsApi
       #  * +: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.
+      #  * +:timer+ timer for running builds periodically.
       #  * +:shell_command+ command to execute in the shell
+      #  * +:notification_email+ email for sending notification
+      #  * +:skype_targets+ skype targets for sending notifications to. Use *
+      #    to specify group chats. Use space to separate multiple targets.
+      #    Example: testuser *testgroup.
+      #  * +:skype_strategy+ skype strategy to be used for sending
+      #    notifications. Valid values: all, failure, failure_and_fixed,
+      #    change. Default: change.
+      #  * +:skype_notify_on_build_start+ Default: false
+      #  * +:skype_notify_suspects+ Default: false
+      #  * +:skype_notify_culprits+ Default: false
+      #  * +:skype_notify_fixers+ Default: false
+      #  * +:skype_notify_upstream_committers+ Default: false
+      #  * +:skype_message+ what should be sent as notification message. Valid:
+      #    just_summary, summary_and_scm_changes,
+      #    summary_and_build_parameters, summary_scm_changes_and_failed_tests.
+      #    Default: summary_and_scm_changes
       #  * +:child_projects+ projects to add as downstream projects
       #  * +:child_threshold+ threshold for child projects.
-      #      success, failure, or unstable. Default: failure.
+      #    success, failure, or unstable. Default: failure.
+      #
+      # @example Create a Freestype Project
+      #   create_freestyle(
+      #     :name => "test_freestyle_job",
+      #     :keep_dependencies => true,
+      #     :concurrent_build => true,
+      #     :scm_provider => "git",
+      #     :scm_url => "git://github.com./arangamani/jenkins_api_client.git",
+      #     :scm_branch => "master",
+      #     :shell_command => "bundle install\n rake func_tests"
+      #   )
       #
       def create_freestyle(params)
         # Supported SCM providers
@@ -211,7 +239,15 @@ module JenkinsApi
               "#{params[:block_build_when_downstream_building]}")
             xml.blockBuildWhenUpstreamBuilding(
               "#{params[:block_build_when_upstream_building]}")
-            xml.triggers.vector
+            if params[:timer]
+              xml.triggers.vector {
+                xml.send("hudson.triggers.TimerTrigger") {
+                  xml.spec params[:timer]
+                }
+              }
+            else
+              xml.triggers.vector
+            end
             xml.concurrentBuild "#{params[:concurrent_build]}"
             # Shell command stuff
             xml.builders {
@@ -244,6 +280,7 @@ module JenkinsApi
                     "#{params[:notification_email_send_to_individuals]}")
                 }
               end
+              skype_notification(params, xml) if params[:skype_targets]
             }
             xml.buildWrappers
           }
@@ -251,6 +288,58 @@ module JenkinsApi
         create(params[:name], builder.to_xml)
       end
 
+      # Adding skype notificaiton to a job
+      #
+      # @param [Hash] params parameters for adding skype notification
+      #  * +:name+ name of the job to add skype notification
+      #  * +:skype_targets+ skype targets for sending notifications to. Use *
+      #    to specify group chats. Use space to separate multiple targets.
+      #    Example: testuser, *testgroup.
+      #  * +:skype_strategy+ skype strategy to be used for sending
+      #    notifications. Valid values: all, failure, failure_and_fixed,
+      #    change. Default: change.
+      #  * +:skype_notify_on_build_start+ Default: false
+      #  * +:skype_notify_suspects+ Default: false
+      #  * +:skype_notify_culprits+ Default: false
+      #  * +:skype_notify_fixers+ Default: false
+      #  * +:skype_notify_upstream_committers+ Default: false
+      #  * +:skype_message+ what should be sent as notification message. Valid:
+      #    just_summary, summary_and_scm_changes, summary_and_build_parameters,
+      #    summary_scm_changes_and_failed_tests.
+      #    Default: summary_and_scm_changes
+      #
+      def add_skype_notification(params)
+        raise "No job name specified" unless params[:name]
+        raise "No Skype target specified" unless params[:skype_targets]
+        xml = get_config(params[:name])
+        n_xml = Nokogiri::XML(xml)
+        puts n_xml.xpath("//hudson.plugins.skype.im.transport.SkypePublisher")
+        if n_xml.xpath("//hudson.plugins.skype.im.transport.SkypePublisher").empty?
+          p_xml = Nokogiri::XML::Builder.new(:encoding => "UTF-8") { |xml|
+            skype_notification(params, xml)
+          }
+          skype_xml = Nokogiri::XML(p_xml.to_xml).xpath(
+            "//hudson.plugins.skype.im.transport.SkypePublisher"
+          ).first
+          n_xml.xpath("//publishers").first.add_child(skype_xml)
+          post_config(params[:name], n_xml.to_xml)
+        end
+      end
+
+      # Rename a job given the old name and new name
+      #
+      # @param [String] old_job Name of the old job
+      # @param [String] new_job Name of the new job.
+      #
+      def rename(old_job, new_job)
+        # Obtain the configuration of the old job
+        xml = get_config(old_job)
+        # Create the new job with the configuration obtained
+        create(new_job, xml)
+        # Delete the old job
+        delete(old_job)
+      end
+
       # Delete a job given the name
       #
       # @param [String] job_name
@@ -259,6 +348,15 @@ module JenkinsApi
         @client.api_post_request("/job/#{job_name}/doDelete")
       end
 
+      # Deletes all jobs from Jenkins
+      #
+      # @note This method will remove all jobs from Jenkins. Please use with
+      #       caution.
+      #
+      def delete_all!
+        list_all.each { |job| delete(job) }
+      end
+
       # 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
@@ -293,7 +391,7 @@ 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
+      # @param [Number] build_num 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'
@@ -476,13 +574,19 @@ module JenkinsApi
       end
 
       # Build a job given the name of the job
+      # You can optionally pass in a list of params for Jenkins to use for parameterized builds
       #
       # @param [String] job_name
+      # @param [Hash] params
       #
       # @return [String] response_code return code from HTTP POST
       #
-      def build(job_name)
-        @client.api_post_request("/job/#{job_name}/build")
+      def build(job_name, params={})
+        if params.empty?
+          @client.api_post_request("/job/#{job_name}/build")
+        else
+          @client.api_post_request("/job/#{job_name}/buildWithParameters", params)
+        end
       end
 
       # Obtain the configuration stored in config.xml of a specific job
@@ -893,6 +997,78 @@ module JenkinsApi
         filtered_job_names[0..parallel-1]
       end
 
+      private
+
+      # Method for creating portion of xml that builds Skype notification
+      # Use this option only when you have the Skype plugin installed and
+      # everything is set up properly
+      #
+      # @param [Hash] params Parameters for adding skype notificaiton. For the
+      # options in this params Hash refer to create_freestyle
+      # @param [XML] xml Main xml to attach the skype portion.
+      #
+      def skype_notification(params, xml)
+        params[:skype_strategy] = case params[:skype_strategy]
+        when "all"
+          "ALL"
+        when "failure"
+          "ANY_FAILURE"
+        when "failure_and_fixed"
+          "FAILURE_AND_FIXED"
+        when "change"
+          "STATECHANGE_ONLY"
+        else
+          "STATECHANGE_ONLY"
+        end
+
+        params[:skype_notify_on_build_start] = false if params[:skype_notify_on_build_start].nil?
+        params[:skype_notify_suspects] = false if params[:skype_notify_suspects].nil?
+        params[:skype_notify_culprits] = false if params[:skype_notify_culprits].nil?
+        params[:skype_notify_fixers] = false if params[:skype_notify_fixers].nil?
+        params[:skype_notify_upstream_committers] = false if params[:skype_notify_upstream_committers].nil?
+
+        targets = params[:skype_targets].split(/\s+/)
+        xml.send("hudson.plugins.skype.im.transport.SkypePublisher") {
+          xml.targets {
+            targets.each { |target|
+              if target =~ /^\*/
+                # Group Chat
+                xml.send("hudson.plugins.im.GroupChatIMMessageTarget") {
+                  # Skipe the first * character
+                  xml.value target[1..-1]
+                  xml.notificationOnly false
+                }
+              else
+                # Individual message
+                xml.send("hudson.plugins.im.DefaultIMMessageTarget") {
+                  xml.value target
+                }
+              end
+            }
+          }
+          xml.strategy "#{params[:skype_strategy]}"
+          xml.notifyOnBuildStart params[:skype_notify_on_build_start]
+          xml.notifySuspects params[:skype_notify_suspects]
+          xml.notifyCulprits params[:skype_notify_culprits]
+          xml.notifyFixers params[:skype_notify_fixers]
+          xml.notifyUpstreamCommitters params[:skype_notify_upstream_committers]
+          notification_class = case params[:skype_message]
+          when "just_summary"
+            "hudson.plugins.im.build_notify.SummaryOnlyBuildToChatNotifier"
+          when "summary_and_scm_changes"
+            "hudson.plugins.im.build_notify.DefaultBuildToChatNotifier"
+          when "summary_and_build_parameters"
+            "hudson.plugins.im.build_notify.BuildParametersBuildToChatNotifier"
+          when "summary_scm_changes_and_failed_tests"
+            "hudson.plugins.im.build_notify.PrintFailingTestsBuildToChatNotifier"
+          else
+            "hudson.plugins.im.build_notify.DefaultBuildToChatNotifier"
+          end
+          xml.buildToChatNotifier(:class => notification_class)
+          xml.matrixMultiplier "ONLY_CONFIGURATIONS"
+        }
+      end
+
     end
   end
 end

data/lib/jenkins_api_client/node.rb

@@ -108,6 +108,15 @@ module JenkinsApi
       #  * +:slave_port+ Slave port
       #  * +:private_key_file+ Private key file of master
       #
+      # @example Create a Dump Slave
+      #   create_dump_slave(
+      #     :name => "slave1",
+      #     :slave_host => "10.10.10.10",
+      #     :private_key_file => "/root/.ssh/id_rsa",
+      #     :executors => 10,
+      #     :labels => "slave, ruby"
+      #   )
+      #
       def create_dump_slave(params)
 
         if list.include?(params[:name])
@@ -164,7 +173,7 @@ module JenkinsApi
 
       # Deletes the specified node
       #
-      # @params [String] node_name Name of the node to delete
+      # @param [String] node_name Name of the node to delete
       #
       def delete(node_name)
         if list.include?(node_name)
@@ -174,6 +183,16 @@ module JenkinsApi
         end
       end
 
+      # Deletes all slaves from Jenkins. The master will be the only node alive
+      # after the exection of this call.
+      #
+      # @note This method will remove all slaves from Jenkins. Please use with
+      #       caution.
+      #
+      def delete_all!
+        list.each { |node| delete(node) unless node == "master" }
+      end
+
       # This method lists all nodes
       #
       # @param [String] filter a regex to filter node names
@@ -249,7 +268,7 @@ module JenkinsApi
       #
       def get_config(node_name)
         node_name = "(master)" if node_name == "master"
-        @client.get_config("/computer/#{node_name}/config.xml")
+        @client.get_config("/computer/#{node_name}")
       end
 
       # Posts the given config.xml to the Jenkins node

data/lib/jenkins_api_client/version.rb

@@ -23,8 +23,8 @@
 module JenkinsApi
   class Client
     MAJOR   = 0
-    MINOR   = 7
-    TINY    = 3
+    MINOR   = 8
+    TINY    = 0
     PRE     = nil
     VERSION = [MAJOR, MINOR, TINY, PRE].compact.join('.')
   end

data/lib/jenkins_api_client/view.rb

@@ -38,15 +38,103 @@ module JenkinsApi
         "#<JenkinsApi::Client::View>"
       end
 
-      # Create a new view
-      #
-      # @param [String] view_name
-      #
-      def create(view_name)
-        post_msg = "/createView?name=#{view_name}&"
-        post_msg << "mode=hudson.model.ListView&json={\"name\":\"#{view_name}"
-        post_msg << "\",\"mode\":\"hudson.model.ListView\"}"
-        @client.api_post_request(post_msg)
+      # Creates a new empty view of the given type
+      #
+      # @param [String] view_name Name of the view to be created
+      # @param [String] type Type of view to be created. Valid options:
+      # listview, myview. Default: listview
+      #
+      def create(view_name, type = "listview")
+        mode = case type
+        when "listview"
+          "hudson.model.ListView"
+        when "myview"
+          "hudson.model.MyView"
+        end
+        initial_post_params = {
+          "name" => view_name,
+          "mode" => mode,
+          "json" => {
+            "name" => view_name,
+            "mode" => mode
+          }
+        }
+        @client.api_post_request("/createView", initial_post_params)
+      end
+
+      # Creates a listview by accepting the given parameters hash
+      #
+      # @param [Hash] params options to create the new view
+      # @option params [String] :name Name of the view
+      # @option params [String] :description Description of the view
+      # @option params [String] :status_filter Filter jobs based on the status.
+      #         Valid options: all_selected_jobs, enabled_jobs_only,
+      #         disabled_jobs_only. Default: all_selected_jobs
+      # @option params [TrueClass|FalseClass] :filter_queue true or false
+      # @option params [TrueClass|FalseClass] :filter_executors true or false
+      # @option params [String] :regex Regular expression to filter jobs that
+      #         are to be added to the view
+      #
+      def create_list_view(params)
+        create(params[:name], "listview")
+        status_filter = case params[:status_filter]
+        when "all_selected_jobs"
+          ""
+        when "enabled_jobs_only"
+          "1"
+        when "disabled_jobs_only"
+          "2"
+        else
+          ""
+        end
+        post_params = {
+          "name" => params[:name],
+          "mode" => "hudson.model.ListView",
+          "description" => params[:description],
+          "statusFilter" => status_filter,
+          "json" => {
+            "name" => params[:name],
+            "description" => params[:description],
+            "mode" => "hudson.model.ListView",
+            "statusFilter" => "",
+            "columns" => [
+              {
+                "stapler-class" => "hudson.views.StatusColumn",
+                "kind"=> "hudson.views.StatusColumn"
+              },
+              {
+                "stapler-class" => "hudson.views.WeatherColumn",
+                "kind" => "hudson.views.WeatherColumn"
+              },
+              {
+                "stapler-class" => "hudson.views.JobColumn",
+                "kind" => "hudson.views.JobColumn"
+              },
+              {
+                "stapler-class" => "hudson.views.LastSuccessColumn",
+                "kind" => "hudson.views.LastSuccessColumn"
+              },
+              {
+                "stapler-class" => "hudson.views.LastFailureColumn",
+                "kind" => "hudson.views.LastFailureColumn"
+              },
+              {
+                "stapler-class" => "hudson.views.LastDurationColumn",
+                "kind" => "hudson.views.LastDurationColumn"
+              },
+              {
+                "stapler-class" => "hudson.views.BuildButtonColumn",
+                "kind" => "hudson.views.BuildButtonColumn"
+              }
+            ]
+          }.to_json
+        }
+        post_params.merge!("filterQueue" => "on") if params[:filter_queue]
+        post_params.merge!("filterExecutors" => "on") if params[:filter_executors]
+        post_params.merge!("useincluderegex" => "on",
+                           "includeRegex" => params[:regex]) if params[:regex]
+        @client.api_post_request("/view/#{params[:name]}/configSubmit",
+                                 post_params)
       end
 
       # Delete a view
@@ -57,6 +145,15 @@ module JenkinsApi
         @client.api_post_request("/view/#{view_name}/doDelete")
       end
 
+      # Deletes all views (except the All view) in Jenkins.
+      #
+      # @note This method deletes all views (except the All view) available
+      #       in Jenkins. Please use with caution.
+      #
+      def delete_all!
+        list.each { |view| delete(view) unless view == "All"}
+      end
+
       # This method lists all views
       #
       # @param [String] filter a regex to filter view names

data/spec/func_tests/job_spec.rb

@@ -58,66 +58,75 @@ describe JenkinsApi::Client::Job do
       end
 
       describe "#create_freestyle" do
+
+        def test_and_validate(name, params)
+          @client.job.create_freestyle(params).to_i.should == 200
+          @client.job.list(name).include?(name).should be_true
+          @client.job.delete(name).to_i.should == 302
+          @client.job.list(name).include?(name).should be_false
+        end
+
         it "Should be able to create a simple freestyle job" do
+          name = "test_job_name_using_params"
           params = {
-            :name => "test_job_name_using_params"
+            :name => name
           }
-          @client.job.create_freestyle(params).to_i.should == 200
-          @client.job.delete("test_job_name_using_params").to_i.should == 302
+          test_and_validate(name, params)
         end
         it "Should be able to create a freestyle job with shell command" do
+          name = "test_job_using_params_shell"
           params = {
-            :name => "test_job_using_params_shell",
+            :name => name,
             :shell_command => "echo this is a free style project"
           }
-          @client.job.create_freestyle(params).to_i.should == 200
-          @client.job.delete("test_job_using_params_shell").to_i.should == 302
+          test_and_validate(name, params)
         end
         it "Should accept Git SCM provider" do
+          name = "test_job_with_git_scm"
           params = {
-            :name => "test_job_with_git_scm",
+            :name => name,
             :scm_provider => "git",
             :scm_url => "git://github.com./arangamani/jenkins_api_client.git",
             :scm_branch => "master"
           }
-          @client.job.create_freestyle(params).to_i.should == 200
-          @client.job.delete("test_job_with_git_scm").to_i.should == 302
+          test_and_validate(name, params)
         end
         it "Should accept subversion SCM provider" do
+          name = "test_job_with_subversion_scm"
           params = {
-            :name => "test_job_with_subversion_scm",
+            :name => name,
             :scm_provider => "subversion",
             :scm_url => "http://svn.freebsd.org/base/",
             :scm_branch => "master"
           }
-          @client.job.create_freestyle(params).to_i.should == 200
-          @client.job.delete("test_job_with_subversion_scm").to_i.should == 302
+          test_and_validate(name, params)
         end
         it "Should accept CVS SCM provider with branch" do
+          name = "test_job_with_cvs_scm_branch"
           params = {
-            :name => "test_job_with_cvs_scm_branch",
+            :name => name,
             :scm_provider => "cvs",
             :scm_url => "http://cvs.NetBSD.org",
             :scm_module => "src",
             :scm_branch => "MAIN"
           }
-          @client.job.create_freestyle(params).to_i.should == 200
-          @client.job.delete("test_job_with_cvs_scm_branch").to_i.should == 302
+          test_and_validate(name, params)
         end
         it "Should accept CVS SCM provider with tag" do
+          name = "test_job_with_cvs_scm_tag"
           params = {
-            :name => "test_job_with_cvs_scm_tag",
+            :name => name,
             :scm_provider => "cvs",
             :scm_url => "http://cvs.NetBSD.org",
             :scm_module => "src",
             :scm_tag => "MAIN"
           }
-          @client.job.create_freestyle(params).to_i.should == 200
-          @client.job.delete("test_job_with_cvs_scm_tag").to_i.should == 302
+          test_and_validate(name, params)
         end
         it "Should fail if unsupported SCM is specified" do
+          name = "test_job_unsupported_scm"
           params = {
-            :name => "test_job_unsupported_scm",
+            :name => name,
             :scm_provider => "non-existent",
             :scm_url => "http://non-existent.com/non-existent.non",
             :scm_branch => "master"
@@ -127,57 +136,119 @@ describe JenkinsApi::Client::Job do
           ).to raise_error
         end
         it "Should accept restricted_node option" do
+          name = "test_job_restricted_node"
           params = {
-            :name => "test_job_restricted_node",
+            :name => name,
             :restricted_node => "master"
           }
-          @client.job.create_freestyle(params).to_i.should == 200
-          @client.job.delete("test_job_restricted_node").to_i.should == 302
+          test_and_validate(name, params)
         end
         it "Should accept block_build_when_downstream_building option" do
+          name = "test_job_block_build_when_downstream_building"
           params = {
-            :name => "test_job_block_build_when_downstream_building",
+            :name => name,
             :block_build_when_downstream_building => true,
           }
-          @client.job.create_freestyle(params).to_i.should == 200
-          @client.job.delete(
-            "test_job_block_build_when_downstream_building"
-          ).to_i.should == 302
+          test_and_validate(name, params)
         end
         it "Should accept block_build_when_upstream_building option" do
+          name = "test_job_block_build_when_upstream_building"
           params = {
-            :name => "test_job_block_build_when_upstream_building",
+            :name => name,
             :block_build_when_upstream_building => true
           }
-          @client.job.create_freestyle(params).to_i.should == 200
-          @client.job.delete(
-            "test_job_block_build_when_upstream_building"
-          ).to_i.should == 302
+          test_and_validate(name, params)
         end
         it "Should accept concurrent_build option" do
+          name = "test_job_concurrent_build"
           params = {
-            :name => "test_job_concurrent_build",
+            :name => name,
             :concurrent_build => true
           }
-          @client.job.create_freestyle(params).to_i.should == 200
-          @client.job.delete("test_job_concurrent_build").to_i.should == 302
+          test_and_validate(name, params)
+        end
+        it "Should accept the timer option" do
+          name = "test_job_using_timer"
+          params = {
+            :name => name,
+            :timer => "* * * * *"
+          }
+          test_and_validate(name, params)
         end
         it "Should accept child projects option" do
+          name = "test_job_child_projects"
           params = {
-            :name => "test_job_child_projects",
+            :name => name,
             :child_projects => @job_name,
             :child_threshold => "success"
           }
-          @client.job.create_freestyle(params).to_i.should == 200
-          @client.job.delete("test_job_child_projects").to_i.should == 302
+          test_and_validate(name, params)
         end
         it "Should accept notification_email option" do
+          name = "test_job_notification_email"
           params = {
-            :name => "test_job_notification_email",
+            :name => name,
             :notification_email => "kannan@testdomain.com"
           }
+          test_and_validate(name, params)
+        end
+        it "Should accept notification for individual skype targets" do
+          name = "test_job_with_individual_skype_targets"
+          params = {
+            :name => name,
+            :skype_targets => "testuser"
+          }
+          test_and_validate(name, params)
+        end
+        it "Should accept notification for group skype targets" do
+          name = "test_job_with_group_skype_targets"
+          params = {
+            :name => name,
+            :skype_targets => "*testgroup"
+          }
+          test_and_validate(name, params)
+        end
+        it "Should accept complex skype configuration" do
+          name = "test_job_with_complex_skype_configuration"
+          params = {
+            :name => name,
+            :skype_targets => "testuser *testgroup anotheruser *anothergroup",
+            :skype_strategy => "failure_and_fixed",
+            :skype_notify_on_build_start => true,
+            :skype_notify_suspects => true,
+            :skype_notify_culprits => true,
+            :skype_notify_fixers => true,
+            :skype_notify_upstream_committers => false,
+            :skype_message => "summary_and_scm_changes"
+          }
+          test_and_validate(name, params)
+        end
+      end
+
+      describe "#add_skype_notification" do
+        it "Should accept skype configuration and add to existing job" do
+          name = "skype_notification_test_job"
+          params = {
+            :name => name
+          }
           @client.job.create_freestyle(params).to_i.should == 200
-          @client.job.delete("test_job_notification_email").to_i.should == 302
+          @client.job.add_skype_notification(
+            :name => name,
+            :skype_targets => "testuser"
+          ).to_i.should == 200
+          @client.job.delete(name).to_i.should == 302
+        end
+      end
+      describe "#rename" do
+        it "Should accept new and old job names and rename the job" do
+          xml = @helper.create_job_xml
+          @client.job.create("old_job_rename_test", xml)
+          @client.job.rename("old_job_rename_test", "new_job_rename_test")
+          @client.job.list("old_job_rename_test").should == []
+          resp = @client.job.list("new_job_rename_test")
+          resp.size.should == 1
+          resp.first.should == "new_job_rename_test"
+          @client.job.delete("new_job_rename_test")
         end
       end
 

data/spec/func_tests/node_spec.rb

@@ -19,6 +19,12 @@ describe JenkinsApi::Client::Node do
         puts "WARNING: Credentials are not set properly."
         puts e.message
       end
+
+      @client.node.create_dump_slave(
+        :name => "slave",
+        :slave_host => "10.0.0.1",
+        :private_key_file => "/root/.ssh/id_rsa"
+      ) unless @client.node.list.include?("slave")
     end
 
     describe "InstanceMethods" do
@@ -170,5 +176,9 @@ describe JenkinsApi::Client::Node do
       end
 
     end
+
+    after(:all) do
+      @client.node.delete("slave")
+    end
   end
 end

data/spec/unit_tests/job_spec.rb

@@ -93,6 +93,74 @@ describe JenkinsApi::Client::Job do
           @client.should_receive(:post_config)
           @job.create_freestyle(params)
         end
+        it "accepts timer and creates job" do
+          params = {
+            :name => "test_job_with_timer",
+            :timer => "* * * * *"
+          }
+          @client.should_receive(:post_config)
+          @job.create_freestyle(params)
+        end
+        it "accepts individual targets for skype notification" do
+          params = {
+            :name => "test_job_with_individual_skype_target",
+            :skype_targets => "testuser"
+          }
+          @client.should_receive(:post_config)
+          @job.create_freestyle(params)
+        end
+        it "accepts group targets for skype notification" do
+          params = {
+            :name => "test_job_with_group_skype_target",
+            :skype_targets => "*testgroup"
+          }
+          @client.should_receive(:post_config)
+          @job.create_freestyle(params)
+        end
+        it "accepts complex configuration for skype notifications" do
+          params = {
+            :name => "test_job_with_complex_skype_configuration",
+            :skype_targets => "testuser *testgroup anotheruser *anothergroup",
+            :skype_strategy => "failure_and_fixed",
+            :skype_notify_on_build_start => true,
+            :skype_notify_suspects => true,
+            :skype_notify_culprits => true,
+            :skype_notify_fixers => true,
+            :skype_notify_upstream_committers => false,
+            :skype_message => "summary_and_scm_changes"
+          }
+          @client.should_receive(:post_config)
+          @job.create_freestyle(params)
+        end
+      end
+
+      describe "#add_skype_notification" do
+        it "accepts skype configuration and adds to existing job" do
+          params = {
+            :name => "skype_notification_test_job"
+          }
+          @client.should_receive(:post_config)
+          @job.create_freestyle(params)
+          @client.should_receive(:get_config).and_return(@sample_job_xml)
+          @client.should_receive(:post_config)
+          @job.add_skype_notification(
+            :name => "skype_notification_test_job",
+            :skype_targets => "testuser"
+          )
+        end
+      end
+
+      describe "#rename" do
+        it "accepts the old and new job names and renames the job" do
+          @client.should_receive(:get_config).with("/job/old_job")
+          @client.should_receive(:api_post_request).with(
+            "/job/old_job/doDelete"
+          )
+          @client.should_receive(:post_config).with(
+            "/createItem?name=new_job", nil
+          )
+          @job.rename("old_job", "new_job")
+        end
       end
 
       describe "#delete" do
@@ -251,6 +319,11 @@ describe JenkinsApi::Client::Job do
             "/job/test_job/build").and_return(302)
           @job.build("test_job").should == 302
         end
+        it "accepts the job name with params and builds the job" do
+          @client.should_receive(:api_post_request).with(
+              "/job/test_job/buildWithParameters",{:branch => 'feature/new-stuff'}).and_return(302)
+          @job.build("test_job",{:branch => 'feature/new-stuff'}).should == 302
+        end
       end
 
       describe "#get_config" do

data/spec/unit_tests/node_spec.rb

@@ -169,10 +169,8 @@ describe JenkinsApi::Client::Node do
 
       describe "#get_config" do
         it "accepts the node name and obtains the config xml from the server" do
-          @client.should_receive(
-            :get_config
-          ).with(
-            "/computer/slave/config.xml"
+          @client.should_receive(:get_config).with(
+            "/computer/slave"
           ).and_return(
             @sample_computer_xml
           )

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jenkins_api_client
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-05 00:00:00.000000000 Z
+date: 2013-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -193,7 +193,6 @@ files:
 - Rakefile
 - bin/jenkinscli
 - config/login.yml.example
-- jenkins_api_client.gemspec
 - lib/jenkins_api_client.rb
 - lib/jenkins_api_client/build_queue.rb
 - lib/jenkins_api_client/cli/base.rb

data/jenkins_api_client.gemspec

@@ -1,101 +0,0 @@
-# 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.7.2"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Kannan Manickam"]
-  s.date = "2013-02-02"
-  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",
-    "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/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.24"
-  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<activesupport>, ["~> 3.2.8"])
-      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<builder>, ["~> 3.1.3"])
-      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<activesupport>, ["~> 3.2.8"])
-      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<builder>, ["~> 3.1.3"])
-      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<activesupport>, ["~> 3.2.8"])
-    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<builder>, ["~> 3.1.3"])
-    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
-