teamcity-ruby-client 0.1.0

data/spec/cassettes/Projects/GET/_project_buildtypes/should_fetch_all_the_buildTypes_for_a_project.yml

@@ -0,0 +1,45 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:8111/guestAuth/app/rest/7.0/projects/id:project2/buildTypes
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json; charset=utf-8
+      User-Agent:
+      - TeamCity Ruby Client 0.0.1
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Apache-Coyote/1.1
+      Set-Cookie:
+      - JSESSIONID=CDED34F8A3AEFF72A18A3733E4E38B68; Path=/; HttpOnly
+      - RememberMe=""; Expires=Thu, 01-Jan-1970 00:00:10 GMT; Path=/; HttpOnly
+      Pragma:
+      - no-cache
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      Cache-Control:
+      - no-cache
+      - no-store
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Date:
+      - Tue, 26 Feb 2013 03:28:32 GMT
+    body:
+      encoding: US-ASCII
+      string: ! '{"buildType":[{"id":"bt2","name":"build A1","href":"/guestAuth/app/rest/7.0/buildTypes/id:bt2","projectName":"Project
+        A","projectId":"project2","webUrl":"http://localhost:8111/viewType.html?buildTypeId=bt2"}]}'
+    http_version: 
+  recorded_at: Tue, 26 Feb 2013 03:28:32 GMT
+recorded_with: VCR 2.4.0

data/spec/cassettes/Projects/GET/_project_buildtypes/should_return_nil_if_the_project_does_not_have_any_build_build_types.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:8111/guestAuth/app/rest/7.0/projects/id:project5/buildTypes
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json; charset=utf-8
+      User-Agent:
+      - TeamCity Ruby Client 0.0.1
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Apache-Coyote/1.1
+      Set-Cookie:
+      - JSESSIONID=A8CE54A1F37D36EB7C9300AA1456389C; Path=/; HttpOnly
+      - RememberMe=""; Expires=Thu, 01-Jan-1970 00:00:10 GMT; Path=/; HttpOnly
+      Pragma:
+      - no-cache
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      Cache-Control:
+      - no-cache
+      - no-store
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Date:
+      - Tue, 26 Feb 2013 03:46:46 GMT
+    body:
+      encoding: US-ASCII
+      string: 'null'
+    http_version: 
+  recorded_at: Tue, 26 Feb 2013 03:46:46 GMT
+recorded_with: VCR 2.4.0

data/spec/cassettes/Projects/GET/_project_parameters/should_fetch_all_the_paramters_for_a_given_project.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:8111/guestAuth/app/rest/7.0/projects/id:project2/parameters
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json; charset=utf-8
+      User-Agent:
+      - TeamCity Ruby Client 0.0.1
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Apache-Coyote/1.1
+      Set-Cookie:
+      - JSESSIONID=941AB4BA14E5E85C970F81A63BF2D69D; Path=/; HttpOnly
+      - RememberMe=""; Expires=Thu, 01-Jan-1970 00:00:10 GMT; Path=/; HttpOnly
+      Pragma:
+      - no-cache
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      Cache-Control:
+      - no-cache
+      - no-store
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Date:
+      - Wed, 27 Feb 2013 12:52:33 GMT
+    body:
+      encoding: US-ASCII
+      string: ! '{"property":[{"name":"env.test1","value":"test"},{"name":"param1","value":"1"},{"name":"system.test","value":"test"}]}'
+    http_version: 
+  recorded_at: Wed, 27 Feb 2013 12:52:33 GMT
+recorded_with: VCR 2.4.0

data/spec/cassettes/Projects/GET/_project_parameters/should_return_nil_if_there_are_no_parameters_defined_for_a_project.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:8111/guestAuth/app/rest/7.0/projects/id:project3/parameters
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json; charset=utf-8
+      User-Agent:
+      - TeamCity Ruby Client 0.0.1
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Apache-Coyote/1.1
+      Set-Cookie:
+      - JSESSIONID=DED63B8443311CD8DBFB7C4BDB8FE7E2; Path=/; HttpOnly
+      - RememberMe=""; Expires=Thu, 01-Jan-1970 00:00:10 GMT; Path=/; HttpOnly
+      Pragma:
+      - no-cache
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      Cache-Control:
+      - no-cache
+      - no-store
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Date:
+      - Wed, 27 Feb 2013 12:57:56 GMT
+    body:
+      encoding: US-ASCII
+      string: 'null'
+    http_version: 
+  recorded_at: Wed, 27 Feb 2013 12:57:57 GMT
+recorded_with: VCR 2.4.0

