hudkins 0.0.1

data/.autotest

@@ -0,0 +1,23 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+# Autotest.add_hook :initialize do |at|
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception 'vendor'
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+# end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/History.txt

@@ -0,0 +1,6 @@
+=== 0.0.1 / 2011-09-16
+
+* 1 major enhancement
+
+  * Ported hapi repo to hudkins for public release.
+

data/Manifest.txt

@@ -0,0 +1,29 @@
+.autotest
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/hudkins
+lib/assets/config.xml
+lib/assets/config_snippets/builders.xml
+lib/assets/free_style_project.xml.erb
+lib/assets/hudkinsrc
+lib/hudkins.rb
+lib/hudkins/command.rb
+lib/hudkins/command/exec.rb
+lib/hudkins/command/irb_start.rb
+lib/hudkins/common.rb
+lib/hudkins/errors.rb
+lib/hudkins/job.rb
+lib/hudkins/jobs.rb
+lib/hudkins/mixin.rb
+lib/hudkins/rake.rb
+lib/hudkins/restclient.rb
+lib/hudkins/sysinfo.rb
+test/fixtures/config.erb
+test/fixtures/jobs.erb
+test/fixtures/new_project_config.erb
+test/test_helper.rb
+test/unit/hudkins/test_job.rb
+test/unit/hudkins/test_jobs.rb
+test/unit/test_hudkins.rb

data/README.txt

@@ -0,0 +1,98 @@
+= hudkins
+
+* http://github.com/bhenderson/hudkins
+
+== DESCRIPTION:
+
+Hudson interaction gem.
+
+== FEATURES/PROBLEMS:
+
+* so far this is mostly for inspection of current jobs. There are quite a few
+  options in hudson for creating a new job and these haven't been implemented
+  yet.
+
+=== Implemented:
+
+* Create new job
+
+=== Unimplemented:
+
+* Copy job
+* Build Que
+
+* Hudson returns incorrect mime types!!! I've hacked it by setting response.type to the :accept header. This needs to be extracted out to dry up the code
+
+== SYNOPSIS:
+
+See Hudkins class documentation.
+  hud = Hudkins.new "http://example.com"
+  hud.jobs # => Hudkins::Jobs
+
+=== Working with Jobs
+
+  job = hud.jobs.find_by_name "project-main"
+  job.scm_url # => "https://subversion/project/branches/1.1"
+  job.scm_url = "https://subversion/project/branches/1.2"
+  job.post_config! # => Hudkins::Response
+  job.build!
+
+=== Creating new jobs
+
+  new_job = hud.add_job new_project_name
+  new_job.disabled? # => true
+  new_job.scm_url # => nil
+  new_job.scm_use :git/:svn, "http://svn/my_cool_repo/new_project_name/trunk"
+
+  job = hud.jobs.find_by_name :job_name
+  job2 = job.copy new_name ||
+         hud.copy_job job, new_name
+  job2.scm_url = "http://svn/new/url"
+  job2.post_config!
+
+
+== REQUIREMENTS:
+
+* heavily built ontop of "https://github.com/archiloque/rest-client"
+* see link:Rakefile
+
+== INSTALL:
+
+* git clone http://github.com/bhenderson/hudkins.git
+* cd hudkins/
+* rake package
+* gem install pkg/hudkins.gem
+
+== DEVELOPERS:
+
+After checking out the source, run:
+
+  $ rake newb
+
+This task will install any missing dependencies, run the tests/specs,
+and generate the RDoc.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2011
+
+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/Rakefile

@@ -0,0 +1,25 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+Hoe.plugin :isolate
+
+$:.unshift './'
+
+Hoe.spec 'hudkins' do
+  developer('Brian Henderson', 'bhenderson@attinteractive.com')
+  developer('Adam Avilla', 'bhenderson@attinteractive.com')
+
+  extra_deps << [ "json",              "~> 1.5.0"]
+  extra_deps << [ "nokogiri",          "~> 1.5.0"]
+  extra_deps << [ "rest-client",       "~> 1.6.1"]
+
+  extra_dev_deps << [ "minitest",      "~> 1.7.2"]
+  extra_dev_deps << [ "mocha",         "~> 0.9.8"]
+end
+
+
+#require "lib/hudkins/rake"
+
+# vim: syntax=ruby

data/bin/hudkins

@@ -0,0 +1,5 @@
+#!/user/bin/env ruby
+
+require "hudkins/command"
+
+Hudkins::Command.run

data/lib/assets/config.xml

