jenkins_api_client 0.0.1

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+gem "nokogiri"
+gem "activesupport"
+
+group :development do
+  gem "bundler", "~> 1.2.1"
+  gem "jeweler", "~> 1.6.4"
+  gem "builder", "~> 3.1.3"
+end

data/README.md

@@ -0,0 +1,4 @@
+jenkins_api_client
+==================
+
+Client libraries for communicating with a Jenkins CI server

data/Rakefile

@@ -0,0 +1,24 @@
+require File.expand_path('../lib/jenkins_api_client', __FILE__)
+require File.expand_path('../lib/jenkins_api_client/version', __FILE__)
+require 'rake'
+require 'jeweler'
+
+Jeweler::Tasks.new do |gemspec|
+  gemspec.name         = 'jenkins_api_client'
+  gemspec.version      = JenkinsApi::Client::VERSION
+  gemspec.platform     = Gem::Platform::RUBY
+  gemspec.date         = Time.now.utc.strftime("%Y-%m-%d")
+  gemspec.require_path = 'lib'
+  gemspec.authors      = [ 'Kannan Manickam' ]
+  gemspec.email        = [ 'arangamani.kannan@gmail.com' ]
+  gemspec.homepage     = 'https://github.com/arangamani/jenkins_api_client'
+  gemspec.summary      = 'Jenkins JSON API Client'
+  gemspec.description  = %{
+This is a simple and easy-to-use Jenkins Api client with features focused on
+automating Job configuration programaticaly and so forth}
+  gemspec.rubygems_version = '1.8.17'
+  gemspec.add_runtime_dependency 'json'
+  gemspec.add_development_dependency 'rake',         '0.8.7'
+  gemspec.add_development_dependency 'activesupport'
+  gemspec.add_development_dependency 'bundler'
+end

data/lib/jenkins_api_client.rb

@@ -0,0 +1 @@
+require File.expand_path('../jenkins_api_client/client', __FILE__)

data/lib/jenkins_api_client/client.rb

@@ -0,0 +1,71 @@
+require 'rubygems'
+require 'json'
+require 'net/http'
+require 'nokogiri'
+require 'active_support/core_ext'
+require 'active_support/builder'
+
+require File.expand_path('../version', __FILE__)
+require File.expand_path('../exceptions', __FILE__)
+require File.expand_path('../job', __FILE__)
+
+module JenkinsApi
+  class Client
+
+    attr_accessor :server_ip, :server_port, :username, :password
+    DEFAULT_SERVER_PORT = 8080
+    VALID_PARAMS = %w(server_ip server_port username password)
+
+    # @param [Hash] args
+    def initialize(args)
+      args.each { |key, value|
+        instance_variable_set("@#{key}", value) if value
+      } if args.is_a? Hash
+     raise "Server IP is required to connect to Jenkins Server" unless @server_ip
+     raise "Credentials are required to connect to te Jenkins Server" unless @username && @password
+     @server_port = DEFAULT_SERVER_PORT unless @server_port
+    end
+
+    def job
+      JenkinsApi::Client::Job.new(self)
+    end
+
+    def to_s
+      "#<JenkinsApi::Client>"
+    end
+
+    def api_get_request(url_prefix)
+      http = Net::HTTP.start(@server_ip, @server_port)
+      request = Net::HTTP::Get.new("#{url_prefix}/api/json")
+      request.basic_auth @username, @password
+      response = http.request(request)
+      JSON.parse(response.body)
+    end
+
+    def api_post_request(url_prefix)
+      http = Net::HTTP.start(@server_ip, @server_port)
+      request = Net::HTTP::Post.new("#{url_prefix}")
+      request.basic_auth @username, @password
+      response = http.request(request)
+    end
+
+
+    def get_config(url_prefix)
+      http = Net::HTTP.start(@server_ip, @server_port)
+      request = Net::HTTP::Get.new("#{url_prefix}/config.xml")
+      request.basic_auth @username, @password
+      response = http.request(request)
+      response.body
+    end
+
+    def post_config(url_prefix, xml)
+      http = Net::HTTP.start(@server_ip, @server_port)
+      request = Net::HTTP::Post.new("#{url_prefix}/config.xml")
+      request.basic_auth @username, @password
+      request.body = xml
+      response = http.request(request)
+      response.code
+    end
+
+  end
+end

data/lib/jenkins_api_client/exceptions.rb

@@ -0,0 +1,11 @@
+module JenkinsApi
+  module Exceptions
+    class ApiException < RuntimeError
+
+      def initialize(message="")
+        super("Error: #{message}")
+      end
+
+    end
+  end
+end

data/lib/jenkins_api_client/job.rb

@@ -0,0 +1,151 @@
+module JenkinsApi
+  class Client
+    class Job
+
+      def initialize(client)
+        @client = client
+      end
+
+      def test_method
+        puts "Username is: #{@client}"
+      end
+
+      def list_all
+        response_json = @client.api_get_request("")
+        jobs = []
+        response_json["jobs"].each { |job|
+          jobs << job["name"]
+        }
+        jobs.sort!
+      end
+
+      def list(filter)
+        response_json = @client.api_get_request("")
+        jobs = []
+        response_json["jobs"].each { |job|
+          jobs << job["name"] if job["name"] =~ /#{filter}/i
+        }
+        jobs
+      end
+
+      def list_all_with_details
+       response_json = @client.api_get_request("")
+       response_json["jobs"]
+      end
+
+      def list_details(job_name)
+        @client.api_get_request("/job/#{job_name}")
+      end
+
+      def get_upstream_projects(job_name)
+        response_json = @client.api_get_request("/job/#{job_name}")
+        response_json["upstreamProjects"]
+      end
+
+      def get_downstream_projects(job_name)
+        response_json = @client.api_get_request("/job/#{job_name}")
+        response_json["downstreamProjects"]
+      end
+
+      def get_builds(job_name)
+        response_json = @client.api_get_request("/job/#{job_name}")
+        response_json["builds"]
+      end
+
+      def build(job_name)
+        @client.api_post_request("/job/#{job_name}/build")
+      end
+
+      def get_config(job_name)
+        @client.get_config("/job/#{job_name}")
+      end
+
+      def post_config(job_name, xml)
+        @client.post_config("/job/#{job_name}", xml)
+      end
+
+      def change_description(job_name)
+        xml = get_config(job_name)
+        n_xml = Nokogiri::XML(xml)
+        desc = n_xml.xpath("//description").first
+        desc.content = "Some description"
+        xml_modified = n_xml.to_xml
+        post_config(job_name, xml_modified)
+      end
+
+      def add_downstream_projects(job_name, downstream_project, threshold = 'success')
+        case threshold
+        when 'success'
+          name = 'SUCCESS'
+          ordinal = 0
+          color = 'BLUE'
+        when 'unstable'
+          name = 'UNSTABLE'
+          ordinal = 1
+          color = 'YELLOW'
+        when 'failure'
+          name = 'FAILURE'
+          ordinal = 2
+          color = 'RED'
+        end
+        xml = get_config(job_name)
+        n_xml = Nokogiri::XML(xml)
+        child_projects_node = n_xml.xpath("//childProjects").first
+        if child_projects_node
+          child_projects_node.content = child_projects_node.content + ", #{downstream_project}"
+        else
+          publisher_node = n_xml.xpath("//publishers").first
+          build_trigger_node = publisher_node.add_child("<hudson.tasks.BuildTrigger/>")
+          child_project_node = build_trigger_node.first.add_child("<childProjects>#{downstream_project}</childProjects>")
+          threshold_node = child_project_node.first.add_next_sibling("<threshold/>")
+          threshold_node.first.add_child("<name>#{name}</name><ordinal>#{ordinal}</ordinal><color>#{color}</color>")
+        end
+        xml_modified = n_xml.to_xml
+        post_config(job_name, xml_modified)
+      end
+
+      def remove_downstream_projects(job_name)
+        xml = get_config(job_name)
+        n_xml = Nokogiri::XML(xml)
+        n_xml.search("//hudson.tasks.BuildTrigger").each{ |node|
+          child_project_trigger = false
+          node.search("//childProjects").each { |child_node|
+            child_project_trigger = true
+            child_node.search("//threshold").each { |threshold_node|
+              threshold_node.children.each { |threshold_value_node|
+                threshold_value_node.content = nil
+                threshold_value_node.remove
+              }
+              threshold_node.content = nil
+              threshold_node.remove
+            }
+            child_node.content = nil
+            child_node.remove
+          }
+          node.content = nil
+          node.remove
+        }
+        publisher_node = n_xml.search("//publishers").first
+        publisher_node.content = nil if publisher_node.children.empty?
+        xml_modified = n_xml.to_xml
+        post_config(job_name, xml_modified)
+      end
+
+      def restrict_to_node(job_name, node_name)
+        xml = get_config(job_name)
+        n_xml = Nokogiri::XML(xml)
+        if (node = n_xml.xpath("//assignedNode").first)
+          node.content = node_name
+        else
+          project = n_xml.xpath("//scm").first
+          child_node = project.add_next_sibling("<assignedNode>#{node_name}</assignedNode>")
+          roam_node = n_xml.xpath("//canRoam").first
+          roam_node.content = "false"
+        end
+        xml_modified = n_xml.to_xml
+        post_config(job_name, xml_modified)
+      end
+
+    end
+  end
+end

data/lib/jenkins_api_client/version.rb

@@ -0,0 +1,6 @@
+
+module JenkinsApi
+  class Client
+    VERSION = "0.0.1"
+  end
+end

metadata

@@ -0,0 +1,205 @@
+--- !ruby/object:Gem::Specification
+name: jenkins_api_client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kannan Manickam
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  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: activesupport
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.3
+- !ruby/object:Gem::Dependency
+  name: json
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: ! '
+
+  This is a simple and easy-to-use Jenkins Api client with features focused on
+
+  automating Job configuration programaticaly and so forth'
+email:
+- arangamani.kannan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- Gemfile
+- README.md
+- Rakefile
+- lib/jenkins_api_client.rb
+- lib/jenkins_api_client/client.rb
+- lib/jenkins_api_client/exceptions.rb
+- lib/jenkins_api_client/job.rb
+- lib/jenkins_api_client/version.rb
+homepage: https://github.com/arangamani/jenkins_api_client
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -29913673152348123
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Jenkins JSON API Client
+test_files: []