hudson-remote-api 0.6.0 → 0.7.0

data/README.md

@@ -0,0 +1,175 @@
+[![Build Status](https://secure.travis-ci.org/Druwerd/hudson-remote-api.png)](http://travis-ci.org/Druwerd/hudson-remote-api)
+# hudson-remote-api
+hudson-remote-api is ruby library to talk to Hudson's xml remote access api
+
+## Installation:
+
+    gem install hudson-remote-api
+
+## Configuration:
+
+```ruby
+require 'hudson-remote-api'
+```
+
+```ruby
+# Auto Configuration 
+# detects Hudson instance on your network & sets Hudson[:url]
+Hudson.auto_config
+```
+Or
+
+```ruby
+# Manual Configuration
+Hudson[:url] = 'http://localhost:8080'
+Hudson[:user] = 'hudson'
+Hudson[:password] = 'password'
+
+# To turn off checking for crumbIssuer
+Hudson[:crumb] = false
+```
+## Usage:
+
+### List jobs
+```ruby
+# list all jobs
+Hudson::Job.list
+
+# list current active jobs
+Hudson::Job.list_active
+```
+
+### Build Queue
+```ruby
+# list all jobs in the build queue (waiting to run)
+Hudson::BuildQueue.list
+```
+
+### Create (or load existing) job
+```ruby
+j = Hudson::Job.new('my_new_job')
+```
+
+### Actions on a job
+```ruby
+j = Hudson::Job.new('my_new_job')
+
+# start a build
+j.build
+
+# start a parameterized build. Pass parameters as a Hash.
+j.build({ :awesome_dev => "thomasbiddle" })
+
+# create a copy of existing job
+j.copy('copy_of_my_job')
+
+# disable the job
+j.disable
+
+# enable the job
+j.enable
+
+# clear out the job's workspace
+j.wipe_out_workspace
+
+# wait (sleep) until the job has completed building
+j.wait_for_build_to_finish
+
+# delete the job
+j.delete
+```
+
+### Information on a job 
+```ruby
+j = Hudson::Job.new('job_name')
+
+# the job's URL address on Hudson server
+puts j.url
+
+# job's current build indicator color
+puts j.color
+
+# returns true if job is currently running
+j.active?
+
+# list of job's build numbers
+puts j.builds_list
+
+# latest build number
+puts j.last_build
+
+# latest successful build number
+puts j.last_successful_build
+
+# latest failed build number
+puts j.last_failed_build
+
+# next build number
+puts j.next_build_number
+
+# view current triggers
+# returns hash containing trigger name in key and trigger spec in value.
+# Example: {"hudson.triggers.TimerTrigger"=>"0 22 * * *", "hudson.triggers.SCMTrigger"=>"* * * * *"}
+j.triggers
+```
+
+### Information on a build
+```ruby
+# gets information on latest build
+b = Hudson::Build.new('job_name')
+
+# gets information on particular build number
+b = Hudson::Build.new('job_name', 42)
+
+# get commit revisions in this build
+puts b.revisions
+
+# get the result of this build
+puts b.result
+
+# get the culprit of this build
+puts b.culprit
+```
+
+### Modifying a job
+
+#### Set job description
+```ruby
+j.description = "My new job description"
+```
+
+#### Set repository
+```ruby
+# Git
+j.repository_url = { :url => 'https://github.com/beeplove/hudson-remote-api-mkhan.git', :branch => 'origin/master' }
+# or, only to change branch
+j.repository_url = { :branch => 'origin/master' }
+
+# SVN
+j.repository_url = "http://svn.myrepo.com"
+```
+
+#### Set build triggers
+```ruby
+j.triggers = { 'hudson.triggers.SCMTrigger' => '* * * * *'}
+# or, using shortcut
+j.triggers = { 'SCMTrigger' => '* * * * *', 'TimerTrigger' => '0 22 * * *'}
+
+# Add or update a trigger in existing triggers*
+j.triggers = j.triggers.merge({ 'hudson.triggers.TimerTrigger' => '0 22 * * *'})
+
+# Delete existing triggers
+j.triggers = {}
+# or,
+j.triggers = nil
+
+```
+*Avoid using shortcut form when editing a trigger in existing triggers
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/hudson-remote-api/job.rb

@@ -1,7 +1,7 @@
 module Hudson
     # This class provides an interface to Hudson jobs
     class Job < HudsonObject
-        attr_accessor :name, :config, :repository_url, :repository_urls, :repository_browser_location, :description
+        attr_accessor :name, :config, :repository_url, :repository_urls, :repository_browser_location, :description, :parameterized_job
         
 SVN_SCM_CONF = <<-SVN_SCM_STRING
   <scm class="hudson.scm.SubversionSCM">
@@ -78,6 +78,7 @@ SVN_SCM_STRING
           @xml_api_path = File.join(Hudson[:url], "job/#{@name}/api/xml")
           @xml_api_config_path = File.join(Hudson[:url], "job/#{@name}/config.xml")
           @xml_api_build_path = File.join(Hudson[:url], "job/#{@name}/build")
+          @xml_api_build_with_params_path = File.join(Hudson[:url], "job/#{@name}/buildWithParameters")
           @xml_api_disable_path = File.join(Hudson[:url], "job/#{@name}/disable")
           @xml_api_enable_path = File.join(Hudson[:url], "job/#{@name}/enable")
           @xml_api_delete_path  = File.join(Hudson[:url], "job/#{@name}/doDelete")
@@ -97,6 +98,11 @@ SVN_SCM_STRING
                 @description = @config_doc.elements["/project/description"].text || ""
             end
 
+            @parameterized_job = false
+            if @config_doc.elements["/project/properties/hudson.model.ParametersDefinitionProperty"]
+              @parameterized_job = true
+            end
+
             if @config_doc.elements["/project/scm"].attributes['class'] == "hudson.plugins.git.GitSCM"
                 @git = true
                 @repository_url = {}
@@ -302,9 +308,13 @@ SVN_SCM_STRING
           File.join( Hudson[:url], 'job', name) + '/'
         end
         
-        # Start building this job on Hudson server (can't build parameterized jobs)
-        def build()
-            response = send_post_request(@xml_api_build_path, {:delay => '0sec'})
+        # Start building this job on Hudson server
+        def build(params={})
+            if @parameterized_job
+              response = send_post_request(@xml_api_build_with_params_path, {:delay => '0sec'}.merge(params))
+            else
+              response = send_post_request(@xml_api_build_path, {:delay => '0sec'})
+            end
             response.is_a?(Net::HTTPSuccess) or response.is_a?(Net::HTTPRedirection)
         end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hudson-remote-api
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,21 +9,48 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-14 00:00:00.000000000 Z
-dependencies: []
+date: 2013-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Connect to Hudson's remote web API
 email: Druwerd@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE
-- README
+- README.md
 files:
-- LICENSE
-- README
-- Rakefile
-- VERSION
-- hudson-remote-api.gemspec
 - lib/hudson-remote-api.rb
 - lib/hudson-remote-api/build.rb
 - lib/hudson-remote-api/build_queue.rb
@@ -32,11 +59,8 @@ files:
 - lib/hudson-remote-api/job.rb
 - lib/hudson-remote-api/multicast.rb
 - lib/hudson-remote-api/new_job_config.xml
-- test/test_hudson_build.rb
-- test/test_hudson_build_queue.rb
-- test/test_hudson_config.rb
-- test/test_hudson_job.rb
-- test/test_hudson_multicast.rb
+- LICENSE
+- README.md
 homepage: http://github.com/Druwerd/hudson-remote-api
 licenses: []
 post_install_message: 
@@ -49,6 +73,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 651736009942463285
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -57,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: hudson-remote-api
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Connect to Hudson's remote web API

data/README

@@ -1,50 +0,0 @@
-hudson-remote-api is ruby library to talk to Hudson's xml remote access api
-
-Usage:
-
-require 'hudson-remote-api'
-
-# Auto Configuration sets Hudson[:url]
-Hudson.auto_config
-
-# Manual Configuration
-Hudson[:url] = 'http://localhost:8080'
-Hudson[:user] = 'hudson'
-Hudson[:password] = 'password'
-
-# To turn off checking for crumbIssuer
-Hudson[:crumb] = false
-
-# List all Hudson jobs
-Hudson::Job.list
-
-# List all active Hudson jobs
-Hudson::Job.list_active
-
-# print the last build number of a job
-j = Hudson::Job.new('jobname')
-puts j.last_build
-
-# if you are using hudson.plugins.git.GitSCM
-j.repository_url = { :url => 'https://github.com/beeplove/hudson-remote-api-mkhan.git', :branch => 'origin/master' }
-# or, only to change branch
-j.repository_url = { :branch => 'origin/master' }
-
-# Set build trigger
-j.triggers = { 'hudson.triggers.SCMTrigger' => '* * * * *'}
-# or, using shortcut
-j.triggers = { 'SCMTrigger' => '* * * * *', 'TimerTrigger' => '0 22 * * *'}
-
-# To add or update a trigger in existing triggers
-j.triggers = j.triggers.merge({ 'hudson.triggers.TimerTrigger' => '0 22 * * *'})
-# Avoid using shortcut form when to edit a trigger in existing triggers
-
-# To delete existing triggers
-j.triggers = {}
-# or,
-j.triggers = nil
-
-# To view current trigger
-j.triggers
-# would return hash containing trigger name in key and trigger spec in value.
-# Example of returned hash: {"hudson.triggers.TimerTrigger"=>"0 22 * * *", "hudson.triggers.SCMTrigger"=>"* * * * *"}

data/Rakefile

@@ -1,26 +0,0 @@
-require 'rubygems'
-require 'rake'
-require 'rake/testtask'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gemspec|
-    gemspec.name = "hudson-remote-api"
-    gemspec.summary = "Connect to Hudson's remote web API"
-    gemspec.description = "Connect to Hudson's remote web API"
-    gemspec.email = "Druwerd@gmail.com"
-    gemspec.homepage = "http://github.com/Druwerd/hudson-remote-api"
-    gemspec.authors = ["Dru Ibarra"]
-    gemspec.rubyforge_project = gemspec.name
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install jeweler -s http://gemcutter.org"
-end
-
-Rake::TestTask.new do |t|
- t.libs << 'test'
-end
-
-desc "Run tests"
-task :default => :test

data/VERSION

@@ -1 +0,0 @@
-0.6.0

data/hudson-remote-api.gemspec

@@ -1,54 +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 = "hudson-remote-api"
-  s.version = "0.6.0"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Dru Ibarra"]
-  s.date = "2012-07-14"
-  s.description = "Connect to Hudson's remote web API"
-  s.email = "Druwerd@gmail.com"
-  s.extra_rdoc_files = [
-    "LICENSE",
-    "README"
-  ]
-  s.files = [
-    "LICENSE",
-    "README",
-    "Rakefile",
-    "VERSION",
-    "hudson-remote-api.gemspec",
-    "lib/hudson-remote-api.rb",
-    "lib/hudson-remote-api/build.rb",
-    "lib/hudson-remote-api/build_queue.rb",
-    "lib/hudson-remote-api/config.rb",
-    "lib/hudson-remote-api/errors.rb",
-    "lib/hudson-remote-api/job.rb",
-    "lib/hudson-remote-api/multicast.rb",
-    "lib/hudson-remote-api/new_job_config.xml",
-    "test/test_hudson_build.rb",
-    "test/test_hudson_build_queue.rb",
-    "test/test_hudson_config.rb",
-    "test/test_hudson_job.rb",
-    "test/test_hudson_multicast.rb"
-  ]
-  s.homepage = "http://github.com/Druwerd/hudson-remote-api"
-  s.require_paths = ["lib"]
-  s.rubyforge_project = "hudson-remote-api"
-  s.rubygems_version = "1.8.24"
-  s.summary = "Connect to Hudson's remote web API"
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-    else
-    end
-  else
-  end
-end
-

data/test/test_hudson_build.rb

@@ -1,26 +0,0 @@
-require 'test/unit'
-$LOAD_PATH << File.dirname(__FILE__) + "/../lib"
-require 'hudson-remote-api.rb'
-
-class TestHudsonBuild < Test::Unit::TestCase
-  
-  def setup
-    assert Hudson::Job.new('test_job').build
-    assert Hudson::Build.new('test_job')
-  end
-  
-  def test_build_info
-    build = Hudson::Build.new('test_job')
-    assert_equal 'test_job', build.job.name
-    
-    assert build.number.to_i > 0, "build number test failed"
-    
-    assert build.revisions, "build revisions test failed"
-    assert build.revisions.kind_of?(Hash), "build revisions is not an Hash"
-    
-    assert_equal "SUCCESS", build.result, "build result test failed"
-    
-    assert_nil build.culprit, "build culprit test failed"
-  end
-  
-end

data/test/test_hudson_build_queue.rb

@@ -1,16 +0,0 @@
-require 'test/unit'
-$LOAD_PATH << File.dirname(__FILE__) + "/../lib"
-require 'hudson-remote-api.rb'
-
-class TestHudsonBuildQueue < Test::Unit::TestCase
-  
-  def test_list
-    assert Hudson::BuildQueue.list
-  end
-  
-  def test_load_xml_api
-    Hudson[:url] = "test.host.com"
-    assert_equal("http://test.host.com/queue/api/xml",
-                 Hudson::BuildQueue.__send__("class_variable_get", "@@xml_api_build_queue_info_path"))
-  end
-end

data/test/test_hudson_config.rb

@@ -1,37 +0,0 @@
-require 'test/unit'
-$LOAD_PATH << File.dirname(__FILE__) + "/../lib"
-require 'hudson-remote-api.rb'
-
-class TestHudsonConfig < Test::Unit::TestCase
-  
-  def test_get
-    assert Hudson[:url]
-  end
-  
-  def test_set
-    test_url = "test.host.com"
-    Hudson[:url] = test_url
-    assert_equal(Hudson[:url], "http://#{test_url}")
-  end
-  
-  def test_load_settings_hash
-    new_settings = {:url => 'test.com', :user => 'test', :password => 'test', :version => '1.00'}
-    Hudson.settings = new_settings
-    assert_equal(Hudson[:url], "http://#{new_settings[:url]}")
-    assert_equal(Hudson[:user], "test")
-    assert_equal(Hudson[:password], "test")
-    assert_equal(Hudson[:version], "1.00")
-    assert_equal(Hudson[:crumb], true)
-  end
-  
-  def test_auto_config
-    assert_nothing_thrown{ Hudson.auto_config }
-  end
-
-  def test_when_crumb_is_false
-    new_settings = {:url => 'test.com', :user => 'test', :password => 'test', :version => '1.00', :crumb => false}
-    Hudson.settings = new_settings
-    assert_equal(Hudson[:crumb], false)
-  end
-  
-end

data/test/test_hudson_job.rb

@@ -1,118 +0,0 @@
-require 'test/unit'
-$LOAD_PATH << File.dirname(__FILE__) + "/../lib"
-require 'hudson-remote-api.rb'
-
-class TestHudsonJob < Test::Unit::TestCase
-  TEST_SVN_REPO_URL = "http://svn.apache.org/repos/asf/subversion/trunk/doc/user/"
-  
-  def setup
-    Hudson[:url] = "http://localhost:8080"
-  end
-  
-  def test_list
-    assert Hudson::Job.list
-  end
-  
-  def test_list_active
-      assert Hudson::Job.list_active
-  end
-  
-  def test_create
-    new_job_name = 'new_test_job'
-    new_job = Hudson::Job.create(new_job_name)
-    assert new_job
-    assert_equal(new_job.name, new_job_name)
-    assert_equal(true, new_job.triggers.empty?, "New job should have empty triggers")
-    assert new_job.delete
-  end
-  
-  def test_get
-    job = Hudson::Job.get('test_job')
-    assert job
-    assert_equal 'test_job', job.name, "failed to get job name"
-  end
-  
-  def test_desc_update
-    job = Hudson::Job.new('test_job')
-    assert job.description = "test"
-    assert job.description != nil, "Job description should not be nil"
-  end
-  
-  def test_scm_url
-    job = Hudson::Job.new('test_svn_job')
-    job.build
-    assert job.repository_url = TEST_SVN_REPO_URL
-    
-    job = Hudson::Job.new('test_svn_job')
-    assert_equal TEST_SVN_REPO_URL, job.repository_url
-  end
-  
-  def test_new
-    job = Hudson::Job.new('test_job')
-    assert job
-    assert_equal(job.name, 'test_job')
-    
-    new_job = Hudson::Job.new('test_job2')
-    assert new_job
-    assert_equal('test_job2', new_job.name)
-    assert new_job.delete
-  end
-  
-  def test_copy
-    job = Hudson::Job.get('test_job')
-    new_job = job.copy
-    assert new_job
-    assert_equal(new_job.name, 'copy_of_test_job')
-    assert new_job.delete
-  end
-
-  def test_url
-    job = Hudson::Job.get("test_job")
-    assert_equal(job.url, "http://localhost:8080/job/#{job.name}/")
-  end
-  
-  def test_job_with_spaces
-    job = Hudson::Job.create('test job with spaces')
-    assert job
-    assert job.name
-    assert job.delete
-  end
-  
-  def test_builds_list
-    job = Hudson::Job.get("test_job")
-    assert job.builds_list.kind_of?(Array)
-  end
-
-  def test_triggers_set
-    job_name = 'build_triggers'
-    job = Hudson::Job.create(job_name)
-
-    job.triggers = { "hudson.triggers.SCMTrigger" => '* * * * *' }
-    assert_equal(1, job.triggers.size, "Failed to set triggers with 1 trigger.")
-    assert_equal({"hudson.triggers.SCMTrigger" => '* * * * *'}, job.triggers, "Failed to set triggers with 1 trigger.")
-
-    assert job.delete
-  end
-
-  def test_triggers_set_using_shortcut
-    job_name = 'build_triggers'
-    job = Hudson::Job.create(job_name)
-
-    job.triggers = { "SCMTrigger" => '* * * * *', 'TimerTrigger' => '0 22 * * *' }
-    assert_equal(2, job.triggers.size, "Failed to set triggers using shortcut.")
-    assert_equal({"hudson.triggers.SCMTrigger"=>"* * * * *", "hudson.triggers.TimerTrigger"=>"0 22 * * *"}, job.triggers, "Failed to set triggers using shortcut.")
-
-    assert job.delete
-  end
-
-  def test_triggers_delete
-    job_name = 'build_triggers'
-    job = Hudson::Job.create(job_name)
-
-    job.triggers = { "SCMTrigger" => '* * * * *', 'TimerTrigger' => '0 22 * * *' }
-    job.triggers = {}
-    assert_equal(true, job.triggers.empty?, "Failed to delete triggers.")
-
-    assert job.delete
-  end
-end

data/test/test_hudson_multicast.rb

@@ -1,11 +0,0 @@
-require 'test/unit'
-$LOAD_PATH << File.dirname(__FILE__) + "/../lib"
-require 'hudson-remote-api.rb'
-
-class TestHudsonMulticast < Test::Unit::TestCase
-  
-  def test_multicast
-    assert_nothing_thrown{ Hudson.discover }
-  end
-  
-end