teamcity-client 0.0.2 → 0.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. data/README.rdoc +34 -6
  2. data/lib/teamcity-client.rb +2 -2
  3. metadata +3 -3
@@ -1,12 +1,40 @@
1
- == teamcity-client
1
+ = teamcity-client
2
2
 
3
- Team City Ghetto HTTP client.
3
+ A HTTP client for retrieving data from Team City servers. Currently
4
+ supports the ability to retrieve the number of new build errors for
5
+ a given build, and display progress for a the build if still in
6
+ progress while retrieving errors.
4
7
 
5
8
  Authentication is not yet supported and therefore guest access is
6
9
  required.
7
10
 
8
- Currently supports retrieving the number of new build errors for
9
- a given build.
11
+ == Installation
12
+
13
+ $ gem install teamcity-client
14
+
15
+ == Usage
16
+
17
+ teamcity-client can be embedded in your Ruby scripts, or used as
18
+ a command line utility.
19
+
20
+ In your Ruby script:
21
+
22
+ require "rubygems"
23
+ require "teamcity-cliemt"
24
+
25
+ client = TeamCityClient.new "teamcity:8111"
26
+ errors = client.build_errors(42)
27
+
28
+ Via command line:
29
+
30
+ $ teamcity-client -a host:port -b 42
31
+
32
+ Command line options:
33
+
34
+ Usage: teamcity-client [options]
35
+
36
+ -b, --build ID Check status and new errors for the given build ID (required)
37
+ -a, --address HOST:PORT Host and port of the TeamCity server (default: teamcity:8111)
38
+ -h, --help Show this message
39
+ -v, --version Show version
10
40
 
11
- Initialize with a host:port string for grabbing and parsing pages
12
- in the Team City interface.
@@ -2,7 +2,7 @@ require "rubygems"
2
2
  require "rest-client"
3
3
  require "nokogiri"
4
4
 
5
- # Team City Ghetto HTTP client.
5
+ # Team City HTTP client.
6
6
  #
7
7
  # Authentication is not yet supported and therefore guest access is
8
8
  # required.
@@ -14,7 +14,7 @@ require "nokogiri"
14
14
  # in the Team City interface.
15
15
  class TeamCityClient
16
16
 
17
- VERSION = "0.0.2"
17
+ VERSION = "0.0.3"
18
18
 
19
19
  def initialize(host)
20
20
  @host = host
metadata CHANGED
@@ -1,13 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: teamcity-client
3
3
  version: !ruby/object:Gem::Version
4
- hash: 27
4
+ hash: 25
5
5
  prerelease:
6
6
  segments:
7
7
  - 0
8
8
  - 0
9
- - 2
10
- version: 0.0.2
9
+ - 3
10
+ version: 0.0.3
11
11
  platform: ruby
12
12
  authors:
13
13
  - Stephen McDonald