Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ajitsing/gocd
Gem to fetch gocd information easily
https://github.com/ajitsing/gocd
ci continuous-delivery continuous-deployment continuous-integration gem gocd goconfig pipeline ruby rubygem
Last synced: 2 months ago
JSON representation
Gem to fetch gocd information easily
- Host: GitHub
- URL: https://github.com/ajitsing/gocd
- Owner: ajitsing
- License: apache-2.0
- Created: 2016-09-17T20:39:57.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-10-22T15:20:32.000Z (about 6 years ago)
- Last Synced: 2024-03-24T17:44:18.803Z (9 months ago)
- Topics: ci, continuous-delivery, continuous-deployment, continuous-integration, gem, gocd, goconfig, pipeline, ruby, rubygem
- Language: Ruby
- Homepage: http://www.singhajit.com/ruby-gem-to-fetch-information-gocd-rich-models/
- Size: 72.3 KB
- Stars: 6
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# gocd
[](https://GitHub.com/ajitsing/gocd/graphs/commit-activity)
[](https://opensource.org/licenses/Apache-2.0)
[](https://badge.fury.io/rb/gocd)
[](http://hits.dwyl.io/ajitsing/gocd)
[](https://travis-ci.org/ajitsing/gocd)
[](https://twitter.com/Ajit5ingh)
### Installation
```ruby
gem 'gocd'
```
or
```bash
gem install gocd
```
### Code Documentation
http://www.rubydoc.info/gems/gocd/1.3
### Usage
```ruby
GOCD.server = GOCD::Server.new 'http://goserverurl.com'
GOCD.credentials = GOCD::Credentials.new 'username', 'password'
```
###### To check all pipelines:
```ruby
GOCD::AllPipelines.red_pipelines
```
###### To check a group of pipelines:
```ruby
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```.
```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'
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:
```ruby
idle_agents = GOCD::Agents.idle
idle_agents.each { |agent| agent.name }
```
###### To get all the missing agents:
```ruby
GOCD::Agents.missing
```
###### To get all the disabled agents:
```ruby
GOCD::Agents.disabled
```
#### Pipeline Configuration
###### Get all the environments
```ruby
include GOCD::PIPELINE_CONFIG
environments #returns all the environments and the whole hierarchy of it
```
###### Get all the pipelines
```ruby
include GOCD::PIPELINE_CONFIG
pipelines = environments.map(&:pipelines).flatten
```
###### Get all the stages
```ruby
include GOCD::PIPELINE_CONFIG
stages = environments.map(&:pipelines).flatten.map(&:stages).flatten
```
###### Get all the jobs
```ruby
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
```ruby
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
-------
```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.
```