hudson-remote-api 0.1.0 → 0.2.0

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010 Dru Ibarra
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README

@@ -4,8 +4,11 @@ Usage:
 
 require 'hudson-remote-api'
 
-# Configuration
-Hudson[:host] = 'localhost'
+# Auto Configuration sets Hudson[:url]
+Hudson.auto_config
+
+# Manual Configuration
+Hudson[:url] = 'http://localhost:8080'
 Hudson[:user] = 'hudson'
 Hudson[:password] = 'password'
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/hudson-remote-api.gemspec

@@ -1,22 +1,24 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in rakefile, and run the gemspec command
+# 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.version = "0.2.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.date = %q{2010-09-03}
   s.description = %q{Connect to Hudson's remote web API}
   s.email = %q{Druwerd@gmail.com}
   s.extra_rdoc_files = [
-    "README"
+    "LICENSE",
+     "README"
   ]
   s.files = [
     ".gitignore",
+     "LICENSE",
      "README",
      "Rakefile",
      "VERSION",
@@ -24,8 +26,16 @@ Gem::Specification.new do |s|
      "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/job.rb",
+     "lib/hudson-remote-api/multicast.rb",
+     "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",
+     "test/test_hudson_remote_api.rb"
   ]
   s.homepage = %q{http://github.com/Druwerd/hudson-remote-api}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -33,6 +43,14 @@ Gem::Specification.new do |s|
   s.rubyforge_project = %q{hudson-remote-api}
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Connect to Hudson's remote web API}
+  s.test_files = [
+    "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",
+     "test/test_hudson_remote_api.rb"
+  ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/lib/hudson-remote-api.rb

@@ -3,35 +3,35 @@
 # Author:: Dru Ibarra
 
 require 'net/http'
+require 'uri'
 require 'rexml/document'
 require 'cgi'
 require 'yaml'
 require 'zlib'
+require File.dirname(__FILE__) + '/hudson-remote-api/config.rb'
 
 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)
+    
+    
+    def self.load_xml_api
+      @@hudson_xml_api_path = File.join(Hudson[:url], "api/xml")
+      @@xml_api_create_item_path = File.join(Hudson[:url], "createItem")
+    end
+    
+    load_xml_api
+    
+    def self.get_xml(url)
+      puts url
+      uri = URI.parse(url)
+      host = uri.host
+      port = uri.port
+      path = uri.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)}
+      response = Net::HTTP.start(host, port){|http| http.request(request)}
 
       if response.is_a?(Net::HTTPSuccess) or response.is_a?(Net::HTTPRedirection)
         encoding = response.get_fields("Content-Encoding")
@@ -50,21 +50,29 @@ module Hudson
       self.class.get_xml(path)
     end
 
-    def send_post_request(path, data={})
+    def send_post_request(url, data={})
+      uri = URI.parse(url)
+      host = uri.host
+      port = uri.port
+      path = uri.path
       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)}
+      Net::HTTP.new(host, port).start{|http| http.request(request)}
     end
 
     def send_xml_post_request(path, xml)
+      uri = URI.parse(url)
+      host = uri.host
+      port = uri.port
+      path = uri.path
       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)}
+      Net::HTTP.new(host, port).start{|http| http.request(request)}
     end
   end
 end

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

@@ -1,4 +1,3 @@
-require 'hudson-remote-api'
 module Hudson
 	class Build < HudsonObject
 		attr_reader :number, :job, :revisions, :result
@@ -12,18 +11,19 @@ module Hudson
 				@number = @job.last_build
 			end
 			@revisions = {}
+			@xml_api_build_info_path = File.join(Hudson[:url], "job/#{@job.name}/#{@number}/api/xml")
 			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
+			build_info_xml = get_xml(@xml_api_build_info_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

@@ -1,11 +1,16 @@
-require 'hudson-remote-api'
 module Hudson
     # This class provides an interface to Hudson's build queue
     class BuildQueue < HudsonObject
+        
+        def self.load_xml_api
+          @@xml_api_build_queue_info_path = File.join(Hudson[:url], "queue/api/xml")
+        end
+        
+        load_xml_api 
+      
         # List the jobs in the queue
         def self.list()
-            path = "#{HUDSON_URL_ROOT}/queue/api/xml"
-            xml = get_xml(path)
+            xml = get_xml(@@xml_api_build_queue_info_path)
             queue = []
             queue_doc = REXML::Document.new(xml)
             return queue if queue_doc.elements["/queue/item"].nil?

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

@@ -0,0 +1,46 @@
+require File.dirname(__FILE__) + '/multicast.rb'
+
+module Hudson
+  # set default settings
+  @@settings = {:url => 'http://localhost:8080', :user => nil, :password => nil, :version => nil}
+  
+  def self.[](param)
+    return @@settings[param]
+  end
+
+  def self.[]=(param,value)
+    param = param.to_sym if param.kind_of?(String)
+    if param == :host or param == :url
+      value = "http://#{value}" if value !~ /https?:\/\//
+      @@settings[:url] = value
+    else
+      @@settings[param]=value
+    end
+    HudsonObject::load_xml_api
+  end
+
+  def self.settings=(settings)
+    if settings.kind_of?(Hash)
+      settings.each do |param, value|
+        Hudson[param] = value
+      end
+    end
+  end
+  
+  # Discovers nearby Hudson server on the network and configures settings
+  def self.auto_config
+    xml_response = discover()
+    if xml_response
+      #puts xml_response
+      doc = REXML::Document.new(xml_response)
+      url = doc.elements["/hudson/url"]
+      if url
+        Hudson[:url] = url.text
+        Hudson[:version] = doc.elements["/hudson/version"].text
+        puts "found Hudson version #{Hudson[:version]} @ #{Hudson[:url]}"
+        return true
+      end
+    end
+  end
+  
+end

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

@@ -1,4 +1,3 @@
-require 'hudson-remote-api'
 module Hudson
     # This class provides an interface to Hudson jobs
     class Job < HudsonObject
@@ -8,8 +7,7 @@ module Hudson
         
         # List all Hudson jobs
         def self.list()
-            path = "#{HUDSON_URL_ROOT}/api/xml"
-            xml = get_xml(path)
+            xml = get_xml(@@hudson_xml_api_path)
             
             jobs = []
             jobs_doc = REXML::Document.new(xml)
@@ -21,8 +19,7 @@ module Hudson
         
         # List all jobs in active execution
         def self.list_active
-            path = "#{HUDSON_URL_ROOT}/api/xml"
-            xml = get_xml(path)
+            xml = get_xml(@@hudson_xml_api_path)
             
             active_jobs = []
             jobs_doc = REXML::Document.new(xml)
@@ -36,14 +33,24 @@ module Hudson
         
         def initialize(name)
             @name = name
+            load_xml_api
             load_config
             load_info
         end
         
+        def load_xml_api
+          @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_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")
+          @xml_api_wipe_out_workspace_path = File.join(Hudson[:url], "job/#{@name}/doWipeOutWorkspace")
+        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 = get_xml(@xml_api_config_path)
             @config_doc = REXML::Document.new(@config)
             
             @config_doc = REXML::Document.new(@config)
@@ -61,19 +68,19 @@ module Hudson
         end
         
         def load_info()
-            path = "#{HUDSON_URL_ROOT}/job/#{@name}/api/xml"
-            @info = get_xml(path)
+            @info = get_xml(@xml_api_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
+            if @info_doc.elements["/freeStylePorject"]
+              @color = @info_doc.elements["/freeStyleProject/color"].text if @info_doc.elements["/freeStyleProject/color"]
+              @last_build = @info_doc.elements["/freeStyleProject/lastBuild/number"].text if @info_doc.elements["/freeStyleProject/lastBuild/number"]
+              @last_completed_build = @info_doc.elements["/freeStyleProject/lastCompletedBuild/number"].text if @info_doc.elements["/freeStyleProject/lastCompletedBuild/number"]
+              @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 if @info_doc.elements["/freeStyleProject/nextBuildNumber"]
+            end
         end
         
         def active?
@@ -91,9 +98,8 @@ module Hudson
         # 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})
+            response = send_post_request(@@xml_api_create_item_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
@@ -101,8 +107,7 @@ module Hudson
         # 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 = send_xml_post_request(@xml_api_config_path, @config)
             response.is_a?(Net::HTTPSuccess) or response.is_a?(Net::HTTPRedirection)
         end
         
@@ -147,37 +152,33 @@ module Hudson
         
         # 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 = send_post_request(@xml_api_build_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)
+        def disable()            
+            response = send_post_request(@xml_api_disable_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)
+        def enable()            
+            response = send_post_request(@xml_api_enable_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 = send_post_request(@xml_api_delete_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)
+                response = send_post_request(@xml_api_wipe_out_workspace_path)
             else
                 response = false
             end

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

@@ -0,0 +1,22 @@
+require 'socket'
+require 'timeout'
+require 'rexml/document'
+
+module Hudson
+  def self.discover(multicast_addr = "239.77.124.213", port=33848, timeout_limit=5)
+    socket = UDPSocket.open
+    socket.setsockopt(Socket::IPPROTO_IP, Socket::IP_TTL, [1].pack('i'))
+    socket.send(ARGV.join(' '), 0, multicast_addr, port)
+    msg = nil
+    #msg, info = socket.recvfrom_nonblock(1024)
+    timeout(timeout_limit) do
+      msg, info = socket.recvfrom(1024)
+    end
+    msg
+  rescue Exception => e
+    puts e
+    nil
+  ensure
+    socket.close 
+  end
+end

data/test/test_hudson_build.rb

@@ -0,0 +1,12 @@
+require 'test/unit'
+$LOAD_PATH << File.dirname(__FILE__) + "/../lib"
+require 'hudson-remote-api.rb'
+
+class TestHudsonBuild < Test::Unit::TestCase
+  
+  def test_init
+    # TODO: load hudson build fixtures
+    #assert Hudson::Build.new('test_job')
+  end
+  
+end

data/test/test_hudson_build_queue.rb

@@ -0,0 +1,11 @@
+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
+  
+end

data/test/test_hudson_config.rb

@@ -0,0 +1,30 @@
+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")
+  end
+  
+  def test_auto_config
+    assert_nothing_thrown{ Hudson.auto_config }
+  end
+  
+end

data/test/test_hudson_job.rb

@@ -0,0 +1,19 @@
+require 'test/unit'
+$LOAD_PATH << File.dirname(__FILE__) + "/../lib"
+require 'hudson-remote-api.rb'
+
+class TestHudsonJob < Test::Unit::TestCase
+  
+  def test_list
+    assert Hudson::Job.list
+  end
+  
+  def test_list_active
+      assert Hudson::Job.list_active
+  end
+  
+  def test_init
+    # TODO: load job fixtures
+    #assert Hudson::Job.new('test_job')
+  end
+end

data/test/test_hudson_multicast.rb

@@ -0,0 +1,11 @@
+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

data/test/test_hudson_remote_api.rb

@@ -0,0 +1,2 @@
+test_files = Dir.glob("*.rb")
+test_files.each{|f| require f}

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: hudson-remote-api
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Dru Ibarra
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-01 00:00:00 -07:00
+date: 2010-09-03 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -26,9 +26,11 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
+- LICENSE
 - README
 files: 
 - .gitignore
+- LICENSE
 - README
 - Rakefile
 - VERSION
@@ -36,8 +38,16 @@ files:
 - 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
+- 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
+- test/test_hudson_remote_api.rb
 has_rdoc: true
 homepage: http://github.com/Druwerd/hudson-remote-api
 licenses: []
@@ -72,5 +82,10 @@ rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Connect to Hudson's remote web API
-test_files: []
-
+test_files: 
+- 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
+- test/test_hudson_remote_api.rb