jenkins2 0.1.0 → 1.0.0

data/lib/jenkins2/api/credentials.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+require_relative 'rud'
+
+module Jenkins2
+	class API
+		module Credentials
+			def credentials(params={})
+				Proxy.new connection, 'credentials', params
+			end
+
+			class Proxy < ::Jenkins2::ResourceProxy
+				def store(id, params={})
+					path = build_path 'store', id
+					Store::Proxy.new connection, path, params
+				end
+			end
+
+			module Store
+				class Proxy < ::Jenkins2::ResourceProxy
+					def domain(id, params={})
+						Domain::Proxy.new(connection, build_path('domain', id), params)
+					end
+
+					def create_domain(config_xml)
+						connection.post(build_path('createDomain'), config_xml) do |req|
+							req['Content-Type'] = 'text/xml'
+						end.code == '200'
+					end
+				end
+
+				module Domain
+					class Proxy < ::Jenkins2::ResourceProxy
+						include ::Jenkins2::API::RUD
+
+						BOUNDARY = '----Jenkins2RubyMultipartClient' + rand(1_000_000).to_s
+
+						# Creates ssh username with private key credentials. Jenkins must have ssh-credentials
+						# plugin installed, to use this functionality. Accepts the following key-word
+						# parameters.
+						# +scope+:: Scope of the credential. GLOBAL or SYSTEM
+						# +id+:: Id of the credential. Will be Generated by Jenkins, if not provided.
+						# +description+:: Human readable text, what this credential is used for.
+						# +username+:: Ssh username.
+						# +private_key+:: Ssh private key, with new lines replaced by <tt>\n</tt> sequence.
+						# +passphrase+:: Passphrase for the private key. Empty string, if not provided.
+						def create_ssh(private_key:, **args)
+							json_body = {
+								'' => '1',
+								credentials: args.merge(
+									privateKeySource: {
+										value: '0',
+										privateKey: private_key,
+										'stapler-class' => 'com.cloudbees.jenkins.plugins.sshcredentials.impl.'\
+											'BasicSSHUserPrivateKey$DirectEntryPrivateKeySource'
+									},
+									'$class' => 'com.cloudbees.jenkins.plugins.sshcredentials.impl.'\
+										'BasicSSHUserPrivateKey'
+								)
+							}.to_json
+							create_("json=#{::CGI.escape json_body}")
+						end
+
+						# Creates a secret text credential. Jenkins must have plain-credentials plugin
+						# installed, to use this functionality. Accepts hash with the following parameters.
+						# +scope+:: Scope of the credential. GLOBAL or SYSTEM
+						# +id+:: Id of the credential. Will be Generated by Jenkins, if not provided.
+						# +description+:: Human readable text, what this credential is used for.
+						# +secret+:: Some secret text.
+						def create_secret_text(**args)
+							json_body = {
+								'' => '3',
+								credentials: args.merge(
+									'$class' => 'org.jenkinsci.plugins.plaincredentials.impl.StringCredentialsImpl'
+								)
+							}.to_json
+							create_("json=#{::CGI.escape json_body}")
+						end
+
+						# Creates a secret file credential. Jenkins must have plain-credentials plugin
+						# installed, to use this functionality. Accepts hash with the following parameters.
+						# +scope+:: Scope of the credential. GLOBAL or SYSTEM
+						# +id+:: Id of the credential. Will be Generated by Jenkins, if not provided.
+						# +description+:: Human readable text, what this credential is used for.
+						# +filename+:: Name of the file.
+						# +content+:: File content.
+						def create_secret_file(filename:, content:, **args)
+							body = "--#{BOUNDARY}\r\n"\
+								"Content-Disposition: form-data; name=\"file0\"; filename=\"#{filename}\"\r\n"\
+								"Content-Type: application/octet-stream\r\n\r\n"\
+								"#{content}\r\n"\
+								"--#{BOUNDARY}\r\n"\
+								"Content-Disposition: form-data; name=\"json\"\r\n\r\n"\
+								"#{{
+									'' => '2',
+									credentials: args.merge(
+										'$class' => 'org.jenkinsci.plugins.plaincredentials.impl.FileCredentialsImpl',
+										'file' => 'file0'
+									)
+								}.to_json}"\
+								"\r\n\r\n--#{BOUNDARY}--\r\n"
+							create_(body, "multipart/form-data, boundary=#{BOUNDARY}")
+						end
+
+						# Creates username and password credential. Accepts hash with the following parameters.
+						# +scope+:: Scope of the credential. GLOBAL or SYSTEM
+						# +id+:: Id of the credential. Will be Generated by Jenkins, if not provided.
+						# +description+:: Human readable text, what this credential is used for.
+						# +username+:: Username.
+						# +password+:: Password in plain text.
+						def create_username_password(**args)
+							json_body = {
+								'' => '0',
+								credentials: args.merge(
+									'$class' => 'com.cloudbees.plugins.credentials.impl.'\
+										'UsernamePasswordCredentialsImpl'
+								)
+							}.to_json
+							create_("json=#{::CGI.escape json_body}")
+						end
+
+						def create_(body, content_type='application/x-www-form-urlencoded')
+							connection.post(build_path('createCredentials'), body) do |req|
+								req['Content-Type'] = content_type
+							end.code == '302'
+						end
+
+						def create(config_xml)
+							connection.post(build_path('createCredentials'), config_xml) do |req|
+								req['Content-Type'] = 'text/xml'
+							end.code == '200'
+						end
+
+						# Returns credential as json. Raises Net::HTTPNotFound, if no such credential
+						# +id+:: Credential's id
+						def credential(id, params={})
+							path = build_path 'credential', id
+							Credential::Proxy.new connection, path, params
+						end
+					end
+
+					module Credential
+						class Proxy < ::Jenkins2::ResourceProxy
+							include ::Jenkins2::API::RUD
+						end
+					end
+				end
+			end
+		end
+	end
+end

data/lib/jenkins2/api/job.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative 'rud'
+
+module Jenkins2
+	class API
+		module Job
+			def job(name, **params)
+				proxy = Proxy.new connection, 'job', params
+				proxy.id = name
+				proxy
+			end
+
+			class Proxy < ::Jenkins2::ResourceProxy
+				attr_accessor :id
+				include ::Jenkins2::API::RUD
+
+				def create(config_xml)
+					connection.post('createItem', config_xml, name: id) do |req|
+						req['Content-Type'] = 'text/xml'
+					end.code == '200'
+				end
+
+				def copy(from)
+					connection.post('createItem', nil, name: id, from: from, mode: 'copy').code == '302'
+				end
+
+				def disable
+					connection.post(build_path('disable')).code == '302'
+				end
+
+				def enable
+					connection.post(build_path('enable')).code == '302'
+				end
+
+				def build(build_parameters={})
+					if build_parameters.empty?
+						connection.post(build_path('build'))
+					else
+						connection.post(build_path('buildWithParameters'), nil, build_parameters)
+					end.code == '201'
+				end
+
+				def polling
+					connection.post(build_path('polling')).code == '302'
+				end
+			end
+		end
+	end
+end

data/lib/jenkins2/api/plugins.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Jenkins2
+	class API
+		module Plugins
+			def plugins(**params)
+				Proxy.new connection, 'pluginManager', params
+			end
+
+			class Proxy < ::Jenkins2::ResourceProxy
+				BOUNDARY = '----Jenkins2RubyMultipartClient' + rand(1_000_000).to_s
+
+				def install(*short_names)
+					path = build_path 'install'
+					form_data = short_names.flatten.inject({}) do |memo, obj|
+						memo.merge "plugin.#{obj}.default" => 'on'
+					end.merge('dynamicLoad' => 'Install without restart')
+					connection.post(path, ::URI.encode_www_form(form_data)).code == '302'
+				end
+
+				def upload(hpi_file, filename)
+					body = "--#{BOUNDARY}\r\n"\
+						"Content-Disposition: form-data; name=\"file0\"; filename=\"#{filename}\"\r\n"\
+						"Content-Type: application/octet-stream\r\n\r\n"\
+						"#{hpi_file}\r\n"\
+						"--#{BOUNDARY}\r\n"\
+						"Content-Disposition: form-data; name=\"json\"\r\n\r\n"\
+						"\r\n\r\n--#{BOUNDARY}--\r\n"
+					connection.post(build_path('uploadPlugin'), body) do |req|
+						req['Content-Type'] = "multipart/form-data, boundary=#{BOUNDARY}"
+					end.code == '302'
+				end
+
+				def plugin(id, params={})
+					path = build_path 'plugin', id
+					Plugin::Proxy.new connection, path, params
+				end
+			end
+
+			module Plugin
+				class Proxy < ::Jenkins2::ResourceProxy
+					def uninstall
+						path = build_path 'doUninstall'
+						form_data = { 'Submit' => 'Yes', 'json' => '{}' }
+						connection.post(path, ::URI.encode_www_form(form_data)).code == '302'
+					end
+
+					def active?
+						raw.instance_of? ::Net::HTTPOK and subject.active
+					end
+				end
+			end
+		end
+	end
+end

data/lib/jenkins2/api/root.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Jenkins2
+	class API
+		module Root
+			def root(**params)
+				Proxy.new connection, '', params
+			end
+
+			def version
+				connection.head('/')['X-Jenkins']
+			end
+
+			def quiet_down
+				connection.post('quietDown').code == '302'
+			end
+
+			def cancel_quiet_down
+				connection.post('cancelQuietDown').code == '302'
+			end
+
+			def restart
+				connection.post('safeRestart').code == '302'
+			end
+
+			def restart!
+				connection.post('restart').code == '302'
+			end
+
+			class Proxy < ::Jenkins2::ResourceProxy
+			end
+		end
+	end
+end

data/lib/jenkins2/api/rud.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Jenkins2
+	class API
+		module RUD
+			# = Read
+			def config_xml
+				connection.get(build_path('config.xml')).body
+			end
+
+			def update(config_xml)
+				connection.post(build_path('config.xml'), config_xml).code == '200'
+			end
+
+			def delete
+				connection.post(build_path('doDelete')).code == '302'
+				# connection.delete(build_path('config.xml')).code == '302'
+			end
+		end
+	end
+end

data/lib/jenkins2/api/user.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Jenkins2
+	class API
+		module User
+			def me(**params)
+				Me::Proxy.new connection, 'me', params
+			end
+
+			def user(id, **params)
+				proxy = Proxy.new connection, 'user', params
+				proxy.id = id
+				proxy
+			end
+
+			def people(**params)
+				People::Proxy.new connection, 'people', params
+			end
+
+			class Proxy < ::Jenkins2::ResourceProxy
+				attr_accessor :id
+			end
+
+			module Me
+				class Proxy < ::Jenkins2::ResourceProxy
+				end
+			end
+
+			module People
+				class Proxy < ::Jenkins2::ResourceProxy
+				end
+			end
+		end
+	end
+end

data/lib/jenkins2/api/view.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative 'rud'
+
+module Jenkins2
+	class API
+		module View
+			MODE_LIST_VIEW = 'hudson.model.ListView'
+
+			def view(id, **params)
+				proxy = Proxy.new connection, 'view', params
+				proxy.id = id
+				proxy
+			end
+
+			def views(**params)
+				::Jenkins2::ResourceProxy.new(connection, '', params).views
+			end
+
+			class Proxy < ::Jenkins2::ResourceProxy
+				attr_accessor :id
+				include ::Jenkins2::API::RUD
+
+				def create(config_xml)
+					connection.post('createView', config_xml, name: id) do |req|
+						req['Content-Type'] = 'text/xml'
+					end.code == '200'
+				end
+
+				def add_job(job_name)
+					connection.post(build_path('addJobToView'), nil, name: job_name).code == '200'
+				end
+
+				def remove_job(job_name)
+					connection.post(build_path('removeJobFromView'), nil, name: job_name).code == '200'
+				end
+			end
+		end
+	end
+end

data/lib/jenkins2/cli.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+require 'optparse/uri'
+require 'yaml'
+
+require_relative 'version'
+require_relative 'cli/credentials'
+require_relative 'cli/nodes'
+require_relative 'cli/root'
+require_relative 'cli/plugins'
+require_relative 'cli/user'
+require_relative 'cli/view'
+
+module Jenkins2
+	class CLI
+		attr_reader :options, :errors
+
+		def initialize(options={})
+			@options = options.dup
+			@command = []
+			@errors = []
+			@parser = nil
+			add_options
+		end
+
+		def call
+			if options[:help]
+				summary
+			elsif options[:version]
+				Jenkins2::VERSION
+			elsif !errors.empty?
+				errors.join("\n") + "\n" + summary
+			else
+				run
+			end
+		end
+
+		def parse(args)
+			parser.order! args do |nonopt|
+				@command << nonopt
+				return command_to_class.new(options).parse(args) if command_to_class
+				next
+			end
+			missing = mandatory_arguments.select{|a| options[a].nil? }
+			@errors << "Missing argument(s): #{missing.join(', ')}." unless missing.empty?
+			self
+		end
+
+		# This method should be overwritten in subclasses
+		def self.description; end
+
+		def self.class_to_command
+			to_s.split('::').last.gsub(/(.)([A-Z])/, '\1-\2').downcase if superclass == Jenkins2::CLI
+		end
+
+		def self.subcommands
+			constants(false).collect{|c| const_get(c) }.select do |c|
+				c.is_a?(Class) and c.superclass == Jenkins2::CLI
+			end.sort_by(&:to_s)
+		end
+
+		private
+
+		# This method can be overwritten in subclasses, to add more mandatory arguments
+		def mandatory_arguments
+			[:server]
+		end
+
+		# This method should be overwritten in subclasses
+		def add_options; end
+
+		# This method should be overwritten in subclasses
+		def run
+			summary
+		end
+
+		def summary
+			if self.class.subcommands.empty?
+				global_parser.to_s + parser.to_s
+			else
+				parser.separator 'Commands:'
+				self.class.subcommands.each do |sc|
+					key = sc.class_to_command
+					parser.base.append(OptionParser::Switch::NoArgument.new(key, nil, [key], nil, nil,
+						[sc.description], proc{ OptionParser.new(&block) }), [], [key])
+				end
+				parser.to_s
+			end
+		end
+
+		def parser
+			@parser ||= if (key = self.class.class_to_command)
+				OptionParser.new do |parser|
+					parser.banner = 'Command:'
+					parser.top.append(OptionParser::Switch::NoArgument.new(key, nil, [key], nil,
+						nil, [self.class.description], proc{ OptionParser.new(&block) }), [], [key])
+				end
+			else
+				global_parser
+			end
+		end
+
+		def global_parser
+			@global_parser ||= OptionParser.new do |parser|
+				parser.banner = 'Usage: jenkins2 [global-arguments] <command> [command-arguments]'
+				parser.separator ''
+				parser.separator 'Global arguments (accepted by all commands):'
+				parser.on '-s', '--server URL', ::URI, 'Jenkins Server Url' do |s|
+					@options[:server] = s
+				end
+				parser.on '-u', '--user USER', 'Jenkins API User' do |u|
+					@options[:user] = u
+				end
+				parser.on '-k', '--key KEY', 'Jenkins API Key' do |k|
+					@options[:key] = k
+				end
+				parser.on '-c', '--config [PATH]', %(Read configuration file. All global options can be \
+configured in configuration file. File format is yaml. Arguments provided in command line will \
+overwrite those in configuration file. Program looks for .jenkins2.conf in current directory if \
+no PATH is provided.) do |c|
+					@options[:config] = c || ::File.join('.jenkins2.conf')
+					config_file_options = YAML.load_file(options[:config])
+					@options = config_file_options.merge options
+				end
+				parser.on '-l', '--log FILE', 'Log file. Prints to standard out, if not provided' do |l|
+					@options[:log] = l
+				end
+				parser.on '-v', '--verbose VALUE', Integer, 'Print more info. 1 up to 3. Prints only '\
+					'errors by default.' do |v|
+					@options[:verbose] = v
+				end
+				parser.on '-h', '--help', 'Show help' do
+					@options[:help] = true
+				end
+				parser.on '-V', '--version', 'Show version' do
+					@options[:version] = true
+				end
+				parser.separator ''
+				parser.separator 'For command specific arguments run: jenkins2 --help <command>'
+				parser.separator ''
+			end
+		end
+
+		def command_to_class
+			const = @command.join('-').split('-').map(&:capitalize).join
+			if self.class.const_defined?(const)
+				klass = self.class.const_get(const)
+				return klass if klass.is_a?(Class) and klass.superclass == Jenkins2::CLI
+			end
+			nil
+		end
+
+		def jc
+			@jc ||= Jenkins2.connect options
+		end
+	end
+end