jenkins2-api 1.0.11 → 1.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0dc51dd8cb6002895b38bd52dcf06d5f03906fcd
-  data.tar.gz: 3ed37d6dac2519080c51c159efedc94c6f453280
+SHA256:
+  metadata.gz: b8f8387235bc79d14b363e9112d548612e6de47619d30206a5613435dc8c7854
+  data.tar.gz: 0f6312936b46c1f9d1cfbb17adb43f81e2aa0ec01727a25388927aae3c901f01
 SHA512:
-  metadata.gz: dca04af0bc21825a78a59c2d30ae1d07fc164bb7ef47fd8ca11d9c74c0df35d8d5e4a5b74a2f8b22ff7c9c80914af6e69148ab3088eea4a5d4bd0371d73d37ba
-  data.tar.gz: c5dcdd1e9c09beebef6a1ae5d1c82f972569d3fd71d2ae85481087ab5e3c8dfcf7499a662b1b410462008fb4b14aac49380a4831171ecc98b2aa8eae68e38fd4
+  metadata.gz: 30ec4147422b79b321f57e2ba4df7fda87ffc07c037b582435258b6d4ee67416002081e1345218fead43cda6e4715a3fd56d89a18fe457d6b2c018f89e4848db
+  data.tar.gz: adf0e7b3c6dbd226749ef7bc50dea960b2863164b179d86edfeed10ff83ccd158e6d3a825d49943780f70fe2540116b1b2fff4c2ba588495052bf2d1ad1aa1dc

data/README.md