@@ -0,0 +1,30 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<project>
+  <actions/>
+  <description>foo bar</description>
+  <keepDependencies>false</keepDependencies>
+  <properties/>
+  <scm class="hudson.scm.SubversionSCM">
+    <locations>
+      <hudson.scm.SubversionSCM_-ModuleLocation>
+        <remote>svn://subversion.flight.yellowpages.com/search/syndication/tags/1.1.0_201008</remote>
+      </hudson.scm.SubversionSCM_-ModuleLocation>
+    </locations>
+    <useUpdate>true</useUpdate>
+    <doRevert>false</doRevert>
+    <excludedRegions></excludedRegions>
+    <includedRegions></includedRegions>
+    <excludedUsers></excludedUsers>
+    <excludedRevprop></excludedRevprop>
+    <excludedCommitMessages></excludedCommitMessages>
+  </scm>
+  <assignedNode>master</assignedNode>
+  <canRoam>false</canRoam>
+  <disabled>true</disabled>
+  <blockBuildWhenUpstreamBuilding>false</blockBuildWhenUpstreamBuilding>
+  <triggers class="vector"/>
+  <concurrentBuild>false</concurrentBuild>
+  <builders/>
+  <publishers/>
+  <buildWrappers/>
+</project>

data/lib/assets/config_snippets/builders.xml

@@ -0,0 +1,5 @@
+<builders>
+  <hudson.tasks.Shell>
+    <command></command>
+  </hudson.tasks.Shell>
+</builders>

data/lib/assets/free_style_project.xml.erb

@@ -0,0 +1,14 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<project>
+  <keepDependencies>false</keepDependencies>
+  <properties/>
+  <scm class="hudson.scm.NullSCM"/>
+  <canRoam>true</canRoam>
+  <disabled>true</disabled>
+  <blockBuildWhenUpstreamBuilding>false</blockBuildWhenUpstreamBuilding>
+  <triggers class="vector"/>
+  <concurrentBuild>false</concurrentBuild>
+  <builders/>
+  <publishers/>
+  <buildWrappers/>
+</project>

data/lib/assets/hudkinsrc

@@ -0,0 +1,4 @@
+# Sample rc file
+---
+:host: http://example.com
+:verbose: true

data/lib/hudkins.rb

@@ -0,0 +1,263 @@
+require "rest_client"
+require "json"
+require "nokogiri"
+
+require "hudkins/restclient"
+require "hudkins/mixin"
+require "hudkins/common"
+
+##
+# === Description
+# Primary class used to interact with your Hudson server
+#
+# === Examples
+#   hud = Hudkins.new "http://my-hudson.localdomain.com:8080"
+#   hud.jobs # => Hudkins::Jobs
+#   job = hud.jobs.find_by_name :job_name
+#
+# == Command Line
+#   There is an included binary for doing simple commands.
+#   See Hudkins::Command#run_start_irb for a powerful way to interact with your
+#   hudson server at an irb cmd prompt.
+#
+class Hudkins
+  include Hudkins::Common
+  VERSION = '0.0.1'
+
+  attr_reader :host, :resource
+
+  ##
+  # === Examples
+  #   Hudkins.new <host_name> [opts]
+  #
+  #   <host_name> will be URI parsed
+  #
+  # === Options
+  # +host_timeout+::  number of seconds to timeout trying to connect to the server. see Hudkins#host_available?
+  #
+  def initialize(host = "http://example.com", opts = {})
+    @host = URI.parse( ENV["hudkins_host"] || host )
+    @options = opts
+    @resource = RestClient::Resource.new @host.to_s
+  end
+
+  ##
+  # === Description
+  # Reset what Hudkins#host is after initialization. Also updates Hudkins#reset_resource.
+  def host= host_name
+    @host = URI.parse host_name
+    # reinitialize @resource
+    resource = @host
+  end
+
+  ##
+  # === Description
+  # Update Hudkins#resource with new host name.
+  def reset_resource= uri = host, opts = {}
+    @resource = RestClient::Resource.new( uri.to_s, opts)
+  end
+
+  ##
+  # === Description
+  # Access to internal list of jobs. see Hudkins::Jobs
+  #
+  # One inital api call is made and then cached. See Hudkins#initialize_jobs
+  def jobs
+    @jobs ||= initialize_jobs
+  end
+
+  ##
+  # === Description
+  # Reload jobs from the server
+  def update_jobs
+    # I might need to reinitiailze
+    @jobs = initialize_jobs
+  end
+
+  ##
+  # === Description
+  # Available to make arbitrary HTTP/get calls to the server.
+  # Returns an Hudkins::Response object. (see that class for reasoning.)
+  #
+  # === Parameters
+  # +path+::  "/path/to/resource"
+  # +opts+::  {:accept => "text/plain"} (default)
+  # +block+:: { optional return block for RestClient#get }
+  def get path = nil, opts = {}, &block
+    use_resource :get, path, nil, opts, &block
+  end
+
+  ##
+  # === Description
+  # Available to make arbitrary HTTP/post calls to the server.
+  #
+  # === Parameters
+  # +path+::  "/path/to/resource"
+  # +data+::  "<?xml...>" (any object that responds to to_s).
+  # +opts+::  {:content => "text/plain"} (default)
+  # +block+:: { optional return block for RestClient#get }
+  def post path = nil, data = "", opts = {}, &block
+    use_resource :post, path, data, opts, &block
+  end
+
+  ##
+  # === Description
+  # Same as #get but attempt to parse the response body.
+  # Raise unless Response#success?
+  def get_parsed *args
+    parse_response get(*args)
+  end
+
+  ##
+  # === Description
+  # Same as #post but attempt to parse the response body.
+  # Raise unless Response#success?
+  def post_parsed *args
+    parse_response post(*args)
+  end
+
+  # Action methods
+
+  ##
+  # === Description
+  # TODO this needs cleaned up to be more like copy_job
+  # Use remote api to create a new job.
+  # Updates internal job list (Hudkins#jobs) afterwards
+  #
+  # === Example
+  #   hud.add_job :job_name, "<?xml..>"
+  #
+  # === Options
+  # +job_name+::    String or Symbol used as the name of the new job.
+  # +config_data+:: Uses provided template for bare-bones config, but
+  #                 optionally takes a string parameter (such as xml from
+  #                 another job's config)
+  #
+  # === Notes
+  # The remote api here is not fun. It uses HTTP#post instead of HTTP#create
+  # (which is normal) but the error messages are not very useful.
+  def add_job job_name, config_data = new_config
+    # yuck..
+    job = update_jobs.find_by_name( job_name )
+    unless job
+      response = post "/createItem?" + url_escape(:name => job_name), config_data, :content_type => "text/xml"
+      if response.success?
+        update_jobs.find_by_name job_name
+      else
+        case response.code
+        when 400
+          warn "the server returned an error. most likely the job name already exists."
+          jobs.find_by_name( job_name ) || ( raise response.errors )
+        else
+          warn "there was a problem."
+          raise response.errors
+        end
+      end
+    else
+      job
+    end
+  end
+
+  ##
+  # === Description
+  # Copy a job
+  #
+  # === Examples
+  #   new_job = hud.copy_job "job-name", "new-job-name"
+  #
+  #   job = hud.find_by_name "job-name"
+  #   new_job = hud.copy_job job, "new-job-name"
+  def copy_job job, new_job
+    job = Hudkins::Job === job ? job : jobs.find_by_name( job )
+    job.copy( new_job ) if job # find_by_name didn't return nil
+  end
+
+  ##
+  # === Description
+  # Gets the hudson version the server is running
+  #
+  # === Examples
+  #   hud.server_version # => "1.37.0"
+  def server_version
+    get.response.headers[:x_hudson]
+  end
+
+  def parse_string string, format
+    case format
+    when :xml then
+      Nokogiri::XML string
+    when :json then
+      JSON.parse string
+    else
+      raise "unsupported type #{format.inspect}"
+    end
+  end
+
+  private
+    def initialize_jobs
+      Hudkins::Jobs.new(self)
+    end
+
+    def get_default_options
+      {:accept => "text/plain"}
+    end
+
+    def post_default_options
+      {:content_type => "text/plain"}
+    end
+
+    def new_config
+      File.read( File.join( File.dirname(__FILE__), "assets", "free_style_project.xml.erb"  ) )
+    end
+
+    def use_resource verb, path, data = nil, opts = {}, &block
+      check_host_availability
+      # allow symbals
+      new_resource = path.nil? ? @resource : @resource[path.to_s]
+      args = [ send("#{verb}_default_options").merge( opts ) ]
+      # not sure how else to make this generic for both get and post
+      # maybe something like opts.delete :data
+      args.unshift data.to_s if data
+      new_resource.send(verb, *args, &(block || resource_block))
+    end
+
+    def resource_block
+      # restclient
+      # |response, request, result|
+      Proc.new {|*args| Response.new *args}
+    end
+
+    # body = @response.body, format = @response.format
+    def parse_response response
+      # I debated on wether or not to push up the raise statement. But it seems like I might want to do a "get" even if it doesn't return a valid response whereas why would I want to parse an invalid response?
+      raise response.result unless response.success?
+      body, format = response.body, response.type
+      begin
+        parse_string body, format
+      rescue => e
+        raise "unparsable response for #{response.request.url}.\n#{e.message}"
+      end
+    end
+
+    #def parse_response response
+      #raise response.result unless response.success?
+      #body = response.body
+      #begin
+        #case body
+        #when /^\s*<\?xml/ then
+          #Nokogiri::XML body
+        #when /^\s*\{/ then
+          #JSON.parse body
+        #else
+          #body
+        #end
+      #rescue => e
+        #raise "unparsable response. #{e.message}"
+      #end
+    #end
+  # private
+end # Hudkins
+
+require "hudkins/jobs"
+require "hudkins/job"
+require "hudkins/errors"