jenkins2 0.1.0 → 1.0.0

data/lib/jenkins2/log.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 require 'logger'
 
@@ -5,11 +7,12 @@ module Jenkins2
 	class Log
 		extend SingleForwardable
 
-		def self.init( log: $stdout, verbose: 0 )
+		def self.init(log: $stderr, verbose: 0)
+			log ||= $stderr
 			@logger = Logger.new log
-			@logger.level = Logger::ERROR - verbose
-			@logger.formatter = proc do |severity, datetime, progname, msg|
-				if log == $stdout
+			@logger.level = Logger::ERROR - verbose.to_i
+			@logger.formatter = proc do |severity, datetime, _progname, msg|
+				if [$stdout, $stderr].include?(log)
 					"#{msg}\n"
 				else
 					"[#{datetime.strftime '%FT%T%:z'}] #{severity} #{msg}\n"
@@ -20,10 +23,8 @@ module Jenkins2
 
 		def_delegators :logger, :debug, :info, :warn, :error, :fatal, :unknown, :level
 
-		private
-
 		def self.logger
-			@logger ||= self.init
+			@logger ||= init
 		end
 	end
 end

data/lib/jenkins2/resource_proxy.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'erb'
+
+require_relative 'util'
+
+module Jenkins2
+	class ResourceProxy < ::BasicObject
+		attr_reader :connection, :path
+
+		def initialize(connection, path, params={}, &block)
+			@path = path
+			@id = nil
+			@connection, @params = connection, params
+			subject if block
+		end
+
+		def method_missing(message, *args, &block)
+			if respond_to_missing? message
+				::Jenkins2::Log.debug message
+				subject.send(message, *args, &block)
+			else
+				super
+			end
+		end
+
+		def respond_to_missing?(method_name, include_private=false)
+			subject.respond_to? method_name, include_private
+		end
+
+		def raw
+			@raw ||= connection.get_json(build_path, @params)
+		end
+
+		def subject
+			@subject ||= ::JSON.parse(raw.body, object_class: ::OpenStruct)
+		end
+
+		private
+
+		def build_path(*sections)
+			escaped_sections = [@id, sections].flatten.compact.collect{|i| ::ERB::Util.url_encode i }
+			::File.join(@path, *escaped_sections)
+		end
+	end
+end

data/lib/jenkins2/util.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'net/http'
+
+require_relative 'log'
+require_relative 'errors'
+
+module Jenkins2
+	module Util
+		extend self
+		# Waits for a block to return +truthful+ value. Useful, for example, when you set a node
+		# temporarily offline, and then wait for it to become idle.
+		# +max_wait_minutes+:: Maximum wait time in minutes.
+		# +&block+:: Run this block until it returs true, max_wait_minutes pass or block throws some
+		# kind of exception.
+		#
+		# Returns the result of a block, if it eventually succeeded or nil in case of timeout.
+		#
+		# Note that this is both a method of module Util, so you can <tt>include Jenkins::Util</tt>
+		# into your classes so they have a #wait method, as well as a module method, so you can call it
+		# directly as ::wait().
+		def wait(max_wait_minutes: 60)
+			[3, 5, 7, 15, 30, [60] * (max_wait_minutes - 1)].flatten.each do |sec|
+				begin
+					result = yield
+					return result if result
+					Log.warn{ "Received result is not truthy: #{result}." }
+					Log.warn{ "Retry request in #{sec} seconds." }
+					sleep sec
+				rescue Jenkins2::NotFoundError, Jenkins2::ServiceUnavailableError => e
+					Log.warn{ "Received error: #{e}." }
+					Log.warn{ "Retry request in #{sec} seconds." }
+					sleep sec
+				end
+			end
+			Log.error{ "Tired of waiting (#{max_wait_minutes} minutes). Give up." }
+			nil
+		end
+
+		# Tries a block several times, if raised exception is <tt>Net::HTTPFatalError</tt>,
+		# <tt>Errno::ECONNREFUSED</tt> or <tt>Net::ReadTimeout</tt>.
+		# +retries+:: Number of retries.
+		# +retry_delay+:: Seconds to sleep, before attempting next retry.
+		# +&block+:: Code to run inside <tt>retry</tt> loop.
+		#
+		# Returns the result of a block, if it eventually succeeded or throws the exception, thown by
+		# the block on last try.
+		#
+		# Note that this is both a method of module Util, so you can <tt>include Jenkins::Util</tt>
+		# into your classes so they have a #try method, as well as a module method, so you can call it
+		# directly as ::try().
+		def try(retries: 3, retry_delay: 5)
+			yield
+		rescue Errno::ECONNREFUSED, Net::HTTPFatalError, Net::ReadTimeout => e
+			i ||= 0
+			unless (i += 1) == retries
+				Log.warn{ "Received error: #{e}." }
+				Log.warn{ "Retry request in #{retry_delay} seconds. Retry number #{i}." }
+				sleep retry_delay
+				retry
+			end
+			Log.error{ "Received error: #{e}." }
+			Log.error{ "Reached maximum number of retries (#{retries}). Give up." }
+			raise e
+		end
+	end
+end

data/lib/jenkins2/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jenkins2
-	VERSION = '0.1.0'
+	VERSION = '1.0.0'
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: jenkins2
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Juri Timošin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-11 00:00:00.000000000 Z
+date: 2018-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: ci_reporter_minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.3'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.3'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -39,33 +39,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.5'
 - !ruby/object:Gem::Dependency
-  name: ci_reporter_minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '11.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '11.3'
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0.52'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0.52'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -80,34 +80,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
-- !ruby/object:Gem::Dependency
-  name: test-kitchen
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.17'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.17'
-- !ruby/object:Gem::Dependency
-  name: kitchen-lxd
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
 description: Command line interface and API client for Jenkins 2. Allows manipulating
   nodes, jobs, plugins, credentials. See README.md for details.
 email: draco.ater@gmail.com
@@ -121,17 +93,29 @@ files:
 - README.md
 - bin/jenkins2
 - lib/jenkins2.rb
-- lib/jenkins2/client.rb
-- lib/jenkins2/client/credential_commands.rb
-- lib/jenkins2/client/node_commands.rb
-- lib/jenkins2/client/plugin_commands.rb
-- lib/jenkins2/cmdparse.rb
-- lib/jenkins2/command_line.rb
+- lib/jenkins2/api.rb
+- lib/jenkins2/api/computer.rb
+- lib/jenkins2/api/credentials.rb
+- lib/jenkins2/api/job.rb
+- lib/jenkins2/api/plugins.rb
+- lib/jenkins2/api/root.rb
+- lib/jenkins2/api/rud.rb
+- lib/jenkins2/api/user.rb
+- lib/jenkins2/api/view.rb
+- lib/jenkins2/cli.rb
+- lib/jenkins2/cli/credentials.rb
+- lib/jenkins2/cli/job.rb
+- lib/jenkins2/cli/nodes.rb
+- lib/jenkins2/cli/plugins.rb
+- lib/jenkins2/cli/root.rb
+- lib/jenkins2/cli/user.rb
+- lib/jenkins2/cli/view.rb
+- lib/jenkins2/connection.rb
+- lib/jenkins2/errors.rb
 - lib/jenkins2/log.rb
-- lib/jenkins2/try.rb
-- lib/jenkins2/uri.rb
+- lib/jenkins2/resource_proxy.rb
+- lib/jenkins2/util.rb
 - lib/jenkins2/version.rb
-- lib/jenkins2/wait.rb
 homepage: https://bitbucket.org/DracoAter/jenkins2
 licenses:
 - MIT
@@ -144,7 +128,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/jenkins2/client.rb

@@ -1,127 +0,0 @@
-require 'net/http'
-require 'openssl'
-require 'json'
-
-require_relative 'log'
-require_relative 'uri'
-require_relative 'wait'
-require_relative 'client/credential_commands'
-require_relative 'client/node_commands'
-require_relative 'client/plugin_commands'
-
-module Jenkins2
-	# The entrance point for your Jenkins remote management.
-	class Client
-		include CredentialCommands
-		include PluginCommands
-		include NodeCommands
-		# Creates a "connection" to Jenkins.
-		# Keyword parameters:
-		# +server+:: Jenkins Server URL.
-		# +user+:: Jenkins API user. Can be omitted, if no authentication required.
-		# +key+:: Jenkins API key. Can be omitted, if no authentication required.
-		def initialize( **args )
-			@server = args[:server]
-			@user = args[:user]
-			@key = args[:key]
-			@crumb = nil
-		end
-
-		# Returns Jenkins version
-		def version
-			api_request( :get, '/', :raw )['X-Jenkins']
-		end
-
-		# Stops executing new builds, so that the system can be eventually shut down safely.
-		# Parameters are ignored
-		def prepare_for_shutdown( **args )
-			api_request( :post, '/quietDown' )
-		end
-
-		# Forcefully restart Jenkins NOW!
-		# Parameters are ignored
-		def restart!( **args )
-			api_request( :post, '/restart' )
-		end
-		
-		# Cancels the effect of +prepare-for-shutdown+ command.
-		# Parameters are ignored
-		def cancel_shutdown( **args )
-			api_request( :post, '/cancelQuietDown' )
-		end
-
-		# Waits for all the nodes to become idle or until +max_wait_minutes+ pass. Is expected to be
-		# called after +prepare_for_shutdown+, otherwise new builds will still be run.
-		# +max_wait_minutes+:: Maximum wait time in minutes. Default 60.
-		def wait_nodes_idle( max_wait_minutes: 60 )
-			Wait.wait( max_wait_minutes: max_wait_minutes ) do
-				api_request( :get, '/computer/api/json' )['busyExecutors'].zero?
-			end
-		end
-
-		# Job Commands
-
-		# Starts a build
-		# +job_name+:: Name of the job to build
-		# +build_params+:: Build parameters as hash, where keys are names of variables.
-		def build( **args )
-			job, params = args[:job], args[:params]
-			if params.nil? or params.empty?
-				api_request( :post, "/job/#{job}/build" )
-			else
-				api_request( :post, "/job/#{job}/buildWithParameters" ) do |req|
-					req.form_data = params
-				end
-			end
-		end
-
-		private
-		def api_request( method, path, reply_with=:json )
-			req = case method
-				when :get then Net::HTTP::Get
-				when :post then Net::HTTP::Post
-			end.new( URI File.join( @server, URI.escape( path ) ) )
-			Log.debug { "Request: #{method} #{req.uri}" }
-			req.basic_auth @user, @key
-			yield req if block_given?
-			req.content_type ||= 'application/x-www-form-urlencoded'
-			Log.debug { "Request content_type: #{req.content_type}, body: #{req.body}" }
-			begin
-				req[@crumb["crumbRequestField"]] = @crumb["crumb"] if @crumb
-				response = Net::HTTP.start( req.uri.hostname, req.uri.port, use_ssl: req.uri.scheme == 'https', verify_mode: OpenSSL::SSL::VERIFY_NONE ) do |http|
-					http.request req
-				end
-				handle_response( response, reply_with )
-			rescue Net::HTTPServerException => e
-				if e.message == "403 \"No valid crumb was included in the request\""
-					update_crumbs
-					retry
-				else
-					raise
-				end
-			end
-		end
-
-		def update_crumbs
-			@crumb = api_request( :get, '/crumbIssuer/api/json' )
-		end
-
-		def handle_response( response, reply_with )
-			Log.debug { "Response: #{response.code}, #{response.body}" }
-			case response
-			when Net::HTTPSuccess
-				case reply_with
-				when :json then JSON.parse response.body
-				when :body then response.body
-				when :raw then response
-				end
-			when Net::HTTPRedirection
-				response['location']
-			when Net::HTTPClientError, Net::HTTPServerError
-				response.value
-			else
-				response.value
-			end
-		end
-	end
-end

data/lib/jenkins2/client/credential_commands.rb

@@ -1,134 +0,0 @@
-module Jenkins2
-	class Client
-		module CredentialCommands
-			BOUNDARY = '----Jenkins2RubyMultipartClient' + rand(1000000).to_s
-
-			# Creates credentials based on provided arguments. Calls either:
-			# - +create_credential_username_password+
-			# - +create_credential_ssh+
-			# - +create_credential_secret_text+
-			# - +create_credential_secret_file+
-			# See those functions' documentation for the exact parameters required
-			def create_credential( **args )
-				return create_credential_username_password( args ) if args[:password]
-				return create_credential_ssh( args ) if args[:private_key]
-				return create_credential_secret_text( args ) if args[:secret]
-				return create_credential_secret_file( args ) if args[:content]
-			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_credential_username_password( **args )
-				json_body = { "" => "0",
-					credentials: args.merge(
-						'$class' => 'com.cloudbees.plugins.credentials.impl.UsernamePasswordCredentialsImpl'
-					)
-				}.to_json
-				api_request( :post, '/credentials/store/system/domain/_/createCredentials' ) do |req|
-					req.body = "json=#{CGI::escape json_body}"
-					req.content_type = 'application/x-www-form-urlencoded'
-				end
-			end
-
-			# Creates ssh username with private key credential. Jenkins must have ssh-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.
-			# +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_credential_ssh( **args )
-				json_body = { "" => "1",
-					credentials: {
-						scope: args[:scope],
-						username: args[:username],
-						privateKeySource: {
-							value: "0",
-							privateKey: args[:private_key],
-							'stapler-class' => 'com.cloudbees.jenkins.plugins.sshcredentials.impl.BasicSSHUserPrivateKey$DirectEntryPrivateKeySource'
-						},
-						passphrase: args[:passphrase],
-						id: args[:id],
-						description: args[:description],
-						'$class' => 'com.cloudbees.jenkins.plugins.sshcredentials.impl.BasicSSHUserPrivateKey'
-					}
-				}.to_json
-				api_request( :post, '/credentials/store/system/domain/_/createCredentials' ) do |req|
-					req.body = "json=#{CGI::escape json_body}"
-					req.content_type = 'application/x-www-form-urlencoded'
-				end
-			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_credential_secret_text( **args )
-				json_body = { "" => "3",
-					credentials: args.merge(
-						'$class' => 'org.jenkinsci.plugins.plaincredentials.impl.StringCredentialsImpl'
-					)
-				}.to_json
-				api_request( :post, '/credentials/store/system/domain/_/createCredentials' ) do |req|
-					req.body = "json=#{CGI::escape json_body}"
-					req.content_type = 'application/x-www-form-urlencoded'
-				end
-			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_credential_secret_file( **args )
-				filename = args.delete :filename
-				content = args.delete :content
-				body = "--#{BOUNDARY}\r\n"
-				body << "Content-Disposition: form-data; name=\"file0\"; filename=\"#{filename}\"\r\n"
-				body << "Content-Type: application/octet-stream\r\n\r\n"
-				body << content
-				body << "\r\n"
-				body << "--#{BOUNDARY}\r\n"
-				body << "Content-Disposition: form-data; name=\"json\"\r\n\r\n"
-				body << { "" => "2",
-					credentials: args.merge(
-						'$class' => 'org.jenkinsci.plugins.plaincredentials.impl.FileCredentialsImpl',
-						'file' => 'file0'
-					)
-				}.to_json
-				body << "\r\n\r\n--#{BOUNDARY}--\r\n"
-				api_request( :post, '/credentials/store/system/domain/_/createCredentials' ) do |req|
-					req.add_field 'Content-Type', "multipart/form-data, boundary=#{BOUNDARY}"
-					req.body = body
-				end
-			end
-
-			# Deletes credential
-			# +id+:: Credential's id
-			def delete_credential( id )
-				api_request( :post, "/credentials/store/system/domain/_/credential/#{id}/doDelete" ) do |req|
-					req.content_type = 'application/x-www-form-urlencoded'
-				end
-			end
-
-			# Returns credential as json. Raises Net::HTTPNotFound, if no such credential
-			# +id+:: Credential's id
-			def get_credential( id )
-				api_request( :get, "/credentials/store/system/domain/_/credential/#{id}/api/json" )
-			end
-
-			# Lists all credentials
-			def list_credentials( store: 'system', domain: '_' )
-				api_request( :get, "/credentials/store/#{store}/domain/#{domain}/api/json?depth=1" )['credentials']
-			end
-		end
-	end
-end