data/spec/cassettes/Projects/GET/_projects/should_fetch_projects.yml

@@ -0,0 +1,46 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:8111/guestAuth/app/rest/7.0/projects
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json; charset=utf-8
+      User-Agent:
+      - TeamCity Ruby Client 0.0.1
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Apache-Coyote/1.1
+      Set-Cookie:
+      - JSESSIONID=5057656A6D66E122DBED5E13085F68F2; Path=/; HttpOnly
+      - RememberMe=""; Expires=Thu, 01-Jan-1970 00:00:10 GMT; Path=/; HttpOnly
+      Pragma:
+      - no-cache
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      Cache-Control:
+      - no-cache
+      - no-store
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Date:
+      - Tue, 26 Feb 2013 03:04:07 GMT
+    body:
+      encoding: US-ASCII
+      string: ! '{"project":[{"id":"project2","name":"Project A","href":"/guestAuth/app/rest/7.0/projects/id:project2"},{"id":"project3","name":"Project
+        B","href":"/guestAuth/app/rest/7.0/projects/id:project3"},{"id":"project4","name":"Project
+        C","href":"/guestAuth/app/rest/7.0/projects/id:project4"}]}'
+    http_version: 
+  recorded_at: Tue, 26 Feb 2013 03:04:07 GMT
+recorded_with: VCR 2.4.0

data/spec/cassettes/Projects/GET/_projects/should_return_nil_if_there_are_no_projects.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:8111/guestAuth/app/rest/7.0/projects
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json; charset=utf-8
+      User-Agent:
+      - TeamCity Ruby Client 0.0.1
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Apache-Coyote/1.1
+      Set-Cookie:
+      - JSESSIONID=D4F1893628C97DB58C370726929F7B67; Path=/; HttpOnly
+      - RememberMe=""; Expires=Thu, 01-Jan-1970 00:00:10 GMT; Path=/; HttpOnly
+      Pragma:
+      - no-cache
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      Cache-Control:
+      - no-cache
+      - no-store
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Date:
+      - Tue, 26 Feb 2013 03:04:07 GMT
+    body:
+      encoding: US-ASCII
+      string: 'null'
+    http_version: 
+  recorded_at: Tue, 26 Feb 2013 03:04:07 GMT
+recorded_with: VCR 2.4.0

data/spec/faraday/null_response_body_spec.rb

@@ -0,0 +1,18 @@
+require "spec_helper.rb"
+
+describe 'FaradayMiddleware' do
+  describe 'NullResponseBody' do
+
+    before(:each) do
+      @url = "#{TeamCity::Configuration::DEFAULT_ENDPOINT}projects"
+    end
+
+    it "should return empty hash if the body is 'null'" do
+      stub_request(:get, @url).to_return(:body => "null", :headers => {:content_type => "application/json; charset=utf-8"})
+      VCR.turned_off do
+        results = TeamCity.get('projects')
+        results.should be_empty
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'rspec/autorun'
+require 'webmock/rspec'
+require_relative 'support/vcr_setup'
+
+require File.expand_path('../../lib/teamcity', __FILE__)
+
+RSpec.configure do |c|
+  c.treat_symbols_as_metadata_keys_with_true_values = true
+end
+
+def stub_get(path)
+  stub_request(:get, TeamCity.endpoint + path)
+end

data/spec/support/vcr_setup.rb

@@ -0,0 +1,9 @@
+require 'vcr'
+
+# See https://www.relishapp.com/vcr/vcr/v/2-4-0/docs/configuration
+# for more configuration options (make sure and check the version of vcr matches)
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/cassettes'
+  c.hook_into :webmock
+  c.configure_rspec_metadata!
+end

data/spec/teamcity/api_spec.rb

@@ -0,0 +1,63 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe TeamCity::API do
+  before do
+    @keys = TeamCity::Configuration::VALID_OPTIONS_KEYS
+  end
+
+  context "with module configuration" do
+
+    before do
+      TeamCity.configure do |config|
+        @keys.each do |key|
+          config.send("#{key}=", key)
+        end
+      end
+    end
+
+    after do
+      TeamCity.reset
+    end
+
+    it "should inherit module configuration" do
+      api = TeamCity::API.new
+      @keys.each do |key|
+        api.send(key).should == key
+      end
+    end
+
+    context "with class configuration" do
+
+      before do
+        @configuration = {
+          :adapter => :excon,
+          :endpoint => 'http://teamcity.mydomain.com/',
+          :format => :xml,
+          :user_agent => 'My User Agent',
+        }
+      end
+
+      context "during initialization"
+
+        it "should override module configuration" do
+          api = TeamCity::API.new(@configuration)
+          @keys.each do |key|
+            api.send(key).should == @configuration[key]
+          end
+        end
+
+      context "after initilization" do
+
+        it "should override module configuration after initialization" do
+          api = TeamCity::API.new
+          @configuration.each do |key, value|
+            api.send("#{key}=", value)
+          end
+          @keys.each do |key|
+            api.send(key).should == @configuration[key]
+          end
+        end
+      end
+    end
+  end
+end

data/spec/teamcity/client/builds_spec.rb

@@ -0,0 +1,62 @@
+require_relative '../../spec_helper'
+
+describe 'Builds' do
+
+  before(:each) do
+    @tc = TeamCity
+  end
+
+  before(:all) do
+    TeamCity.configure do |config|
+      config.endpoint = 'http://localhost:8111/guestAuth/app/rest/7.0/'
+    end
+  end
+
+  after(:all) do
+    TeamCity.reset
+  end
+
+  # Get requests
+  describe 'GET', :vcr do
+
+    describe '.builds' do
+      it 'should fetch all the builds' do
+        @tc.builds.size.should eq(4)
+      end
+
+      it 'should allow you to filter results by build locators' do
+        @tc.builds(count:2).size.should eq(2)
+      end
+
+      it 'should allow you to filter by multiple build locators' do
+        @tc.builds(count: 2, status: 'SUCCESS').size.should eq(2)
+      end
+    end
+
+    describe '.build' do
+      it 'should fetch the build details' do
+        @tc.build(id: 2).id.should eq(2)
+      end
+
+      it 'should raise an error if the build does not exist' do
+        expect { @tc.build(id: 10000) }.to raise_error
+      end
+
+      it 'should raise an error if an id is not provided' do
+        expect { @tc.build }.to raise_error
+      end
+    end
+
+    describe '.build_tags' do
+      it 'should fetch the build tags' do
+        tags = @tc.build_tags(id: 2)
+        tags.size.should eq(1)
+        tags.first.should eq('release_tag')
+      end
+
+      it 'should return nil if there are no build tags defined for a build' do
+        @tc.build_tags(id: 1).should be_nil
+      end
+    end
+  end
+end

data/spec/teamcity/client/buildtypes_spec.rb

@@ -0,0 +1,106 @@
+require_relative '../../spec_helper'
+
+describe 'BuildTypes' do
+
+  before(:each) do
+    @tc = TeamCity
+  end
+
+  before(:all) do
+    TeamCity.configure do |config|
+      config.endpoint = 'http://localhost:8111/guestAuth/app/rest/7.0/'
+    end
+  end
+
+  after(:all) do
+    TeamCity.reset
+  end
+
+  # Get requests
+  describe 'GET', :vcr do
+
+    describe '.buildtypes' do
+
+      it 'should fetch all the buildtypes' do
+        @tc.buildtypes.size.should eq(3)
+      end
+
+    end
+
+    describe '.buildtype' do
+
+      it 'should fetch the details of a buildtype by id' do
+        @tc.buildtype(id: 'bt2').id.should eq('bt2')
+      end
+
+      it 'should raise an error if the buildtype does not exist' do
+        expect { @tc.buildtype(id: 'missing') }.to raise_error
+      end
+
+      it 'should raise an error if an id is not provided' do
+        expect { @tc.buildtype }.to raise_error
+      end
+    end
+
+    describe '.buildtype_state' do
+      it 'should fetch the state of the buildtype' do
+        pending "bug in rest api plugin"
+        @tc.buildtype_state(id: 'bt2')
+      end
+    end
+
+    describe '.buildtype_settings' do
+      it 'should fetch the settings for a given buildtype' do
+        @tc.buildtype_settings(id: 'bt2').should have_at_least(1).items
+      end
+
+      it 'should return an array' do
+        @tc.buildtype_settings(id: 'bt2').should be_kind_of(Array)
+      end
+    end
+
+    describe '.buildtype_template' do
+      it 'should return the attributes of the associated template' do
+        @tc.buildtype_template(id: 'bt2').id.should_not be_nil
+      end
+
+      it 'should return nil if the buildtype is not associated with a template' do
+        @tc.buildtype_template(id: 'bt3').should be_nil
+      end
+
+      it 'should raise an exception if the response is not due to a template not assigned' do
+        expect { @tc.buildtype_template(id: 'bt500').should be_nil }.to raise_error
+      end
+    end
+
+    [
+      :parameters,
+      :steps,
+      :features,
+      :triggers,
+      :agent_requirements,
+      :snapshot_dependencies,
+      :artifact_dependencies,
+      :vcs_root_entries
+    ].each do |type|
+      describe ".buildtype_#{type}" do
+
+        before(:each) do
+          @method_name = "buildtype_#{type}"
+        end
+
+          it "should fetch the build configuration #{type} for a buildtype" do
+          @tc.send(@method_name, id: 'bt2').should have_at_least(1).items
+        end
+
+        it 'should return an array' do
+          @tc.send(@method_name, id: 'bt2').should be_kind_of(Array)
+        end
+
+        it "should return nil if there are no #{type} defined" do
+          @tc.send(@method_name, id: 'bt4').should be_nil
+        end
+      end
+    end
+  end
+end

data/spec/teamcity/client/projects_spec.rb

@@ -0,0 +1,82 @@
+require_relative '../../spec_helper'
+
+describe 'Projects' do
+
+  before(:each) do
+    @tc = TeamCity
+  end
+
+  before(:all) do
+    TeamCity.configure do |config|
+      config.endpoint = 'http://localhost:8111/guestAuth/app/rest/7.0/'
+    end
+  end
+
+  after(:all) do
+    TeamCity.reset
+  end
+
+  # Get requests
+  describe 'GET', :vcr do
+
+    describe '.projects' do
+
+      it 'should fetch projects' do
+        @tc.projects.should_not be_nil
+      end
+
+      it 'should return nil if there are no projects' do
+        @tc.projects.should be_nil
+      end
+    end
+
+    describe '.project' do
+
+      it 'should fetch a single project by id' do
+        @tc.project(id: 'project2').should_not be_nil
+      end
+
+      it 'should raise an error if the project does not exist' do
+        expect { @tc.project(id: 'missing') }.to raise_error
+      end
+
+      it 'should raise an error if an id is not provided' do
+        expect { @tc.project }.to raise_error
+      end
+    end
+
+    describe '.project_buildtypes' do
+
+      it 'should fetch all the buildTypes for a project' do
+        bts = @tc.project_buildtypes(id: 'project2')
+        bts.each do |bt|
+          bt.projectId.should eq('project2')
+        end
+      end
+
+      it 'should return nil if the project does not have any build build types' do
+        bts = @tc.project_buildtypes(id: 'project5')
+        bts.should be_nil
+      end
+    end
+
+    describe '.project_parameters' do
+      it 'should fetch all the paramters for a given project' do
+        parameters = @tc.project_parameters(id: 'project2')
+        parameters.size.should eq(3)
+      end
+
+      it 'should return nil if there are no parameters defined for a project' do
+        parameters = @tc.project_parameters(id: 'project3')
+        parameters.should be_nil
+      end
+
+      it 'should raise an error if the project does not exist' do
+        expect { @tc.project_parameters(id: 'missing')}
+      end
+    end
+
+
+
+  end
+end

data/spec/teamcity/client_spec.rb

@@ -0,0 +1,10 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe TeamCity::Client do
+  it "should connect using the endpoint configuration" do
+    client = TeamCity::Client.new
+    endpoint = URI.parse(client.endpoint)
+    connection = client.send(:connection).build_url(nil).to_s
+    (connection + '/').should == endpoint.to_s
+  end
+end

data/spec/teamcity/version_spec.rb

@@ -0,0 +1,7 @@
+require_relative '../spec_helper'
+
+describe 'Version' do
+  it 'should be defined' do
+    TeamCity::VERSION.should match(/\d\.\d\.\d/)
+  end
+end