bamboo-client 0.0.3 → 0.0.4

data/cucumber.yml

@@ -1,2 +1,4 @@
 autotest-all: --color --format pretty features
+autotest-rest: --color --format pretty features/rest.feature
+autotest-remote: --color --format pretty features/remote.feature
 default: --color --format progress features

data/features/rest.feature

@@ -0,0 +1,22 @@
+Feature: Bamboo REST client
+  In order to know more about our build pipeline
+  As a Bamboo user
+  I want to use Bamboo's REST API
+
+  Background:
+    Given I am using the REST client
+
+  Scenario: Fetch plans
+    When I fetch all the plans
+    Then I should get a list of plans
+    And all plans should have a key
+
+  Scenario: Fetch projects
+    When I fetch all projects
+    Then I should get a list of projects
+    And all projects should have a key
+
+  Scenario: Fetch all builds
+    When I fetch all builds
+    Then I should get a list of builds
+    And all builds should have a state

data/features/step_definitions/remote_steps.rb

@@ -12,7 +12,7 @@ end
 
 Then /^I should get a list of builds$/ do
   @builds.should_not be_empty
-  @builds.each { |e| e.should be_kind_of(Bamboo::Client::Remote::Build)  }
+  @builds.each { |e| e.should be_kind_of(client.class::Build)  }
 end
 
 When /^I fetch a build result$/ do

data/features/step_definitions/rest_steps.rb

@@ -0,0 +1,33 @@
+When /^I fetch all the plans$/ do
+  @plans = client.plans
+end
+
+Then /^I should get a list of plans$/ do
+  @plans.should_not be_empty
+  @plans.each { |plan| plan.should be_kind_of(Bamboo::Client::Rest::Plan) }
+end
+
+When /^I fetch all projects$/ do
+  @projects = client.projects
+end
+
+Then /^I should get a list of projects$/ do
+  @projects.should_not be_empty
+  @projects.each { |pro| pro.should be_kind_of(Bamboo::Client::Rest::Project) }
+end
+
+Then /^all plans should have a key$/ do
+  @plans.each { |e| e.key.should be_kind_of(String) }
+end
+
+Then /^all projects should have a key$/ do
+  @projects.each { |e| e.key.should be_kind_of(String) }
+end
+
+When /^I fetch all builds$/ do
+  @builds = client.builds
+end
+
+Then /^all builds should have a state$/ do
+  @builds.each { |b| [:successful, :failed].should include(b.state) }
+end

data/features/support/env.rb

@@ -1,6 +1,8 @@
 $:.unshift File.expand_path("../../../lib", __FILE__)
 require "bamboo-client"
 
+$DEBUG = false
+
 module BambooClientHelper
   attr_reader :client
 
@@ -27,4 +29,4 @@ module BambooClientHelper
   end
 end
 
-World(BambooClientHelper)
+World(BambooClientHelper)

data/lib/bamboo-client.rb

@@ -1,5 +1,6 @@
 require "uri"
 require "restclient"
+require "time"
 
 require "bamboo-client/version"
 require "bamboo-client/http"
@@ -7,6 +8,7 @@ require "bamboo-client/abstract"
 require "bamboo-client/rest"
 require "bamboo-client/remote"
 
+require "pp" if $DEBUG
 
 module Bamboo
   module Client

data/lib/bamboo-client/http/abstract.rb

@@ -7,6 +7,29 @@ module Bamboo
         def initialize(url)
           @uri = URI.parse url
         end
+
+        private
+
+        def uri_for(uri_or_path, params = nil)
+          if uri_or_path.kind_of? URI
+            u = uri_or_path.dup
+
+            u.host   = @uri.host
+            u.port   = @uri.port
+            u.scheme = @uri.scheme
+          else
+            u = uri.dup
+            u.path = uri_or_path
+          end
+
+          u.query = query_string_for(params) if params
+          u.to_s
+        end
+
+        def query_string_for(params)
+          params.map { |k, v| "#{k.to_s}=#{CGI.escape(v.to_s)}" }.join('&')
+        end
+
       end # Abstract
     end # Http
   end # Client

data/lib/bamboo-client/http/json.rb

@@ -4,6 +4,50 @@ module Bamboo
   module Client
     module Http
       class Json < Abstract
+        class Doc
+          attr_reader :data
+
+          def self.from(str)
+            new JSON.parse(str)
+          end
+
+          def initialize(data)
+            @data = data
+            pp @data if $DEBUG
+          end
+
+          def doc_for(key)
+            Doc.new @data.fetch(key)
+          end
+
+          def auto_expand(klass, client)
+            key_to_expand = @data.fetch('expand')
+
+            obj = @data[key_to_expand]
+            case obj
+            when Hash
+              if obj.has_key?('expand')
+                Doc.new(obj).auto_expand(klass, client)
+              else
+                klass.new(obj, client)
+              end
+            when Array
+              obj.map { |e| klass.new(e, client) }
+            else
+              raise TypeError, "don't know how to auto-expand #{obj.inspect}"
+            end
+          end
+        end # Doc
+
+        def post(uri_or_path, data = {})
+          resp = RestClient.post(uri_for(uri_or_path), data.to_json, :accept => :json, :content_type => :json)
+          Doc.from(resp) unless resp.empty?
+        end
+
+        def get(uri_or_path, params = nil)
+          uri = uri_for(uri_or_path, params)
+          Doc.from RestClient.get(uri, :accept => :json)
+        end
 
       end # Json
     end # Http

data/lib/bamboo-client/http/xml.rb

@@ -44,14 +44,6 @@ module Bamboo
           Doc.from RestClient.post(uri_for(path), data)
         end
 
-        private
-
-        def uri_for(path)
-          u      = uri.dup
-          u.path = path
-
-          u.to_s
-        end
       end # Xml
     end # Http
   end # Client

data/lib/bamboo-client/rest.rb

@@ -8,6 +8,167 @@ module Bamboo
     #
 
     class Rest < Abstract
+      def initialize(http)
+        super
+        @service = "/rest/api/latest"
+      end
+
+      def plans
+        get("plan/").auto_expand Plan, @http
+      end
+
+      def projects
+        get("project/").auto_expand Project, @http
+      end
+
+      def builds
+        get("build/").auto_expand Build, @http
+      end
+
+      private
+
+      def get(what)
+        @http.get File.join(@service, what)
+      end
+
+      class Plan
+        def initialize(data, http)
+          @data = data
+          @http = http
+        end
+
+        def enabled?
+          @data['enabled']
+        end
+
+        def type
+          @data['type'].downcase.to_sym
+        end
+
+        def name
+          @data['name']
+        end
+
+        def key
+          @data['key']
+        end
+
+        def url
+          @data.fetch("link")['href']
+        end
+      end # Plan
+
+      class Project
+        def initialize(data, http)
+          @data = data
+          @http = http
+        end
+
+        def name
+          @data['name']
+        end
+
+        def key
+          @data['key']
+        end
+
+        def url
+          @data.fetch("link")['href']
+        end
+      end # Project
+
+      class Build
+        def initialize(data, http)
+          @data = data
+          @http = http
+
+          @changes = nil
+        end
+
+        def state
+          @data.fetch('state').downcase.to_sym
+        end
+
+        def life_cycle_state
+          @data.fetch("lifeCycleState").downcase.to_sym
+        end
+
+        def number
+          @data['number']
+        end
+
+        def key
+          @data['key']
+        end
+
+        def id
+          @data['id']
+        end
+
+        def url
+          @data.fetch("link")['href']
+        end
+
+        def uri
+          @uri ||= URI.parse(url)
+        end
+
+        def changes
+          @changes ||= (
+            doc = fetch_details("changes.change.files").doc_for('changes')
+            doc.auto_expand Change, @http
+          )
+        end
+
+        private
+
+        def fetch_details(expand)
+          @http.get(uri, :expand => expand)
+        end
+      end # Build
+
+      class Change
+        def initialize(data, http)
+          @data = data
+          @http = http
+        end
+
+        def id
+          @data['changesetId']
+        end
+
+        def date
+          Time.parse @data['date']
+        end
+
+        def author
+          @data['author']
+        end
+
+        def full_name
+          @data['fullName']
+        end
+
+        def user_name
+          @data['userName']
+        end
+
+        def comment
+          @data['comment']
+        end
+
+        def files
+          # could use expand here
+          Array(@data.fetch('files')['file']).map do |data|
+            {
+              :name     => data['name'],
+              :revision => data['revision']
+            }
+          end
+        end
+
+
+      end # Change
 
     end # Rest
   end # Client

data/lib/bamboo-client/version.rb

@@ -1,5 +1,5 @@
 module Bamboo
   module Client
-    VERSION = "0.0.3"
+    VERSION = "0.0.4"
   end
 end

data/spec/bamboo-client/http/json_spec.rb

@@ -0,0 +1,80 @@
+require File.expand_path("../../../spec_helper", __FILE__)
+
+module Bamboo
+  module Client
+    module Http
+      describe Json do
+        let(:url) { "http://example.com" }
+        let(:json) { Json.new(url) }
+
+        it "does a GET" do
+          RestClient.should_receive(:get).with(
+            "#{url}/", :accept => :json
+            ).and_return('{"some": "data"}')
+
+          doc = json.get "/"
+          doc.should be_kind_of(Json::Doc)
+        end
+
+        it "does a POST" do
+          RestClient.should_receive(:post).with(
+            "#{url}/", '{"some":"data"}', :accept => :json, :content_type => :json
+            ).and_return('')
+
+          json.post("/", :some => "data").should be_nil
+        end
+      end
+
+      describe Json::Doc do
+        it "auto expands a one-level expansion" do
+          doc = Json::Doc.new(
+            "expand" => "a",
+            "a" => {"some" => "data"}
+          )
+
+          doc.auto_expand(SpecHelper::Wrapper, nil).obj.should == {"some" => "data"}
+        end
+
+        it "auto expands Arrays" do
+          expected = [{"some" => "data"}, {"something" => "else"}]
+
+          doc = Json::Doc.new(
+            "expand" => "a",
+            "a" => expected
+          )
+
+          actual = doc.auto_expand(SpecHelper::Wrapper, nil).map { |e| e.obj }
+          actual.should == expected
+        end
+
+        it "auto-expands the next expansion level" do
+          doc = Json::Doc.new(
+            "expand" => "a",
+            "a" => {
+              "expand" => "b",
+              "b" => %w[foo bar]
+            }
+          )
+
+          actual = doc.auto_expand(SpecHelper::Wrapper, nil).map { |e| e.obj }
+          actual.should == %w[foo bar]
+        end
+
+        it "raises a TypeError if an object can't be expanded" do
+          doc = Json::Doc.new(
+            "expand" => "a",
+            "a" => 1
+          )
+
+          lambda { doc.auto_expand(SpecHelper::Wrapper, nil) }.should raise_error(TypeError)
+        end
+
+        it "returns a doc for the given key" do
+          doc = Json::Doc.new("foo" => {"bar" => "baz"})
+          doc.doc_for("foo").data.should == {"bar" => "baz"}
+        end
+      end
+
+    end # Http
+  end # Client
+end # Bamboo

data/spec/bamboo-client/http/xml_spec.rb

@@ -19,8 +19,8 @@ module Bamboo
       end
 
       describe Xml::Doc do
-        let(:wrapped) { 
-          m = mock("nokogiri document") 
+        let(:wrapped) {
+          m = mock("nokogiri document")
           m.stub!(:css).with("errors error").and_return []
           m
         }
@@ -34,6 +34,11 @@ module Bamboo
           doc.text_for("some selector").should == "bar"
         end
 
+        it "checks for errors in the given document" do
+          wrapped.should_receive(:css).with("errors error").and_return [mock(:text => "error!")]
+          lambda { doc.text_for "some selector" }.should raise_error(Bamboo::Client::Error)
+        end
+
         it "returns an instance of the given class for each node matching the selector" do
           wrapped.should_receive(:css).with("selector").and_return(['node1', 'node2'])
 

data/spec/bamboo-client/rest_spec.rb

@@ -4,8 +4,148 @@ module Bamboo
   module Client
     describe Rest do
       let(:http) { mock(Http::Json) }
+      let(:document) { mock(Http::Json::Doc) }
       let(:client) { Rest.new(http) }
 
-    end
-  end
-end
+      it "should be able to fetch plans" do
+        document.should_receive(:auto_expand).with(Rest::Plan, http).and_return %w[foo bar]
+
+        http.should_receive(:get).with(
+          "/rest/api/latest/plan/"
+        ).and_return(document)
+
+        client.plans.should == %w[foo bar]
+      end
+
+      it "should be able to fetch projects" do
+        document.should_receive(:auto_expand).with(Rest::Project, http).and_return %w[foo bar]
+
+        http.should_receive(:get).with("/rest/api/latest/project/").
+                                  and_return(document)
+
+        client.projects.should == %w[foo bar]
+      end
+
+      it "should be able to fetch builds" do
+        document.should_receive(:auto_expand).with(Rest::Build, http).and_return %w[foo bar]
+
+        http.should_receive(:get).with("/rest/api/latest/build/").
+                                  and_return(document)
+
+        client.builds.should == %w[foo bar]
+      end
+
+      describe Rest::Plan do
+        let(:data) { json_fixture("plan") }
+        let(:plan) { Rest::Plan.new data, http  }
+
+        it "knows if the plan is enabled" do
+          plan.should be_enabled
+        end
+
+        it "has a type" do
+          plan.type.should == :chain
+        end
+
+        it "has a name" do
+          plan.name.should == "Selenium 2 Ruby - WebDriver Remote Client Tests - Windows"
+        end
+
+        it "has a key" do
+          plan.key.should == "S2RB-REMWIN"
+        end
+
+        it "has a URL" do
+          plan.url.should == "http://xserve.openqa.org:8085/rest/api/latest/plan/S2RB-REMWIN"
+        end
+      end # Plan
+
+      describe Rest::Project do
+        let(:data) { json_fixture("project") }
+        let(:plan) { Rest::Project.new data, http  }
+
+        it "has a name" do
+          plan.name.should == "Selenium 2 Java"
+        end
+
+        it "has a key" do
+          plan.key.should == "S2J"
+        end
+
+        it "has a URL" do
+          plan.url.should == "http://xserve.openqa.org:8085/rest/api/latest/project/S2J"
+        end
+      end
+
+      describe Rest::Build do
+        let(:data) { json_fixture("build") }
+        let(:build) { Rest::Build.new data, http }
+
+        it "has a key" do
+          build.key.should == "IAD-DEFAULT-5388"
+        end
+
+        it "has a state" do
+          build.state.should == :successful
+        end
+
+        it "has an id" do
+          build.id.should == 8487295
+        end
+
+        it "has a number" do
+          build.number.should == 5388
+        end
+
+        it "has a life cycle state" do
+          build.life_cycle_state.should == :finished
+        end
+
+        it "has a URL" do
+          build.url.should == "http://localhost:8085/rest/api/latest/result/IAD-DEFAULT-5388"
+        end
+
+        it "has a list of changes" do
+          # TODO: arg expectation
+          http.should_receive(:get).and_return Http::Json::Doc.new(json_fixture("build_with_changes"))
+          build.changes.first.should be_kind_of(Rest::Change)
+        end
+      end
+
+      describe Rest::Change do
+        let(:data) { json_fixture("change") }
+        let(:change) { Rest::Change.new data, http }
+
+        it "has an id" do
+          change.id.should == "131"
+        end
+
+        it "has a date" do
+          change.date.should == Time.parse("2011-01-20T10:04:47.000+01:00")
+        end
+
+        it "has an author" do
+          change.author.should == "joedev"
+        end
+
+        it "has a full name" do
+          change.full_name.should == "Joe Developer"
+        end
+
+        it "has a username" do
+          change.user_name.should == "joedev"
+        end
+
+        it "has a comment" do
+          change.comment.should == "Fixed the config thing."
+        end
+
+        it "has a list of files" do
+          change.files.first.should == {:name => "/trunk/server/src/main/resources/some-config.ini", :revision => "131"}
+        end
+      end
+
+
+    end # Rest
+  end # Client
+end # Bamboo

data/spec/fixtures/build.json

@@ -0,0 +1,12 @@
+{
+  "type": "restChainResult",
+  "id": 8487295,
+  "number": 5388,
+  "lifeCycleState": "Finished",
+  "state": "Successful",
+  "key": "IAD-DEFAULT-5388",
+  "link": {
+    "rel": "self",
+    "href": "http://localhost:8085/rest/api/latest/result/IAD-DEFAULT-5388"
+  }
+}

data/spec/fixtures/build_with_changes.json

@@ -0,0 +1,76 @@
+{
+  "id": 8159340,
+  "number": 29,
+  "lifeCycleState": "Finished",
+  "state": "Successful",
+  "key": "ADS-DEFAULT-29",
+  "expand": "changes,metadata,stages,labels,jiraIssues,comments",
+  "link": {
+    "rel": "self",
+    "href": "http://localhost:8085/rest/api/latest/build/ADS-DEFAULT-29"
+  },
+  "buildStartedTime": "2011-01-20T10:08:41.000+01:00",
+  "buildCompletedTime": "2011-01-20T10:09:32.000+01:00",
+  "buildDurationInSeconds": 51,
+  "buildDuration": 51074,
+  "buildDurationDescription": "51 seconds",
+  "buildRelativeTime": "4 weeks ago",
+  "vcsRevisionKey": "131",
+  "buildTestSummary": "13 passed",
+  "successfulTestCount": 13,
+  "failedTestCount": 0,
+  "buildReason": "Code has changed",
+  "stages": {
+    "size": 1,
+    "max-result": 1,
+    "start-index": 0
+  },
+  "labels": {
+    "size": 0,
+    "max-result": 0,
+    "start-index": 0
+  },
+  "jiraIssues": {
+    "size": 1,
+    "max-result": 1,
+    "start-index": 0
+  },
+  "comments": {
+    "size": 0,
+    "max-result": 0,
+    "start-index": 0
+  },
+  "changes": {
+    "expand": "change",
+    "size": 1,
+    "max-result": 1,
+    "start-index": 0,
+    "change": [
+      {
+        "changesetId": "131",
+        "fullName": "Joe Developer",
+        "userName": "joedev",
+        "author": "joedev",
+        "expand": "files",
+        "comment": "Fixed the config thing.",
+        "date": "2011-01-20T10:04:47.000+01:00",
+        "files": {
+          "size": 1,
+          "max-result": 1,
+          "start-index": 0,
+          "file": [
+            {
+              "name": "/trunk/server/src/main/resources/some-config.ini",
+              "revision": "131"
+            }
+          ]
+        }
+      }
+    ]
+  },
+  "metadata": {
+    "size": 7,
+    "max-result": 7,
+    "start-index": 0
+  }
+}

data/spec/fixtures/change.json

@@ -0,0 +1,20 @@
+{
+  "changesetId": "131",
+  "fullName": "Joe Developer",
+  "userName": "joedev",
+  "author": "joedev",
+  "expand": "files",
+  "comment": "Fixed the config thing.",
+  "date": "2011-01-20T10:04:47.000+01:00",
+  "files": {
+    "size": 1,
+    "max-result": 1,
+    "start-index": 0,
+    "file": [
+      {
+        "name": "/trunk/server/src/main/resources/some-config.ini",
+        "revision": "131"
+      }
+    ]
+  }
+}

data/spec/fixtures/plan.json

@@ -0,0 +1,12 @@
+{
+    "enabled":true,
+    "type":"chain",
+    "name":"Selenium 2 Ruby - WebDriver Remote Client Tests - Windows",
+    "key":"S2RB-REMWIN",
+    "link":
+    {
+        "rel":"self",
+        "href":"http://xserve.openqa.org:8085/rest/api/latest/plan/S2RB-REMWIN"
+    }
+}
+

data/spec/fixtures/project.json

@@ -0,0 +1,8 @@
+{
+  "name": "Selenium 2 Java",
+  "key": "S2J",
+  "link": {
+    "rel": "self",
+    "href": "http://xserve.openqa.org:8085/rest/api/latest/project/S2J"
+  }
+}

data/spec/spec_helper.rb

@@ -16,6 +16,12 @@ module Bamboo::Client::SpecHelper
     Nokogiri.XML File.read(path)
   end
 
+  def json_fixture(name)
+    path = File.join fixture_path("#{name}.json")
+
+    JSON.parse File.read(path)
+  end
+
   def fixture_path(file)
     dir = File.expand_path("../fixtures", __FILE__)
 

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: bamboo-client
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 3
-  version: 0.0.3
+  prerelease: 
+  version: 0.0.4
 platform: ruby
 authors: 
 - Jari Bakken
@@ -14,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-19 00:00:00 +01:00
+date: 2011-02-17 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,8 +21,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :development
   version_requirements: *id001
@@ -38,8 +32,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :development
   version_requirements: *id002
@@ -51,8 +43,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :development
   version_requirements: *id003
@@ -64,8 +54,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :runtime
   version_requirements: *id004
@@ -77,8 +65,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :runtime
   version_requirements: *id005
@@ -90,8 +76,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :runtime
   version_requirements: *id006
@@ -114,7 +98,9 @@ files:
 - bamboo-client.gemspec
 - cucumber.yml
 - features/remote.feature
+- features/rest.feature
 - features/step_definitions/remote_steps.rb
+- features/step_definitions/rest_steps.rb
 - features/support/env.rb
 - lib/bamboo-client.rb
 - lib/bamboo-client/abstract.rb
@@ -126,11 +112,17 @@ files:
 - lib/bamboo-client/rest.rb
 - lib/bamboo-client/version.rb
 - spec/bamboo-client/client_spec.rb
+- spec/bamboo-client/http/json_spec.rb
 - spec/bamboo-client/http/xml_spec.rb
 - spec/bamboo-client/remote_spec.rb
 - spec/bamboo-client/rest_spec.rb
+- spec/fixtures/build.json
 - spec/fixtures/build.xml
 - spec/fixtures/build_result.xml
+- spec/fixtures/build_with_changes.json
+- spec/fixtures/change.json
+- spec/fixtures/plan.json
+- spec/fixtures/project.json
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: ""
@@ -146,32 +138,36 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: bamboo-client
-rubygems_version: 1.3.7
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: Ruby client for Atlassian Bamboo's REST APIs
 test_files: 
 - features/remote.feature
+- features/rest.feature
 - features/step_definitions/remote_steps.rb
+- features/step_definitions/rest_steps.rb
 - features/support/env.rb
 - spec/bamboo-client/client_spec.rb
+- spec/bamboo-client/http/json_spec.rb
 - spec/bamboo-client/http/xml_spec.rb
 - spec/bamboo-client/remote_spec.rb
 - spec/bamboo-client/rest_spec.rb
+- spec/fixtures/build.json
 - spec/fixtures/build.xml
 - spec/fixtures/build_result.xml
+- spec/fixtures/build_with_changes.json
+- spec/fixtures/change.json
+- spec/fixtures/plan.json
+- spec/fixtures/project.json
 - spec/spec_helper.rb