jenkins_api_client 1.0.0.alpha.1 → 1.0.0.alpha.2

data/.travis.yml

@@ -2,19 +2,12 @@ language: ruby
 rvm:
   - 2.0.0
   - 1.9.3
-  - jruby-18mode
   - jruby-19mode
-  - rbx-18mode
   - rbx-19mode
-  - 1.8.7
-  - ree
 matrix:
   allow_failures:
-    - rvm: jruby-18mode
     - rvm: jruby-19mode
-    - rvm: rbx-18mode
     - rvm: rbx-19mode
-    - rvm: ree
 before_install:
   - travis/setup.sh
 

data/Gemfile

@@ -1,6 +1,6 @@
 source "https://rubygems.org"
 
-gem "nokogiri", "~> 1.5.0"
+gem "nokogiri", "~> 1.6.0"
 gem "thor", ">= 0.16.0"
 gem "json", ">= 0"
 gem "terminal-table", ">= 1.4.0"
@@ -9,7 +9,7 @@ gem "mixlib-shellout", ">= 1.1.0"
 group :development do
   gem "bundler", ">= 1.0"
   gem "jeweler", ">= 1.6.4"
-  gem "rspec", "~> 2.13.0"
+  gem "rspec", "~> 2.14.1"
   gem "simplecov"
   gem "yard-thor"
   gem "yard"

data/README.md

@@ -67,6 +67,14 @@ file. To use the client without credentials, just leave out the
 <tt>username</tt> and <tt>password</tt> parameters. The <tt>password</tt>
 parameter is only required if <tt>username</tt> is specified.
 
+#### Using with Open ID
+
+It is very simple to authenticate with your Jenkins server that has Open ID
+authentication enabled. You will have to obtain your API token and use the API
+token as the password. For obtaining the API token, go to your user configuration
+page and click 'Show API Token'. Use this token for the `password` parameter when
+initializing the client.
+
 ### Cross-site Scripting (XSS) and Crumb Support
 
 Support for Jenkins crumbs has been added.  These allow an application to

data/Rakefile

@@ -22,6 +22,7 @@ Jeweler::Tasks.new do |gemspec|
 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.required_ruby_version    = '>= 1.9.2'
   gemspec.rubygems_version = '1.8.17'
 end
 

data/Vagrantfile

@@ -9,11 +9,11 @@ Vagrant.configure("2") do |config|
   config.vm.hostname = "jenkins-api-client"
 
   # Every Vagrant virtual environment requires a box to build off of.
-  config.vm.box = "Ubuntu-12.04-LTS"
+  config.vm.box = "opscode-ubuntu-12.04"
 
   # The url from where the 'config.vm.box' box will be fetched if it
   # doesn't already exist on the user's system.
-  config.vm.box_url = "https://s3-us-west-2.amazonaws.com/squishy.vagrant-boxes/precise64_squishy_2013-02-09.box"
+  config.vm.box_url = "https://opscode-vm-bento.s3.amazonaws.com/vagrant/opscode_ubuntu-12.04_provisionerless.box"
 
   # Assign this VM to a host-only network IP, allowing you to access it
   # via the IP. Host-only networks can talk to the host machine as well as
@@ -73,11 +73,12 @@ Vagrant.configure("2") do |config|
   config.vm.synced_folder ".", "/opt/jenkins_api_client"
 
   config.vm.provision :shell, :inline =>
-    " sudo apt-get install -y git rubygems libxslt-dev libxml2-dev;" +
+    " sudo apt-get update;" +
+    " sudo apt-get install -y git ruby1.9.1-full rubygems libxslt-dev libxml2-dev;" +
     " cd /opt/jenkins_api_client;" +
     " ls -lrt;" +
-    " ruby --version;" +
-    " sudo gem install bundler;" +
+    " ruby1.9.1 --version;" +
+    " sudo gem1.9.1 install bundler;" +
     " bundle install;" +
     " travis/setup.sh;" +
     " bundle exec rake unit_tests;" +

data/jenkins_api_client.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "jenkins_api_client"
-  s.version = "0.14.1"
+  s.version = "1.0.0.alpha.2"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kannan Manickam"]
-  s.date = "2013-08-19"
+  s.date = "2013-10-25"
   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"]
@@ -49,20 +49,26 @@ Gem::Specification.new do |s|
     "spec/func_tests/client_spec.rb",
     "spec/func_tests/job_spec.rb",
     "spec/func_tests/node_spec.rb",
+    "spec/func_tests/plugin_spec.rb",
     "spec/func_tests/spec_helper.rb",
     "spec/func_tests/system_spec.rb",
     "spec/func_tests/user_spec.rb",
     "spec/func_tests/view_spec.rb",
     "spec/unit_tests/build_queue_spec.rb",
     "spec/unit_tests/client_spec.rb",
+    "spec/unit_tests/fixtures/files/available_plugins.json",
     "spec/unit_tests/fixtures/files/computer_sample.xml",
+    "spec/unit_tests/fixtures/files/installed_plugins.json",
     "spec/unit_tests/fixtures/files/job_sample.xml",
+    "spec/unit_tests/fixtures/files/updatable_plugins.json",
     "spec/unit_tests/job_spec.rb",
     "spec/unit_tests/node_spec.rb",
+    "spec/unit_tests/plugin_spec.rb",
     "spec/unit_tests/spec_helper.rb",
     "spec/unit_tests/system_spec.rb",
     "spec/unit_tests/user_spec.rb",
     "spec/unit_tests/view_spec.rb",
+    "travis/hudson.model.UpdateCenter.xml",
     "travis/jenkins_config.xml",
     "travis/jenkins_config_with_crumb.xml",
     "travis/setup.sh",
@@ -72,6 +78,7 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "https://github.com/arangamani/jenkins_api_client"
   s.require_paths = ["lib"]
+  s.required_ruby_version = Gem::Requirement.new(">= 1.9.2")
   s.rubygems_version = "1.8.23"
   s.summary = "Jenkins JSON API Client"
 
@@ -79,38 +86,41 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<nokogiri>, ["~> 1.5.0"])
+      s.add_runtime_dependency(%q<nokogiri>, ["~> 1.6.0"])
       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<mixlib-shellout>, [">= 1.1.0"])
       s.add_development_dependency(%q<bundler>, [">= 1.0"])
       s.add_development_dependency(%q<jeweler>, [">= 1.6.4"])
-      s.add_development_dependency(%q<rspec>, ["~> 2.13.0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.14.1"])
       s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<yard-thor>, [">= 0"])
       s.add_development_dependency(%q<yard>, [">= 0"])
     else
-      s.add_dependency(%q<nokogiri>, ["~> 1.5.0"])
+      s.add_dependency(%q<nokogiri>, ["~> 1.6.0"])
       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<mixlib-shellout>, [">= 1.1.0"])
       s.add_dependency(%q<bundler>, [">= 1.0"])
       s.add_dependency(%q<jeweler>, [">= 1.6.4"])
-      s.add_dependency(%q<rspec>, ["~> 2.13.0"])
+      s.add_dependency(%q<rspec>, ["~> 2.14.1"])
       s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<yard-thor>, [">= 0"])
       s.add_dependency(%q<yard>, [">= 0"])
     end
   else
-    s.add_dependency(%q<nokogiri>, ["~> 1.5.0"])
+    s.add_dependency(%q<nokogiri>, ["~> 1.6.0"])
     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<mixlib-shellout>, [">= 1.1.0"])
     s.add_dependency(%q<bundler>, [">= 1.0"])
     s.add_dependency(%q<jeweler>, [">= 1.6.4"])
-    s.add_dependency(%q<rspec>, ["~> 2.13.0"])
+    s.add_dependency(%q<rspec>, ["~> 2.14.1"])
     s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<yard-thor>, [">= 0"])
     s.add_dependency(%q<yard>, [">= 0"])
   end
 end

data/lib/jenkins_api_client/client.rb

@@ -401,6 +401,14 @@ module JenkinsApi
     # @return [String] Response code returned from Jenkins
     #
     def post_config(url_prefix, xml)
+      post_data(url_prefix, xml, 'application/xml')
+    end
+
+    def post_json(url_prefix, json)
+      post_data(url_prefix, json, 'application/json')
+    end
+
+    def post_data(url_prefix, data, content_type)
       retries = @crumb_max_retries
       begin
         refresh_crumbs
@@ -408,8 +416,8 @@ module JenkinsApi
         url_prefix = URI.escape("#{@jenkins_path}#{url_prefix}")
         request = Net::HTTP::Post.new("#{url_prefix}")
         @logger.info "POST #{url_prefix}"
-        request.body = xml
-        request.content_type = 'application/xml'
+        request.body = data
+        request.content_type = content_type
         if @crumbs_enabled
           request[@crumb["crumbRequestField"]] = @crumb["crumb"]
         end
@@ -434,6 +442,24 @@ module JenkinsApi
       end
     end
 
+    def init_update_center
+      @logger.info "Initializing Jenkins Update Center..."
+      @logger.debug "Obtaining the JSON data for Update Center..."
+      # TODO: Clean me up
+      update_center_data = open("http://updates.jenkins-ci.org/update-center.json").read
+      # The Jenkins mirror returns the data in the following format
+      #   updateCenter.post(
+      #     {.. JSON data...}
+      #   );
+      # which is used by the Javascript used by the Jenkins UI to send to Jenkins.
+      #
+      update_center_data.gsub!("updateCenter.post(\n", "")
+      update_center_data.gsub!("\n);", "")
+
+      @logger.debug "Posting the obtained JSON to Jenkins Update Center..."
+      post_json("/updateCenter/byId/default/postBack", update_center_data)
+    end
+
     # Checks if Jenkins uses crumbs (i.e) the XSS disable option is checked in
     # Jenkins' security settings
     #

data/lib/jenkins_api_client/exceptions.rb

@@ -202,7 +202,7 @@ module JenkinsApi
       def initialize(logger, message = "", log_level = Logger::ERROR)
         message = "Internel Server Error. Perhaps the in-memory configuration" +
           " Jenkins is different from the disk configuration. Please try to" +
-          " reload the configuration" if message.empty?
+          " reload the configuration" if message.nil? || message.empty?
         super(logger, message)
       end
     end

data/lib/jenkins_api_client/node.rb

@@ -124,9 +124,8 @@ module JenkinsApi
       #   )
       #
       def create_dump_slave(params)
-        unless params[:name] && params[:slave_host] && params[:private_key_file]
-          raise ArgumentError, "Name, slave host, and private key file are" +
-            " required for creating a slave."
+        unless params[:name] && params[:slave_host]
+          raise ArgumentError, "Name, slave host are required for creating a slave."
         end
 
         @logger.info "Creating a dump slave '#{params[:name]}'"
@@ -137,7 +136,11 @@ module JenkinsApi
           :remote_fs => "/var/jenkins",
           :labels => params[:name],
           :slave_port => 22,
-          :mode => "normal"
+          :mode => "normal",
+          :credential_id => "",
+          :java_path => "",
+          :prefix_start_slave_cmd => "",
+          :suffix_start_slave_cmd => ""
         }
 
         params = default_params.merge(params)
@@ -165,8 +168,13 @@ module JenkinsApi
               "stapler-class" => "hudson.plugins.sshslaves.SSHLauncher",
               "host" => params[:slave_host],
               "port" => params[:slave_port],
-              "username" => params[:slave_user],
-              "privatekey" => params[:private_key_file],
+              "credentialsId" => params[:credential_id],
+              "javaPath" => params[:java_path],
+              "jvmOptions" => params[:jvm_options],
+              "prefixStartSlaveCmd" => params[:prefix_start_slave_cmd],
+              "suffixStartSlaveCmd" => params[:suffix_start_slave_cmd]
+              #"username" => params[:slave_user],
+              #"privatekey" => params[:private_key_file],
             }
           }.to_json
         }
@@ -294,6 +302,37 @@ module JenkinsApi
         @client.post_config("/computer/#{node_name}/config.xml", xml)
       end
 
+
+      def create_cred
+        post_params = {
+          "name" => "testcred",
+          "description" => "test cred description",
+          "json" => {
+            "domainCredentials" => {
+              "domain" => {
+                "name" => "",
+                "description" => "",
+              },
+              "credentials" => {
+                "scope" => "GLOBAL",
+                "id" => "",
+                "username" => "root",
+                "description" => "root users credential",
+                "privateKeySource" => {
+                  "value" => "0",
+                  "privateKey" => "blah blah blah",
+                  "stapler-class" => "com.cloudbees.jenkins.plugins.sshcredentials.impl.BasicSSHUserPrivateKey$DirectEntryPrivateKeySource"
+                },
+                "passphrase" => "",
+                "stapler-class" => "com.cloudbees.jenkins.plugins.sshcredentials.impl.BasicSSHUserPrivateKey",
+                "kind" => "com.cloudbees.jenkins.plugins.sshcredentials.impl.BasicSSHUserPrivateKey"
+              }
+            }
+          }.to_json
+        }
+        @client.api_post_request("/credentials/configSubmit", post_params)
+      end
+
     end
   end
 end

data/lib/jenkins_api_client/version.rb

@@ -29,7 +29,7 @@ module JenkinsApi
     # Tiny version of the gem used for patches
     TINY    = 0
     # Used for pre-releases
-    PRE     = 'alpha.1'
+    PRE     = 'alpha.2'
     # Version String of Jenkins API Client.
     VERSION = [MAJOR, MINOR, TINY, PRE].compact.join('.')
   end

data/spec/func_tests/client_spec.rb

@@ -65,12 +65,6 @@ describe JenkinsApi::Client do
           @client.get_hudson_version.class.should == String
         end
       end
-
-      describe "#get_server_date" do
-        it "Should return the server date" do
-          @client.get_server_date.class.should == String
-        end
-      end
     end
 
     describe "SubClassAccessorMethods" do

data/spec/func_tests/{plugin_spec.rb.pending → plugin_spec.rb}

@@ -17,7 +17,7 @@ describe JenkinsApi::Client::PluginManager do
         @client = JenkinsApi::Client.new(
           YAML.load_file(File.expand_path(@creds_file, __FILE__))
         )
-        @client.plugin.check_for_updates
+        @client.init_update_center
         sleep 30
       rescue Exception => e
         puts "WARNING: Credentials are not set properly."
@@ -70,7 +70,7 @@ describe JenkinsApi::Client::PluginManager do
         it "installs multiple plugins given as an array" do
           @client.plugin.install(@test_plugins)
           # Plugin installation might take a bit
-          sleep 5
+          sleep 15
           @client.system.restart(true) if @client.plugin.restart_required?
           @client.system.wait_for_ready
           installed = @client.plugin.list_installed.keys

data/spec/unit_tests/plugin_spec.rb

@@ -5,7 +5,7 @@ describe JenkinsApi::Client::PluginManager do
   context "With properly initialized Client" do
     before do
       mock_logger = Logger.new "/dev/null"
-      @client = mock
+      @client = double
       @client.should_receive(:logger).and_return(mock_logger)
       @plugin = JenkinsApi::Client::PluginManager.new(@client)
       @installed_plugins = load_json_from_fixture("installed_plugins.json")

data/travis/setup.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/bin/bash -x
 
 # Install Jenkins
 wget -q -O - http://pkg.jenkins-ci.org/debian/jenkins-ci.org.key | sudo apt-key add -

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jenkins_api_client
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha.1
+  version: 1.0.0.alpha.2
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-15 00:00:00.000000000 Z
+date: 2013-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -130,7 +130,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: 2.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -138,7 +138,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: 2.14.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -234,7 +234,7 @@ files:
 - spec/func_tests/client_spec.rb
 - spec/func_tests/job_spec.rb
 - spec/func_tests/node_spec.rb
-- spec/func_tests/plugin_spec.rb.pending
+- spec/func_tests/plugin_spec.rb
 - spec/func_tests/spec_helper.rb
 - spec/func_tests/system_spec.rb
 - spec/func_tests/user_spec.rb
@@ -271,10 +271,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: -755549316541829445
+      version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: