jenkins_api_client 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae6ba9e0eccf49a825c6adc02e7d6d3a6200ac9d
-  data.tar.gz: eeb2d4cfb1d2858e157c74aa6b146ba572bf7246
+  metadata.gz: 58d034d4ed3f397f82ac0db50f4bdd3f955e162c
+  data.tar.gz: 96e93335ff4401d5077def1902fe7211c054351b
 SHA512:
-  metadata.gz: 7e6088e2b7231336b556fca98788f58be9abb0d68a739ecc73789adf22f23532519cd7f08b7b4e7ed9d5f5a96db24de9ef3f303752e14784aae91e9a129d9acc
-  data.tar.gz: 148deba58cb95bb445af9b232613c740648590def0e96cfdb4bc5c7cb6687a68e17682cf8c3f9408e5ae086ecec5bb69240017547c0872a71a5376e071b77aa8
+  metadata.gz: 7c286e0b68b5db499f97e2fac0545678127303d796c6bd29be9afabab715a23c6d4219b97b3b5e07427cfe818703a3bbe6dbf1e66caa3b56fd1a2e985fdd869c
+  data.tar.gz: 81ef02baf6791a223e5ba72337d4ecfd040d332c51660d1137628df691affac6b011851e04bd4f07b45a535281a36c4dad152650518f90bc0c77f2de5d7ad127

data/CHANGELOG.md

@@ -4,6 +4,11 @@ CHANGELOG
 upcoming
 --------
 
