teamcity 1.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3eb6aff20afed3470c00122396362dd62f95df00
+  data.tar.gz: b5d2158d34685fb4f82ca754655b83cdfb580f7e
+SHA512:
+  metadata.gz: a48358a4caea06e7ab6eb82d8e2dddbec89daa79aa3f363a63852e766b84fb616f8990f42cd0ede01e52ba56015412d7918da5d7775c08b4747b196e76c371f2
+  data.tar.gz: 126c66120c7a280b5e09746f0b302aac979e48421f3f443591b1fa3acaec56fe4d2dcea62a8146e06737823746c88b1395c862c63eced9b5fcd530eacb9c5730

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea
+.ruby-version

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/.yardopts

@@ -0,0 +1 @@
+--tag rest_api_version:"REST API VERSION"

data/CHANGELOG.md

@@ -0,0 +1,83 @@
+## 1.3.1 (Jun 4, 20014)
+
+* Dependencies
+    * Loosen up hashie version constraint to >= 2.0
+
+## 1.3.0 (Jun 4, 2014)
+
+* BuildType: Added ```.buildtype_branches```, provides the ability to
+  get a listing of branches the build is configured to build.
+
+* Dependencies
+    * faraday 0.8.5 -> 0.9.0 (fixed some methods to keep consistent return values)
+    * hashie 2.0.0 -> 3.0.0
+
+* Development
+    * Changed .rvmrc file to universal .ruby-version and .ruby-gemset files
+
+## 1.2.0 (Dec 7, 2013)
+
+* BuildType: Added ```.set_buildtype_setting```, provides the ability to set build configuration settings [@jeffersongirao]
+* BuildType: Added ```.create_buildtype```, provides the ability to create a new build configuration [@jeffersongirao]
+* BuildType: Added ```.create_build_trigger```, provides the ability to create build configuration trigger [@jeffersongirao], [@nskboy]
+* BuildType: Added ```.set_buildtype_setting```, adds ability to set build configuration settings [@jeffersongirao]
+* BuildType: Added ```.create_build_step```, provides the ability to create a build step in a build configuration [@jeffersongirao]
+* Project: Added ```.set_parent_project``` and ```.parent_project``` for setting and getting parent project. (TeamCity8 only) [@jeffersongirao]
+* Bug: Fix ```.create_vcs_root``` to work for svn [@jeffersongirao]
+* Bug: Fix incompatibility with ruby 1.9.2 [@jeffersongirao]
+* Cleanup: Remove dependency on xmlbuilder and linguistics [@jeffersongirao]
+* Testing: Upgrade to rspec 2.14.1 and added guard-rspec gem
+* Documentation: Added *rest_api_version* tag for specify teamcity api compatibility
+
+## 1.1.0 (Nov 1, 2013)
+
+* Features:
+    * Added ```build_artifacts``` (Provides the ability to fetch the
+      contents of an aritfact) [@orikremer]
+
+* Gem Updates
+    * Upgraded webmock to remove deprecation warning [@akiellor]
+
+## 1.0.1 (Nov 1, 2013)
+
+* Same as 1.1.0 above
+
+## 1.0.0 (Aug 26, 2013)
+
+* Features:
+    * TeamCity 8 Support
+    * Added ```build_pinned?``` (Provides the ability to ask if a build is pinned)
+    * If using TeamCity8 any call that is setting a value will now return that value instead of nil
+
+* API Changes:
+    * ```create_vcs_root``` method signature has been changed from using Ordinal Params to using Hash Params
+    * Removed the ability to set the format when configuring the client (Each method will now state what format it is sending and receiving, see the source for more info)
+
+* Doc Changes:
+    * The API docs were updated to reflect the return values now returned when using TeamCity 8
+
+## 0.4.0 (Jun 15, 2013)
+
+* Added ```pin_build``` and ```unpin_build``` (Provides the ability to pin and unpin a build respectively)
+* Added ```build_statistics``` (Provides the ability to fetch build [statistics](http://confluence.jetbrains.com/display/TCD8/Custom+Chart#CustomChart-listOfDefaultStatisticValues))
+* Added ```buildtype_investigations``` (Provides the ability to fetch build investigation details)
+
+## 0.3.0 (May 23, 2013)
+
+* Loosen up dependency requirement on the version of builder (Conflicted with transitive dependencies of rails 3.2.13)
+* Added ```delete_buildtype``` to the API (Provides the ability to delete a build configuration)
+* Added ```set_build_step_field``` to the API (Provides the ability to set a build step field, i.e. enable/disable a build step)
+
+## 0.2.0 (May 7, 2013)
+
+  - added support for httpAuth
+  - added several CRUD methods to the api for BuildTypes, Projects, and VCSRoots
+  - code cleanup
+
+## 0.1.0 (April 28, 2013)
+
+Features:
+
+  - added GET support for projects
+  - added GET support for build types (build configurations)
+  - added GET support for builds

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in teamcity-ruby-client.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+#
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jason Perry
+
+MIT License
+
+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/README.md

@@ -0,0 +1,194 @@
+# The TeamCity Ruby Gem [![Gem Version](https://badge.fury.io/rb/teamcity-ruby-client.png)](http://badge.fury.io/rb/teamcity-ruby-client)
+[![Build Status](https://travis-ci.org/jperry/teamcity-ruby-client.png?branch=master)](https://travis-ci.org/jperry/teamcity-ruby-client.png?branch=master) [![Code Climate](https://codeclimate.com/github/jperry/teamcity-ruby-client.png)](https://codeclimate.com/github/jperry/teamcity-ruby-client) [![Dependency Status](https://gemnasium.com/jperry/teamcity-ruby-client.png)](https://gemnasium.com/jperry/teamcity-ruby-client)
+
+Ruby wrapper for the TeamCity Rest API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'teamcity-ruby-client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install teamcity-ruby-client
+
+## API Usage Examples
+
+* Tested on TeamCity 7.X and 8.0.X
+* Most of the api calls return either an array of Hashie::Mash objects or a single Hashie::Mash object which allows you to send messages to retreive an attribute easily.
+* See [api docs](http://rubydoc.info/gems/teamcity-ruby-client/TeamCity/Client) or [specs](spec/teamcity/client) for additional examples and usage
+
+### Configuration
+
+* See [configuration](lib/teamcity/configuration.rb) source or api doc for more configuration options
+* You may use v7 of the TeamCity api by adding '7.0' to the endpoint configuration (This would be similar to using latest on a TeamCity 7 server)
+
+```ruby
+require 'teamcity'
+
+# This only needs to be set once per Ruby execution.
+# You may use guestAuth instead of httpAuth and omit the use of http_user and http_password
+# This is using the latest version of the api
+TeamCity.configure do |config|
+  config.endpoint = 'http://my-teamcity-server:8111/httpAuth/app/rest'
+  config.http_user = 'teamcity-user'
+  config.http_password = 'teamcity-password'
+end
+```
+
+### Projects
+
+```ruby
+# Get a list of projects
+puts TeamCity.projects
+
+# Get a project by id
+puts TeamCity.project(id: 'project1')
+
+# Get a list of buildtypes for a project
+puts TeamCity.project_buildtypes(id: 'project1')
+
+# Each item returned is a Hashie::Mash object which allows you to send messages
+# to retreive an attribute easily.  For example, get the name of
+# the first buildtype in a project
+puts TeamCity.project_buildtypes(id: 'project1').first.name
+
+# Create an empty project
+TeamCity.create_project('my-new-project')
+
+# Copy a project
+TeamCity.copy_project('project1', 'copied-project-name')
+
+# Delete a project
+TeamCity.delete_project('project1')
+
+# Change project name
+TeamCity.set_project_field('project1', 'name', 'new-project-name')
+```
+
+### Build Types (Build Configurations)
+
+```ruby
+# Get a list of buildtypes (build configurations)
+puts TeamCity.buildtypes
+
+# Get buildtype details (build configuration)
+puts TeamCity.buildtype(id: 'bt1')
+
+# Get buildtype steps
+puts TeamCity.buildtype_steps(id: 'bt1')
+
+# Change buildtype name
+TeamCity.set_buildtype_field('bt1', 'name', 'new-buildtype-name')
+```
+
+### Builds ###
+
+```ruby
+# Get build details
+puts TeamCity.build(id: 1)
+
+# Get build tags
+puts TeamCity.build_tags(id: 1)
+
+# Fetch all the builds (defaults to the last 100 builds, use the 'count' build locator to return more)
+puts TeamCity.builds
+
+# Filter builds by multiple criteria's using the build locator
+puts TeamCity.builds(count: 1, status: 'SUCCESS') # This will return the most recent build that passed
+
+puts TeamCity.builds(count: 1).first.name
+
+puts TeamCity.builds(buildType: 'bt3') # Fetch all builds where buildType=bt4
+
+puts TeamCity.builds(status: 'FAILURE') # Fetch all builds that failed
+
+# Passing the output to another to fetch additional information
+puts TeamCity.build(id: TeamCity.builds(count: 1).first.id).buildType.name # Fetch the name of the last build to run
+
+```
+
+### VCS Roots ###
+
+```ruby
+# Get all the vcs roots
+puts Teamcity.vcs_roots
+
+# Get vcs root details
+puts TeamCity.vcs_root_details(1)
+
+# Create VCS Root for a project
+TeamCity.create_vcs_root(vcs_name: 'my-git-vcs-root', vcs_type: 'git', :project_id => 'project2') do |properties|
+  properties['branch'] = 'master'
+  properties['url'] = 'git@github.com:jperry/teamcity-ruby-client.git'
+  properties['authMethod'] = 'PRIVATE_KEY_DEFAULT'
+  properties['ignoreKnownHosts'] = true
+end
+
+```
+
+## Documentation
+
+### API Docs
+
+[Latest](http://rubydoc.info/gems/teamcity-ruby-client/)
+
+### Generating API Docs
+
+1. Pull the source down
+2. ```bundle install```
+3. ```rake yard```
+4. open doc/index.html
+
+### TeamCity Rest API Plugin
+
+[Link](http://confluence.jetbrains.com/display/TW/REST+API+Plugin)
+
+## Contributing
+
+Ways to contribute:
+
+* report a bug
+* fix an issue that is logged
+* suggest enhancements
+* suggest a new feature
+* cleaning up code
+* refactoring code
+* fix documentation errors
+* test on a new versions of teamcity
+* Use the gem :)
+
+## Submitting an issue
+
+I use issue tracker to track bugs, features, enhancements, etc.  Please check the list of issues to confirm
+it hasn't already been reported.  Please tag the the issue with an appropriate tag.  If submitting a bug please
+include any output that will help me in diagnosing the issue, link to a gist if you have multiple outputs 
+(client output, teamcity server output).  Please include the version of teamcity you are using
+the client against as well as the gem and ruby versions.
+
+## Submitting a Pull Request
+
+1. Fork the project.
+2. Create a topic branch.
+3. Implement your feature or bug fix.
+4. Add documentation for your feature or bug fix.
+    * Please use the *@rest_api_version* tag to specify if a method is only compatible with a specific version of the rest api
+5. Run ```rake doc:yard```. If your changes are not 100% documented, go back to step 4.
+6. Add specs for your feature or bug fix.
+7. If the rspec test is making a request use VCR to record the response, see the other examples.
+7. Run ```rake spec```. If your changes are not 100% covered, go back to step 6.
+8. Commit and push your changes.
+9. Submit a pull request.
+
+## Debugging Tips
+
+* Enable debug-rest in TeamCity to see all the rest api requests come through in the `teamcity-rest.log`, you can find this on the Diagnostics page under Server Administration
+
+## Questions/Comments
+
+Feel free to contact me directly through github.  Enjoy!

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/faraday/null_response_body.rb

@@ -0,0 +1,17 @@
+module FaradayMiddleware
+  # This middleware handles any responses where the body
+  # is 'null' which is the case when asking teamcity for
+  # an empty collection.  When this is encountered we
+  # set the response to an empty json object
+  class NullResponseBody < Faraday::Middleware
+    # Faraday Middleware
+    # @note - should only be called by Faraday
+    def call(env)
+      @app.call(env).on_complete do |response|
+        if response[:body] == "null"
+          response[:body] = {}
+        end
+      end
+    end
+  end
+end

data/lib/teamcity.rb

@@ -0,0 +1,26 @@
+require_relative 'teamcity/configuration'
+require_relative 'teamcity/client'
+require_relative 'teamcity/headers'
+require_relative 'teamcity/element_builder'
+
+module TeamCity
+  extend Configuration
+
+  # Alias for TeamCity::Client.new
+  #
+  # @return [TeamCity::Client]
+  def self.client(options={})
+    TeamCity::Client.new(options)
+  end
+
+  # Delegate to TeamCity::Client
+  def self.method_missing(method, *args, &block)
+    return super unless client.respond_to?(method)
+    client.send(method, *args, &block)
+  end
+
+  # Delegate to TeamCity::Client
+  def self.respond_to?(method)
+    return client.respond_to?(method) || super
+  end
+end

data/lib/teamcity/api.rb

@@ -0,0 +1,19 @@
+require_relative 'connection'
+require_relative 'request'
+
+module TeamCity
+  class API
+    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+
+    # Creates a new API
+    def initialize(options={})
+      options = TeamCity.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    include Connection
+    include Request
+  end
+end

data/lib/teamcity/client.rb

@@ -0,0 +1,16 @@
+require_relative 'api'
+
+module TeamCity
+  # Wrapper for the TeamCity REST API
+  #
+  class Client < API
+    Dir[File.expand_path('../client/*.rb', __FILE__)].each{|f| require f}
+
+    include TeamCity::Client::Projects
+    include TeamCity::Client::BuildTypes
+    include TeamCity::Client::Builds
+    include TeamCity::Client::Common
+    include TeamCity::Client::VCSRoots
+    include TeamCity::Client::Tests
+  end
+end