@@ -123,3 +123,39 @@ failed_tests.each do |failed|
   puts "  [✘] #{failed['name']} on #{failed['classname']}"
 end
 ```
+
+#### List and Install plugins
+
+```
+p client.configuration.plugin_list
+
+client.configuration.plugin_install(
+  'Blue Ocean Pipeline Editor',  # Plugin name
+  'blueocean-pipeline-editor'    # Plugin ID
+)
+
+# Safe restart our jenkins master when all plugins are installed.
+client.configuration.safe_restart
+```
+
+From CLI:
+
+```
+jenkins2api plugin list
+jenkins2api plugin install 'Pipeline: Stage View Plugin' 'pipeline-stage-view'
+jenkins2api system safe-restart
+```
+
+#### Trigger a build
+
+```
+client.job.build('test-project', { GIT_BRANCH: 'experiment' })
+client.job.build('test-project-clone')
+```
+
+From CLI
+
+```
+jenkins2api job build test-project-clone
+jenkins2api job build test-project --params=GIT_BRANCH:experiment GIT_REPO:customrepo
+```

data/bin/jenkins2api

@@ -34,6 +34,18 @@ module Jenkins2API
         'node <command>',
         'Node related commands'
       )
+      register(
+        Jenkins2API::Command::Plugin,
+        'plugin',
+        'plugin <command>',
+        'Plugins related commands'
+      )
+      register(
+        Jenkins2API::Command::System,
+        'system',
+        'system <command>',
+        'System related commands'
+      )
     end
   end
 end

data/lib/client.rb

@@ -64,7 +64,7 @@ module Jenkins2API
     # ==== Params:
     # +method+:: +:post+ or +:get+
     # +path+:: Path to the Jenkins resource (e.g.: +/job/my-job/+)
-    # +response_type+:: +:json+ or +:raw+
+    # +response_type+:: +:json+, +:xml+ or +:raw+
     # +opts+:: sym options to pass to the endpoint. Applicable only if +:post+
     def api_request(method, path, response_type = :json, **opts)
       req = new_request(method, path, response_type, opts)
@@ -85,10 +85,11 @@ module Jenkins2API
     # Creates a new request for the API call
     # with default and required values
     def new_request(method, path, response_type, **opts)
-      response_type = :json unless %i[json raw].include?(response_type)
+      response_type = :json unless %i[json raw xml].include?(response_type)
 
       parts = [@server, URI.escape(path)]
       parts << 'api/json' if response_type == :json
+      parts << 'api/xml' if response_type == :xml
       uri = URI(File.join(parts))
       uri.query = URI.encode_www_form(opts)
 

data/lib/commands/build.rb

@@ -18,6 +18,12 @@ module Jenkins2API
 
         puts slave_name
       end
+
+      desc 'logs JOB_NAME BUILD_ID', 'Get the logs for a specific build'
+      # Retrieve logs for a specific job and join them by newline
+      def logs(name, build_id)
+        puts client.build.logtext_lines(name, build_id).join("\n")
+      end
     end
   end
 end

data/lib/commands/job.rb

@@ -5,6 +5,13 @@ module Jenkins2API
   module Command
     # Contains all the commands under +job+ namespace
     class Job < Jenkins2API::ThorCommand
+      desc 'build JOB_NAME', 'Start a build for a specific job'
+      method_option :params, default: {}, type: :hash
+      method_option :delay, default: 0, type: :numeric
+      # Start a build
+      def build(name)
+        client.job.build(name, options[:params], options[:delay])
+      end
     end
   end
 end

data/lib/commands/plugin.rb

@@ -0,0 +1,32 @@
+require 'thor'
+
+module Jenkins2API
+  # Command module wraps all the cli commands
+  module Command
+    # Contains all the commands under +plugin+ namespace
+    class Plugin < Jenkins2API::ThorCommand
+      desc 'list', 'List plugins'
+      # List installed plugins
+      def list
+        puts "Legend:\n  I  Inactive\n  U  Update is available\n"
+
+        client.configuration.plugin_list.each do |plugin|
+          flag = ' '
+          flag = 'I' unless plugin['active']
+          flag = 'U' if plugin['hasUpdate']
+
+          printf(
+            " [%s] %s (%s@%s)\n", flag, plugin['longName'],
+            plugin['shortName'], plugin['version']
+          )
+        end
+      end
+
+      desc 'install PLUGIN_NAME PLUGIN_ID', 'Install a specific plugin'
+      # Install a plugin
+      def install(name, id)
+        client.configuration.plugin_install(name, id)
+      end
+    end
+  end
+end

data/lib/commands/system.rb

@@ -0,0 +1,15 @@
+require 'thor'
+
+module Jenkins2API
+  # Command module wraps all the cli commands
+  module Command
+    # Contains all the commands under +system+ namespace
+    class System < Jenkins2API::ThorCommand
+      desc 'safe-restart', 'Restart jenkins in safe mode'
+      # Install a plugin
+      def safe_restart
+        client.configuration.safe_restart
+      end
+    end
+  end
+end

data/lib/endpoints/build.rb

@@ -28,7 +28,7 @@ module Jenkins2API
       # +name+:: Name of the Job
       # +build_id+:: ID of the build
       def test_results(name, build_id)
-        @client.api_request(:get, "/job/#{name}/#{build_id}/testReport")
+        @client.api_request(:get, "/job/#{name}/#{build_id}/testReport", :xml)
       end
 
       # Get +console log+ for a specific build as text

data/lib/endpoints/configuration.rb

@@ -22,6 +22,15 @@ module Jenkins2API
           :"plugin.#{short}.default" => 'on'
         )
       end
+
+      # Safe-restart jenkins
+      def safe_restart
+        @client.api_request(
+          :post,
+          '/updateCenter/safeRestart',
+          :raw
+        )
+      end
     end
   end
 end

data/lib/endpoints/job.rb

@@ -31,6 +31,38 @@ module Jenkins2API
         @client.api_request(:get, "/job/#{name}")['builds']
       end
 
+      # Get all available sub-jobs for a specific job
+      #
+      # ==== Params:
+      # +name+:: Name of the Job
+      #
+      # Returns with an array of jobs
+      def jobs(name)
+        @client.api_request(:get, "/job/#{name}")['jobs']
+      end
+
+      # Trigger a build on a specific job
+      #
+      # ==== Params:
+      # +name+:: Name of the job
+      # +parameters+:: Hash with build parameters,
+      #   key => valule pairs
+      # +delay+:: Delay the build in seconds
+      def build(name, parameters = {}, delay = 0)
+        post = { parameter: [] }
+        parameters.each do |key, value|
+          post[:parameter] << { name: key, value: value }
+        end
+
+        @client.api_request(
+          :post,
+          "/job/#{name}/build?delay=#{delay}sec",
+          :raw,
+          json: post.to_json
+        )
+      end
+
+      # Compatibility with jenkins-api gem (for Jenkins1)
       alias get_builds builds
     end
   end

data/lib/version.rb

@@ -1,5 +1,5 @@
 module Jenkins2API
   # Current version to publish
   # Gemspec also uses this constant
-  VERSION = '1.0.11'.freeze
+  VERSION = '1.0.17'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jenkins2-api
 version: !ruby/object:Gem::Version
-  version: 1.0.11
+  version: 1.0.17
 platform: ruby
 authors:
 - Balazs Nadasdi
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-05-02 00:00:00.000000000 Z
+date: 2020-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -28,16 +28,22 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +128,8 @@ files:
 - lib/commands/build.rb
 - lib/commands/job.rb
 - lib/commands/node.rb
+- lib/commands/plugin.rb
+- lib/commands/system.rb
 - lib/endpoints/artifact.rb
 - lib/endpoints/base_endpoint.rb
 - lib/endpoints/build.rb
@@ -142,7 +150,7 @@ homepage: https://yitsushi.github.io/jenkins2-api/
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -150,23 +158,22 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
-signing_key: 
+rubygems_version: 3.0.1
+signing_key:
 specification_version: 4
 summary: API client for Jenkins 2.
 test_files:
-- spec/features/build_spec.rb
+- spec/spec_helper.rb
 - spec/features/client_spec.rb
 - spec/features/job_spec.rb
-- spec/spec_helper.rb
+- spec/features/build_spec.rb
 - spec/support/fake_jenkins.rb
-- spec/support/fixtures/job_list.json
 - spec/support/fixtures/latest_build.json
+- spec/support/fixtures/job_list.json