jenkins2-api 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e066522b8efd20bd5b1f6a70d0d9b9f3e2ac48c4
-  data.tar.gz: 2481dbf92e587438d66f036210234966d4969c13
+  metadata.gz: cf08bef0ebc99c4ee387ccd5c44140e0e88502ec
+  data.tar.gz: c6175c21f3bc45ef9ed6521cd234ba3770c094f1
 SHA512:
-  metadata.gz: 74638d02bab0f644794e90004860ec502e40050dbd81af413d9642b0e9b052f14bdbfb45ee0eb161f5a56ef2322803c51611bc7013c52e748fabf4c3f8999b2d
-  data.tar.gz: 05afbcf3189101deb7922d252d6113a2a13aecba2ebe097faad651b4c1b2418cbb725df16d3b55454713c2634eaec296e812a43221be3f4da205f4eb9e195f98
+  metadata.gz: d902bef434ed9fbff993448d4b06c6e3f30f6c89bcbc9677d38f95c32943f4530c45b5c24e987945eb584eeede6f905f856e0ccd81737412436fd8cd87c59edb
+  data.tar.gz: c8d76aa5459101bc30c9082d9b05f607d6ed6c3050034dcd5c5d72ea001386f5d9144799a6f6f854b8af9ce6a21f2df7ae394ab700fa38f84432eb67b644c152

data/lib/endpoints/job.rb

@@ -19,6 +19,8 @@ module Jenkins2API
       def builds(name)
         @client.api_request(:get, "/job/#{name}")['builds']
       end
+
+      alias_method :get_builds, :builds
     end
   end
 end

data/lib/version.rb

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

data/spec/features/build_spec.rb

@@ -0,0 +1,32 @@
+require 'jenkins2-api'
+require 'net/http'
+
+RSpec.describe Jenkins2API::Endpoint::Job, '#latest' do
+  context 'get the latest build for a job' do
+    it 'returns with the build' do
+      build = @client.build.latest('sample-job-pipeline')
+
+      expect(build['id']).to eq('144')
+      expect(build['displayName']).to eq('#144')
+    end
+  end
+end
+
+RSpec.describe Jenkins2API::Endpoint::Job, '#get' do
+  context 'get a specific build for a job' do
+    it 'returns with the build' do
+      build = @client.build.get('sample-job-pipeline', 144)
+
+      expect(build['id']).to eq('144')
+      expect(build['displayName']).to eq('#144')
+    end
+  end
+
+  context 'get an invalid build for a job' do
+    it 'returns with the build' do
+      expect do
+        @client.build.get('sample-job-pipeline', 135)
+      end.to raise_error(Net::HTTPServerException, /Not Found/)
+    end
+  end
+end

data/spec/features/client_spec.rb

@@ -0,0 +1,22 @@
+require 'jenkins2-api'
+
+RSpec.describe Jenkins2API::Client, '#initialize' do
+  context 'connect without credentials' do
+    it 'throws an error' do
+      expect do
+        Jenkins2API::Client.new
+      end.to raise_error(ArgumentError)
+    end
+  end
+
+  context 'connect with credentials' do
+    it 'does not throw an error' do
+      expect do
+        Jenkins2API::Client.new(
+          username: 'myuser',
+          password: 'mytoken'
+        )
+      end.not_to raise_error
+    end
+  end
+end

data/spec/features/job_spec.rb

@@ -0,0 +1,10 @@
+require 'jenkins2-api'
+
+RSpec.describe Jenkins2API::Endpoint::Job, '#list' do
+  context 'get the list of available jobs' do
+    it 'returns an array of two jobs' do
+      jobs = @client.job.list
+      expect(jobs.length).to eq(2)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require 'webmock/rspec'
+require 'support/fake_jenkins.rb'
+require 'jenkins2-api'
+
+WebMock.disable_net_connect!(allow_localhost: true)
+
+def create_new_client
+  Jenkins2API::Client.new(
+    server:   'http://example.jenkins2.com',
+    username: 'myuser',
+    password: 'mytoken'
+  )
+end
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.before(:each) do
+    @client = create_new_client
+    stub_request(:any, /example.jenkins2.com/).to_rack(FakeJenkins)
+  end
+end

data/spec/support/fake_jenkins.rb

@@ -0,0 +1,22 @@
+require 'sinatra/base'
+
+# Fake Jenkins server for rspec
+class FakeJenkins < Sinatra::Base
+  get '/api/json' do
+    json_response 200, 'job_list.json'
+  end
+
+  get '/job/sample-job-pipeline/144/api/json' do
+    json_response 200, 'latest_build.json'
+  end
+
+  get '/job/sample-job-pipeline/lastBuild/api/json' do
+    json_response 200, 'latest_build.json'
+  end
+
+  def json_response(response_code, file_name)
+    content_type :json
+    status response_code
+    File.open(File.dirname(__FILE__) + '/fixtures/' + file_name, 'rb').read
+  end
+end

data/spec/support/fixtures/job_list.json

@@ -0,0 +1,43 @@
+{
+  "_class" : "hudson.model.Hudson",
+  "assignedLabels" : [{}],
+  "mode" : "NORMAL",
+  "nodeDescription" : "the master Jenkins node",
+  "nodeName" : "",
+  "numExecutors" : 0,
+  "description" : null,
+  "jobs": [
+    {
+      "_class" : "hudson.model.FreeStyleProject",
+      "name" : "sample-job-freestyle",
+      "url" : "http://example.jenkins2.com/job/sample-job-freestyle/",
+      "color" : "red"
+    },
+    {
+      "_class" : "org.jenkinsci.plugins.workflow.job.WorkflowJob",
+      "name" : "sample-job-pipeline",
+      "url" : "http://example.jenkins2.com/job/sample-job-pipeline/",
+      "color" : "blue"
+    }
+  ],
+  "overallLoad" : { },
+  "primaryView" : {
+    "_class" : "hudson.model.AllView",
+    "name" : "All",
+    "url" : "http://example.jenkins2.com/"
+  },
+  "quietingDown" : false,
+  "slaveAgentPort" : 0,
+  "unlabeledLoad" : {
+    "_class" : "jenkins.model.UnlabeledLoadStatistics"
+  },
+  "useCrumbs" : false,
+  "useSecurity" : true,
+  "views" : [
+    {
+      "_class" : "hudson.model.AllView",
+      "name" : "All",
+      "url" : "http://example.jenkins2.com/"
+    }
+  ]
+}

data/spec/support/fixtures/latest_build.json

@@ -0,0 +1,126 @@
+{
+  "_class" : "org.jenkinsci.plugins.workflow.job.WorkflowRun",
+  "actions" : [
+    {
+      "_class" : "hudson.model.CauseAction",
+      "causes" : [
+        {
+          "_class" : "hudson.triggers.TimerTrigger$TimerTriggerCause",
+          "shortDescription" : "Started by timer"
+        }
+      ]
+    },
+    {
+      "_class" : "jenkins.metrics.impl.TimeInQueueAction"
+    },
+    {
+      "_class" : "hudson.plugins.git.util.BuildData",
+      "buildsByBranchName" : {
+        "origin/master" : {
+          "_class" : "hudson.plugins.git.util.Build",
+          "buildNumber" : 144,
+          "buildResult" : null,
+          "marked" : {
+            "SHA1" : "9e94b394e214cb89681023c3e47791fb1b8e0ffe",
+            "branch" : [
+              {
+                "SHA1" : "9e94b394e214cb89681023c3e47791fb1b8e0ffe",
+                "name" : "origin/master"
+              }
+            ]
+          },
+          "revision" : {
+            "SHA1" : "9e94b394e214cb89681023c3e47791fb1b8e0ffe",
+            "branch" : [
+              {
+                "SHA1" : "9e94b394e214cb89681023c3e47791fb1b8e0ffe",
+                "name" : "origin/master"
+              }
+            ]
+          }
+        },
+        "refs/remotes/origin/master" : {
+          "_class" : "hudson.plugins.git.util.Build",
+          "buildNumber" : 111,
+          "buildResult" : null,
+          "marked" : {
+            "SHA1" : "c9a33c0e591ed88919df0abecb26ab20bc926516",
+            "branch" : [
+              {
+                "SHA1" : "c9a33c0e591ed88919df0abecb26ab20bc926516",
+                "name" : "refs/remotes/origin/master"
+              }
+            ]
+          },
+          "revision" : {
+            "SHA1" : "c9a33c0e591ed88919df0abecb26ab20bc926516",
+            "branch" : [
+              {
+                "SHA1" : "c9a33c0e591ed88919df0abecb26ab20bc926516",
+                "name" : "refs/remotes/origin/master"
+              }
+            ]
+          }
+        }
+      },
+      "lastBuiltRevision" : {
+        "SHA1" : "9e94b394e214cb89681023c3e47791fb1b8e0ffe",
+        "branch" : [
+          {
+            "SHA1" : "9e94b394e214cb89681023c3e47791fb1b8e0ffe",
+            "name" : "origin/master"
+          }
+        ]
+      },
+      "remoteUrls" : [
+        "git@github.com:yitsushi/sample-project.git"
+      ],
+      "scmName" : ""
+    },
+    {
+      "_class" : "hudson.plugins.git.GitTagAction"
+    },
+    { },
+    { },
+    { },
+    {
+      "_class" : "hudson.tasks.junit.TestResultAction",
+      "failCount" : 3,
+      "skipCount" : 0,
+      "totalCount" : 69,
+      "urlName" : "testReport"
+    },
+    { },
+    { },
+    { },
+    { },
+    { },
+    {
+      "_class" : "org.jenkinsci.plugins.workflow.job.views.FlowGraphAction"
+    },
+    { },
+    { }
+  ],
+  "artifacts" : [ ],
+  "building" : false,
+  "description" : null,
+  "displayName" : "#144",
+  "duration" : 3467090,
+  "estimatedDuration" : 3589668,
+  "executor" : null,
+  "fullDisplayName" : "sample-job-pipeline #144",
+  "id" : "144",
+  "keepLog" : false,
+  "number" : 144,
+  "queueId" : 19243,
+  "result" : "UNSTABLE",
+  "timestamp" : 1492499520931,
+  "url" : "http://example.jenkins2.com/job/sample-job-pipeline/144/",
+  "changeSets" : [
+  ],
+  "nextBuild" : null,
+  "previousBuild" : {
+    "number" : 143,
+    "url" : "http://example.jenkins2.com/job/sample-job-pipeline/143/"
+  }
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jenkins2-api
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Balazs Nadasdi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-06 00:00:00.000000000 Z
+date: 2017-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -130,6 +130,13 @@ files:
 - lib/jenkins2-api.rb
 - lib/thor_command.rb
 - lib/version.rb
+- spec/features/build_spec.rb
+- spec/features/client_spec.rb
+- spec/features/job_spec.rb
+- spec/spec_helper.rb
+- spec/support/fake_jenkins.rb
+- spec/support/fixtures/job_list.json
+- spec/support/fixtures/latest_build.json
 homepage: https://yitsushi.github.io/jenkins2-api/
 licenses:
 - MIT
@@ -154,4 +161,11 @@ rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: API client for Jenkins 2.
-test_files: []
+test_files:
+- spec/features/build_spec.rb
+- spec/features/client_spec.rb
+- spec/features/job_spec.rb
+- spec/spec_helper.rb
+- spec/support/fake_jenkins.rb
+- spec/support/fixtures/job_list.json
+- spec/support/fixtures/latest_build.json