go_api_client 0.5.4 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7aa9c91f14314043611166b22565c1c95587702d
+  data.tar.gz: 1a2fde5f96169a0e4ac65f85d994ee46c4a2eba2
+SHA512:
+  metadata.gz: f0951a88f086294399c4d1829d0f83d7bf01f04122715ff110ef8241f798922bbfc8ecf5d895d0e5f2e3c27901da2cda0eed85b0ac14f0a5448ede972028a3e1
+  data.tar.gz: ff239e75702a3bd2f2539dc4d75faa0952af375e06068f10a12e19682efe95075ea38cfa6b35ad561e2b212d61b564c92dd4bc2f6e3af569300f860d99a541a2

data/.gitignore

@@ -9,3 +9,7 @@ TAGS
 .yardoc
 doc
 /bin/
+*.gem
+/*.iml
+*.lock
+/vendor

data/.travis.yml

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+#
+# Copyright 2014 North Development AB
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+language: ruby
+rvm:
+- 1.9.3
+- 2.0.0

data/README.md

@@ -0,0 +1,86 @@
+# Go API Client Gem
+
+This gem provides access to the [ThoughtWorks Studios Go](http://www.thoughtworks-studios.com/go-continuous-delivery) API, it is capable of parsing out the atom feed and generate an object graph with all the pipelines/stages/jobs and committer information.
+
+[![Build Status](https://api.travis-ci.org/unibet/go-api-client.svg)](https://travis-ci.org/unibet/go-api-client)
+[![Gem Version](https://badge.fury.io/rb/go_api_client.svg)](http://badge.fury.io/rb/go_api_client)
+
+## Installation
+
+```
+sudo gem install go_api_client
+```
+
+## Usage
+
+```
+require 'go_api_client'
+
+client = GoApiClient::Client.new({:host => 'go.example.com'})
+# check if the server is building 'MyProject' pipeline
+! client.api(:cctray).projects({:pipeline_name => 'MyProject', :activity => 'Building'}).empty?
+
+# check if the build has finished
+client.api(:cctray).projects({:pipeline_name => 'MyProject', :activity => 'Building'}).empty?
+
+# schedule a pipeline
+client.api(:pipeline).schedule({:pipeline_name => 'MyProject'})
+
+# Eager fetch pipeline information with parsed stages and jobs
+client.api(:pipeline).pipeline({:pipeline_name => 'MyProject', :pipeline_id => 1, :eager_parser => [:stage, :job]})
+
+# Lazy fetch pipeline and its first stage
+pipeline = client.api(:pipeline).pipeline({:pipeline_name => 'MyProject', :pipeline_id => 1})
+client.api(:stage).stage({:stage_uri => pipeline.stages.first})
+
+# Eager get feed for a pipeline tougher with related stages and jobs
+client.api(:feed).feed({:pipeline_name => 'MyProject', :eager_parser => [:pipeline, :stage, :job]})
+
+# Get all properties for a given job
+client.api(:properties).properties({:pipeline_name => 'MyProject', :pipeline_counter => 1, :stage_name => 'defaultStage', :stage_counter => 1, :job_name => 'defaultJob'})
+
+# Get value of a specific property for a given job
+client.api(:properties).properties({:pipeline_name => 'MyProject', :pipeline_counter => 1, :stage_name => 'defaultStage', :stage_counter => 1, :job_name => 'defaultJob', :property_name => 'cruise_agent'})
+
+# Create a property for a given job
+client.api(:properties).create_property({:pipeline_name => 'MyProject', :pipeline_counter => 1, :stage_name => 'defaultStage', :stage_counter => 1, :job_name => 'defaultJob', :property_name => 'myproperty', :property_value => 'Showcase_for_I29'})
+
+# Get configuration of 'MyProject' pipeline
+client.api(:config).pipelines({:pipeline_name => 'MyProject'})
+
+# Get configuration of 'MyProject' pipeline eagerly parsing the template
+client.api(:config).pipelines({:pipeline_name => 'MyProject', :eager_parser => [:template]})
+
+# Get configuration for all pipelines
+client.api(:config).pipelines
+
+# Get configuration of a template
+client.api(:config).templates({:template_name => 'MyTemplate'})
+```
+
+## License
+
+Go API Client Gem is MIT Licensed
+
+The MIT License
+
+Copyright (c) 2014 North Development AB (http://www.unibet.com)
+Copyright (c) 2012 ThoughtWorks, Inc. (http://thoughtworks.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/go_api_client.gemspec

@@ -1,18 +1,18 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require "go_api_client/version"
+require 'go_api_client/version'
 
 Gem::Specification.new do |s|
-  s.name        = "go_api_client"
+  s.name        = 'go_api_client'
   s.version     = GoApiClient::Version::VERSION
-  s.authors     = ["Nikhil Mungel", "Ketan Padegaonkar", "Shishir Das"]
-  s.email       = ["hyfather@gmail.com", "KetanPadegaonkar@gmail.com", "shishir.das@gmail.com"]
-  s.homepage    = "https://github.com/ThoughtWorksInc/go-api-client"
+  s.authors     = ['Nikhil Mungel', 'Ketan Padegaonkar', 'Shishir Das', 'Ilja Bobkevic']
+  s.email       = %w(hyfather@gmail.com KetanPadegaonkar@gmail.com shishir.das@gmail.com iljb.bobkevic@unibet.com)
+  s.homepage    = 'https://github.com/ThoughtWorksInc/go-api-client'
   s.summary     = %q{Client to parse Go CI atom feed}
   s.description = %q{This gem parses atom feed generated by the Go Continuous Integration server and provides an OO representation of the pipelines and stages.}
   s.license     = 'MIT'
 
-  s.rubyforge_project = "go_api_client"
+  s.rubyforge_project = 'go_api_client'
 
   s.files         = `git ls-files`.split("\n") - `git ls-files -- vendor/cache`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -20,10 +20,10 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # specify any dependencies here; for example:
-  s.add_development_dependency "webmock"
-  s.add_development_dependency "simplecov"
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'test-unit'
+  s.add_development_dependency 'webmock', '~> 1', '>= 1.8'
+  s.add_development_dependency 'simplecov', '~> 0.6', '>= 0.6.1'
+  s.add_development_dependency 'rake', '~> 0.9', '>= 0.9.2.2'
+  s.add_development_dependency 'test-unit', '~> 2', '>= 2.0'
 
-  s.add_runtime_dependency "nokogiri"
+  s.add_runtime_dependency 'nokogiri', '~> 1.5', '>= 1.5.2'
 end

data/lib/go_api_client/api/abstract_api.rb

@@ -0,0 +1,12 @@
+module GoApiClient
+  module Api
+    class AbstractApi < GoApiClient::AttributeHelper
+      protected
+      attr_accessor :http_fetcher, :base_uri
+
+      def initialize(attributes={})
+        super(attributes)
+      end
+    end
+  end
+end

data/lib/go_api_client/api/cctray.rb

@@ -0,0 +1,53 @@
+require 'nokogiri'
+
+module GoApiClient
+  module Api
+    class Cctray < GoApiClient::Api::AbstractApi
+
+      def initialize(attributes = {})
+        super(attributes)
+        @cctray_uri = "#{@base_uri}/cctray.xml"
+      end
+
+      def projects(options={})
+        options = ({:pipeline_name => nil, :stage_name => nil, :job_name => nil, :activity => nil, :web_uri => nil, :eager_parser => []}).merge(options)
+
+        name_args = []
+        name_args << "starts-with(@name, '#{options[:pipeline_name]}')" if  options[:pipeline_name]
+        name_args << "starts-with(substring-after(@name, ' :: '), '#{options[:stage_name]}')" if options[:stage_name]
+        name_args << "starts-with(substring-after(substring-after(@name, ' :: '), ' :: '), '#{options[:job_name]}')" if options[:job_name]
+
+        xpath_args = []
+        xpath_args << name_args.join(' and ') unless name_args.empty?
+        xpath_args << "@activity='#{options[:activity]}'" if options[:activity]
+        xpath_args << "@webUrl='#{options[:web_uri]}'" if options[:web_uri]
+
+        xpath_str = './Project'
+        unless xpath_args.empty?
+          xpath_str = "#{xpath_str}[#{xpath_args.join(' and ')}]"
+        end
+
+        doc = Nokogiri::XML(@http_fetcher.get!(@cctray_uri))
+        if doc.root
+          if options[:eager_parser] && options[:eager_parser].include?(:stage)
+            stage_api = GoApiClient::Api::Stage.new({:base_uri => @base_uri, :http_fetcher => @http_fetcher})
+          end
+
+          doc.root.xpath(xpath_str).collect do |element|
+            project = GoApiClient::Parsers::Project.parse(element)
+            project.parsed_pipeline_name, project.parsed_stage_name, project.parsed_job_name = project.name.split('::').map(&:strip)
+            if options[:eager_parser] && options[:eager_parser].include?(:stage) && ! project.parsed_job_name
+              project.parsed_stage = stage_api.stage(options.merge({:stage_uri => "#{project.web_uri}.xml"}))
+            end
+            project
+          end
+        else
+          []
+        end
+      end
+
+      private
+      attr_reader :cctray_uri
+    end
+  end
+end

data/lib/go_api_client/api/config.rb

@@ -0,0 +1,60 @@
+require 'nokogiri'
+
+module GoApiClient
+  module Api
+    class Config < GoApiClient::Api::AbstractApi
+
+      def initialize(attributes = {})
+        super(attributes)
+      end
+
+      def templates(options={})
+        options = ({:template_name => nil, :config_uri => nil}).merge(options)
+        uri = options[:config_uri] ? options[:config_uri] : "#{@base_uri}/api/admin/config.xml"
+
+        xpath_str = './templates/pipeline' + (options[:template_name] ? "[@name='#{options[:template_name]}']" : '')
+        doc = Nokogiri::XML(@http_fetcher.get!(uri)).remove_namespaces!
+        if doc.root
+          doc.root.xpath(xpath_str).collect do |element|
+            GoApiClient::Parsers::Config::Pipeline.parse(element)
+          end
+        else
+          []
+        end
+      end
+
+      def pipelines(options={})
+        options = ({:group_name => nil, :pipeline_name => nil, :config_uri => nil, :eager_parser => []}).merge(options)
+        uri = options[:config_uri] ? options[:config_uri] : "#{@base_uri}/api/admin/config.xml"
+
+        group_args = []
+        group_args << "@group='#{options[:group_name]}'" if options[:group_name]
+
+        pipeline_args= []
+        pipeline_args << "@name='#{options[:pipeline_name]}'" if options[:pipeline_name]
+
+        xpath_args = []
+        xpath_args << (group_args.empty? ? 'pipelines' : "pipelines[#{group_args.join(' and ')}]")
+        xpath_args << (pipeline_args.empty? ? 'pipeline' : "pipeline[#{pipeline_args.join(' and ')}]")
+
+        xpath_str = './'
+        unless xpath_args.empty?
+          xpath_str = "#{xpath_str}#{xpath_args.join('/')}"
+        end
+
+        doc = Nokogiri::XML(@http_fetcher.get!(uri)).remove_namespaces!
+        if doc.root
+          doc.root.xpath(xpath_str).collect do |element|
+            pipeline = GoApiClient::Parsers::Config::Pipeline.parse(element)
+            if options[:eager_parser] && options[:eager_parser].include?(:template) && pipeline.template
+              pipeline.parsed_template = templates(options.merge({:template_name => pipeline.template}))
+            end
+            pipeline
+          end
+        else
+          []
+        end
+      end
+    end
+  end
+end

data/lib/go_api_client/api/feed.rb

@@ -0,0 +1,39 @@
+require 'nokogiri'
+
+module GoApiClient
+  module Api
+    class Feed < GoApiClient::Api::AbstractApi
+
+      def initialize(attributes = {})
+        super(attributes)
+      end
+
+      def feed(options={})
+        options = ({:pipeline_name => nil, :feed_uri => nil, :eager_parser => []}).merge(options)
+        if options[:feed_uri]
+          uri = options[:feed_uri]
+        else
+          raise 'Insufficient arguments' unless options[:pipeline_name]
+          uri = "#{@base_uri}/api/pipelines/#{options[:pipeline_name]}/stages.xml"
+        end
+        feed = GoApiClient::Parsers::Feed.parse(Nokogiri::XML(@http_fetcher.get!(uri)).root)
+
+        if options[:eager_parser]
+          if options[:eager_parser].include?(:stage)
+            stage_api = GoApiClient::Api::Stage.new({:base_uri => @base_uri, :http_fetcher => @http_fetcher})
+            feed.parsed_entries.each do |entry|
+              entry.parsed_stage = stage_api.stage(options.merge({:stage_uri => entry.stage_uri}))
+            end
+          end
+          if options[:eager_parser].include?(:pipeline)
+            pipeline_api = GoApiClient::Api::Pipeline.new({:base_uri => @base_uri, :http_fetcher => @http_fetcher})
+            feed.parsed_entries.each do |entry|
+              entry.parsed_pipeline = pipeline_api.pipeline(options.merge({:pipeline_uri => entry.pipeline_uri}))
+            end
+          end
+        end
+        feed
+      end
+    end
+  end
+end

data/lib/go_api_client/api/job.rb

@@ -0,0 +1,34 @@
+require 'nokogiri'
+
+module GoApiClient
+  module Api
+    class Job < GoApiClient::Api::AbstractApi
+
+      def initialize(attributes = {})
+        super(attributes)
+      end
+
+      def job(options = {})
+        if options[:job_uri]
+          uri = options[:job_uri]
+        else
+          raise 'Insufficient arguments' unless options[:job_id]
+          uri = "#{@base_uri}/api/jobs/#{options[:job_id]}.xml"
+        end
+        GoApiClient::Parsers::Job.parse(Nokogiri::XML(@http_fetcher.get!(uri)).root)
+      end
+
+      def scheduled_jobs
+        uri = "#{@base_uri}/api/jobs/scheduled.xml"
+        doc = Nokogiri::XML(@http_fetcher.post!(uri))
+        if doc.root
+          doc.root.xpath('./job').collect do |element|
+            GoApiClient::Parsers::ScheduledJob.parse(element)
+          end
+        else
+          []
+        end
+      end
+    end
+  end
+end

data/lib/go_api_client/api/pipeline.rb

@@ -0,0 +1,87 @@
+require 'nokogiri'
+
+module GoApiClient
+  module Api
+    class Pipeline < GoApiClient::Api::AbstractApi
+
+      def initialize(attributes = {})
+        attributes = ({:pipeline_cache => {}, :stage_cache => {}}).merge(attributes)
+        super(attributes)
+      end
+
+      # Schedule a particular pipeline with the latest available materials.
+      def schedule(options = {})
+        # options {:materials => nil, :variables => nil, :secure_variables => nil}
+        options = ({:schedule_uri => nil, :pipeline_name => nil}).merge(options)
+        if options[:schedule_uri]
+          uri = options[:schedule_uri]
+        else
+          raise 'Insufficient arguments' unless options[:pipeline_name]
+          uri = "#{@base_uri}/api/pipelines/#{options[:pipeline_name]}/schedule"
+        end
+        @http_fetcher.post!(uri)
+      end
+
+      # This API allows you to release a lock on a pipeline so that you can start up a new instance without
+      # having to wait for the earlier instance to finish.
+      def release_lock(options = {})
+        options = ({:release_lock_uri => nil, :pipeline_name => nil}).merge(options)
+        if options[:release_lock_uri]
+          uri = options[:release_lock_uri]
+        else
+          raise 'Insufficient arguments' unless options[:pipeline_name]
+          uri = "#{@base_uri}/api/pipelines/#{options[:pipeline_name]}/releaseLock"
+        end
+        @http_fetcher.post!(uri)
+      end
+
+      # This API provides the ability to pause a pipeline.
+      def pause(options = {})
+        options = ({:pause_uri => nil, :pipeline_name => nil}).merge(options)
+        if options[:pause_uri]
+          uri = options[:pause_uri]
+        else
+          raise 'Insufficient arguments' unless options[:pipeline_name]
+          uri = "#{@base_uri}/api/pipelines/#{options[:pipeline_name]}/pause"
+        end
+        @http_fetcher.post!(uri)
+      end
+
+      # This API provides the ability to unpause a pipeline.
+      def unpause(options={})
+        options = ({:unpause_uri => nil, :pipeline_name => nil}).merge(options)
+        if options[:unpause_uri]
+          uri = options[:unpause_uri]
+        else
+          raise 'Insufficient arguments' unless options[:pipeline_name]
+          uri = "#{@base_uri}/api/pipelines/#{options[:pipeline_name]}/unpause"
+        end
+        @http_fetcher.post!(uri)
+      end
+
+      def pipeline(options = {})
+        options = ({:pipeline_uri => nil, :pipeline_name => nil, :pipeline_id => nil, :eager_parser => []}).merge(options)
+        if options[:pipeline_uri]
+          uri = options[:pipeline_uri]
+        else
+          raise 'Insufficient arguments' unless options[:pipeline_name] && options[:pipeline_id]
+          uri = "#{@base_uri}/api/pipelines/#{options[:pipeline_name]}/#{options[:pipeline_id]}.xml"
+        end
+        pipeline = GoApiClient::Parsers::Pipeline.parse(Nokogiri::XML(@http_fetcher.get!(uri)).root)
+        @pipeline_cache[GoApiClient::Domain::InternalCache.new(pipeline.self_uri, options)] ||= pipeline
+        if options[:eager_parser] && options[:eager_parser].include?(:stage)
+          stage_api = GoApiClient::Api::Stage.new({:base_uri => @base_uri, :http_fetcher => @http_fetcher, :pipeline_cache => @pipeline_cache, :stage_cache => @stage_cache})
+          pipeline.parsed_stages = pipeline.stages.collect do |stage_uri|
+            stage = @stage_cache[GoApiClient::Domain::InternalCache.new(stage_uri, options)] || stage_api.stage(options.merge({:stage_uri => stage_uri}))
+            @stage_cache[GoApiClient::Domain::InternalCache.new(stage_uri, options)] ||= stage
+            stage
+          end
+        end
+        pipeline
+      end
+
+      private
+      attr_accessor :pipeline_cache, :stage_cache
+    end
+  end
+end