jenkins_api_client 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3897dc16888185c70f0fe4c10ebe276926d993fd
-  data.tar.gz: aa5e4de611aebea6b1cce304b30f518b7804219a
+  metadata.gz: f4bc7855c7d74b4542c7a98175b2319f92c5b667
+  data.tar.gz: 6ab8636c67ef0e24a747ebcc413547138ba0b3e1
 SHA512:
-  metadata.gz: 9d9f39b820ddbc284a1c28aeae2268b3bc4116869e89bf84f6c604305c869f8005f1754c0264d2f6f8bfec0e424bf599b6c9dfe20adab709279b884fb66e5867
-  data.tar.gz: 9fbde3bbdb855aa297968da8153ebd7ffc16d1b9eeefa914aa2be69315a83969f4c8f30829b87ce5a5096ccdd36756157cc123c1e8152cda76dd8e4e7834c982
+  metadata.gz: 83a8e6835f8ba2c6de4b151b95a8ccc3f798abe0a808d4b448fd7e1ef16239f6b2ee7eedc0a89eeeba9e6866b7c92aac007e98e7599fb4f1417188948b4cf83a
+  data.tar.gz: c1e08e48ad162f2d7e9ae1d647cb96b24655d2f7bbe7f77527416e6eb8d4095d3199e3589cc214af7016c8f869a378e6b6f45cbd1d11ea502a23b9284563aa75

data/CHANGELOG.md

@@ -4,6 +4,16 @@ CHANGELOG
 upcoming
 --------
 
+v1.1.0   [05-NOV-2014]
+----------------------
+* [#145][] Fix `BuildQueue#get_details` to compare against task_name. Credit: [@notruthless][]
+* [#149][] Lower log level of GET/POST messages emitted by Client to DEBUG. Credit: [@scotje][]
+* [#151][] Add ability to configure credentialId for git. Credit: [@hubert][]
+* [#153][] Feature/extract plugins. Credit: [@hubert][]
+* [#147][] Added ability to get current build artifact. Credit: [@joelneubert][]
+* [#148][] Make `Client::Job#build` only request current build number if `build_start_timeout` option is passed.
+  Credit: [@scotje][]
+
 v1.0.1   [16-JUL-2014]
 ----------------------
 * Add `charset=UTF-8` along with content_type when posting data to Jenkins.
@@ -269,6 +279,12 @@ v0.0.1  [15-OCT-2012]
 [#136]: https://github.com/arangamani/jenkins_api_client/issues/136
 [#140]: https://github.com/arangamani/jenkins_api_client/issues/140
 [#141]: https://github.com/arangamani/jenkins_api_client/issues/141
+[#145]: https://github.com/arangamani/jenkins_api_client/issues/145
+[#147]: https://github.com/arangamani/jenkins_api_client/issues/147
+[#148]: https://github.com/arangamani/jenkins_api_client/issues/148
+[#149]: https://github.com/arangamani/jenkins_api_client/issues/149
+[#151]: https://github.com/arangamani/jenkins_api_client/issues/151
+[#153]: https://github.com/arangamani/jenkins_api_client/issues/153
 [@Loa]: https://github.com/Loa
 [@Niarfe]: https://github.com/Niarfe
 [@bobbrez]: https://github.com/bobbrez
@@ -281,15 +297,19 @@ v0.0.1  [15-OCT-2012]
 [@dkerwin]: https://github.com/dkerwin
 [@dougforpres]: https://github.com/dougforpres
 [@drnic]: https://github.com/drnic
+[@hubert]: https://github.com/hubert
+[@joelneubert]: https://github.com/joelneubert
 [@kevinhcross]: https://github.com/kevinhcross
 [@lheinlen-os]: https://github.com/lheinlen-os
 [@madisp]: https://github.com/madisp
 [@mattrose]: https://github.com/mattrose
 [@missedone]: https://github.com/missedone
 [@n-rodriguez]: https://github.com/n-rodriguez
+[@notruthless]: https://github.com/notruthless
 [@riywo]: https://github.com/riywo
 [@rubytester]: https://github.com/rubytester
+[@scotje]: https://github.com/scotje
 [@spikegrobstein]: https://github.com/spikegrobstein
 [@sunaot]: https://github.com/sunaot
 [@tjhanley]: https://github.com/tjhanley
-[@woodbusy]: https://github.com/woodbusy
+[@woodbusy]: https://github.com/woodbusy

data/README.md

@@ -107,7 +107,7 @@ The following example passes the YAML file contents. An example yaml file is
 located in <tt>config/login.yml.example</tt>.
 
 ```ruby
-@client = JenkinsApi::Client.new(YAML.Load_file(File.expand_path(
+@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
@@ -138,10 +138,11 @@ 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 201 if
+# the build was successful, for Jenkins >= v1.519
+# For versions older than v1.519, the success code is 302.
 code = @client.job.build(initial_jobs[0])
-raise "Could not build the job specified" unless code == 302
+raise "Could not build the job specified" unless code == '201'
 ```
 
 In the above example, you might have noticed that the chain method returns an
@@ -179,10 +180,90 @@ 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 do |job|
   code = @client.job.build(job)
-  raise "Unable to build job: #{job}" unless code == 302
+  raise "Unable to build job: #{job}" unless code == '201'
+end
+```
+
+### Configuring plugins
+
+Given the abundance of plugins for Jenkins, we now provide a extensible way to 
+setup jobs and configure their plugins. Right now, the gem ships with the hipchat
+plugin, with more plugins to follow in the future. 
+
+```ruby
+hipchat_settings = JenkinsApi::Client::PluginSettings::Hipchat.new({
+  :room => '10000',
+  :start_notification => true,
+  :notify_success => true,
+  :notify_aborted => true,
+  :notify_not_built => true,
+  :notify_unstable => true,
+  :notify_failure => true,
+  :notify_back_to_normal => true,
+})
+
+client = JenkinsApi::Client.new(
+  server_url: jenkins_server,
+  username: username,
+  password: password
+)
+
+# NOTE: plugins can be splatted so if you had another plugin it could be passed
+# to the new call below as another arg after hipchat
+job = JenkinsApi::Client::Job.new(client, hipchat)
+
+```
+
+Writing your own plugins is also straightforward. Inherit from the 
+JenkinsApi::Client::PluginSettings::Base class and override the configure method.
+Jenkins jobs are configured using xml so you just nee to figure out where in the
+configuration to hook in your plugin settings.
+
+Here is an example of a plugin written to configure a job for workspace cleanup.  
+
+```ruby
+module JenkinsApi
+  class Client
+    module PluginSettings
+      class WorkspaceCleanup < Base
+
+        # @option params [Boolean] :delete_dirs (false)
+        #   whether to also apply pattern on directories
+        # @option params [String] :cleanup_parameters
+        # @option params [String] :external_delete
+        def initialize(params={})
+          @params = params
+        end
+
+        # Create or Update a job with params given as a hash instead of the xml
+        # This gives some flexibility for creating/updating simple jobs so the
+        # user doesn't have to learn about handling xml.
+        #
+        # @param xml_doc [Nokogiri::XML::Document] xml document to be updated with 
+        # the plugin configuration
+        #
+        # @return [Nokogiri::XML::Document]
+        def configure(xml_doc)
+          xml_doc.tap do |doc|
+            Nokogiri::XML::Builder.with(doc.at('buildWrappers')) do |build_wrappers|
+              build_wrappers.send('hudson.plugins.ws__cleanup.PreBuildCleanup') do |x|
+                x.deleteDirs @params.fetch(:delete_dirs) { false }
+                x.cleanupParameter @params.fetch(:cleanup_parameter) { '' }
+                x.externalDelete @params.fetch(:external_delete) { '' }
+              end
+            end
+          end
+        end
+      end
+    end
+  end
 end
 ```
 
+Currently, the skype plugin is still configured directly on the jenkins job. This will 
+likely be extracted into its own plugin in the near future, but we will maintain 
+backwards compatibility until after an official deprecation period.
+
 ### Waiting for a build to start/Getting the build number
 Newer versions of Jenkins (starting with the 1.519 build) make it easier for
 an application to determine the build number for a 'build' request. (previously
@@ -208,6 +289,7 @@ caveats:
 ##### New (v >= 1.519)
 * All options work, and build number is accurately determined from queue
   info.
+* The build trigger success code is now 201 (Created). Previously it was 302.
 
 #### Initiating a build and returning the build_number
 

data/jenkins_api_client.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: jenkins_api_client 1.0.1 ruby lib
+# stub: jenkins_api_client 1.1.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "jenkins_api_client"
-  s.version = "1.0.1"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Kannan Manickam"]
-  s.date = "2014-07-16"
+  s.date = "2014-11-05"
   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"]
@@ -43,6 +43,9 @@ Gem::Specification.new do |s|
     "lib/jenkins_api_client/job.rb",
     "lib/jenkins_api_client/node.rb",
     "lib/jenkins_api_client/plugin_manager.rb",
+    "lib/jenkins_api_client/plugin_settings/base.rb",
+    "lib/jenkins_api_client/plugin_settings/collection.rb",
+    "lib/jenkins_api_client/plugin_settings/hipchat.rb",
     "lib/jenkins_api_client/system.rb",
     "lib/jenkins_api_client/urihelper.rb",
     "lib/jenkins_api_client/user.rb",
@@ -68,6 +71,8 @@ Gem::Specification.new do |s|
     "spec/unit_tests/fixtures/files/updatable_plugins.json",
     "spec/unit_tests/job_spec.rb",
     "spec/unit_tests/node_spec.rb",
+    "spec/unit_tests/plugin_settings/colllection_spec.rb",
+    "spec/unit_tests/plugin_settings/hipchat_spec.rb",
     "spec/unit_tests/plugin_spec.rb",
     "spec/unit_tests/spec_helper.rb",
     "spec/unit_tests/system_spec.rb",

data/lib/jenkins_api_client.rb

@@ -36,3 +36,15 @@ require 'jenkins_api_client/cli/base'
 require 'jenkins_api_client/cli/job'
 require 'jenkins_api_client/cli/node'
 require 'jenkins_api_client/cli/system'
+
+module JenkinsApi
+  class Client
+    module PluginSettings
+      class InvalidType < Exception; end
+
+      autoload :Base, 'jenkins_api_client/plugin_settings/base'
+      autoload :Hipchat, 'jenkins_api_client/plugin_settings/hipchat'
+      autoload :Collection, 'jenkins_api_client/plugin_settings/collection'
+    end
+  end
+end

data/lib/jenkins_api_client/build_queue.rb

@@ -94,7 +94,7 @@ module JenkinsApi
         response_json = @client.api_get_request("/queue")
         details = {}
         response_json["items"].each do |item|
-          details = item if item["task"]["name"]
+          details = item if item["task"]["name"] == task_name
         end
         details
       end

data/lib/jenkins_api_client/client.rb

@@ -249,6 +249,25 @@ module JenkinsApi
         " @http_read_timeout=#{@http_read_timeout.inspect}>"
     end
 
+    # Connects to the server and downloads artifacts to a specified location
+    #
+    # @param [String] job_name
+    # @param [String] filename location to save artifact
+    #
+    def get_artifact(job_name,filename)
+      @artifact = job.find_artifact(job_name)
+      uri = URI.parse(@artifact)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      http.use_ssl = true
+      request = Net::HTTP::Get.new(uri.request_uri)
+      request.basic_auth(@username, @password)
+      response = http.request(request)
+      File.write(File.expand_path(filename), response.body) if response.code == "200"
+    rescue
+      raise "Response was not 200"
+    end
+
     # Connects to the Jenkins server, sends the specified request and returns
     # the response.
     #
@@ -303,7 +322,7 @@ module JenkinsApi
     # @return [Net::HTTP::Response] Response from Jenkins for "/"
     #
     def get_root
-      @logger.info "GET #{@jenkins_path}/"
+      @logger.debug "GET #{@jenkins_path}/"
       request = Net::HTTP::Get.new("#{@jenkins_path}/")
       make_http_request(request)
     end
@@ -328,7 +347,7 @@ module JenkinsApi
         to_get = "#{url_prefix}#{url_suffix}"
       end
       request = Net::HTTP::Get.new(to_get)
-      @logger.info "GET #{to_get}"
+      @logger.debug "GET #{to_get}"
       response = make_http_request(request)
       if raw_response
         handle_exception(response, "raw")
@@ -352,7 +371,7 @@ module JenkinsApi
         # Added form_data default {} instead of nil to help with proxies
         # that barf with empty post
         request = Net::HTTP::Post.new("#{@jenkins_path}#{url_prefix}")
-        @logger.info "POST #{url_prefix}"
+        @logger.debug "POST #{url_prefix}"
         if @crumbs_enabled
           request[@crumb["crumbRequestField"]] = @crumb["crumb"]
         end
@@ -390,7 +409,7 @@ module JenkinsApi
     #
     def get_config(url_prefix)
       request = Net::HTTP::Get.new("#{@jenkins_path}#{url_prefix}/config.xml")
-      @logger.info "GET #{url_prefix}/config.xml"
+      @logger.debug "GET #{url_prefix}/config.xml"
       response = make_http_request(request)
       handle_exception(response, "body")
     end
@@ -416,7 +435,7 @@ module JenkinsApi
         refresh_crumbs
 
         request = Net::HTTP::Post.new("#{@jenkins_path}#{url_prefix}")
-        @logger.info "POST #{url_prefix}"
+        @logger.debug "POST #{url_prefix}"
         request.body = data
         request.content_type = content_type
         if @crumbs_enabled

data/lib/jenkins_api_client/job.rb

@@ -33,15 +33,36 @@ module JenkinsApi
       # Version that jenkins started to include queued build info in build response
       JENKINS_QUEUE_ID_SUPPORT_VERSION = '1.519'
 
+      attr_reader :plugin_collection
+
       # Initialize the Job object and store the reference to Client object
       #
       # @param client [Client] the client object
       #
       # @return [Job] the job object
       #
-      def initialize(client)
+      def initialize(client, *plugin_settings)
         @client = client
         @logger = @client.logger
+        @plugin_collection = JenkinsApi::Client::PluginSettings::Collection.new(*plugin_settings)
+      end
+
+      # Add a plugin to be included in job's xml configureation
+      #
+      # @param plugin [Jenkins::Api::Client::PluginSettings::Base]
+      #
+      # @return [JenkinsApi::Client::PluginSettings::Collection] the job object
+      def add_plugin(plugin)
+        plugin_collection.add(plugin)
+      end
+
+      # Remove a plugin to be included in job's xml configureation
+      #
+      # @param plugin [Jenkins::Api::Client::PluginSettings::Base]
+      #
+      # @return [JenkinsApi::Client::PluginSettings::Collection] the job object
+      def remove_plugin(plugin)
+        plugin_collection.remove(plugin)
       end
 
       # Return a string representation of the object
@@ -118,6 +139,8 @@ module JenkinsApi
       #   the type of source control. Supported providers: git, svn, and cvs
       # @option params [String] :scm_url
       #   the remote url for the selected scm provider
+      # @option params [String] :scm_credentials_id
+      #   the id of the credentials to use for authenticating with scm. Only for "git"
       # @option params [String] :scm_module
       #   the module to download. Only for use with "cvs" scm provider
       # @option params [String] :scm_branch (master)
@@ -329,7 +352,9 @@ module JenkinsApi
             xml.buildWrappers
           end
         end
-        builder.to_xml
+        
+        xml_doc = Nokogiri::XML(builder.to_xml)
+        plugin_collection.configure(xml_doc).to_xml
       end
 
 
@@ -757,7 +782,7 @@ module JenkinsApi
       #    this method (build) exits.  Default: nil
       #
       # @return [Integer] build number, or nil if not started (IF TIMEOUT SPECIFIED)
-      # @return [Integer] HTTP response code (per prev. behavior) (NO TIMEOUT SPECIFIED)
+      # @return [String] HTTP response code (per prev. behavior) (NO TIMEOUT SPECIFIED)
       #
       def build(job_name, params={}, opts = {})
         if opts.nil? || opts.class.is_a?(FalseClass)
@@ -772,11 +797,13 @@ module JenkinsApi
         msg << " with parameters: #{params.inspect}" unless params.empty?
         @logger.info msg
 
-        # Best-guess build-id
-        # This is only used if we go the old-way below... but we can use this number to detect if multiple
-        # builds were queued
-        current_build_id = get_current_build_number(job_name)
-        expected_build_id = current_build_id > 0 ? current_build_id + 1 : 1
+        if (opts['build_start_timeout'] || 0) > 0
+          # Best-guess build-id
+          # This is only used if we go the old-way below... but we can use this number to detect if multiple
+          # builds were queued
+          current_build_id = get_current_build_number(job_name)
+          expected_build_id = current_build_id > 0 ? current_build_id + 1 : 1
+        end
 
         if (params.nil? or params.empty?)
           response = @client.api_post_request("/job/#{path_encode job_name}/build",
@@ -1425,6 +1452,20 @@ module JenkinsApi
         result
       end
 
+      #A Method to find artifacts path from the Current Build
+      #
+      # @param [String] job_name
+      #
+      def find_artifact(job_name)
+        current_build_number  = get_current_build_number(job_name)
+        job_path              = "job/#{path_encode job_name}/"
+        response_json         = @client.api_get_request("/#{job_path}#{current_build_number}")
+        relative_build_path   = response_json['artifacts'][0]['relativePath']
+        jenkins_path          = response_json['url']
+        artifact_path         = URI.escape("#{jenkins_path}artifact/#{relative_build_path}")
+        return artifact_path
+      end
+
       private
 
       # Obtains the threshold params used by jenkins in the XML file
@@ -1517,6 +1558,7 @@ module JenkinsApi
             xml.send("hudson.plugins.git.UserRemoteConfig") {
               xml.name
               xml.refspec
+              xml.credentialsId "#{params[:scm_credentials_id]}"
               xml.url "#{params[:scm_url]}"
             }
           }

data/lib/jenkins_api_client/plugin_settings/base.rb

@@ -0,0 +1,11 @@
+module JenkinsApi
+  class Client
+    module PluginSettings
+      class Base 
+        def configure
+          raise InvalidType, 'Object must inherit from JenkinsApi::Client::PluginSettings::Base and override configure method'
+        end
+      end
+    end
+  end
+end

data/lib/jenkins_api_client/plugin_settings/collection.rb

@@ -0,0 +1,39 @@
+require 'forwardable'
+
+module JenkinsApi
+  class Client
+    module PluginSettings
+      class Collection 
+        extend Forwardable
+
+        def_delegator :@plugin_settings, :size
+
+        def initialize(*plugin_settings)
+          raise JenkinsApi::Client::PluginSettings::InvalidType unless plugin_settings.all? { |p| p.is_a?(JenkinsApi::Client::PluginSettings::Base) }
+          @plugin_settings = plugin_settings
+        end
+
+        def add(plugin)
+          raise JenkinsApi::Client::PluginSettings::InvalidType unless plugin.is_a?(JenkinsApi::Client::PluginSettings::Base)
+          tap do |x|
+            if @plugin_settings.none? { |p| p.class == plugin.class }
+              @plugin_settings << plugin
+            end
+          end
+        end
+
+        def remove(plugin)
+          tap do |x|
+            @plugin_settings.delete_if { |p| p.class == plugin.class }
+          end
+        end
+
+        def configure(xml_doc)
+          xml_doc.tap do |x|
+            @plugin_settings.each { |p| p.configure(x) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jenkins_api_client/plugin_settings/hipchat.rb

@@ -0,0 +1,53 @@
+module JenkinsApi
+  class Client
+    module PluginSettings
+      class Hipchat < Base
+
+        # @option params [String] :room
+        #   id of the room
+        # @option params [Boolean] :start_notification (false)
+        #   whether to notify room when build starts
+        # @option params [Boolean] :notify_success (false)
+        #   whether to notify room when build succeeds
+        # @option params [Boolean] :notify_aborted (false)
+        #   whether to notify room when build aborts
+        # @option params [Boolean] :notify_not_built (false)
+        #   whether to notify room when job could not be build
+        # @option params [String] :notify_unstable
+        #   whether to notify room when job becomes unstable
+        # @option params [String] :notify_failure
+        #   whether to notify room when job fails
+        # @option params [String] :notify_back_to_normal
+        #   whether to notify room when job becomes stable
+        # 
+        def initialize(params={})
+          @params = params
+        end
+
+        # Create or Update a job with params given as a hash instead of the xml
+        # This gives some flexibility for creating/updating simple jobs so the
+        # user doesn't have to learn about handling xml.
+        #
+        # @param params [Hash] parameters to create a freestyle project
+        #
+        # @return [Nokogiri::XML::Document]
+        def configure(xml_doc)
+          xml_doc.tap do |doc|
+            Nokogiri::XML::Builder.with(doc.at('properties')) do |properties|
+              properties.send('jenkins.plugins.hipchat.HipChatNotifier_-HipChatJobProperty') do |x|
+                x.room @params.fetch(:room) { '' }
+                x.startNotification @params.fetch(:start_notification) { false }
+                x.notifySuccess @params.fetch(:notify_success) { false }
+                x.notifyAborted @params.fetch(:notify_aborted) { false }
+                x.notifyNotBuilt @params.fetch(:notify_not_built) { false }
+                x.notifyUnstable @params.fetch(:notify_unstable) { false }
+                x.notifyFailure @params.fetch(:notify_failure) { false }
+                x.notifyBackToNormal @params.fetch(:notify_back_to_normal) { false }
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jenkins_api_client/version.rb

@@ -25,9 +25,9 @@ module JenkinsApi
     # Major version of the gem
     MAJOR   = 1
     # Minor version of the gem
-    MINOR   = 0
+    MINOR   = 1
     # Tiny version of the gem used for patches
-    TINY    = 1
+    TINY    = 0
     # Used for pre-releases
     PRE     = nil
     # Version String of Jenkins API Client.

data/spec/unit_tests/fake_http_response.rb

@@ -3,7 +3,7 @@ class FakeResponse
 
   def initialize(code=200, body='eww, a body', header={})
     @body = body
-    @code = code
+    @code = code.to_s
     @header = header
   end
 end

data/spec/unit_tests/job_spec.rb

@@ -85,7 +85,8 @@ describe JenkinsApi::Client::Job do
             :name => "test_job_using_params_git",
             :scm_provider => "git",
             :scm_url => "git://github.com/arangamani/jenkins_api_client/git",
-            :scm_branch => "master"
+            :scm_branch => "master",
+            :scm_credentials_id => 'foobar'
           }
           @client.should_receive(:post_config)
           @job.create_freestyle(params)
@@ -383,21 +384,17 @@ describe JenkinsApi::Client::Job do
       describe "#build" do
         # First tests confirm the build method works the same as it used to
         it "accepts the job name and builds the job" do
-          @client.should_receive(:api_get_request).with(
-            "/job/test_job").and_return({})
           @client.should_receive(:api_post_request).with(
             "/job/test_job/build", {}, true).and_return(FakeResponse.new(302))
-          @job.build("test_job").should == 302
+          @job.build("test_job").should == '302'
         end
         it "accepts the job name with params and builds the job" do
-          @client.should_receive(:api_get_request).with(
-            "/job/test_job").and_return({})
           @client.should_receive(:api_post_request).with(
             "/job/test_job/buildWithParameters",
             {:branch => 'feature/new-stuff'},
             true
           ).and_return(FakeResponse.new(302))
-          @job.build("test_job", {:branch => 'feature/new-stuff'}).should == 302
+          @job.build("test_job", {:branch => 'feature/new-stuff'}).should == '302'
         end
 
         ### OLD NON-QUEUE RESPONSE JENKINS ###
@@ -618,6 +615,49 @@ describe JenkinsApi::Client::Job do
           @job.get_promotions("test_job").should == {'dev' => 42, 'stage' => nil}
         end
       end
+
+      describe '#scm_git' do
+        before do
+          @job.send(:scm_git, {scm_url: 'http://foo.bar', scm_credentials_id: 'foobar', scm_branch: 'master'}, xml_builder=Nokogiri::XML::Builder.new(:encoding => 'UTF-8'))
+          @xml_config = Nokogiri::XML(xml_builder.to_xml)
+        end
+
+        it 'adds scm_url to hudson.plugins.git.UserRemoteConfig userRemoteConfig url tag' do
+          expect(@xml_config.at_css('scm userRemoteConfigs url').content).to eql('http://foo.bar')
+        end
+
+        it 'adds scm_credentials_id to hudson.plugins.git.UserRemoteConfig userRemoteConfig credentialsId tag' do
+          expect(@xml_config.at_css('scm userRemoteConfigs credentialsId').content).to eql('foobar')
+        end
+
+        it 'adds branch to scm branches' do
+          expect(@xml_config.at_css('scm branches name').content).to eql('master')
+        end
+      end
+    end
+
+    describe '#build_freestyle_config' do
+      it 'calls configure on its plugin collection' do
+        expect(@job.plugin_collection).to receive(:configure).and_return(Nokogiri::XML::Document.new(''))
+        @job.build_freestyle_config(name: 'foobar')
+      end
+    end
+
+    context 'plugin settings' do
+      let(:plugin) { JenkinsApi::Client::PluginSettings::Base.new }
+      describe '#add_plugin' do
+        it 'calls add on @plugin_collection with given plugin setting' do
+          expect(@job.plugin_collection).to receive(:add).with(plugin)
+          @job.add_plugin(plugin)
+        end
+      end
+
+      describe '#remove_plugin' do
+        it 'calls remove on @plugin_collection with given plugin setting' do
+          expect(@job.plugin_collection).to receive(:remove).with(plugin)
+          @job.remove_plugin(plugin)
+        end
+      end
     end
   end
 end

data/spec/unit_tests/plugin_settings/colllection_spec.rb

@@ -0,0 +1,62 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe JenkinsApi::Client::PluginSettings::Collection do
+  let(:plugin_settings_collection) { JenkinsApi::Client::PluginSettings::Collection.new }
+  let(:plugin_setting)             { JenkinsApi::Client::PluginSettings::Base.new }
+
+  describe '#initialize' do
+    it 'raises a InvalidType exception if given anything that is not a plugin setting' do
+      expect { JenkinsApi::Client::PluginSettings::Collection.new(Object.new) }.to raise_error(JenkinsApi::Client::PluginSettings::InvalidType)
+    end
+  end
+
+  describe '#add' do
+    context 'collection does not have member of given plugin setting' do
+      it 'adds the plugin to the collection' do
+        expect(plugin_settings_collection.add(plugin_setting).size).to eql(1)
+      end
+    end
+
+    context 'collection alreayd has member of same tyep as given plugin setting' do
+      it 'no-ops' do
+        plugin_settings_collection.add(plugin_setting)
+        expect(plugin_settings_collection.add(plugin_setting).size).to eql(1)
+      end
+    end
+
+    it 'raises a InvalidType exception if a non plugin setting is added' do
+      expect { plugin_settings_collection.add(Object.new) }.to raise_error(JenkinsApi::Client::PluginSettings::InvalidType)
+    end
+  end
+
+  describe '#remove' do
+    context 'collection does not have member of given plugin setting' do
+      it 'no-ops' do
+        expect(plugin_settings_collection.remove(plugin_setting).size).to eql(0)
+      end
+    end
+
+    context 'collection already has member of same type as given plugin setting' do
+      it 'removes item with same type as given plugin setting from the collection' do
+        plugin_settings_collection.add(plugin_setting)
+        expect(plugin_settings_collection.remove(plugin_setting).size).to eql(0)
+      end
+    end
+  end
+
+  describe '#configure' do
+    context 'collection is empty' do
+      it 'no-ops' do
+        expect { plugin_settings_collection.configure(Nokogiri::XML::Document.new)}.to_not raise_error
+      end
+    end
+
+    context 'collection has plugins' do
+      it 'calls configure on each of its plugin members' do
+        plugin_settings_collection.add(plugin_setting)
+        expect(plugin_setting).to receive(:configure).once
+        plugin_settings_collection.configure(Nokogiri::XML::Document.new)
+      end
+    end
+  end
+end

data/spec/unit_tests/plugin_settings/hipchat_spec.rb

@@ -0,0 +1,44 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe JenkinsApi::Client::PluginSettings::Hipchat do
+  describe '#configure' do
+    context 'given a Nokogiri::XML::Builder object' do
+      it 'adds hipchat configuration to the properties tag with default opts' do
+        hipchat_settings = JenkinsApi::Client::PluginSettings::Hipchat.new
+        hipchat_settings.configure(xml_doc=Nokogiri::XML("<?xml version=\"1.0\"?>\n<properties>\n</properties>\n"))
+
+        expect(xml_doc.at_css('properties room').content).to eql('')
+        expect(xml_doc.at_css('properties startNotification').content).to eql('false')
+        expect(xml_doc.at_css('properties notifySuccess').content).to eql('false')
+        expect(xml_doc.at_css('properties notifyAborted').content).to eql('false')
+        expect(xml_doc.at_css('properties notifyNotBuilt').content).to eql('false')
+        expect(xml_doc.at_css('properties notifyUnstable').content).to eql('false')
+        expect(xml_doc.at_css('properties notifyFailure').content).to eql('false')
+        expect(xml_doc.at_css('properties notifyBackToNormal').content).to eql('false')
+      end
+
+      it 'uses params if given' do
+        hipchat_settings = JenkinsApi::Client::PluginSettings::Hipchat.new({
+          :room => '10000',
+          :start_notification => true,
+          :notify_success => true,
+          :notify_aborted => true,
+          :notify_not_built => true,
+          :notify_unstable => true,
+          :notify_failure => true,
+          :notify_back_to_normal => true,
+        })
+        hipchat_settings.configure(xml_doc=Nokogiri::XML("<?xml version=\"1.0\"?>\n<properties>\n</properties>\n"))
+
+        expect(xml_doc.at_css('properties room').content).to eql('10000')
+        expect(xml_doc.at_css('properties startNotification').content).to eql('true')
+        expect(xml_doc.at_css('properties notifySuccess').content).to eql('true')
+        expect(xml_doc.at_css('properties notifyAborted').content).to eql('true')
+        expect(xml_doc.at_css('properties notifyNotBuilt').content).to eql('true')
+        expect(xml_doc.at_css('properties notifyUnstable').content).to eql('true')
+        expect(xml_doc.at_css('properties notifyFailure').content).to eql('true')
+        expect(xml_doc.at_css('properties notifyBackToNormal').content).to eql('true')
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jenkins_api_client
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Kannan Manickam
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-16 00:00:00.000000000 Z
+date: 2014-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -216,6 +216,9 @@ files:
 - lib/jenkins_api_client/job.rb
 - lib/jenkins_api_client/node.rb
 - lib/jenkins_api_client/plugin_manager.rb
+- lib/jenkins_api_client/plugin_settings/base.rb
+- lib/jenkins_api_client/plugin_settings/collection.rb
+- lib/jenkins_api_client/plugin_settings/hipchat.rb
 - lib/jenkins_api_client/system.rb
 - lib/jenkins_api_client/urihelper.rb
 - lib/jenkins_api_client/user.rb
@@ -241,6 +244,8 @@ files:
 - spec/unit_tests/fixtures/files/updatable_plugins.json
 - spec/unit_tests/job_spec.rb
 - spec/unit_tests/node_spec.rb
+- spec/unit_tests/plugin_settings/colllection_spec.rb
+- spec/unit_tests/plugin_settings/hipchat_spec.rb
 - spec/unit_tests/plugin_spec.rb
 - spec/unit_tests/spec_helper.rb
 - spec/unit_tests/system_spec.rb