jenkins2-api 0.0.5 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cebe4d3e619b2cb154314f60490e055e180b0fd4
-  data.tar.gz: aee05428b659c60ed2c3271788e19b727f792ddf
+  metadata.gz: ce596bcac88f03c2226d88a297f7922760a599f7
+  data.tar.gz: 143eb32b438a562b5066f028264f5c68164799de
 SHA512:
-  metadata.gz: 451ad5c493b71ec0bfe0fac7d448aa73701ba96648b79e96ea2d7b19c464c22c3424988483b9c8991fe0054175a57485f578dd576761b952186d86a48bfb6256
-  data.tar.gz: 9fcc75cafafa59b96c3acfaf0553850124c6b3fbc7925ebc95dd6bb06982bd9e9d8c700dd648e787862ce9c29d37ab46a8c55854b0c576f48f2eeba604a5b373
+  metadata.gz: 455bb82a3071c90be0c389484027642d0559ab6f57cf98ee45cbd990e0e3eab8451298a792ad2f885dc427fcb278f96445ec8bbde8a33fccf85fa266b69c8b52
+  data.tar.gz: b6604ce550b178f1837ca48cc2cda2557dcdb01998cfe3eaff05d73d80b16045f7911ddf9490e38b948d71bfe2b19d8a0e5f4447db4fdaca500182e537d59845

data/README.md

@@ -0,0 +1,124 @@
+[![Gem Version](https://badge.fury.io/rb/jenkins2-api.svg)](https://badge.fury.io/rb/jenkins2-api)
+
+# API Client for Jenkins2
+
+## Install
+
+```
+gem install jenkins2-api
+```
+
+## Executable
+
+You can specify server and credentials with parameters:
+
+```
+--password
+--username
+--server
+```
+
+Or with environment variables:
+
+```
+JENKINS_SERVER=''
+JENKINS_USERNAME=''
+JENKINS_PASSWORD=''
+```
+
+Password can be a password or an API token from `/user/{user}/configure`
+
+### List computers / nodes
+
+```
+# List all nodes
+jenkins2api node all
+
+# Only slaves
+jenkins2api node slaves
+```
+
+### Get the name of the slave where a build was executed
+
+```
+jenkins2api build slave-name jobname buildid
+```
+
+If you build slave names contain an AWS EC2 ID, you you add `--ec2id` parameter to match for it
+and then it will print out only the ec2 instance id.
+
+```
+jenkins2api build slave-name jobname buildid --ec2id
+```
+
+## Ruby side
+
+All response are a generic Jenkins response. There are no wrapper classes around them.
+
+Create a new client:
+
+```
+require 'jenkins2-api'
+
+client = Jenkins2API::Client.new(
+  :server   => 'http://jenkins.example.com/',
+  :username => 'myusername',
+  :password => 'myapitoken'
+)
+```
+
+To list all the available jobs:
+
+```
+jobs = client.job.list
+jobs.each do |job|
+  puts "[%10s] #{job['name']}" % [job['color']]
+end
+```
+
+List all node:
+
+```
+nodes = client.node.all
+puts "Total Executors: #{nodes['totalExecutors']}"
+puts "Busy Executors: #{nodes['busyExecutors']}"
+
+puts "Executors:"
+nodes['computer'].each do |computer|
+  type = 'slave'
+  type = 'master' if computer['_class'] == 'hudson.model.Hudson$MasterComputer'
+  puts "  [%7s] #{computer['displayName']}" % [type]
+end
+```
+
+Get a specific job's latest build information:
+
+```
+build = client.build.latest('my-job')
+
+puts "Latest build: #{build['id']}"
+puts "Result: #{build['result']}"
+puts "URL: #{build['url']}"
+logfiles = build['artifacts'].select { |artifact| artifact['fileName'].match(/.*\.xml$/) }
+
+slave_name = client.build.slave_name('my-job', build['id'])
+
+puts "Build on: #{slave_name}"
+```
+
+Process junit reports:
+
+```
+failed_tests = []
+logfiles.each do |file|
+  results = Nokogiri::XML(client.artifact.get('my-job', build['id'], file))
+  failed_tests += results.xpath('//testcase').select do |testcase|
+    !testcase.children.empty?
+  end
+end
+
+puts "Failed tests:" unless failed_tests.empty?
+failed_tests.each do |failed|
+  puts "  [✘] #{failed['name']} on #{failed['classname']}"
+end
+```

data/lib/version.rb

@@ -1,4 +1,4 @@
 module Jenkins2API
-  VERSION = '0.0.5'
+  VERSION = '1.0.1'
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jenkins2-api
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 1.0.1
 platform: ruby
 authors:
 - Balazs Nadasdi
@@ -45,7 +45,7 @@ files:
 - lib/jenkins2-api.rb
 - lib/thor_command.rb
 - lib/version.rb
-homepage: https://github.com/Yitsushi/jenkins2-api
+homepage: https://yitsushi.github.io/jenkins2-api/
 licenses:
 - MIT
 metadata: {}