jenkins2-api 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6bfbc056dbe1bc9f82b4f9178e5f7892e06eee8
-  data.tar.gz: 6c8d9cc4ebb65a8ce2b0498734858b2dfd0b7740
+  metadata.gz: f548e9981de4f48fd4bc914b6679f0432c0e1261
+  data.tar.gz: 843887cb04a375b2ae75eb09f9ac5f8d8e586c99
 SHA512:
-  metadata.gz: 627027afdbe1cb6d91f7b2a0818d2b272cf375f14ee54ef94bf2ed50481dd7c49f879efa5dbe57e77bc92d417b9ab01cc4c454b5934126a5e787b7f2ee51c067
-  data.tar.gz: 00e6d6f5c358c5664d05556224f6cdb1d208791609d15a6f63f1466924a44f4f035a836170a6a1cfe0c81e0f768a42cfbd187c3cadd3a5c57930c232d256a9e9
+  metadata.gz: 6b342762cced5d396f367b628d0a418fdc4bdc5a0a2dfe4785f3a99440b1084de0109cacf6d6771f736c1ff403f6bc0c77aa93999b9005c834dafb7422e6ba61
+  data.tar.gz: 2414d7813cd1bf923388b0aed30615b417a7161950705f844164a952cfd99d9c77b7917b13a4105ca3948b1bea7bcba8730a3518932ff171f028d7f4465b91aa

data/lib/client.rb

@@ -28,24 +28,24 @@ module Jenkins2API
       end
     end
 
-    # Job related endpoints. Creates new +Jenkins2API::Job+ instance
+    # Job related endpoints. Creates new +Jenkins2API::Endpoint::Job+ instance
     def job
-      @job ||= Job.new(self)
+      @job ||= Endpoint::Job.new(self)
     end
 
-    # Build related endpoints. Creates new +Jenkins2API::Build+ instance
+    # Build related endpoints. Creates new +Jenkins2API::Endpoint::Build+ instance
     def build
-      @build ||= Build.new(self)
+      @build ||= Endpoint::Build.new(self)
     end
 
-    # Artifact related endpoints. Creates new +Jenkins2API::Artifact+ instance
+    # Artifact related endpoints. Creates new +Jenkins2API::Endpoint::Artifact+ instance
     def artifact
-      @artifact ||= Artifact.new(self)
+      @artifact ||= Endpoint::Artifact.new(self)
     end
 
-    # Node/Computer related endpoints. Creates new +Jenkins2API::Node+ instance
+    # Node/Computer related endpoints. Creates new +Jenkins2API::Endpoint::Node+ instance
     def node
-      @node ||= Node.new(self)
+      @node ||= Endpoint::Node.new(self)
     end
 
     # Creates and calls an API endpoint.

data/lib/endpoints/artifact.rb

@@ -1,28 +1,30 @@
-require_relative '../endpoint'
+require_relative 'base_endpoint'
 
 module Jenkins2API
-  # This class contains all the calls to reach
-  # Jenkins2 and obtain Artifact data
-  class Artifact < Endpoint
-    # Returns a list of all artifacts for a specific build
-    #
-    # Params:
-    # +name+:: Job name
-    # +build_id+:: ID of the build
-    def all(name, build_id)
-      @client.build.get(name)['artifacts']
-    end
+  module Endpoint
+    # This class contains all the calls to reach
+    # Jenkins2 and obtain Artifact data
+    class Artifact < BaseEndpoint
+      # Returns a list of all artifacts for a specific build
+      #
+      # Params:
+      # +name+:: Job name
+      # +build_id+:: ID of the build
+      def all(name, build_id)
+        @client.build.get(name)['artifacts']
+      end
 
-    # Download a specific artifact.
-    #
-    # Params:
-    # +name+:: Job name
-    # +build_id+:: ID of the build
-    # +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)
+      # Download a specific artifact.
+      #
+      # Params:
+      # +name+:: Job name
+      # +build_id+:: ID of the build
+      # +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)
+      end
     end
   end
 end

data/lib/endpoints/base_endpoint.rb

@@ -0,0 +1,12 @@
+module Jenkins2API
+  # Module to wrap all the endpoint
+  module Endpoint
+    # General methods for endpoints
+    class BaseEndpoint
+      # Stores the Jenkins2API::Client instance
+      def initialize(client)
+        @client = client
+      end
+    end
+  end
+end

data/lib/endpoints/build.rb

@@ -1,64 +1,66 @@
-require_relative '../endpoint'
+require_relative 'base_endpoint'
 
 module Jenkins2API
-  # This class contains all the calls to reach
-  # Jenkins2 and obtain Build data
-  class Build < Endpoint
-    # Get a specific build
-    #
-    # ==== Params:
-    # +job_name+:: Name of the Job
-    # +build_id+:: ID of the build
-    def get(job_name, build_id)
-      @client.api_request(:get, "/job/#{job_name}/#{build_id}")
-    end
+  module Endpoint
+    # This class contains all the calls to reach
+    # Jenkins2 and obtain Build data
+    class Build < BaseEndpoint
+      # Get a specific build
+      #
+      # ==== Params:
+      # +job_name+:: Name of the Job
+      # +build_id+:: ID of the build
+      def get(job_name, build_id)
+        @client.api_request(:get, "/job/#{job_name}/#{build_id}")
+      end
 
-    # Get the latest build
-    #
-    # ==== Params:
-    # +job_name+:: Name of the Job
-    def latest(name)
-      @client.api_request(:get, "/job/#{name}/lastBuild")
-    end
+      # Get the latest build
+      #
+      # ==== Params:
+      # +job_name+:: Name of the Job
+      def latest(name)
+        @client.api_request(:get, "/job/#{name}/lastBuild")
+      end
 
-    # Get test report for a specific build
-    #
-    # ==== Params:
-    # +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")
-    end
+      # Get test report for a specific build
+      #
+      # ==== Params:
+      # +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")
+      end
 
-    # Get +console log+ for a specific build as text
-    #
-    # ==== Params:
-    # +job_name+:: Name of the Job
-    # +build_id+:: ID of the build
-    #
-    # 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")
-    end
+      # Get +console log+ for a specific build as text
+      #
+      # ==== Params:
+      # +job_name+:: Name of the Job
+      # +build_id+:: ID of the build
+      #
+      # 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")
+      end
 
-    # Get the name of the slave where the build was executed
-    #
-    # ==== Params:
-    # +name+:: Name of the Job
-    # +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
+      # Get the name of the slave where the build was executed
+      #
+      # ==== Params:
+      # +name+:: Name of the Job
+      # +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
+        name = relevant_line.match(/^Running on (.*) in \//).captures.first rescue nil
 
-      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
-      end
+        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
+        end
 
-      name
+        name
+      end
     end
   end
 end

data/lib/endpoints/job.rb

@@ -1,22 +1,24 @@
-require_relative '../endpoint'
+require_relative 'base_endpoint'
 
 module Jenkins2API
-  # This class contains all the calls to reach
-  # Jenkins2 and obtain Build data
-  class Job < Endpoint
-    # Lists all available jobs
-    def list
-      @client.api_request(:get, "")['jobs']
-    end
+  module Endpoint
+    # This class contains all the calls to reach
+    # Jenkins2 and obtain Build data
+    class Job < BaseEndpoint
+      # Lists all available jobs
+      def list
+        @client.api_request(:get, "")['jobs']
+      end
 
-    # Get all available builds for a specific job
-    #
-    # ==== Params:
-    # +name+:: Name of the Job
-    #
-    # Returns with an array of builds
-    def builds(name)
-      @client.api_request(:get, "/job/#{name}")['builds']
+      # Get all available builds for a specific job
+      #
+      # ==== Params:
+      # +name+:: Name of the Job
+      #
+      # Returns with an array of builds
+      def builds(name)
+        @client.api_request(:get, "/job/#{name}")['builds']
+      end
     end
   end
 end

data/lib/endpoints/node.rb

@@ -1,14 +1,16 @@
-require_relative '../endpoint'
+require_relative 'base_endpoint'
 
 module Jenkins2API
-  # This class contains all the calls to reach
-  # Jenkins2 and obtain Computer data
-  class Node < Endpoint
-    # List all available Computer
-    #
-    # Returns with slaves and masters also
-    def all
-      @client.api_request(:get, "/computer")
+  module Endpoint
+    # This class contains all the calls to reach
+    # Jenkins2 and obtain Computer data
+    class Node < BaseEndpoint
+      # List all available Computer
+      #
+      # Returns with slaves and masters also
+      def all
+        @client.api_request(:get, "/computer")
+      end
     end
   end
 end

data/lib/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jenkins2-api
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Balazs Nadasdi
@@ -38,8 +38,8 @@ files:
 - lib/commands/build.rb
 - lib/commands/job.rb
 - lib/commands/node.rb
-- lib/endpoint.rb
 - lib/endpoints/artifact.rb
+- lib/endpoints/base_endpoint.rb
 - lib/endpoints/build.rb
 - lib/endpoints/job.rb
 - lib/endpoints/node.rb

data/lib/endpoint.rb

@@ -1,9 +0,0 @@
-module Jenkins2API
-  # General methods for endpoints
-  class Endpoint
-    # Stores the Jenkins2API::Client instance
-    def initialize(client)
-      @client = client
-    end
-  end
-end