+v1.3.0   [03-JAN-2015]
+----------------------
+* [#159][] Add ability to configure git tool for a job. Credit: [@hubert][]
+* [#163][] Improve performance by using the `tree` parameter. Credit: [@stjohnjohnson][]
+
 v1.2.0   [12-NOV-2014]
 ----------------------
 * [#156][] Added workspace cleanup plugin. Credit [@hubert][]
@@ -294,6 +299,8 @@ v0.0.1  [15-OCT-2012]
 [#156]: https://github.com/arangamani/jenkins_api_client/issues/156
 [#157]: https://github.com/arangamani/jenkins_api_client/issues/157
 [#158]: https://github.com/arangamani/jenkins_api_client/issues/158
+[#159]: https://github.com/arangamani/jenkins_api_client/issues/159
+[#163]: https://github.com/arangamani/jenkins_api_client/issues/163
 [@Loa]: https://github.com/Loa
 [@Niarfe]: https://github.com/Niarfe
 [@bobbrez]: https://github.com/bobbrez
@@ -319,6 +326,7 @@ v0.0.1  [15-OCT-2012]
 [@rubytester]: https://github.com/rubytester
 [@scotje]: https://github.com/scotje
 [@spikegrobstein]: https://github.com/spikegrobstein
+[@stjohnjohnson]: https://github.com/stjohnjohnson
 [@sunaot]: https://github.com/sunaot
 [@tjhanley]: https://github.com/tjhanley
 [@woodbusy]: https://github.com/woodbusy

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.2.0 ruby lib
+# stub: jenkins_api_client 1.3.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "jenkins_api_client"
-  s.version = "1.2.0"
+  s.version = "1.3.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-11-13"
+  s.date = "2015-01-03"
   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"]

data/lib/jenkins_api_client/client.rb

@@ -489,7 +489,7 @@ module JenkinsApi
     # @return [Boolean] whether Jenkins uses crumbs or not
     #
     def use_crumbs?
-      response = api_get_request("")
+      response = api_get_request("", "tree=useCrumbs")
       response["useCrumbs"]
     end
 
@@ -498,7 +498,7 @@ module JenkinsApi
     # @return [Boolean] whether Jenkins uses security or not
     #
     def use_security?
-      response = api_get_request("")
+      response = api_get_request("", "tree=useSecurity")
       response["useSecurity"]
     end
 

data/lib/jenkins_api_client/job.rb

@@ -141,6 +141,8 @@ module JenkinsApi
       #   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_git_tool
+      #   the git executable. Defaults to "Default"; 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)
@@ -1619,7 +1621,7 @@ module JenkinsApi
           xml.useShallowClone "false"
           xml.buildChooser(:class =>
                            "hudson.plugins.git.util.DefaultBuildChooser")
-          xml.gitTool "Default"
+          xml.gitTool params.fetch(:scm_git_tool) { "Default" }
           xml.submoduleCfg(:class => "list")
           xml.relativeTargetDir
           xml.reference

data/lib/jenkins_api_client/version.rb

@@ -25,7 +25,7 @@ module JenkinsApi
     # Major version of the gem
     MAJOR   = 1
     # Minor version of the gem
-    MINOR   = 2
+    MINOR   = 3
     # Tiny version of the gem used for patches
     TINY    = 0
     # Used for pre-releases

data/lib/jenkins_api_client/view.rb

@@ -184,7 +184,7 @@ module JenkinsApi
       def list(filter = "", ignorecase = true)
         @logger.info "Obtaining views based on filter '#{filter}'"
         view_names = []
-        response_json = @client.api_get_request("")
+        response_json = @client.api_get_request("", "tree=views[name]")
         response_json["views"].each { |view|
           if ignorecase
             view_names << view["name"] if view["name"] =~ /#{filter}/i

data/spec/unit_tests/client_spec.rb

@@ -319,6 +319,46 @@ describe JenkinsApi::Client do
           @client.compare_versions("1.0.10", "1.0.2").should eql(1)
         end
       end
+
+      describe "#use_crumbs?" do
+        it "returns true if the server has useCrumbs on" do
+          expect(@client).to receive(:api_get_request).with("", "tree=useCrumbs") {
+            {
+              "useCrumbs" => true
+            }
+          }
+          @client.use_crumbs?.should == true
+        end
+
+        it "returns false if the server has useCrumbs off" do
+          expect(@client).to receive(:api_get_request).with("", "tree=useCrumbs") {
+            {
+              "useCrumbs" => false
+            }
+          }
+          @client.use_crumbs?.should == false
+        end
+      end
+
+      describe "#use_security?" do
+        it "returns true if the server has useSecurity on" do
+          expect(@client).to receive(:api_get_request).with("", "tree=useSecurity") {
+            {
+              "useSecurity" => true
+            }
+          }
+          @client.use_security?.should == true
+        end
+
+        it "returns false if the server has useSecurity off" do
+          expect(@client).to receive(:api_get_request).with("", "tree=useSecurity") {
+            {
+              "useSecurity" => false
+            }
+          }
+          @client.use_security?.should == false
+        end
+      end
     end
   end
 

data/spec/unit_tests/job_spec.rb

@@ -618,7 +618,12 @@ describe JenkinsApi::Client::Job do
 
       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'))
+          @job.send(:scm_git, {
+            scm_url: 'http://foo.bar',
+            scm_credentials_id: 'foobar',
+            scm_branch: 'master',
+            scm_git_tool: 'Git_NoPath',
+          }, xml_builder=Nokogiri::XML::Builder.new(:encoding => 'UTF-8'))
           @xml_config = Nokogiri::XML(xml_builder.to_xml)
         end
 
@@ -633,6 +638,10 @@ describe JenkinsApi::Client::Job do
         it 'adds branch to scm branches' do
           expect(@xml_config.at_css('scm branches name').content).to eql('master')
         end
+
+        it 'adds gitTool to scm tag' do
+          expect(@xml_config.at_css('scm gitTool').content).to eql('Git_NoPath')
+        end
       end
     end
 

data/spec/unit_tests/view_spec.rb

@@ -23,7 +23,7 @@ describe JenkinsApi::Client::View do
 
     describe "InstanceMethods" do
       describe "#initialize" do
-        it "initializes by receiving an instane of client object" do
+        it "initializes by receiving an instance of client object" do
           mock_logger = Logger.new "/dev/null"
           @client.should_receive(:logger).and_return(mock_logger)
           expect(
@@ -48,21 +48,21 @@ describe JenkinsApi::Client::View do
 
       describe "#list" do
         it "lists all views" do
-          @client.should_receive(:api_get_request).with("").and_return(@sample_views_json)
+          @client.should_receive(:api_get_request).with("", "tree=views[name]").and_return(@sample_views_json)
           response = @view.list
           response.class.should == Array
           response.size.should == 2
         end
 
         it "lists views matching specific filter" do
-          @client.should_receive(:api_get_request).with("").and_return(@sample_views_json)
+          @client.should_receive(:api_get_request).with("", "tree=views[name]").and_return(@sample_views_json)
           response = @view.list("test_view2")
           response.class.should == Array
           response.size.should == 1
         end
 
         it "lists views matching specific filter and matches case" do
-          @client.should_receive(:api_get_request).with("").and_return(@sample_views_json)
+          @client.should_receive(:api_get_request).with("", "tree=views[name]").and_return(@sample_views_json)
           response = @view.list("TEST_VIEW", false)
           response.class.should == Array
           response.size.should == 0
@@ -71,19 +71,19 @@ describe JenkinsApi::Client::View do
 
       describe "#exists?" do
         it "returns true a view that exists" do
-          @client.should_receive(:api_get_request).with("").and_return(@sample_views_json)
+          @client.should_receive(:api_get_request).with("", "tree=views[name]").and_return(@sample_views_json)
           @view.exists?("test_view2").should == true
         end
 
         it "returns false for non-existent view" do
-          @client.should_receive(:api_get_request).with("").and_return(@sample_views_json)
+          @client.should_receive(:api_get_request).with("", "tree=views[name]").and_return(@sample_views_json)
           @view.exists?("i_am_not_there").should == false
         end
       end
 
       describe "#list_jobs" do
         it "lists all jobs in the given view" do
-          @client.should_receive(:api_get_request).with("").and_return(@sample_views_json)
+          @client.should_receive(:api_get_request).with("", "tree=views[name]").and_return(@sample_views_json)
           @client.should_receive(:api_get_request).with("/view/test_view").and_return(@sample_view_json)
           response = @view.list_jobs("test_view")
           response.class.should == Array
@@ -91,7 +91,7 @@ describe JenkinsApi::Client::View do
         end
 
         it "raises an error if called on a non-existent view" do
-          @client.should_receive(:api_get_request).with("").and_return(@sample_views_json)
+          @client.should_receive(:api_get_request).with("", "tree=views[name]").and_return(@sample_views_json)
           expect(
             lambda { @view.list_jobs("i_am_not_there") }
           ).to raise_error

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jenkins_api_client
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Kannan Manickam
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-13 00:00:00.000000000 Z
+date: 2015-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri