jenkins2-api 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f548e9981de4f48fd4bc914b6679f0432c0e1261
-  data.tar.gz: 843887cb04a375b2ae75eb09f9ac5f8d8e586c99
+  metadata.gz: e066522b8efd20bd5b1f6a70d0d9b9f3e2ac48c4
+  data.tar.gz: 2481dbf92e587438d66f036210234966d4969c13
 SHA512:
-  metadata.gz: 6b342762cced5d396f367b628d0a418fdc4bdc5a0a2dfe4785f3a99440b1084de0109cacf6d6771f736c1ff403f6bc0c77aa93999b9005c834dafb7422e6ba61
-  data.tar.gz: 2414d7813cd1bf923388b0aed30615b417a7161950705f844164a952cfd99d9c77b7917b13a4105ca3948b1bea7bcba8730a3518932ff171f028d7f4465b91aa
+  metadata.gz: 74638d02bab0f644794e90004860ec502e40050dbd81af413d9642b0e9b052f14bdbfb45ee0eb161f5a56ef2322803c51611bc7013c52e748fabf4c3f8999b2d
+  data.tar.gz: 05afbcf3189101deb7922d252d6113a2a13aecba2ebe097faad651b4c1b2418cbb725df16d3b55454713c2634eaec296e812a43221be3f4da205f4eb9e195f98

data/README.md

@@ -1,4 +1,5 @@
 [![Gem Version](https://badge.fury.io/rb/jenkins2-api.svg)](https://badge.fury.io/rb/jenkins2-api)
+[![Build Status](https://travis-ci.org/Yitsushi/jenkins2-api.svg?branch=master)](https://travis-ci.org/Yitsushi/jenkins2-api)
 
 # API Client for Jenkins2
 

data/bin/jenkins2api

@@ -10,15 +10,30 @@ module Jenkins2API
     class Jenkins2 < Thor
       map %w[--version -v] => :__print_version
 
-      desc "--version, -v", "print the version"
+      desc '--version, -v', 'print the version'
       # Prints the current version number
       def __print_version
         puts Jenkins2API::VERSION
       end
 
-      register(Jenkins2API::Command::Job, 'job', 'job <command>', 'Job related commands')
-      register(Jenkins2API::Command::Build, 'build', 'build <command>', 'Build related commands')
-      register(Jenkins2API::Command::Node, 'node', 'node <command>', 'Node related commands')
+      register(
+        Jenkins2API::Command::Job,
+        'job',
+        'job <command>',
+        'Job related commands'
+      )
+      register(
+        Jenkins2API::Command::Build,
+        'build',
+        'build <command>',
+        'Build related commands'
+      )
+      register(
+        Jenkins2API::Command::Node,
+        'node',
+        'node <command>',
+        'Node related commands'
+      )
     end
   end
 end

data/lib/client.rb

@@ -19,31 +19,35 @@ module Jenkins2API
     # Throws an +ArgumentError+ if username is specified
     # but password is empty
     def initialize(**options)
-      @server   = options[:server]    || 'http://127.0.0.1/'
+      @server   = options[:server] || 'http://127.0.0.1/'
       @username = options[:username]
       @password = options[:password]
 
-      if @username && !@password
-        raise ArgumentError, "If username is provided, password is required"
-      end
+      return if @username && @password
+
+      raise ArgumentError, 'If username is provided, password is required'
     end
 
-    # Job related endpoints. Creates new +Jenkins2API::Endpoint::Job+ instance
+    # Job related endpoints.
+    # Creates new +Jenkins2API::Endpoint::Job+ instance
     def job
       @job ||= Endpoint::Job.new(self)
     end
 
-    # Build related endpoints. Creates new +Jenkins2API::Endpoint::Build+ instance
+    # Build related endpoints.
+    # Creates new +Jenkins2API::Endpoint::Build+ instance
     def build
       @build ||= Endpoint::Build.new(self)
     end
 
-    # Artifact related endpoints. Creates new +Jenkins2API::Endpoint::Artifact+ instance
+    # Artifact related endpoints.
+    # Creates new +Jenkins2API::Endpoint::Artifact+ instance
     def artifact
       @artifact ||= Endpoint::Artifact.new(self)
     end
 
-    # Node/Computer related endpoints. Creates new +Jenkins2API::Endpoint::Node+ instance
+    # Node/Computer related endpoints.
+    # Creates new +Jenkins2API::Endpoint::Node+ instance
     def node
       @node ||= Endpoint::Node.new(self)
     end
@@ -56,36 +60,45 @@ module Jenkins2API
     # +response_type+:: +:json+ or +:raw+
     # +opts+:: sym options to pass to the endpoint. Applicable only if +:post+
     def api_request(method, path, response_type = :json, **opts)
-      response_type = :json unless [:json, :raw].include?(response_type)
+      req = new_request(method, path, response_type, opts)
+      req.basic_auth @username, @password
+
+      yield req if block_given?
+
+      req.content_type ||= 'application/x-www-form-urlencoded'
+      response = Net::HTTP.start(req.uri.hostname, req.uri.port) do |http|
+        http.request(req)
+      end
+
+      handle_response(response, response_type)
+    end
+
+    # 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)
 
       parts = [@server, URI.escape(path)]
       parts << 'api/json' if response_type == :json
       uri = URI(File.join(parts))
-      uri.query = URI.encode_www_form(opts)
+      uri.query = URI.encode_www_form(opts) if method == :post
 
-      req = case method
-              when :get then Net::HTTP::Get
-              when :post then Net::HTTP::Post
+      case method
+      when :get then Net::HTTP::Get
+      when :post then Net::HTTP::Post
       end.new(uri)
+    end
 
-      req.basic_auth @username, @password
-      yield req if block_given?
-      req.content_type ||= 'application/x-www-form-urlencoded'
-      response = Net::HTTP.start(req.uri.hostname, req.uri.port) { |http| http.request req }
-
-      case response
-        when Net::HTTPSuccess
-          if response_type == :json
-            JSON.parse(response.body)
-          else
-            response.body
-          end
-        when Net::HTTPRedirection
-          puts "Redirect: #{response['location']}"
-          response['location']
-        else
-          puts "Response: #{response.code}, #{response.body}"
-          response.value
+    # Handles response based on response_type
+    def handle_response(response, response_type)
+      return response['location'] if response.is_a?(Net::HTTPRedirection)
+
+      response.value unless response.is_a?(Net::HTTPSuccess)
+
+      if response_type == :json
+        JSON.parse(response.body)
+      else
+        response.body
       end
     end
   end

data/lib/commands/build.rb

@@ -5,12 +5,16 @@ module Jenkins2API
   module Command
     # Contains all the commands under +build+ namespace
     class Build < Jenkins2API::ThorCommand
-      desc 'slave-name JOB_NAME BUILD_ID', 'Get Node name where a specific build was running'
-      method_option :ec2id, :default => false, :type => :boolean
+      desc 'slave-name JOB_NAME BUILD_ID', 'Get Node name for a specific build'
+      method_option :ec2id, default: false, type: :boolean
       # Displays the name of the slave where the build was executed
       def slave_name(name, build_id)
         slave_name = client.build.slave_name(name, build_id)
-        slave_name = slave_name.match(/(i-[0-9a-zA-Z]+)/).captures.first if options[:ec2id]
+        if options[:ec2id]
+          slave_name = slave_name.match(/(i-[0-9a-zA-Z]+)/)
+                                 .captures
+                                 .first
+        end
 
         puts slave_name
       end

data/lib/commands/job.rb

@@ -8,4 +8,3 @@ module Jenkins2API
     end
   end
 end
-

data/lib/commands/node.rb

@@ -5,29 +5,29 @@ module Jenkins2API
   module Command
     # Contains all the commands under +node+ namespace
     class Node < Jenkins2API::ThorCommand
+      # Jenkins java class of the master instance
+      MASTER_CLASS = 'hudson.model.Hudson$MasterComputer'.freeze
 
-      desc :all, "List all nodes"
+      desc :all, 'List all nodes'
       # List all available nodes
       def all
         nodes = client.node.all
         nodes['computer'].each do |computer|
           type = 'slave'
-          type = 'master' if computer['_class'] == 'hudson.model.Hudson$MasterComputer'
-          puts "[%5s] #{computer['displayName']}" % [type]
+          type = 'master' if computer['_class'] == MASTER_CLASS
+          printf("[%6s] %s\n", type, computer['displayName'])
         end
       end
 
-      desc :slaves, "List all slave nodes"
+      desc :slaves, 'List all slave nodes'
       # List all avilable slaves
       def slaves
         nodes = client.node.all
         nodes['computer'].each do |computer|
-          next if computer['_class'] == 'hudson.model.Hudson$MasterComputer'
+          next if computer['_class'] == MASTER_CLASS
           puts computer['displayName']
         end
       end
     end
   end
 end
-
-

data/lib/endpoints/artifact.rb

@@ -11,7 +11,7 @@ module Jenkins2API
       # +name+:: Job name
       # +build_id+:: ID of the build
       def all(name, build_id)
-        @client.build.get(name)['artifacts']
+        @client.build.get(name, build_id)['artifacts']
       end
 
       # Download a specific artifact.
@@ -19,11 +19,16 @@ module Jenkins2API
       # Params:
       # +name+:: Job name
       # +build_id+:: ID of the build
-      # +artifact+:: artifact +Hash+. this function uses only the +relativePath+ property
+      # +artifact+:: artifact +Hash+.
+      # This function uses only the +relativePath+ property
       #
       # Returns with the content of the artifact
       def get(name, build_id, artifact)
-        @client.api_request(:get, "/job/#{name}/#{build_id}/artifact/#{artifact['relativePath']}", :raw)
+        @client.api_request(
+          :get,
+          "/job/#{name}/#{build_id}/artifact/#{artifact['relativePath']}",
+          :raw
+        )
       end
     end
   end

data/lib/endpoints/build.rb

@@ -40,7 +40,11 @@ module Jenkins2API
       # Return an array of strings.
       # Each item in that array is a line from the log
       def logtext_lines(name, build_id)
-        @client.api_request(:get, "/job/#{name}/#{build_id}/logText/progressiveText", :raw).split("\r\n")
+        @client.api_request(
+          :get,
+          "/job/#{name}/#{build_id}/logText/progressiveText",
+          :raw
+        ).split("\r\n")
       end
 
       # Get the name of the slave where the build was executed
@@ -50,17 +54,33 @@ module Jenkins2API
       # +build_id+:: ID of the build
       def slave_name(name, build_id)
         log = logtext_lines(name, build_id)
-        relevant_line = log.select { |line| line.match(/^Running on /) }.first
 
-        name = relevant_line.match(/^Running on (.*) in \//).captures.first rescue nil
+        line = find_line(log, /^Running on /)
+        name = first_match(line, %r{^Running on (.*) in /})
 
         if name.nil?
-          relevant_line = log.select { |line| line.match(/Building remotely on/) }.first
-          name = relevant_line.match(/Building remotely on (.*) in workspace/).captures.first
+          line = find_line(log, /Building remotely on/)
+          name = first_match(line, /Building remotely on (.*) in workspace/)
         end
 
         name
       end
+
+      private
+
+      # find the first item in a string array
+      # that matches for a given regular expression
+      def find_line(lines, expression)
+        lines.select { |line| line.match(expression) }.first
+      end
+
+      # return the first capture block from a string
+      # that matches for a given regular expression
+      def first_match(line, expression)
+        line.match(expression).captures.first
+      rescue
+        nil
+      end
     end
   end
 end

data/lib/endpoints/job.rb

@@ -7,7 +7,7 @@ module Jenkins2API
     class Job < BaseEndpoint
       # Lists all available jobs
       def list
-        @client.api_request(:get, "")['jobs']
+        @client.api_request(:get, '')['jobs']
       end
 
       # Get all available builds for a specific job
@@ -22,4 +22,3 @@ module Jenkins2API
     end
   end
 end
-

data/lib/endpoints/node.rb

@@ -9,9 +9,8 @@ module Jenkins2API
       #
       # Returns with slaves and masters also
       def all
-        @client.api_request(:get, "/computer")
+        @client.api_request(:get, '/computer')
       end
     end
   end
 end
-

data/lib/thor_command.rb

@@ -5,11 +5,12 @@ module Jenkins2API
   # Wrapper class for commands. Checks if credentials are passed or not
   # and creates a new +Jenkins2API::Client+ instance for commands.
   class ThorCommand < Thor
-    class_option :password, :desc => "Password", :aliases => "-p", :required => false
-    class_option :username, :desc => "Username", :aliases => "-u", :required => false
-    class_option :server, :desc => "Server path", :aliases => "-s", :required => false
+    class_option :password, desc: 'Password', aliases: '-p', required: false
+    class_option :username, desc: 'Username', aliases: '-u', required: false
+    class_option :server, desc: 'Server path', aliases: '-s', required: false
 
     private
+
     # Get or create a new client
     def client
       check_option(:server, 'JENKINS_SERVER')
@@ -17,9 +18,9 @@ module Jenkins2API
       check_option(:password, 'JENKINS_PASSWORD')
 
       @client ||= Jenkins2API::Client.new(
-        :server   => options[:server],
-        :username => options[:username],
-        :password => options[:password]
+        server: options[:server],
+        username: options[:username],
+        password: options[:password]
       )
     end
 
@@ -27,11 +28,11 @@ module Jenkins2API
     def check_option(name, env_name)
       options[name] ||= ENV.fetch(env_name, '')
 
-      unless options.has_key?(name.to_s) && options[name] != ''
-        fail Thor::Error, "#{name} is not defined. " \
-          "You can specify with --#{name} option " \
-          "or '#{env_name}' environment variable."
-      end
+      return if options.key?(name.to_s) && options[name] != ''
+
+      raise Thor::Error, "#{name} is not defined. " \
+        "You can specify with --#{name} option " \
+        "or '#{env_name}' environment variable."
     end
   end
 end

data/lib/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jenkins2-api
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Balazs Nadasdi
@@ -24,6 +24,90 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.48'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.48'
 description: API client for Jenkins 2 with executable
 email: balazs.nadasdi@cheppers.com
 executables: