teamcity-rest-client 0.1.0 → 0.1.1

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/teamcity-rest-client.rb

@@ -23,6 +23,41 @@ module TeamcityRestClient
     end
   end
 
+  class HttpBasicAuthentication
+    def initialize host, port, user, password
+      @host, @port, @user, @password = host, port, user, password
+    end
+
+    def get path
+      open(url(path), :http_basic_authentication => [@user, @password]).read
+    end
+
+    def url path
+      "http://#{@host}:#{@port}/httpAuth#{path}"
+    end  
+    
+    def to_s
+      "HttpBasicAuthentication #{@user}:#{@password}"
+    end
+  end
+
+  class Open
+    def initialize host, port
+      @host, @port = host, port
+    end
+
+    def get path
+      open(url(path)).read
+    end
+
+    def url path
+      "http://#{@host}:#{@port}#{path}"
+    end
+    
+    def to_s
+      "No Authentication"
+    end
+  end
 end
 
 class REXML::Element
@@ -33,10 +68,15 @@ end
 
 class Teamcity
   
-  attr_reader :host, :port, :user, :password
+  attr_reader :host, :port, :authentication
   
   def initialize host, port, user = nil, password = nil
-    @host, @port, @user, @password = host, port, user, password
+    @host, @port = host, port
+    if user != nil && password != nil
+      @authentication = TeamcityRestClient::HttpBasicAuthentication.new host, port, user, password
+    else
+      @authentication = TeamcityRestClient::Open.new host, port
+    end
   end
   
   def project spec
@@ -47,37 +87,39 @@ class Teamcity
   end
   
   def projects
-    doc(get(url('/app/rest/projects'))).elements.collect('//project') do |e| 
+    doc(get('/app/rest/projects')).elements.collect('//project') do |e| 
       TeamcityRestClient::Project.new(self, e.att("name"), e.att("id"), url(e.att("href")))
     end
   end
   
   def build_types
-    doc(get(url('/app/rest/buildTypes'))).elements.collect('//buildType') do |e| 
+    doc(get('/app/rest/buildTypes')).elements.collect('//buildType') do |e| 
       TeamcityRestClient::BuildType.new(e.att("id"), e.att("name"), url(e.att("href")), e.att('projectName'), e.att('projectId'), e.att('webUrl'))
     end
   end
   
   def builds
-    doc(get(url('/app/rest/builds')).gsub(/&buildTypeId/,'&buildTypeId')).elements.collect('//build') do |e|
+    doc(get('/app/rest/builds').gsub(/&buildTypeId/,'&buildTypeId')).elements.collect('//build') do |e|
       TeamcityRestClient::Build.new(e.att('id'), e.att('number'), e.att('status').to_sym, e.att('buildTypeId'), e.att('startDate'), url(e.att('href')), e.att('webUrl'))
     end
   end
-
-  def url path
-    if user != nil && password != nil
-      "http://#{user}:#{password}@#{host}:#{port}#{path}"
-    else
-      "http://#{host}:#{port}#{path}"
-    end
-  end
   
+  def to_s
+    "Teamcity @ http://#{host}:#{port}"
+  end
+
   private
   def doc string
     REXML::Document.new string
   end
+
+  def get path
+    result = @authentication.get(path)
+    raise "Teamcity returned html, perhaps you need to use authentication??" if result =~ /.*<html.*<\/html>.*/im
+    result
+  end
   
-  def get url
-    open(url).read
+  def url path
+    @authentication.url(path)
   end
-end
+end

data/spec/spec_helper.rb

@@ -10,3 +10,7 @@ Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 RSpec.configure do |config|
   
 end
+
+def sample_xml name
+  File.open("#{File.dirname(__FILE__)}/samples/#{name}.xml").read
+end

data/spec/teamcity-rest-client_spec.rb

@@ -1,51 +1,117 @@
 require_relative 'spec_helper'
 
-describe TeamcityRestClient::Project do
-  before :each do
-    @bt11 = stub('bt11', :id => "bt11", :name => "project1-build1", :project_id => "project1")
-    @bt12 = stub('bt12', :id => "bt12", :name => "project1-build2", :project_id => "project1")
-    @bt21 = stub('bt21', :id => "bt21", :name => "project2-build1", :project_id => "project2")
+module TeamcityRestClient
+  
+  describe Project do
+    before :each do
+      @bt11 = stub('bt11', :id => "bt11", :name => "project1-build1", :project_id => "project1")
+      @bt12 = stub('bt12', :id => "bt12", :name => "project1-build2", :project_id => "project1")
+      @bt21 = stub('bt21', :id => "bt21", :name => "project2-build1", :project_id => "project2")
     
-    @bt11_1 = stub('bt11_1', :id => "1", :build_type_id => "bt11")
-    @bt11_2 = stub('bt11_2', :id => "2", :build_type_id => "bt11")
-    @bt12_33 = stub('bt12_33', :id => "33", :build_type_id => "bt12")
-    @bt21_666 = stub('bt21_666', :id => "666", :build_type_id => "bt21")
+      @bt11_1 = stub('bt11_1', :id => "1", :build_type_id => "bt11")
+      @bt11_2 = stub('bt11_2', :id => "2", :build_type_id => "bt11")
+      @bt12_33 = stub('bt12_33', :id => "33", :build_type_id => "bt12")
+      @bt21_666 = stub('bt21_666', :id => "666", :build_type_id => "bt21")
     
-    @tc = stub('teamcity', :build_types => [@bt11, @bt12, @bt21], :builds => [@bt11_1, @bt11_2, @bt12_33, @bt21_666])
-    @project1 = TeamcityRestClient::Project.new @tc, "Project 1", "project1", "http://www.example.com"
-  end
+      @tc = stub('teamcity', :build_types => [@bt11, @bt12, @bt21], :builds => [@bt11_1, @bt11_2, @bt12_33, @bt21_666])
+      @project1 = Project.new @tc, "Project 1", "project1", "http://www.example.com"
+    end
   
-  describe "asking it for it's build types" do
+    describe "asking it for it's build types" do
+      before :each do
+        @build_types = @project1.build_types
+      end
+    
+      it "should have only those for project 1" do
+        @build_types.should == [@bt11, @bt12]
+      end
+    end
+  
+    describe "asking it for it's builds" do
+      before :each do
+        @builds = @project1.builds
+      end
+    
+      it "should have only builds for project 1" do
+        @builds.should == [@bt11_1, @bt11_2, @bt12_33]
+      end
+    end
+  end
+
+  describe HttpBasicAuthentication do
     before :each do
-      @build_types = @project1.build_types
+      @host, @port, @user, @password = "auth.example.com", 2233, "john", "wayne"
+      @auth = HttpBasicAuthentication.new @host, @port, @user, @password
+      @io = stub(:read => "<xml/>")
     end
     
-    it "should have only those for project 1" do
-      @build_types.should == [@bt11, @bt12]
+    describe "url" do
+      it "should add /httpAuth to path" do
+        @auth.url("/something").should == "http://auth.example.com:2233/httpAuth/something"
+      end
+    end
+    
+    describe "get" do
+      it "should call open with http basic auth options" do
+        @auth.should_receive(:open).with("http://auth.example.com:2233/httpAuth/somethingElse", :http_basic_authentication=>[@user, @password]).and_return(@io)
+        @auth.get("/somethingElse")
+      end
     end
   end
   
-  describe "asking it for it's builds" do
+  describe Open do
     before :each do
-      @builds = @project1.builds
+      @host, @port = "auth.example.com", 2233
+      @auth = Open.new @host, @port
+      @io = stub(:read => "<xml/>")
     end
     
-    it "should have only builds for project 1" do
-      @builds.should == [@bt11_1, @bt11_2, @bt12_33]
+    describe "url" do
+      it "should create valid url" do
+        @auth.url("/something").should == "http://auth.example.com:2233/something"
+      end
+    end
+    
+    describe "get" do
+      it "should call open with no auth options" do
+        @auth.should_receive(:open).with("http://auth.example.com:2233/somethingElse").and_return(@io)
+        @auth.get("/somethingElse")
+      end
     end
   end
+
 end
 
 describe Teamcity do
-  describe "using basic http authentication" do
+  before :all do
+    @sample_projects_xml = sample_xml "projects"
+    @sample_builds_xml = sample_xml "builds"
+    @sample_build_types_xml = sample_xml "buildTypes"
+  end
+  
+  describe "specifying username and password" do
     before :each do
-      @user = "bob"
-      @password = "marley"
-      @tc = Teamcity.new "authtc.example.com", 9999, @user, @password
+      @host, @port, @user, @password = "authtc.example.com", 8877, "bob", "marley"
+      @authentication = mock('authentication')
+      TeamcityRestClient::HttpBasicAuthentication.should_receive(:new).with(@host, @port, @user, @password).and_return(@authentication)
+      @tc = Teamcity.new @host, @port, @user, @password
     end
     
-    it "should create a valid url to /something" do
-      @tc.url("/something").should == "http://bob:marley@authtc.example.com:9999/something"
+    it "should create HttpBasicAuthetication" do
+      @tc.authentication.should === @authentication
+    end
+  end
+
+  describe "specifying no username and password" do
+    before :each do
+      @host, @port = "authtc.example.com", 8877
+      @authentication = mock('authentication')
+      TeamcityRestClient::Open.should_receive(:new).with(@host, @port).and_return(@authentication)
+      @tc = Teamcity.new @host, @port
+    end
+    
+    it "should create HttpBasicAuthetication" do
+      @tc.authentication.should === @authentication
     end
   end
   
@@ -83,9 +149,32 @@ describe Teamcity do
     end
   end
   
+  describe "when authentication fails" do
+    before :each do
+      @host, @port = "fail.example.com", 1234
+      @authentication = TeamcityRestClient::Open.new @host, @port
+      TeamcityRestClient::Open.should_receive(:new).and_return(@authentication)
+      fail_html = <<HTML
+
+      <!DOCTYPE html>
+      <html id="htmlId">
+      something
+      </html>  
+HTML
+      
+      @authentication.should_receive(:get).with("/app/rest/buildTypes").and_return(fail_html)
+      @tc = Teamcity.new @host, @port
+    end
+    
+    it "should raise an error" do
+      lambda { @tc.build_types }.should raise_error "Teamcity returned html, perhaps you need to use authentication??"
+    end
+  end
+  
   describe "parsing xml feeds" do
     before :each do
-      @tc = Teamcity.new "tc.example.com", 1234
+      @host, @port = "tc.example.com", 1234
+      @authentication = TeamcityRestClient::Open.new @host, @port
     end
     
     describe "projects" do
@@ -97,7 +186,9 @@ describe Teamcity do
   <project name="Apache Ant" id="project28" href="/app/rest/projects/id:project28"/>
 </projects>        
 XML
-        @tc.should_receive(:open).with("http://tc.example.com:1234/app/rest/projects").and_return(stub(:read => xml))
+        @authentication.should_receive(:get).with("/app/rest/projects").and_return(xml)
+        TeamcityRestClient::Open.should_receive(:new).and_return(@authentication)
+        @tc = Teamcity.new @host, @port
         @projects = @tc.projects
       end
       
@@ -131,7 +222,9 @@ XML
     projectName="Amazon API client" projectId="project54" webUrl="http://teamcity.jetbrains.com/viewType.html?buildTypeId=bt296"/>
 </buildTypes>      
 XML
-        @tc.should_receive(:open).with("http://tc.example.com:1234/app/rest/buildTypes").and_return(stub(:read => xml))
+        @authentication.should_receive(:get).with("/app/rest/buildTypes").and_return(xml)
+        TeamcityRestClient::Open.should_receive(:new).and_return(@authentication)
+        @tc = Teamcity.new @host, @port
         @build_types = @tc.build_types
       end
       
@@ -171,7 +264,9 @@ XML
     webUrl="http://teamcity.jetbrains.com/viewLog.html?buildId=56262&buildTypeId=bt213"/>
 </builds>
 XML
-        @tc.should_receive(:open).with("http://tc.example.com:1234/app/rest/builds").and_return(stub(:read => xml))
+        @authentication.should_receive(:get).with("/app/rest/builds").and_return(xml)
+        TeamcityRestClient::Open.should_receive(:new).and_return(@authentication)
+        @tc = Teamcity.new @host, @port
         @builds = @tc.builds
       end
       

data/teamcity-rest-client.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "teamcity-rest-client"
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["simon"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: teamcity-rest-client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-10-24 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2158820600 !ruby/object:Gem::Requirement
+  requirement: &2159395860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *2158820600
+  version_requirements: *2159395860
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2158820120 !ruby/object:Gem::Requirement
+  requirement: &2159395380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2158820120
+  version_requirements: *2159395380
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2158819640 !ruby/object:Gem::Requirement
+  requirement: &2159394900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *2158819640
+  version_requirements: *2159394900
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &2158819160 !ruby/object:Gem::Requirement
+  requirement: &2159394420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2158819160
+  version_requirements: *2159394420
 description: Teamcity rest api client (readonly)
 email: simojenki@gmail.com
 executables: []
@@ -94,7 +94,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 667469090941014696
+      hash: 2223201661142505741
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: