gocd 1.2.1 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bebfcffbf2b289e8a7b9a9b1c5dcbd71459f77d9
-  data.tar.gz: eb5079534dfecfb1328b730b625b07564ce5aa55
+  metadata.gz: f8c7b5ca4f714b0afe958a5805c4068028b43fa6
+  data.tar.gz: 5294d066465fdf8351e18ac833ffee64993ed960
 SHA512:
-  metadata.gz: 5adad969efae52ec49a18ac60d06c70d576c3bf6884caf7eea79241ee751cd2a878e77291709584f739d607ab01636453af150367c0a5f52e1389b8750e62dd7
-  data.tar.gz: dd8d446f38e5c3d3f45a0f1a42a40e3682a26fbebdf587ce3de573376c007e588720e3fed8a300fa6cdd3e9c6abbe309e63a5fcde73142195fa30de182762dd5
+  metadata.gz: a6bff43e851fc5e2f44adf17b812b2afce3f5e056743e139e196d23b1d8b1dcf7b3be71fe1f762ff1d2f2799436325c8d522cad01807b76075fdc971412eb8cf
+  data.tar.gz: cf2f05530f734a7f0a7a9ffbcf33e8efa6a0ab497795960ddb75bfb96c5bd627df8b6d390656fabc4de558a7cbbde6e51e242dbed39f7508cf982727c1059a07

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.3.1
+  - ruby
+
+before_install:
+  - rvm install 2.3.1
+  - rvm use 2.3.1

data/Gemfile

@@ -1,6 +1,9 @@
+ruby '2.3.1'
+
 source :rubygems
 
 gem 'activesupport'
+gem 'cobravsmongoose', '0.0.2'
 gem 'rspec', '~> 3.0'
 gem 'rake'
 gem 'rest-client'

data/Gemfile.lock

@@ -6,6 +6,7 @@ GEM
       i18n (~> 0.7)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
+    cobravsmongoose (0.0.2)
     concurrent-ruby (1.0.2)
     diff-lcs (1.2.5)
     domain_name (0.5.20161021)
@@ -48,9 +49,13 @@ PLATFORMS
 
 DEPENDENCIES
   activesupport
+  cobravsmongoose (= 0.0.2)
   rake
   rest-client
   rspec (~> 3.0)
 
+RUBY VERSION
+   ruby 2.3.1p112
+
 BUNDLED WITH
    1.13.6

data/README.md

@@ -1,6 +1,10 @@
 # gocd
 
+[![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?v=102)](https://opensource.org/licenses/Apache-2.0)
 [![Gem Version](https://badge.fury.io/rb/gocd.svg)](https://badge.fury.io/rb/gocd)
+![Gem Downloads](http://ruby-gem-downloads-badge.herokuapp.com/gocd?type=total)
+[![Build Status](https://travis-ci.org/ajitsing/gocd.svg?branch=master)](https://travis-ci.org/ajitsing/gocd)
+[![Twitter Follow](https://img.shields.io/twitter/follow/Ajit5ingh.svg?style=social)](https://twitter.com/Ajit5ingh)
 
 ### Installation
 ```ruby
@@ -13,6 +17,9 @@ or
 gem install gocd
 ```
 
+### Code Documentation
+http://www.rubydoc.info/gems/gocd/1.2.1
+
 ### Usage
 
 ```ruby
@@ -34,6 +41,19 @@ pipelines.status
 pipelines.any_red?
 ```
 
+#### 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.map {|pipeline| pipeline.to_hash}.to_json
+end
+```
+
+#### Go Agents
 ###### To get all the idle agents:
 ```ruby
 idle_agents = GOCD::Agents.idle
@@ -50,6 +70,53 @@ GOCD::Agents.missing
 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
 -------

data/gocd.gemspec

@@ -6,7 +6,6 @@ require_relative './lib/gocd/version.rb'
 Gem::Specification.new do |s|
   s.name                        =   'gocd'
   s.version                     =   GOCD::VERSION
-  s.date                        =   '2017-03-01'
   s.summary                     =   'Get info from gocd using its apis'
   s.description                 =   s.summary
   s.authors                     =   ['Ajit Singh']

data/lib/gocd/pipeline_config/environment.rb

@@ -7,7 +7,7 @@ module GOCD
       attr_reader :name, :pipelines, :pipeline_names
 
       def initialize(environment)
-        @name = environment['name']
+        @name = environment['@name']
         @pipeline_names = to_pipelines(environment["pipelines"] || {})
       end
 
@@ -23,7 +23,7 @@ module GOCD
       private
       def to_pipelines(pipelines)
         pipes = pipelines["pipeline"] || []
-        to_array(pipes).map { |p| p['name'] } unless pipes.nil?
+        to_array(pipes).map { |p| p['@name'] } unless pipes.nil?
       end
     end
   end

data/lib/gocd/pipeline_config/job.rb

@@ -9,8 +9,8 @@ module GOCD
       def initialize(pipeline, stage, data)
         @pipeline = pipeline
         @stage = stage
-        @name = data['name']
-        @resources = data['resources'].nil? ? [] : to_array(data['resources']['resource'])
+        @name = data['@name']
+        @resources = data['resources'].nil? ? [] : to_array(parse_resources(data))
       end
 
       def environment=(env)
@@ -20,6 +20,23 @@ module GOCD
       def pipeline=(new_name)
         @pipeline = new_name
       end
+
+      private
+      def parse_resources(data)
+        res = data['resources']['resource']
+        if res.is_a?(Array)
+          res.map do |r|
+            r.is_a?(Hash) ? filter_xml_specific_keys(r).values : r
+          end
+        elsif res.is_a?(Hash)
+          filter_xml_specific_keys(res).values
+        end
+      end
+
+      def filter_xml_specific_keys(res)
+        res.delete('@xmlns')
+        res
+      end
     end
   end
 end

data/lib/gocd/pipeline_config/pipeline.rb

@@ -4,12 +4,13 @@ module GOCD
   module PIPELINE_CONFIG
     class Pipeline
       include GOCD::PIPELINE_CONFIG
-      attr_reader :name, :stages, :template, :environment
+      attr_reader :name, :stages, :template, :environment, :params
 
       def initialize(data)
-        @template = data['template']
-        @name = data['name']
+        @template = data['@template']
+        @name = data['@name']
         @stages = to_stages(data['stage']) || []
+        @params = parse_params(data)
       end
 
       def has_template?
@@ -30,6 +31,20 @@ module GOCD
       def to_stages(data)
         to_array(data).map { |stage| GOCD::PIPELINE_CONFIG::Stage.new(name, stage) } unless data.nil?
       end
+
+      def parse_params(data)
+        params = {}
+        return params if (data['params'].nil? || data['params']['param'].nil?)
+
+        params_response = data['params']['param']
+        if params_response.is_a?(Hash)
+          params[params_response['@name']] = params_response['$']
+        elsif params_response.is_a?(Array)
+          params_response.each { |p| params[p['@name']] = p['$'] }
+        end
+
+        params
+      end
     end
   end
 end

data/lib/gocd/pipeline_config/pipeline_config.rb

@@ -19,7 +19,7 @@ module GOCD
 
     def pipelines
       pipelines = groups.map { |group| group.pipelines }.flatten
-      merge_pipelines_with_templates pipelines, templates
+      merge_pipelines_with_templates pipelines
     end
 
     def templates
@@ -53,20 +53,24 @@ module GOCD
       end
     end
 
-    def merge_pipelines_with_templates(pipelines, templates)
-      pipeline_with_templates = pipelines.select { |p| p.has_template? }
-      standalone_pipelines = pipelines - pipeline_with_templates
+    def merge_pipelines_with_templates(pipelines)
+      pipelines_with_template = pipelines.select { |p| p.has_template? }
+      pipelines_with_template.map! do |p|
+        template = template_for_pipeline(p)
+        next if template.nil?
+        template.name = p.name
+        template.stages.each { |s| s.pipeline = p.name }
+        template
+      end.compact!
 
-      pipelines_merged_with_templates = pipeline_with_templates.map do |pwt|
-        matched_template = templates.select { |t| t.name.upcase == pwt.template.upcase }
-        if matched_template.size > 0
-          matched_template.first.name = pwt.name
-          matched_template
-        else
-          pwt
-        end
-      end
-      [standalone_pipelines + pipelines_merged_with_templates].flatten.compact
+      pipelines_without_template = pipelines.select { |p| !p.has_template? }
+      [pipelines_with_template + pipelines_without_template].flatten.compact
+    end
+
+    def template_for_pipeline(pipeline)
+      template = templates.select { |t| t.name == pipeline.template }.first
+      p "Could not find any template for #{pipeline.name}:#{pipeline.template}" if template.nil?
+      template
     end
   end
 end

data/lib/gocd/pipeline_config/pipeline_group.rb

@@ -7,7 +7,7 @@ module GOCD
       attr_reader :name, :pipelines
 
       def initialize(group_data)
-        @name = group_data['group']
+        @name = group_data['@group']
         @pipelines = to_pipelines(group_data['pipeline']) || []
       end
 

data/lib/gocd/pipeline_config/repository/pipeline_config_repository.rb

@@ -1,10 +1,10 @@
-require 'active_support/core_ext/hash/conversions'
+require 'cobravsmongoose'
 
 module GOCD
   module PIPELINE_CONFIG
     class PipelineConfigRepository
       def self.fetch_config
-        Hash.from_xml(`curl -s -k -u #{GOCD.credentials.curl_credentials} #{GOCD.server.url}/go/api/admin/config/current.xml`)
+        CobraVsMongoose.xml_to_hash(`curl -s -k -u #{GOCD.credentials.curl_credentials} #{GOCD.server.url}/go/api/admin/config/current.xml`)
       end
     end
   end

data/lib/gocd/pipeline_config/stage.rb

@@ -8,7 +8,7 @@ module GOCD
 
       def initialize(pipeline, data)
         @pipeline = pipeline
-        @name = data['name']
+        @name = data['@name']
         @jobs = data['jobs'].nil? ? [] : to_jobs(data['jobs']['job'])
       end
 

data/lib/gocd/version.rb

@@ -1,3 +1,3 @@
 module GOCD
-  VERSION = '1.2.1'
+  VERSION = '1.2.3'
 end

data/spec/gocd/history/history_fetcher_spec.rb

@@ -13,7 +13,7 @@ end
 RSpec.describe GOCD::HistoryFetcher, 'history' do
 
   response = "cruise_agent,cruise_job_duration,cruise_job_id,cruise_job_result,cruise_pipeline_counter,cruise_pipeline_label,cruise_stage_counter,cruise_timestamp_01_scheduled,cruise_timestamp_02_assigned,cruise_timestamp_03_preparing,cruise_timestamp_04_building,cruise_timestamp_05_completing,cruise_timestamp_06_completed,tests_failed_count,tests_ignored_count,tests_total_count,tests_total_duration\nAgent1,320,826882,Passed,10314,pipe-10314-job-5621,1,2017-02-23T14:49:17Z,2017-02-23T14:49:22Z,2017-02-23T14:49:33Z,2017-02-23T14:49:41Z,2017-02-23T14:54:39Z,2017-02-23T14:55:02Z,0,0,4218,84.882\n"
-  job = GOCD::PIPELINE_CONFIG::Job.new('Pipeline', 'stage', {'name' => 'job'})
+  job = GOCD::PIPELINE_CONFIG::Job.new('Pipeline', 'stage', {'@name' => 'job'})
 
   before(:each) do
     setup_credential_and_server

data/spec/gocd/pipeline_config/environment_spec.rb

@@ -1,5 +1,5 @@
 require './lib/gocd/pipeline_config/pipeline_group'
-require 'active_support/core_ext/hash/conversions'
+require 'cobravsmongoose'
 
 RSpec.describe GOCD::PIPELINE_CONFIG::Environment, 'Environment' do
   xml_response = <<-PipelineGroup
@@ -16,7 +16,7 @@ RSpec.describe GOCD::PIPELINE_CONFIG::Environment, 'Environment' do
   PipelineGroup
 
   it 'should parse environment' do
-    response = Hash.from_xml(xml_response)
+    response = CobraVsMongoose.xml_to_hash(xml_response)
     environment = GOCD::PIPELINE_CONFIG::Environment.new response['environment']
 
     expect(environment.name).to eq 'Env'
@@ -26,7 +26,7 @@ RSpec.describe GOCD::PIPELINE_CONFIG::Environment, 'Environment' do
   end
 
   it 'should update environment in pipeline' do
-    response = Hash.from_xml(xml_response)
+    response = CobraVsMongoose.xml_to_hash(xml_response)
     environment = GOCD::PIPELINE_CONFIG::Environment.new response['environment']
 
     pipeline = instance_double('pipeline')

data/spec/gocd/pipeline_config/job_spec.rb

@@ -1,18 +1,18 @@
 require './lib/gocd/pipeline_config/pipeline_group'
-require 'active_support/core_ext/hash/conversions'
+require 'cobravsmongoose'
 
 RSpec.describe GOCD::PIPELINE_CONFIG::Job, 'Job' do
-  xml_response = <<-PipelineGroup
+  xml_response = <<-Job
     <job name="flavor1_spec" timeout="60">
         <resources>
             <resource>mac</resource>
             <resource>spec</resource>
         </resources>
     </job>
-  PipelineGroup
+  Job
 
   it 'should parse job' do
-    response = Hash.from_xml(xml_response)
+    response = CobraVsMongoose.xml_to_hash(xml_response)
     job = GOCD::PIPELINE_CONFIG::Job.new 'MyAwesomePipeline', 'spec', response['job']
 
     expect(job.resources.size).to eq 2
@@ -20,4 +20,21 @@ RSpec.describe GOCD::PIPELINE_CONFIG::Job, 'Job' do
     expect(job.pipeline).to eq 'MyAwesomePipeline'
     expect(job.stage).to eq 'spec'
   end
+
+  it 'should parse job with resources as array' do
+    xml_response = <<-Job
+    <job name="flavor1_spec" timeout="60" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+        <resources>
+            <resource>mac</resource>
+            <resource>spec</resource>
+        </resources>
+    </job>
+    Job
+
+    response = CobraVsMongoose.xml_to_hash(xml_response)
+    job = GOCD::PIPELINE_CONFIG::Job.new 'MyAwesomePipeline', 'spec', response['job']
+
+    expect(job.resources.size).to eq 2
+    expect(job.resources.first).to eq 'mac'
+  end
 end

data/spec/gocd/pipeline_config/pipeline_group_spec.rb

@@ -1,5 +1,5 @@
 require './lib/gocd/pipeline_config/pipeline_group'
-require 'active_support/core_ext/hash/conversions'
+require 'cobravsmongoose'
 
 RSpec.describe GOCD::PIPELINE_CONFIG::PipelineGroup, 'PipelineGroup' do
   pipeline_group_xml = <<-PipelineGroup
@@ -42,7 +42,7 @@ RSpec.describe GOCD::PIPELINE_CONFIG::PipelineGroup, 'PipelineGroup' do
   PipelineGroup
 
   it 'should parse pipeline group' do
-    response = Hash.from_xml(pipeline_group_xml)
+    response = CobraVsMongoose.xml_to_hash(pipeline_group_xml)
     pipeline_group = GOCD::PIPELINE_CONFIG::PipelineGroup.new response['pipelines']
 
     expect(pipeline_group.name).to eq 'MyPipelineGroup'

data/spec/gocd/pipeline_config/pipeline_spec.rb

@@ -1,5 +1,5 @@
 require './lib/gocd/pipeline_config/pipeline_group'
-require 'active_support/core_ext/hash/conversions'
+require 'cobravsmongoose'
 
 RSpec.describe GOCD::PIPELINE_CONFIG::Pipeline, 'Pipeline' do
   xml_response = <<-PipelineGroup
@@ -45,15 +45,16 @@ RSpec.describe GOCD::PIPELINE_CONFIG::Pipeline, 'Pipeline' do
   PipelineGroup
 
   it 'should parse pipeline' do
-    response = Hash.from_xml(xml_response)
+    response = CobraVsMongoose.xml_to_hash(xml_response)
     pipeline = GOCD::PIPELINE_CONFIG::Pipeline.new response['pipeline']
 
     expect(pipeline.name).to eq 'MyAwesomePipeline'
     expect(pipeline.stages.size).to eq 2
+    expect(pipeline.params.keys.size).to eq 0
   end
 
   it 'should parse pipeline created from template' do
-    response = Hash.from_xml(template_pipline)
+    response = CobraVsMongoose.xml_to_hash(template_pipline)
     pipeline = GOCD::PIPELINE_CONFIG::Pipeline.new response['pipeline']
 
     expect(pipeline.name).to eq 'MyAwesomePipeline'
@@ -69,4 +70,38 @@ RSpec.describe GOCD::PIPELINE_CONFIG::Pipeline, 'Pipeline' do
 
     pipeline.environment = 'Env'
   end
+
+  it 'should parse pipeline params' do
+    pipeline_with_params = <<-Pipeline
+    <pipeline name="ChildPipeline" isLocked="false" template="pipeline_template">
+      <params>
+        <param name="MODULE_NAME">Module1</param>
+        <param name="UPSTREAM_PIPELINE">ParentPipeline</param>
+      </params>
+    </pipeline>
+    Pipeline
+
+    response = CobraVsMongoose.xml_to_hash(pipeline_with_params)
+    pipeline = GOCD::PIPELINE_CONFIG::Pipeline.new response['pipeline']
+
+    expect(pipeline.params.keys.size).to eq 2
+    expect(pipeline.params['MODULE_NAME']).to eq 'Module1'
+    expect(pipeline.params['UPSTREAM_PIPELINE']).to eq 'ParentPipeline'
+  end
+
+  it 'should parse pipeline with one param' do
+    pipeline_with_params = <<-Pipeline
+    <pipeline name="ChildPipeline" isLocked="false" template="pipeline_template">
+      <params>
+        <param name="MODULE_NAME">Module1</param>
+      </params>
+    </pipeline>
+    Pipeline
+
+    response = CobraVsMongoose.xml_to_hash(pipeline_with_params)
+    pipeline = GOCD::PIPELINE_CONFIG::Pipeline.new response['pipeline']
+
+    expect(pipeline.params.keys.size).to eq 1
+    expect(pipeline.params['MODULE_NAME']).to eq 'Module1'
+  end
 end

data/spec/gocd/pipeline_config/stage_spec.rb

@@ -1,5 +1,5 @@
 require './lib/gocd/pipeline_config/pipeline_group'
-require 'active_support/core_ext/hash/conversions'
+require 'cobravsmongoose'
 
 RSpec.describe GOCD::PIPELINE_CONFIG::Stage, 'Stage' do
   xml_response = <<-PipelineGroup
@@ -22,7 +22,7 @@ RSpec.describe GOCD::PIPELINE_CONFIG::Stage, 'Stage' do
   PipelineGroup
 
   it 'should parse job' do
-    response = Hash.from_xml(xml_response)
+    response = CobraVsMongoose.xml_to_hash(xml_response)
     stage = GOCD::PIPELINE_CONFIG::Stage.new 'MyAwesomePipeline', response['job']
 
     expect(stage.name).to eq 'build'

data/spec/gocd/pipeline_config/template_spec.rb

@@ -1,5 +1,5 @@
 require './lib/gocd/pipeline_config/template'
-require 'active_support/core_ext/hash/conversions'
+require 'cobravsmongoose'
 
 RSpec.describe GOCD::PIPELINE_CONFIG::Template, 'Template' do
   xml_response = <<-Template
@@ -20,7 +20,7 @@ RSpec.describe GOCD::PIPELINE_CONFIG::Template, 'Template' do
   Template
 
   it 'should parse template' do
-    response = Hash.from_xml(xml_response)
+    response = CobraVsMongoose.xml_to_hash(xml_response)
     pipeline = GOCD::PIPELINE_CONFIG::Template.new response['templates']['pipeline']
 
     expect(pipeline.name).to eq 'MyPipeline'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gocd
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.3
 platform: ruby
 authors:
 - Ajit Singh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-01 00:00:00.000000000 Z
+date: 2017-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -89,6 +89,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -150,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Get info from gocd using its apis