teamcity-ruby-client 0.1.0 → 0.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NGU0NzgwMGI5OGY5MmE3OWI3MWJhMDA0ODhlNDY3NjYzOGE2Yzk5ZA==
+    NmM2N2RlMmE3MDVlOTM4NjVlYmI5ZTgyNjRhNDAzY2FhNWM2YjZiYw==
   data.tar.gz: !binary |-
-    YTc5ZDA0NDdjZmRjZDlkNTVmZmYyNWNiMGFiNTczNTQzZmFmZmZmMQ==
+    MzE2NGViZjYxNzNkY2VmY2ViYTliYzJmYWIwZGU0MDVkZGYyYjMyYg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    N2UzYjg1MGE5YTA1NmU1YjQ5NjkxMmJmNzY2YjE4YmUwZGVkOTRmNjNlOWU2
-    YzQ5YmViNzQ1MWEyNWIxYmQyNjZiYzVlMDRlOTVjMTE5MjdkYmI2NWZjYzhi
-    NjcwNzEwYmE5YWQ4NzAxYWY5ZjNmNjUxNjZmYTlhOTY1NTY3ZGI=
+    ZGI0MWYxNGY0YmU1ZDNhNzc3ZmVlODIxZTRmMjE0NGNkMTk4YjllMDNkZDY4
+    NDcxOTM3ZTg0ZGZjOWIxMWVhN2U1MDc1ZTQ2M2JmMWQxMGFkODBjMzRiNGMz
+    ZjZmM2E0YzlmOWIzNDdmYzg2YmY5MDNiYzdjZjczNTBlNzRlMWE=
   data.tar.gz: !binary |-
-    ZjdlM2M3ZDI2ZDM3ZmU3OTgyZmI3NzM0ODAwNjExNDU4MTk5OGI1ZTliZDg3
-    NTU1NTk4Y2EyYzk0ZGJmN2NjODEyYzdlZDYyZDhjY2UxYzI4YzYwYjE0ZjFk
-    YzI3ZGEzYTc2ZGY1ZWQ1MDBkMjJiYmFlNDM4OWZhMDNiZDJiNDA=
+    ZDJhZTBjNzQ2NjU3MTcwOTFmYzY0MzU0M2NiOWM5YTU5ZWUwOTY1NjQzNmMw
+    YzdhNDYwYzBjMDY2ZWE0YzgwYzg4ODVmM2RmZWFlODQ5YTQyZjFiMmE4NjJi
+    OTM4ZTEwZTNkMzMzYjUzMTMzMjg3ZDg4Njg3ZTJhYjc2ZWFkZDQ=

data/README.md

@@ -98,6 +98,10 @@ puts TeamCity.build(id: TeamCity.builds(count: 1).first.id).buildType.name # Fet
 
 ## Documentation
 
+### API Docs
+
+[Latest](http://rubydoc.info/gems/teamcity-ruby-client/0.1.0/frames)
+
 ### Generating API Docs
 
 1. Pull the source down

data/lib/teamcity/client.rb

@@ -1,4 +1,5 @@
 require_relative 'api'
+require 'builder'
 
 module TeamCity
   # Wrapper for the TeamCity REST API
@@ -10,5 +11,6 @@ module TeamCity
     include TeamCity::Client::BuildTypes
     include TeamCity::Client::Builds
     include TeamCity::Client::Common
+    include TeamCity::Client::VCSRoots
   end
 end

data/lib/teamcity/client/build_types.rb

@@ -88,6 +88,98 @@ module TeamCity
       make_method :snapshot_dependencies
       make_method :vcs_root_entries
 
+      # Attach a vcs root to a build type (build configuration_)
+      #
+      #
+      # @param buildtype_id [String] the buildtype id
+      # @param vcs_root_id [String, Numeric] id of vcs root
+      # @return [Hashie::Mash] vcs root object that was attached
+      def attach_vcs_root(buildtype_id, vcs_root_id)
+        builder = Builder::XmlMarkup.new
+        builder.tag!('vcs-root-entry'.to_sym) do |node|
+          node.tag!('vcs-root'.to_sym, :id => vcs_root_id)
+        end
+        post("buildTypes/#{buildtype_id}/vcs-root-entries") do |req|
+          req.headers['Content-Type'] = 'application/xml'
+          req.body = builder.target!
+        end
+      end
+
+      # Set a buildtype parameter (Create or Update)
+      #
+      #
+      # @param buildtype_id [String] the buildtype id
+      # @param parameter_name [String] name of the parameter to set
+      # @param parameter_value [String] value of the parameter
+      # @return [nil]
+      def set_buildtype_parameter(buildtype_id, parameter_name, parameter_value)
+        path = "buildTypes/#{buildtype_id}/parameters/#{parameter_name}"
+        put_text_request(path, parameter_value)
+      end
+
+      # Delete a buildtype parameter
+      #
+      # @param buildtype_id [String] the buildtype id
+      # @param parameter_name [String] name of the parameter to delete
+      # @return [nil]
+      def delete_buildtype_parameter(buildtype_id, parameter_name)
+        delete("buildTypes/#{buildtype_id}/parameters/#{parameter_name}") do |req|
+          # only accepts text/plain
+          req.headers['Accept'] = 'text/plain'
+        end
+      end
+
+      # Create a buildtype agent requirement (Create)
+      #
+      # @param buildtype_id [String] the buildtype id
+      # @param parameter_name [String] name of the parameter to set
+      # @param parameter_value [String] value of the parameter
+      # @param condition [String] the condition for which to check against
+      # @return [nil]
+      #
+      # @example Create a condition where a system property equals something
+      #    TeamCity.create_agent_requirement('bt1', 'system.os.name', 'Linux', 'equals')
+      #
+      # @note Check the TeamCity UI for supported conditions
+      def create_agent_requirement(buildtype_id, parameter_name, parameter_value, condition)
+        builder = Builder::XmlMarkup.new
+        builder.tag!('agent-requirement'.to_sym, :id => parameter_name, :type => condition) do |node|
+          node.properties do |p|
+            p.property(:name => 'property-name', :value => parameter_name)
+            p.property(:name => 'property-value', :value => parameter_value)
+          end
+        end
+        post("buildTypes/#{buildtype_id}/agent-requirements") do |req|
+          req.headers['Content-Type'] = 'application/xml'
+          req.body = builder.target!
+        end
+      end
+
+      # Delete an agent requirement for a buildtype
+      #
+      # @param buildtype_id [String] the buildtype_id
+      # @param parameter_name [String] name of the requirement to delete
+      # @return [nil]
+      def delete_agent_requirement(buildtype_id, parameter_name)
+        delete("buildTypes/#{buildtype_id}/agent-requirements/#{parameter_name}")
+      end
+
+      # Set a buildtype field
+      #
+      # @example Change buildtype name
+      #   TeamCity.set_buildtype_field('bt3', 'name', 'new-name')
+      # @example Set buildtype description
+      #   TeamCity.set_buildtype_field('bt3', 'description', 'new-description')
+      # @example Pause/Unpause a buildtype
+      #   Teamcity.set_buildtype_field('buildtype', 'paused', 'true|false')
+      #
+      # @param buidltype_id [String] the buildtype id
+      # @param field_name [String] the field name
+      # @param field_value [String] the value to set the field to
+      def set_buildtype_field(buildtype_id, field_name, field_value)
+        path = "buildTypes/#{buildtype_id}/#{field_name}"
+        put_text_request(path, field_value)
+      end
     end
   end
 end

data/lib/teamcity/client/common.rb

@@ -13,11 +13,22 @@ module TeamCity
       # Take a list of locators to search on multiple criterias
       #
       def locator(options={})
-        test = options.inject([]) do |locators, locator|
+        options.inject([]) do |locators, locator|
           key, value = locator
           locators << "#{key}:#{value}"
         end.join(',')
-        test
+      end
+
+      # Put request helper where the body is text
+      #
+      # @param path [String] request path
+      # @param body [String] body contents of the request
+      # @return [nil]
+      def put_text_request(path, body)
+        put(path) do |req|
+          req.headers['Content-Type'] = 'text/plain'
+          req.body = body
+        end
       end
     end
   end

data/lib/teamcity/client/projects.rb

@@ -3,8 +3,6 @@ module TeamCity
     # 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
@@ -15,7 +13,8 @@ module TeamCity
 
       # Get project details
       #
-      # @param options [Hash] option keys, :id => project_id
+      # @param options [Hash] The options hash,
+      # @option options [String] :id the project id
       # @return [Hashie::Mash] of project details
       def project(options={})
         assert_options(options)
@@ -41,6 +40,86 @@ module TeamCity
         response = get("projects/#{locator(options)}/parameters")
         response['property']
       end
+
+      # Create an empty project
+      #
+      # @param name [String] Name of the project
+      # @return [Hashie::Mash] project details
+      def create_project(name)
+        post("projects") do |req|
+          req.headers['Content-Type'] = 'text/plain'
+          req.body = name
+        end
+      end
+
+      # Copy another project
+      #
+      # @param source_project_id [String] id of the project you wish to copy
+      # @param target_project_name [String] name of the project you want to create
+      # @param options [Hash] copy project options
+      # @option options [Boolean] :copyAllAssociatedSettings copy all associated settings
+      # @options options[Boolean] :shareVCSRoots when true the vcs roots will be shared, otherwise they will be copied
+      # @return [Hashie::Mash] project details
+      def copy_project(source_project_id, target_project_name, options={})
+        attributes = {
+          :name => target_project_name,
+          :sourceProjectLocator => "id:#{source_project_id}",
+        }
+        post("projects") do |req|
+          req.headers['Content-Type'] = 'application/xml'
+          builder = Builder::XmlMarkup.new
+          builder.newProjectDescription(options.merge(attributes))
+          req.body = builder.target!
+        end
+      end
+
+      # Delete a project
+      #
+      # @param project_id [String] the id of the project
+      # @return [nil]
+      def delete_project(project_id)
+        delete("projects/#{project_id}")
+      end
+      
+      # Delete a project parameter
+      #
+      # @param project_id [String] the project id
+      # @param parameter_name [String] name of the parameter to delete
+      # @return [nil]
+      def delete_project_parameter(project_id, parameter_name)
+        delete("projects/#{project_id}/parameters/#{parameter_name}") do |req|
+          # only accepts text/plain
+          req.headers['Accept'] = 'text/plain'
+        end
+      end
+
+      # Set a project parameter (Create or Update)
+      #
+      #
+      # @param project_id [String] the project id
+      # @param parameter_name [String] name of the parameter to set
+      # @param parameter_value [String] value of the parameter
+      def set_project_parameter(project_id, parameter_name, parameter_value)
+        path = "projects/#{project_id}/parameters/#{parameter_name}"
+        put_text_request(path, parameter_value)
+      end
+
+      # Set a project field
+      #
+      # @example Set a projects name
+      #   TeamCity.set_project_field('project1', 'name', 'new-name')
+      # @example Set a projects description
+      #   TeamCity.set_project_field('project1', 'description', 'new-description')
+      # @example Archive/Unarchive a project
+      #   Teamcity.set_project_field('project1', 'archived', 'true|false')
+      #
+      # @param project_id [String] the project id
+      # @param field_name [String] the field name: 'name', 'description', 'archived'
+      # @param field_value [String] the value to set the field to
+      def set_project_field(project_id, field_name, field_value)
+        path = "projects/#{project_id}/#{field_name}"
+        put_text_request(path, field_value)
+      end
     end
   end
 end

data/lib/teamcity/client/vcs_roots.rb

@@ -0,0 +1,62 @@
+module TeamCity
+  class Client
+    module VCSRoots
+
+      # List of VCS Roots
+      #
+      # @return [Array<Hashie::Mash>, nil] of vcs roots or nil if no vcs roots exist
+      def vcs_roots
+        response = get('vcs-roots')
+        response['vcs-root']
+      end
+
+      # Get VCS Root details
+      #
+      # @param vcs_root_id [String, Numeric]
+      # @return [Hashie::Mash]
+      def vcs_root_details(vcs_root_id)
+        get("vcs-roots/id:#{vcs_root_id}")
+      end
+
+      # Create VCS Root
+      #
+      # @param vcs_name [String] Name of the vcs root
+      # @param vcs_type [String] Type of VCS: 'git', 'perforce', etc
+      # @param options [Hash] VCS root options
+      # @option options [String] :projectLocator the project id (not required if :shared => true)
+      # @option options [Boolean] :shared whether the vcs root is shared across projects
+      # @yield [Hash] properties to set on the vcs root, view the page source of the vcs root page for the id and value of a property
+      # @return [Hashie::Mash] vcs root object that was created
+      #
+      # @example Create a Git VCS Root that pulls from master that is only shared within a project and uses the default private key
+      #   TeamCity.create_vcs_root('my-git-vcs-root', 'git', :projectLocator => '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
+      def create_vcs_root(vcs_name, vcs_type, options = {}, &block)
+        attributes = {
+          :name    => vcs_name,
+          :vcsName => "jetbrains.#{vcs_type}"
+        }
+        builder = Builder::XmlMarkup.new
+        builder.tag!('vcs-root'.to_sym, options.merge(attributes)) do |node|
+          node.properties do |p|
+            if block_given?
+              properties = {}
+              yield(properties)
+              properties.each do |name, value|
+                p.property(:name => name, :value => value)
+              end
+            end
+          end
+        end
+        post("vcs-roots") do |req|
+          req.headers['Content-Type'] = 'application/xml'
+          req.body = builder.target!
+        end
+      end
+    end
+  end
+end

data/lib/teamcity/configuration.rb

@@ -7,17 +7,23 @@ module TeamCity
       :adapter,
       :endpoint,
       :user_agent,
-      :format
+      :format,
+      :http_user,
+      :http_password
     ].freeze
 
     VALID_FORMATS = [:json].freeze
 
     DEFAULT_ADAPTER = Faraday.default_adapter
 
-    DEFAULT_ENDPOINT = 'http://teamcity:8111/guestAuth/app/rest/7.0/'.freeze
+    DEFAULT_ENDPOINT = 'http://teamcity:8111/httpAuth/app/rest/7.0/'.freeze
 
     DEFAULT_USER_AGENT = "TeamCity Ruby Client #{TeamCity::VERSION}".freeze
 
+    DEFAULT_HTTP_USER = nil
+
+    DEFAULT_HTTP_PASSWORD = nil
+
     DEFAULT_FORMAT = :json
 
     attr_accessor *VALID_OPTIONS_KEYS
@@ -42,6 +48,8 @@ module TeamCity
       self.endpoint       = DEFAULT_ENDPOINT
       self.user_agent     = DEFAULT_USER_AGENT
       self.format         = DEFAULT_FORMAT
+      self.http_user      = DEFAULT_HTTP_USER
+      self.http_password  = DEFAULT_HTTP_PASSWORD
     end
   end
 end

data/lib/teamcity/connection.rb

@@ -21,6 +21,7 @@ module TeamCity
         end
         connection.use FaradayMiddleware::NullResponseBody
         connection.adapter(adapter)
+        connection.basic_auth(http_user, http_password)
       end
     end
   end

data/lib/teamcity/request.rb

@@ -2,30 +2,31 @@ module TeamCity
   # Defines HTTP request methods
   module Request
     # Perform an HTTP GET request
-    def get(path, options={})
-      request(:get, path, options)
+    def get(path, options={}, &block)
+      request(:get, path, options, &block)
     end
 
     # Perform an HTTP POST request
-    def post(path, options={})
-      request(:post, path, options)
+    def post(path, options={}, &block)
+      request(:post, path, options, &block)
     end
 
     # Perform an HTTP PUT request
-    def put(path, options={})
-      request(:put, path, options)
+    def put(path, options={}, &block)
+      request(:put, path, options, &block)
     end
 
     # Perform an HTTP DELETE request
-    def delete(path, options={})
-      request(:delete, path, options)
+    def delete(path, options={}, &block)
+      request(:delete, path, options, &block)
     end
 
     private
 
     # Perform an HTTP request
-    def request(method, path, options)
+    def request(method, path, options, &block)
       response = connection.send(method) do |request|
+        block.call(request) if block_given?
         case method
         when :get, :delete
           request.url(path, options)

data/lib/teamcity/version.rb

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

data/spec/cassettes/BuildTypes/DELETE/_delete_agent_requirement/should_delete_the_agent_requirement.yml

@@ -0,0 +1,38 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: http://teamcity-ruby-client:teamcity@localhost:8111/httpAuth/app/rest/7.0/buildTypes/bt3/agent-requirements/test
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json; charset=utf-8
+      User-Agent:
+      - TeamCity Ruby Client 0.2.0
+  response:
+    status:
+      code: 204
+      message: No Content
+    headers:
+      Server:
+      - Apache-Coyote/1.1
+      Set-Cookie:
+      - JSESSIONID=7D5C309BD50232088662586230C9FE5B; 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
+      Date:
+      - Mon, 06 May 2013 19:35:55 GMT
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version: 
+  recorded_at: Mon, 06 May 2013 19:35:55 GMT
+recorded_with: VCR 2.4.0