teamcity-ruby-client 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NGU0NzgwMGI5OGY5MmE3OWI3MWJhMDA0ODhlNDY3NjYzOGE2Yzk5ZA==
+  data.tar.gz: !binary |-
+    YTc5ZDA0NDdjZmRjZDlkNTVmZmYyNWNiMGFiNTczNTQzZmFmZmZmMQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    N2UzYjg1MGE5YTA1NmU1YjQ5NjkxMmJmNzY2YjE4YmUwZGVkOTRmNjNlOWU2
+    YzQ5YmViNzQ1MWEyNWIxYmQyNjZiYzVlMDRlOTVjMTE5MjdkYmI2NWZjYzhi
+    NjcwNzEwYmE5YWQ4NzAxYWY5ZjNmNjUxNjZmYTlhOTY1NTY3ZGI=
+  data.tar.gz: !binary |-
+    ZjdlM2M3ZDI2ZDM3ZmU3OTgyZmI3NzM0ODAwNjExNDU4MTk5OGI1ZTliZDg3
+    NTU1NTk4Y2EyYzk0ZGJmN2NjODEyYzdlZDYyZDhjY2UxYzI4YzYwYjE0ZjFk
+    YzI3ZGEzYTc2ZGY1ZWQ1MDBkMjJiYmFlNDM4OWZhMDNiZDJiNDA=

data/.gitignore

@@ -0,0 +1,18 @@
+*.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

data/.rvmrc

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p362@teamcity-ruby-client"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.14.2 (latest)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## 0.1.0 (April 28, 2012)
+
+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/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,153 @@
+# The TeamCity Ruby Gem [![Build Status](https://secure.travis-ci.org/jperry/teamcity-ruby-client.png?branch=master)](http://travis-ci.org/jperry/teamcity-ruby-client) [![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.0 and higher
+* 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 the spec tests for more examples
+
+### Configuration
+
+* See [configuration](lib/teamcity/configuration.rb) source or api doc for more configuration options
+
+```ruby
+require 'teamcity'
+
+# Currently only guest authentication is supported, next version will
+# support authentication which will allow write api calls.  This only needs
+# to be set once per Ruby execution.
+TeamCity.configure do |config|
+  config.endpoint = 'http://my-teamcity-server:8111/guestAuth/app/rest'
+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
+```
+
+### 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')
+
+# See the api docs for more api calls
+```
+
+### 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
+
+```
+
+## Documentation
+
+### 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.
+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,16 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'yard'
+require 'yard/rake/yardoc_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+YARD::Rake::YardocTask.new do |yardoc|
+  yardoc.name = 'yard'
+  yardoc.options = ['--verbose']
+  yardoc.files = [
+    'lib/**/*.rb'
+  ]
+end

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/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/build_types.rb

@@ -0,0 +1,93 @@
+require 'linguistics'
+
+module TeamCity
+  class Client
+    # Defines methods related to build types (or build configurations)
+    module BuildTypes
+
+      Linguistics.use :en
+
+      # HTTP GET
+
+      # List of build types
+      #
+      # @return [Array<Hashie::Mash>, nil] of buildtypes or nil if no buildtypes exist
+      def buildtypes
+        response = get('buildTypes')
+        response['buildType']
+      end
+
+      # Get build configuration details
+      #
+      # @param options [Hash] option keys, :id => buildtype_id
+      # @return [Hashie::Mash] of build configuration details
+      def buildtype(options={})
+        assert_options(options)
+        get("buildTypes/#{locator(options)}")
+      end
+
+      # TODO: File jetbrains ticket, this call doesn't work
+      #def buildtype_state(options={})
+      #  assert_options(options)
+      #  get("buildTypes/#{locator(options)}/paused")
+      #end
+
+      # Get build configuration settings
+      #
+      # @param (see #buildtype)
+      # @return [Array<Hashie::Mash>] of build configuration settings
+      def buildtype_settings(options={})
+        assert_options(options)
+        response = get("buildTypes/#{locator(options)}/settings")
+        response['property']
+      end
+
+      # Get build configuration parameters
+      #
+      # @param (see #buildtype)
+      # @return [Array<Hashie::Mash>] of build configuration parameters
+      def buildtype_parameters(options={})
+        assert_options(options)
+        response = get("buildTypes/#{locator(options)}/parameters")
+        response['property']
+      end
+
+      # Get template associated with build configuration
+      #
+      # @param (see #buildtype)
+      # @return [Hashie::Mash, nil] of build configuration parameters or nil if
+      def buildtype_template(options={})
+        assert_options(options)
+        begin
+          get("buildTypes/#{locator(options)}/template")
+        rescue StandardError => e
+          /No template associated/.match(e.to_s) ? nil : raise
+        end
+      end
+
+      # @macro [attach] build configuration settings
+      #   @method buildtype_$1(options = {})
+      #   Get build configuration $1
+      #   @param options [Hash] option keys, :id => buildtype_id
+      #   @return [Array<Hashie::Mash>] of build configuration $1
+      def self.make_method(name)
+        define_method("buildtype_#{name}".to_sym) do |options|
+          name_has_dashes = name.to_s.gsub('_', '-')
+          assert_options(options)
+          response = get("buildTypes/#{locator(options)}/#{name_has_dashes}")
+          response[name_has_dashes.en.plural]
+        end
+      end
+      private_class_method :make_method
+
+      make_method :features
+      make_method :triggers
+      make_method :steps
+      make_method :agent_requirements
+      make_method :artifact_dependencies
+      make_method :snapshot_dependencies
+      make_method :vcs_root_entries
+
+    end
+  end
+end

data/lib/teamcity/client/builds.rb

@@ -0,0 +1,36 @@
+module TeamCity
+  class Client
+    # Defines methods related to builds
+    module Builds
+
+      # HTTP GET
+
+      # List of builds
+      #
+      # @param options [Hash] list of build locators to filter build results on
+      # @return [Array<Hashie::Mash>, nil] of builds or nil if no builds exist
+      def builds(options={})
+        url_params = options.empty? ? '' : "?locator=#{locator(options)}"
+        response = get("builds#{url_params}")
+        response['build']
+      end
+
+      # Get build details
+      #
+      # @param options [Hash] option keys, :id => build_id
+      # @return [Hashie::Mash] of build details
+      def build(options={})
+        assert_options(options)
+        get("builds/#{locator(options)}")
+      end
+
+      def build_tags(options={})
+        assert_options(options)
+        response = get("builds/#{locator(options)}/tags")
+        response['tag']
+      end
+
+
+    end
+  end
+end

data/lib/teamcity/client/common.rb

@@ -0,0 +1,24 @@
+module TeamCity
+  class Client
+    # Defines some common methods shared across the other
+    # teamcity api modules
+    module Common
+
+      private
+
+      def assert_options(options)
+        !options[:id] and raise ArgumentError, "Must provide an id", caller
+      end
+
+      # Take a list of locators to search on multiple criterias
+      #
+      def locator(options={})
+        test = options.inject([]) do |locators, locator|
+          key, value = locator
+          locators << "#{key}:#{value}"
+        end.join(',')
+        test
+      end
+    end
+  end
+end

data/lib/teamcity/client/projects.rb

@@ -0,0 +1,46 @@
+module TeamCity
+  class Client
+    # Defines methods related to projects
+    module Projects
+
+      # HTTP GET
+
+      # List of projects
+      #
+      # @return [Array<Hashie::Mash>, nil] of projects or nil if no projects exist
+      def projects
+        response = get('projects')
+        response['project']
+      end
+
+      # Get project details
+      #
+      # @param options [Hash] option keys, :id => project_id
+      # @return [Hashie::Mash] of project details
+      def project(options={})
+        assert_options(options)
+        get("projects/#{locator(options)}")
+      end
+
+      # List of Build Configurations of a project
+      #
+      # @param (see #project)
+      # @return [Array<Hashie::Mash>, nil] of build types or nil if no build types exist
+      def project_buildtypes(options={})
+        assert_options(options)
+        response = get("projects/#{locator(options)}/buildTypes")
+        response['buildType']
+      end
+
+      # List of parameters defined on a project
+      #
+      # @param (see #project)
+      # @return [Array<Hashie::Mash>, nil] of parameters or nil if no parameters are defined
+      def project_parameters(options={})
+        assert_options(options)
+        response = get("projects/#{locator(options)}/parameters")
+        response['property']
+      end
+    end
+  end
+end

data/lib/teamcity/client.rb

@@ -0,0 +1,14 @@
+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
+  end
+end

data/lib/teamcity/configuration.rb

@@ -0,0 +1,47 @@
+require 'faraday'
+require_relative 'version'
+
+module TeamCity
+  module Configuration
+    VALID_OPTIONS_KEYS = [
+      :adapter,
+      :endpoint,
+      :user_agent,
+      :format
+    ].freeze
+
+    VALID_FORMATS = [:json].freeze
+
+    DEFAULT_ADAPTER = Faraday.default_adapter
+
+    DEFAULT_ENDPOINT = 'http://teamcity:8111/guestAuth/app/rest/7.0/'.freeze
+
+    DEFAULT_USER_AGENT = "TeamCity Ruby Client #{TeamCity::VERSION}".freeze
+
+    DEFAULT_FORMAT = :json
+
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    def self.extended(base)
+      base.reset
+    end
+
+    def configure
+      yield self
+    end
+
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    # Reset all configuration options to defaults
+    def reset
+      self.adapter        = DEFAULT_ADAPTER
+      self.endpoint       = DEFAULT_ENDPOINT
+      self.user_agent     = DEFAULT_USER_AGENT
+      self.format         = DEFAULT_FORMAT
+    end
+  end
+end

data/lib/teamcity/connection.rb

@@ -0,0 +1,27 @@
+require 'faraday_middleware'
+Dir[File.expand_path('../../faraday/*.rb', __FILE__)].each{|f| require f}
+
+module TeamCity
+  # @private
+  module Connection
+    private
+
+    def connection
+      options = {
+        :headers => {'Accept' => "application/#{format}; charset=utf-8", 'User-Agent' => user_agent},
+        :ssl => {:verify => false},
+        :url => endpoint
+      }
+
+      Faraday::Connection.new(options) do |connection|
+        connection.use Faraday::Request::UrlEncoded
+        connection.use FaradayMiddleware::Mashify
+        case format.to_s.downcase
+        when 'json' then connection.use FaradayMiddleware::ParseJson
+        end
+        connection.use FaradayMiddleware::NullResponseBody
+        connection.adapter(adapter)
+      end
+    end
+  end
+end

data/lib/teamcity/request.rb

@@ -0,0 +1,40 @@
+module TeamCity
+  # Defines HTTP request methods
+  module Request
+    # Perform an HTTP GET request
+    def get(path, options={})
+      request(:get, path, options)
+    end
+
+    # Perform an HTTP POST request
+    def post(path, options={})
+      request(:post, path, options)
+    end
+
+    # Perform an HTTP PUT request
+    def put(path, options={})
+      request(:put, path, options)
+    end
+
+    # Perform an HTTP DELETE request
+    def delete(path, options={})
+      request(:delete, path, options)
+    end
+
+    private
+
+    # Perform an HTTP request
+    def request(method, path, options)
+      response = connection.send(method) do |request|
+        case method
+        when :get, :delete
+          request.url(path, options)
+        when :post, :put
+          request.path = path
+          request.body = options unless options.empty?
+        end
+      end
+      response.body
+    end
+  end
+end

data/lib/teamcity/version.rb

@@ -0,0 +1,3 @@
+module TeamCity
+  VERSION = '0.1.0'
+end