gocd 1.3 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 188ab274b584582cbb0f8541d50165549b845d444f0120f784ce5dc7ef14e62a
-  data.tar.gz: '07808c0d30bfa63b5f1c4e395a3c2232bc81933d685d49a3ca003af748b7e0bc'
+  metadata.gz: 6851fe731d257a4bfb632948329e79ae9e8b27a2960927d39410981c66adcc75
+  data.tar.gz: e7a0e79d7bff7f26ec9dcc9eb3097ebf761b508bdb156e54d6480c6764f966bf
 SHA512:
-  metadata.gz: b914ef2f894244676d15d7a12ef96ac4fab8a82ed28928e55fc3e57fa73d33da13b24b464dea34dda594340c23e27f2004e27c1567aac7225d3deaade6d03012
-  data.tar.gz: 23a87cb1c0e574afeacf305cc9c6a42abb8c600ab27bc2aa1b1ec09f2aaaab791f2433fd1b992b6bc1c5a5af394583036bbfcbd082e864048835a5c4d03b50d8
+  metadata.gz: 36e2c47c1215848ac9ce64fe1255a491d50060bca9dbd84e065040952bcef117fed28b03defb23430d1c5a54fe265c3fc7072546d4bb688bdda0c28c9ad13ba4
+  data.tar.gz: e9e6fe0155880227c3a78862c7f3267ad1e3182ff25af21700616c463f20ee33d285f5f74f7af020e3536242e8e15ca4817828cf34d3c1464eb346020f7135ed

data/README.md

@@ -20,7 +20,7 @@ gem install gocd
 ```
 
 ### Code Documentation
-http://www.rubydoc.info/gems/gocd/1.2.1
+http://www.rubydoc.info/gems/gocd/1.3
 
 ### Usage
 
@@ -43,6 +43,23 @@ pipelines.status
 pipelines.any_red?
 ```
 
+#### Cache
+By default all methods in ```GOCD::AllPipelines``` and ```GOCD::PipelineGroup``` make a call to go api to fetch the latest status of pipelines. This can be avoided using cache. To enable cache just pass ```cache: true``` when you call any of the method in ```GOCD::AllPipelines``` and ```GOCD::PipelineGroup```.
+
+```ruby
+GOCD::AllPipelines.any_red?(cache: true)
+GOCD::AllPipelines.red_pipelines(cache: true)
+GOCD::AllPipelines.green_pipelines(cache: true)
+GOCD::AllPipelines.status(cache: true)
+```
+
+```ruby
+pipelines = GOCD::PipelineGroup.new(['Pipeline1 :: stage1'], cache: true)
+pipelines.red_pipelines # will return red pipelines from cache
+pipelines.status # will return pipelines status from cache
+pipelines.any_red?(cache: false) # will check with the latest pipelines
+```
+
 #### Want to create your own gocd dashboard? Its easy now!
 ```ruby
 require 'sinatra'
@@ -51,7 +68,7 @@ require 'gocd'
 get '/' do
   GOCD.server = GOCD::Server.new 'http://goserverurl.com'
   GOCD.credentials = GOCD::Credentials.new 'username', 'password'
-  GOCD::AllPipelines.red_pipelines.map {|pipeline| pipeline.to_hash}.to_json
+  GOCD::AllPipelines.red_pipelines(cache: false).map {|pipeline| pipeline.to_hash}.to_json
 end
 ```
 

data/lib/gocd/pipeline_status/pipeline.rb

@@ -13,7 +13,7 @@ module GOCD
     end
 
     def status
-      {pipeline: name, status: last_build_status}
+      {pipeline: name, status: current_status}
     end
 
     def red?
@@ -39,5 +39,9 @@ module GOCD
     def to_hash
       @pipeline
     end
+
+    def current_status
+      (@pipeline['activity'] && @pipeline['activity'].downcase == 'sleeping') ? last_build_status : @pipeline['activity']
+    end
   end
-end
+end

data/lib/gocd/version.rb

@@ -1,3 +1,3 @@
 module GOCD
-  VERSION = '1.3'
+  VERSION = '1.3.1'
 end

data/spec/gocd/pipeline_status/pipeline_spec.rb

@@ -12,6 +12,11 @@ RSpec.describe GOCD::Pipeline, 'pipeline' do
       expect(@pipeline.name).to eq 'pipeline 1'
     end
 
+    it '#status should be success' do
+      @pipeline = GOCD::Pipeline.new @raw_pipeline
+      expect(@pipeline.status).to eq({pipeline: 'pipeline 1', status: 'Success'})
+    end
+
     it '#last_build_status should return last build status' do
       @pipeline = GOCD::Pipeline.new @raw_pipeline
       expect(@pipeline.last_build_status).to eq 'Success'
@@ -33,6 +38,11 @@ RSpec.describe GOCD::Pipeline, 'pipeline' do
       @raw_pipeline = {'name' => 'pipeline 1', 'activity' => 'sleeping', 'lastBuildStatus' => 'Failure'}
     end
 
+    it '#status should be failure' do
+      @pipeline = GOCD::Pipeline.new @raw_pipeline
+      expect(@pipeline.status).to eq({pipeline: 'pipeline 1', status: 'Failure'})
+    end
+
     it '#green? should return false' do
       @pipeline = GOCD::Pipeline.new @raw_pipeline
       expect(@pipeline.green?).to be_falsey
@@ -57,4 +67,36 @@ RSpec.describe GOCD::Pipeline, 'pipeline' do
     expect(pipeline.last_build_label).to eq('lable')
     expect(pipeline.to_hash).to eq(@raw_pipeline)
   end
-end
+
+  context 'when a previously successful pipeline is running' do
+    let(:raw_pipeline) { {'name' => 'pipeline 1', 'activity' => 'Building', 'lastBuildStatus' => 'Success'} }
+
+    it '#status should be building' do
+      expect(GOCD::Pipeline.new(raw_pipeline).status).to eq({pipeline: 'pipeline 1', status: 'Building'})
+    end
+
+    it '#green? should return true' do
+      expect(GOCD::Pipeline.new(raw_pipeline).green?).to be_truthy
+    end
+
+    it '#red? should return false' do
+      expect(GOCD::Pipeline.new(raw_pipeline).red?).to be_falsey
+    end
+  end
+
+  context 'when a previously failed pipeline is running' do
+    let(:raw_pipeline) { {'name' => 'pipeline 1', 'activity' => 'Building', 'lastBuildStatus' => 'Failure'} }
+
+    it '#status should be building' do
+      expect(GOCD::Pipeline.new(raw_pipeline).status).to eq({pipeline: 'pipeline 1', status: 'Building'})
+    end
+
+    it '#green? should return false' do
+      expect(GOCD::Pipeline.new(raw_pipeline).green?).to be_falsey
+    end
+
+    it '#red? should return true' do
+      expect(GOCD::Pipeline.new(raw_pipeline).red?).to be_truthy
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gocd
 version: !ruby/object:Gem::Version
-  version: '1.3'
+  version: 1.3.1
 platform: ruby
 authors:
 - Ajit Singh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-17 00:00:00.000000000 Z
+date: 2018-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport