go_api_client 0.0.2

data/.gitignore

@@ -0,0 +1,40 @@
+# Compiled source #
+###################
+*.com
+*.class
+*.dll
+*.exe
+*.o
+*.so
+
+# Packages #
+############
+# it's better to unpack these files and commit the raw source
+# git has its own built in compression methods
+*.7z
+*.dmg
+*.gz
+*.iso
+*.jar
+*.rar
+*.tar
+*.zip
+
+# Logs and databases #
+######################
+*.log
+*.sql
+*.sqlite
+
+# OS generated files #
+######################
+.DS_Store*
+ehthumbs.db
+Icon?
+Thumbs.db
+
+
+
+\#*\#
+.\#*
+TAGS

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in go_api_client.gemspec
+gemspec
+
+gem "webmock"

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    go_api_client (0.0.1)
+      nokogiri
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.7)
+    crack (0.3.1)
+    nokogiri (1.5.0)
+    webmock (1.8.0)
+      addressable (>= 2.2.7)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  go_api_client!
+  webmock

data/README.textile

@@ -0,0 +1,36 @@
+h2. Go API Client Gem
+
+This gem provides API access to the go api.
+
+h2. Installation
+
+<pre>$ [sudo] gem install go_api_client</pre>
+
+h2. Usage
+
+h2. License
+
+Go API Client Gem is MIT Licensed
+
+The MIT License
+
+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/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+task :test do
+  Rake::TestTask.new do |t|
+     t.libs << "test"
+     t.test_files = FileList['test/**/*test.rb']
+     t.verbose = true
+   end
+end
+
+task :default => :test
+

data/bin/go_api_client

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require "go_api_client"

data/go_api_client.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "go_api_client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "go_api_client"
+  s.version     = GoApiClient::VERSION
+  s.authors     = ["Nikhil Mungel"]
+  s.email       = ["hyfather@gmail.com"]
+  s.homepage    = ""
+  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.rubyforge_project = "go_api_client"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  s.add_runtime_dependency "nokogiri"
+end

data/lib/go_api_client/atom/author.rb

@@ -0,0 +1,18 @@
+module GoApiClient
+  module Atom
+    class Author
+      attr_accessor :name, :email, :uri
+      def initialize(root)
+        @root = root
+      end
+
+      def parse!
+        self.name     = @root.xpath('xmlns:name').first.content
+        self.email    = @root.xpath('xmlns:email').first.content rescue nil
+        self.uri      = @root.xpath('xmlns:uri').first.content   rescue nil
+        @root = nil
+        self
+      end
+    end
+  end
+end

data/lib/go_api_client/atom/entry.rb

@@ -0,0 +1,28 @@
+module GoApiClient
+  module Atom
+    class Entry
+      attr_accessor :authors, :id, :updated_at, :title, :stage_href, :pipelines
+
+      def initialize(root)
+        @root = root
+      end
+
+      def parse!
+        self.updated_at = @root.xpath('xmlns:updated').first.content
+        self.id         = @root.xpath('xmlns:id').first.content
+        self.title      = @root.xpath('xmlns:title').first.content
+        self.stage_href = @root.
+          xpath("xmlns:link[@type='application/vnd.go+xml' and  @rel='alternate']").
+          first.
+          attributes["href"]
+
+        self.authors    = @root.xpath('xmlns:author').collect do |author|
+          Author.new(author).parse!
+        end
+        @root = nil
+        self
+      end
+    end
+  end
+end
+

data/lib/go_api_client/atom/feed.rb

@@ -0,0 +1,85 @@
+module GoApiClient
+  module Atom
+    class Feed
+      attr_accessor :updated_at
+      attr_accessor :next_page
+      attr_accessor :url
+      attr_accessor :entries
+
+      def initialize(root)
+        @root = root
+      end
+
+      def parse!
+        self.updated_at = @root.xpath('xmlns:updated').first.content
+        self.next_page  = @root.xpath("xmlns:link[@rel='next']").first.attribute('href').value
+        self.url        = @root.xpath("xmlns:link[@rel='self']").first.attribute('href').value
+
+        self.entries    = @root.xpath("xmlns:entry").collect do |entry|
+          Entry.new(entry).parse!
+        end
+        self
+      end
+
+      def self.construct
+        doc = Nokogiri::XML(open("http://localhost:8153/go/api/pipelines/defaultPipeline/stages.xml"))
+        feed = GoApiClient::Atom::Feed.new(doc.root).parse!
+        pipelines = []
+        feed.entries.collect do |entry|
+          pipelines = Stage.new(entry, pipelines).fetch
+        end
+        pipelines
+      end
+    end
+  end
+
+
+  class Stage
+    attr_reader :authors, :details_link, :name, :result
+
+    def initialize(entry, pipelines)
+      @authors = entry.authors
+      @details_link = entry.stage_href
+      @pipelines = pipelines
+    end
+
+    def fetch
+      doc = Nokogiri::XML(open(self.details_link))
+      @name = doc.root.xpath("@name").first.value
+      @result = doc.root.xpath("//result").first.content
+
+      pipeline_link = doc.root.xpath("//pipeline").first.attributes["href"].value
+      existing_pipeline =  @pipelines.find {|p| p.same?(pipeline_link)}
+      
+      if existing_pipeline
+        existing_pipeline.stages << self
+      else
+        new_pipeline = Pipeline.new(pipeline_link).fetch
+        new_pipeline.stages << self
+        @pipelines << new_pipeline
+      end
+      @pipelines
+    end
+  end
+
+  class Pipeline
+    attr_reader :details_link, :id
+    attr_accessor :stages
+
+    def initialize(details_link)
+      @details_link = details_link
+      @stages = []
+    end
+
+    def fetch
+      doc = Nokogiri::XML(open(self.details_link))
+      @label = doc.root.attributes["label"].value
+      @id = doc.root.xpath("//id").first.content
+      self
+    end
+
+    def same?(link)
+      @details_link == link
+    end
+  end
+end

data/lib/go_api_client/atom.rb

@@ -0,0 +1,4 @@
+require 'go_api_client/atom/author'
+require 'go_api_client/atom/entry'
+require 'go_api_client/atom/feed'
+

data/lib/go_api_client/test/stub_http_fetcher.rb

@@ -0,0 +1,91 @@
+require 'ostruct'
+module GoApiClient
+  class StubHttpFetcher
+    # Careful : this will respond to any call with nil
+    class HashStruct < OpenStruct
+      def [](key)
+        self.headers[key]
+      end
+    end
+
+    module Response
+      def invoked!
+        @invoked = true
+      end
+
+      def invoked?
+        !!@invoked
+      end
+    end
+
+    class StringResponse
+      include Response
+      def initialize(content, code = 200, headers = {})
+        @content = content
+        @code = code.to_s
+        @headers = headers
+      end
+
+      def execute
+        HashStruct.new(:body => @content, :code => @code, :headers => @headers)
+      end
+
+    end
+
+    class ErrorResponse
+      include Response
+      def initialize(error)
+        @error = error
+      end
+
+      def execute
+        raise @error
+      end
+    end
+
+    def get(url)
+      if body = interweb[:get][url]
+        body.invoked!
+        return body.execute
+      else
+        raise "404 - Could not find #{url}. Available URLs are #{@interweb[:get].keys.inspect}"
+      end
+    end
+
+    def post(url, params = {})
+      if body = interweb[:post][url]
+        response = body.execute
+        if response.headers == params
+          body.invoked!
+          return response
+        end
+      end
+
+      raise "404 - Could not find a url listening to #{url.inspect} that responds to post params #{params.inspect}. Available URLs are #{@interweb[:post].keys.inspect}"
+    end
+
+    def invoked?(url, type = :get, params = {})
+      if body = interweb[type][url]
+        response = body.execute
+        if response.headers == params
+
+          body.invoked?
+        end
+      end
+    end
+
+    def register_content(content, url, type = :get, headers = {})
+      interweb[type][url] = StringResponse.new(content, 200, headers)
+    end
+
+    def register_error(url, type = :get, error)
+      interweb[type][url] = ErrorResponse.new(error)
+    end
+
+    def interweb
+      @interweb ||= {:get => {}, :post => {}}
+    end
+
+  end
+end
+

data/lib/go_api_client/test.rb

@@ -0,0 +1 @@
+require 'go_api_client/test/stub_http_fetcher.rb'

data/lib/go_api_client/version.rb

@@ -0,0 +1,3 @@
+module GoApiClient
+  VERSION = "0.0.2"
+end

data/lib/go_api_client.rb

@@ -0,0 +1,16 @@
+require 'nokogiri'
+require "go_api_client/version"
+require "go_api_client/atom"
+require "open-uri"
+module GoApiClient
+  def self.runs(host)
+    doc = Nokogiri::XML(open("http://#{host}/go/api/pipelines/defaultPipeline/stages.xml"))
+    feed = GoApiClient::Atom::Feed.new(doc.root).parse!
+    pipelines = []
+    feed.entries.collect do |entry|
+      pipelines = Stage.new(entry, pipelines).fetch
+    end
+    pipelines
+  end
+
+end

data/test/fixtures/pipelines_1.xml

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<pipeline name="defaultPipeline" counter="1" label="1">
+  <link rel="self" href="http://localhost:8153/go/api/pipelines/defaultPipeline/1.xml"/>
+  <id><![CDATA[urn:x-go.studios.thoughtworks.com:job-id:defaultPipeline:1]]></id>
+  <scheduleTime>2012-02-23T17:16:15+05:30</scheduleTime>
+  <materials>
+    <material materialUri="http://localhost:8153/go/api/materials/1.xml" type="GitMaterial" url="git@github.com:oogabooga/zinger.git" branch="master">
+      <modifications>
+        <changeset changesetUri="http://localhost:8153/go/api/materials/1/changeset/9f77888d7a594699894a17f4d61fc9dfac3cfb74.xml">
+          <user><![CDATA[oogabooga <twgosaas@gmail.com>]]></user>
+          <checkinTime>2012-02-21T15:41:30+05:30</checkinTime>
+          <revision><![CDATA[9f77888d7a594699894a17f4d61fc9dfac3cfb74]]></revision>
+          <message><![CDATA[Update README]]></message>
+          <file name="README" action="modified"/>
+        </changeset>
+      </modifications>
+    </material>
+  </materials>
+  <stages>
+    <stage href="http://localhost:8153/go/api/stages/1.xml"/>
+    <stage href="http://localhost:8153/go/api/stages/2.xml"/>
+  </stages>
+  <approvedBy><![CDATA[changes]]></approvedBy>
+</pipeline>

data/test/fixtures/stages.xml

@@ -0,0 +1,63 @@
+<feed xmlns="http://www.w3.org/2005/Atom" xmlns:go="http://www.thoughtworks-studios.com/ns/go">
+    <title><![CDATA[defaultPipeline]]></title>
+    <id>http://localhost:8153/go/api/pipelines/defaultPipeline/stages.xml</id>
+    <author>
+        <name>Go</name>
+    </author>
+    <updated>2012-02-23T17:19:31+05:30</updated>
+    <link rel="self" href="http://localhost:8153/go/api/pipelines/defaultPipeline/stages.xml"/>
+
+    
+        <link rel="next" href="http://localhost:8153/go/api/pipelines/defaultPipeline/stages.xml?before=6"/>
+    
+
+    
+        <entry>
+            <title><![CDATA[defaultPipeline(1) stage Acceptance(1) Failed]]></title>
+            <updated>2012-02-23T17:19:31+05:30</updated>
+            <id>http://localhost:8153/go/pipelines/defaultPipeline/1/Acceptance/1</id>
+
+
+            <author>
+                <name><![CDATA[oogabooga <twgosaas@gmail.com>]]></name>
+            </author>
+
+            
+            <link title="Acceptance Stage Detail" href="http://localhost:8153/go/api/stages/2.xml" rel="alternate" type="application/vnd.go+xml"/>
+            <link title="Acceptance Stage Detail" href="http://localhost:8153/go/pipelines/defaultPipeline/1/Acceptance/1" rel="alternate" type="text/html"/>
+            
+            <link title="defaultPipeline Pipeline Detail" href="http://localhost:8153/go/api/pipelines/defaultPipeline/1.xml" rel="http://www.thoughtworks-studios.com/ns/relations/go/pipeline" type="application/vnd.go+xml"/>
+            <link title="defaultPipeline Pipeline Detail" href="http://localhost:8153/go/pipelines/defaultPipeline/1/Acceptance/1/pipeline" rel="http://www.thoughtworks-studios.com/ns/relations/go/pipeline" type="text/html"/>
+
+
+
+            <category scheme="http://www.thoughtworks-studios.com/ns/categories/go" term="stage" label="Stage" />
+            <category scheme="http://www.thoughtworks-studios.com/ns/categories/go" term="completed" label="Completed" />
+            <category scheme="http://www.thoughtworks-studios.com/ns/categories/go" term="failed" label="Failed" />
+        </entry>
+    
+        <entry>
+            <title><![CDATA[defaultPipeline(1) stage Units(1) Failed]]></title>
+            <updated>2012-02-23T17:16:41+05:30</updated>
+            <id>http://localhost:8153/go/pipelines/defaultPipeline/1/Units/1</id>
+
+
+            <author>
+                <name><![CDATA[oogabooga <twgosaas@gmail.com>]]></name>
+            </author>
+
+            
+            <link title="Units Stage Detail" href="http://localhost:8153/go/api/stages/1.xml" rel="alternate" type="application/vnd.go+xml"/>
+            <link title="Units Stage Detail" href="http://localhost:8153/go/pipelines/defaultPipeline/1/Units/1" rel="alternate" type="text/html"/>
+            
+            <link title="defaultPipeline Pipeline Detail" href="http://localhost:8153/go/api/pipelines/defaultPipeline/1.xml" rel="http://www.thoughtworks-studios.com/ns/relations/go/pipeline" type="application/vnd.go+xml"/>
+            <link title="defaultPipeline Pipeline Detail" href="http://localhost:8153/go/pipelines/defaultPipeline/1/Units/1/pipeline" rel="http://www.thoughtworks-studios.com/ns/relations/go/pipeline" type="text/html"/>
+
+
+
+            <category scheme="http://www.thoughtworks-studios.com/ns/categories/go" term="stage" label="Stage" />
+            <category scheme="http://www.thoughtworks-studios.com/ns/categories/go" term="completed" label="Completed" />
+            <category scheme="http://www.thoughtworks-studios.com/ns/categories/go" term="failed" label="Failed" />
+        </entry>
+    
+</feed>

data/test/fixtures/stages_1.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<stage name="Units" counter="1">
+  <link rel="self" href="http://localhost:8153/go/api/stages/1.xml"/>
+  <id><![CDATA[urn:x-go.studios.thoughtworks.com:stage-id:defaultPipeline:1:Units:1]]></id>
+  <pipeline name="defaultPipeline" counter="1" label="1" href="http://localhost:8153/go/api/pipelines/defaultPipeline/1.xml"/>
+  <updated>2012-02-23T17:16:41+05:30</updated>
+  <result>Failed</result>
+  <state>Completed</state>
+  <approvedBy><![CDATA[changes]]></approvedBy>
+  <jobs>
+    <job href="http://localhost:8153/go/api/jobs/1.xml"/>
+  </jobs>
+</stage>

data/test/fixtures/stages_2.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<stage name="Acceptance" counter="1">
+  <link rel="self" href="http://localhost:8153/go/api/stages/2.xml"/>
+  <id><![CDATA[urn:x-go.studios.thoughtworks.com:stage-id:defaultPipeline:1:Acceptance:1]]></id>
+  <pipeline name="defaultPipeline" counter="1" label="1" href="http://localhost:8153/go/api/pipelines/defaultPipeline/1.xml"/>
+  <updated>2012-02-23T17:19:31+05:30</updated>
+  <result>Failed</result>
+  <state>Completed</state>
+  <approvedBy><![CDATA[anonymous]]></approvedBy>
+  <jobs>
+    <job href="http://localhost:8153/go/api/jobs/2.xml"/>
+  </jobs>
+</stage>

data/test/go_api_client/integration_test.rb

@@ -0,0 +1,25 @@
+require "test_helper"
+
+class IntegrationTest < Test::Unit::TestCase
+
+  def test_end_to_end
+    stub_request(:get, "http://localhost:8153/go/api/pipelines/defaultPipeline/stages.xml").to_return(:body => file_contents("stages.xml"))
+    stub_request(:get, "http://localhost:8153/go/api/pipelines/defaultPipeline/1.xml").to_return(:body => file_contents("pipelines_1.xml"))
+    stub_request(:get, "http://localhost:8153/go/api/stages/1.xml").to_return(:body => file_contents("stages_1.xml"))
+    stub_request(:get, "http://localhost:8153/go/api/stages/2.xml").to_return(:body => file_contents("stages_2.xml"))
+    pipelines = GoApiClient.runs("localhost:8153")
+    assert_equal 1, pipelines.count
+    stages = pipelines.first.stages
+    assert_equal 2, stages.count
+    stages.each do |stage|
+      assert_equal "oogabooga <twgosaas@gmail.com>", stage.authors.first.name
+      assert_equal "Failed", stage.result
+    end
+    assert_equal "Acceptance", stages.first.name
+    assert_equal "Units", stages.last.name
+  end
+
+  def file_contents(file_name)
+    File.read(File.expand_path("../../fixtures/#{file_name}", __FILE__))
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'test/unit'
+require 'go_api_client/test'
+
+require 'go_api_client'
+
+require 'webmock/test_unit'
+

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: go_api_client
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Nikhil Mungel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-24 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70232878359900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70232878359900
+description: This gem parses atom feed generated by the Go Continuous Integration
+  server and provides an OO representation of the pipelines and stages.
+email:
+- hyfather@gmail.com
+executables:
+- go_api_client
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.textile
+- Rakefile
+- bin/go_api_client
+- go_api_client.gemspec
+- lib/go_api_client.rb
+- lib/go_api_client/atom.rb
+- lib/go_api_client/atom/author.rb
+- lib/go_api_client/atom/entry.rb
+- lib/go_api_client/atom/feed.rb
+- lib/go_api_client/test.rb
+- lib/go_api_client/test/stub_http_fetcher.rb
+- lib/go_api_client/version.rb
+- test/fixtures/pipelines_1.xml
+- test/fixtures/stages.xml
+- test/fixtures/stages_1.xml
+- test/fixtures/stages_2.xml
+- test/go_api_client/integration_test.rb
+- test/test_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: go_api_client
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Client to parse Go CI atom feed
+test_files:
+- test/fixtures/pipelines_1.xml
+- test/fixtures/stages.xml
+- test/fixtures/stages_1.xml
+- test/fixtures/stages_2.xml
+- test/go_api_client/integration_test.rb
+- test/test_helper.rb