Project

gocd

0.01
No commit activity in last 3 years
No release in over 3 years
gocdajitsing/gocdHomepageDocumentationSource CodeBug TrackerWiki
Get info from gocd using its apis
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Popularity
Downloads
54,435
Stars
6
Forks
4
Watchers
1
 Releases
Current version
1.3.1
Total releases
14
First release
2016-09-18
Latest release
2018-10-22
 Issues
Open Issues
0
Closed Issues
2
Total Issues
2
Issue Closure Rate
100%
 Pull Requests
Open Pull Requests
0
Closed Pull Requests
1
Merged Pull Requests
4
Pull Request Acceptance Rate
80%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2017-11-15
Reverse Dependencies
1

 Dependencies

Development

bundler
~> 1.5
rspec
>= 0

Runtime

activesupport
>= 0
cobravsmongoose
~> 0.0.2
json
>= 0
rest-client
>= 0
 Project Readme

gocd

Maintenance Open Source Love Gem Version HitCount Gem Downloads Build Status Twitter Follow

Installation

gem 'gocd'

or

gem install gocd

Code Documentation

http://www.rubydoc.info/gems/gocd/1.3

Usage

GOCD.server = GOCD::Server.new 'http://goserverurl.com'
GOCD.credentials = GOCD::Credentials.new 'username', 'password'
To check all pipelines:
GOCD::AllPipelines.red_pipelines
To check a group of pipelines:
pipelines = GOCD::PipelineGroup.new ['Pipeline1 :: stage1', 'Pipeline1 :: stage2', 'Pipeline2 :: stage1']
pipelines.red_pipelines
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.

GOCD::AllPipelines.any_red?(cache: true)
GOCD::AllPipelines.red_pipelines(cache: true)
GOCD::AllPipelines.green_pipelines(cache: true)
GOCD::AllPipelines.status(cache: true)
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!

require 'sinatra'
require 'gocd'

get '/' do
  GOCD.server = GOCD::Server.new 'http://goserverurl.com'
  GOCD.credentials = GOCD::Credentials.new 'username', 'password'
  GOCD::AllPipelines.red_pipelines(cache: false).map {|pipeline| pipeline.to_hash}.to_json
end

Go Agents

To get all the idle agents:
idle_agents = GOCD::Agents.idle
idle_agents.each { |agent| agent.name }
To get all the missing agents:
GOCD::Agents.missing
To get all the disabled agents:
GOCD::Agents.disabled

Pipeline Configuration

Get all the environments
include GOCD::PIPELINE_CONFIG

environments #returns all the environments and the whole hierarchy of it
Get all the pipelines
include GOCD::PIPELINE_CONFIG

pipelines = environments.map(&:pipelines).flatten
Get all the stages
include GOCD::PIPELINE_CONFIG

stages = environments.map(&:pipelines).flatten.map(&:stages).flatten
Get all the jobs
include GOCD::PIPELINE_CONFIG

jobs = environments.map(&:pipelines).flatten.map(&:stages).flatten.map(&:jobs).flatten

History Fetcher

You can fetch history of a job using the HistoryFetcher APIs

require 'gocd'

GOCD.server = GOCD::Server.new 'http://goserverurl.com'
GOCD.credentials = GOCD::Credentials.new 'username', 'password'

include GOCD::PIPELINE_CONFIG

histories = []
runs = 1000
jobs = environments.map(&:pipelines).flatten.map(&:stages).flatten.map(&:jobs).flatten
jobs.each do |job|
  histories << GOCD::HistoryFetcher.fetch_job_history(job, runs)
end

LICENSE

Copyright (C) 2016 Ajit Singh

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.