hudson-remote-api 0.1.0

data/.gitignore

@@ -0,0 +1 @@
+hudson_settings.yml

data/README

@@ -0,0 +1,20 @@
+hudson-remote-api is ruby library to talk to Hudson's xml remote access api
+
+Usage:
+
+require 'hudson-remote-api'
+
+# Configuration
+Hudson[:host] = 'localhost'
+Hudson[:user] = 'hudson'
+Hudson[:password] = 'password'
+
+# 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

data/Rakefile

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'rake'
+
+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
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/hudson-remote-api.gemspec

@@ -0,0 +1,47 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{hudson-remote-api}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Dru Ibarra"]
+  s.date = %q{2010-09-01}
+  s.description = %q{Connect to Hudson's remote web API}
+  s.email = %q{Druwerd@gmail.com}
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    ".gitignore",
+     "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/errors.rb",
+     "lib/hudson-remote-api/job.rb"
+  ]
+  s.homepage = %q{http://github.com/Druwerd/hudson-remote-api}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{hudson-remote-api}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Connect to Hudson's remote web API}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/hudson-remote-api.rb

@@ -0,0 +1,72 @@
+# This set of classes provides a Ruby interface to Hudson's web xml API
+# 
+# Author:: Dru Ibarra
+
+require 'net/http'
+require 'rexml/document'
+require 'cgi'
+require 'yaml'
+require 'zlib'
+
+module Hudson
+  @@settings = {:host => 'localhost', :port => 80, :user => nil, :password => nil}
+
+  def self.[](param)
+    return @@settings[param]
+  end
+
+  def self.[]=(param,value)
+    @@settings[param]=value
+  end
+
+  def self.settings=(settings)
+    @@settings = settings
+  end
+
+  HUDSON_URL_ROOT = ""
+  # Base class for all Hudson objects
+  class HudsonObject
+
+    def self.get_xml(path)
+      request = Net::HTTP::Get.new(path)
+      request.basic_auth(Hudson[:user], Hudson[:password]) if Hudson[:user] and Hudson[:password]
+      request['Content-Type'] = "text/xml"
+      response = Net::HTTP.start(Hudson[:host], Hudson[:port]){|http| http.request(request)}
+
+      if response.is_a?(Net::HTTPSuccess) or response.is_a?(Net::HTTPRedirection)
+        encoding = response.get_fields("Content-Encoding")
+        if encoding and encoding.include?("gzip")
+          return Zlib::GzipReader.new(StringIO.new(response.body)).read
+        else
+          return response.body
+        end
+      else
+        puts response
+        raise APIError, "Error retrieving #{path}"
+      end
+    end
+
+    def get_xml(path)
+      self.class.get_xml(path)
+    end
+
+    def send_post_request(path, data={})
+      request = Net::HTTP::Post.new(path)
+      request.basic_auth(Hudson[:user], Hudson[:password]) if Hudson[:user] and Hudson[:password]
+      request.set_form_data(data)
+      #puts request.to_yaml
+      Net::HTTP.new(Hudson[:host], Hudson[:port]).start{|http| http.request(request)}
+    end
+
+    def send_xml_post_request(path, xml)
+      request = Net::HTTP::Post.new(path)
+      request.basic_auth(Hudson[:user], Hudson[:password]) if Hudson[:user] and Hudson[:password]
+      request.body = xml
+      #puts request.body
+      #puts request.to_yaml
+      Net::HTTP.new(Hudson[:host], Hudson[:port]).start{|http| http.request(request)}
+    end
+  end
+end
+
+Dir[File.dirname(__FILE__) + '/hudson-remote-api/*.rb'].each {|file| require file }

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

@@ -0,0 +1,29 @@
+require 'hudson-remote-api'
+module Hudson
+	class Build < HudsonObject
+		attr_reader :number, :job, :revisions, :result
+		
+		def initialize(job, build_number=nil)
+			@job = Job.new(job) if job.kind_of?(String)
+			@job = job if job.kind_of?(Hudson::Job)
+			if build_number
+				@number = build_number
+			else
+				@number = @job.last_build
+			end
+			@revisions = {}
+			load_build_info
+		end
+		
+		private
+		def load_build_info
+			path = "#{HUDSON_URL_ROOT}/job/#{@job.name}/#{@number}/api/xml"
+			build_info_xml = get_xml(path)
+            build_info_doc = REXML::Document.new(build_info_xml)
+			
+            if !build_info_doc.elements["/freeStyleBuild/changeSet"].nil?
+                build_info_doc.elements.each("/freeStyleBuild/changeSet/revision"){|e| @revisions[e.elements["module"].text] = e.elements["revision"].text }
+            end
+		end
+	end
+end

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

@@ -0,0 +1,18 @@
+require 'hudson-remote-api'
+module Hudson
+    # This class provides an interface to Hudson's build queue
+    class BuildQueue < HudsonObject
+        # List the jobs in the queue
+        def self.list()
+            path = "#{HUDSON_URL_ROOT}/queue/api/xml"
+            xml = get_xml(path)
+            queue = []
+            queue_doc = REXML::Document.new(xml)
+            return queue if queue_doc.elements["/queue/item"].nil?
+            queue_doc.each_element("/queue/item/task") do |job|
+                queue << job.elements["name"].text
+            end
+            queue
+        end
+    end
+end

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

@@ -0,0 +1,3 @@
+module Hudson
+    class APIError < StandardError; end
+end

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

@@ -0,0 +1,187 @@
+require 'hudson-remote-api'
+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_reader :color, :last_build, :last_completed_build, :last_failed_build, :last_stable_build, :last_successful_build, :last_unsuccessful_build, :next_build_number
+        
+        # List all Hudson jobs
+        def self.list()
+            path = "#{HUDSON_URL_ROOT}/api/xml"
+            xml = get_xml(path)
+            
+            jobs = []
+            jobs_doc = REXML::Document.new(xml)
+            jobs_doc.each_element("hudson/job") do |job|
+                jobs << job.elements["name"].text
+            end
+            jobs
+        end
+        
+        # List all jobs in active execution
+        def self.list_active
+            path = "#{HUDSON_URL_ROOT}/api/xml"
+            xml = get_xml(path)
+            
+            active_jobs = []
+            jobs_doc = REXML::Document.new(xml)
+            jobs_doc.each_element("hudson/job") do |job|
+                if job.elements["color"].text.include?("anime")
+                    active_jobs << job.elements["name"].text
+                end
+            end
+            active_jobs
+        end
+        
+        def initialize(name)
+            @name = name
+            load_config
+            load_info
+        end
+        
+        # Load data from Hudson's Job configuration settings into class variables
+        def load_config()
+            path = "#{HUDSON_URL_ROOT}/job/#{@name}/config.xml"
+            @config = get_xml(path)
+            @config_doc = REXML::Document.new(@config)
+            
+            @config_doc = REXML::Document.new(@config)
+            if !@config_doc.elements["/project/scm/locations/hudson.scm.SubversionSCM_-ModuleLocation/remote"].nil?
+                @repository_url = @config_doc.elements["/project/scm/locations/hudson.scm.SubversionSCM_-ModuleLocation/remote"].text || ""
+            end
+            @repository_urls = []
+            if !@config_doc.elements["/project/scm/locations"].nil?
+                @config_doc.elements.each("/project/scm/locations/hudson.scm.SubversionSCM_-ModuleLocation"){|e| @repository_urls << e.elements["remote"].text }
+            end
+            if !@config_doc.elements["/project/scm/browser/location"].nil?
+                @repository_browser_location = @config_doc.elements["/project/scm/browser/location"].text
+            end
+            @description = @config_doc.elements["/project/description"].text || ""
+        end
+        
+        def load_info()
+            path = "#{HUDSON_URL_ROOT}/job/#{@name}/api/xml"
+            @info = get_xml(path)
+            @info_doc = REXML::Document.new(@info)
+            
+            #FIXME: make sure it's really a freeStyleProject
+            @color = @info_doc.elements["/freeStyleProject/color"].text
+            @last_build = @info_doc.elements["/freeStyleProject/lastBuild/number"].text
+            @last_completed_build = @info_doc.elements["/freeStyleProject/lastCompletedBuild/number"].text
+            @last_failed_build = @info_doc.elements["/freeStyleProject/lastFailedBuild/number"].text if @info_doc.elements["/freeStyleProject/lastFailedBuild/number"]
+            @last_stable_build = @info_doc.elements["/freeStyleProject/lastStableBuild/number"].text if @info_doc.elements["/freeStyleProject/lastStableBuild/number"]
+            @last_successful_build = @info_doc.elements["/freeStyleProject/lastSuccessfulBuild/number"].text if @info_doc.elements["/freeStyleProject/lastSuccessfulBuild/number"]
+            @last_unsuccessful_build = @info_doc.elements["/freeStyleProject/lastUnsuccessfulBuild/number"].text if @info_doc.elements["/freeStyleProject/lastUnsuccessfulBuild/number"]
+            @next_build_number = @info_doc.elements["/freeStyleProject/nextBuildNumber"].text
+        end
+        
+        def active?
+            Job.list_active.include?(@name)
+        end
+        
+        def wait_for_build_to_finish(poll_freq=10)
+            loop do 
+                puts "waiting for all #{@name} builds to finish"
+                sleep poll_freq # wait
+                break if !active? and !BuildQueue.list.include?(@name)
+            end
+        end
+        
+        # Create a new job on Hudson server based on the current job object
+        def copy(new_job=nil)
+            new_job = "copy_of_#{@name}" if new_job.nil?
+            path = "#{HUDSON_URL_ROOT}/createItem"
+            
+            response = send_post_request(path, {:name=>new_job, :mode=>"copy", :from=>@name})
+            raise(APIError, "Error copying job #{@name}: #{response.body}") if response.class != Net::HTTPFound
+            Job.new(new_job)
+        end
+        
+        # Update the job configuration on Hudson server
+        def update(config=nil)
+            @config = config if !config.nil?
+            path = "#{HUDSON_URL_ROOT}/job/#{@name}/config.xml"
+            response = send_xml_post_request(path, @config)
+            response.is_a?(Net::HTTPSuccess) or response.is_a?(Net::HTTPRedirection)
+        end
+        
+        # Set the repository url and update on Hudson server
+        def repository_url=(repository_url)
+            return false if @repository_url.nil?
+            @repository_url = repository_url
+            @config_doc.elements["/project/scm/locations/hudson.scm.SubversionSCM_-ModuleLocation/remote"].text = repository_url
+            @config = @config_doc.to_s
+            update
+        end
+        
+        def repository_urls=(repository_urls)
+            return false if !repository_urls.class == Array
+            @repository_urls = repository_urls
+            
+            i = 0
+            @config_doc.elements.each("/project/scm/locations/hudson.scm.SubversionSCM_-ModuleLocation") do |location|
+                location.elements["remote"].text = @repository_urls[i]
+                i += 1
+            end
+
+            @config = @config_doc.to_s
+            update
+        end
+        
+        # Set the repository browser location and update on Hudson server
+        def repository_browser_location=(repository_browser_location)
+            @repository_browser_location = repository_browser_location
+            @config_doc.elements["/project/scm/browser/location"].text = repository_browser_location
+            @config = @config_doc.to_s
+            update
+        end
+        
+        # Set the job description and update on Hudson server
+        def description=(description)
+            @description = description
+            @config_doc.elements["/project/description"].text = description
+            @config = @config_doc.to_s
+            update
+        end
+        
+        # Start building this job on Hudson server (can't build parameterized jobs)
+        def build()
+            path = "#{HUDSON_URL_ROOT}/job/#{@name}/build"
+            response = send_post_request(path, {:delay => '0sec'})
+            response.is_a?(Net::HTTPSuccess) or response.is_a?(Net::HTTPRedirection)
+        end
+
+        def disable()
+            path = "#{HUDSON_URL_ROOT}/job/#{@name}/disable"
+            response = send_post_request(path)
+            puts response.class
+            response.is_a?(Net::HTTPSuccess) or response.is_a?(Net::HTTPRedirection)
+        end
+        
+        def enable()
+            path = "#{HUDSON_URL_ROOT}/job/#{@name}/enable"
+            response = send_post_request(path)
+            puts response.class
+            response.is_a?(Net::HTTPSuccess) or response.is_a?(Net::HTTPRedirection)
+        end
+        
+        # Delete this job from Hudson server
+        def delete()
+            path  = "#{HUDSON_URL_ROOT}/job/#{@name}/doDelete"
+            response = send_post_request(path)
+            response.is_a?(Net::HTTPSuccess) or response.is_a?(Net::HTTPRedirection)
+        end
+        
+        def wipe_out_workspace()
+            wait_for_build_to_finish
+            path = "#{HUDSON_URL_ROOT}/job/#{@name}/doWipeOutWorkspace"
+            if !active?
+                response = send_post_request(path)
+            else
+                response = false
+            end
+            response.is_a?(Net::HTTPSuccess) or response.is_a?(Net::HTTPRedirection)
+        end
+    end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: hudson-remote-api
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Dru Ibarra
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-01 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Connect to Hudson's remote web API
+email: Druwerd@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- .gitignore
+- 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/errors.rb
+- lib/hudson-remote-api/job.rb
+has_rdoc: true
+homepage: http://github.com/Druwerd/hudson-remote-api
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: hudson-remote-api
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Connect to Hudson's remote web API
+test_files: []
+