teamcity-ruby-client 1.1.0 → 1.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZDMzYTI1MjZhMzBkNDAyODIzMDdhY2ZkMWJjNTllZjc4NDQ2N2U1Nw==
+    NTkyNmMwZWJmYjU4MWRhNzkwNjQwOWMzYjZlNmIxZmVhZWE0NTIyMw==
   data.tar.gz: !binary |-
-    YzJlNjc1ZWE0YTIxYmEyMjZhZmMyZTQ1NDdjYzg0ZGQ5MjZhMjMzZA==
+    NTkzYzA4NTNlZWQ5MjliYzU5ODkxYTMwOThmMmE5YTdhNzFjYjI0Yg==
 SHA512:
   metadata.gz: !binary |-
-    YmNiZGQ3ZTM2NGQ3ZGJmOTJhNWI5NjgxNTczOTc0OTJiYmY4NDdhOWEyODky
-    NTE2ZTQ4NzQzYzgyOWQwMGQ5Zjg3NWRiNjE4MmI3NDQzYWM0YzkzYjdkYjQ5
-    ZmUzNDc3NDczMzFmOWI0ZWRlOTdiZDgyMTA3YjU4MTY2ZDk4NjI=
+    YWM1NWY4NDA2YzU3Y2U5NTNhNTA3ZGI0ZDNkYTkyOWQ5ZjdmMDQ3MTc4Njgx
+    NDMzODRhYzJiNWZjZWNlYjc3Njc4ZDQ1ZDQzZDRiYjViOGQxNDM5OGI5OGNh
+    YTJhOTZjMTk0NGQ5MGJlNmNjZTNiYzNlYzQwNjIzMWU4MGUxYzE=
   data.tar.gz: !binary |-
-    Nzk1MjM0MWIyOGYzOGVkMDYzYTUzZWNiOGRmODkzOTU0NTE2ZWM4MzA1OTRm
-    NDc2MGY4NjIxMWYwMzU5ZTFmN2NiZjVlYzNkNWQzYTNlMjI4NDBkYmNjZTE1
-    Mzk2NDRjMTIxNTFkOWVhNzRiYzgxMTNlMWEwYmZjZmQzMmQ5NzM=
+    YjJiNmE0YzU4NTllYzdlOTIxOWI3NDc2ZjMyOTM0NWM3NjkyZTBmNGJmMTkz
+    MjM5NDljMGI3ODVmMjNhY2YxNzhmNmM5ZDU1MWUzZTFiMjc5ZWM2OTE0YWRl
+    NjYxNTBiNmUwMDJlMWQzNmE3MTFiNDIzNzgwN2FhMDg4YmE3OTk=

data/.yardopts

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

data/CHANGELOG.md

@@ -1,12 +1,24 @@
+## 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]
+* 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), courtesy of [@orikremer](https://github.com/orikremer)
+      contents of an aritfact) [@orikremer]
 
 * Gem Updates
-    * Upgraded webmock to remove deprecation warning, courtesy of
-      [@akiellor](https://github.com/akiellor)
+    * Upgraded webmock to remove deprecation warning [@akiellor]
 
 ## 1.0.1 (Nov 1, 2013)
 

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/lib/teamcity.rb

@@ -1,6 +1,7 @@
 require_relative 'teamcity/configuration'
 require_relative 'teamcity/client'
 require_relative 'teamcity/headers'
+require_relative 'teamcity/element_builder'
 
 module TeamCity
   extend Configuration

data/lib/teamcity/client.rb

@@ -1,5 +1,4 @@
 require_relative 'api'
-require 'builder'
 
 module TeamCity
   # Wrapper for the TeamCity REST API
@@ -13,4 +12,4 @@ module TeamCity
     include TeamCity::Client::Common
     include TeamCity::Client::VCSRoots
   end
-end
+end

data/lib/teamcity/client/build_types.rb

@@ -1,12 +1,7 @@
-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
@@ -26,6 +21,17 @@ module TeamCity
         get("buildTypes/#{locator(options)}")
       end
 
+      # Create a Build Configuration
+      #
+      # @param project_id [String] id of the project you are adding the build configuration
+      # @param name [String] name of the buildtype you wish to create
+      # @return [Hashie::Mash] of build configuration details
+      def create_buildtype(project_id, name)
+        post("projects/#{project_id}/buildTypes", :content_type => :text) do |req|
+          req.body = name
+        end
+      end
+
       # Get whether the build is paused or not
       #
       # @param options [Hash] option keys, :id => buildtype_id
@@ -87,10 +93,11 @@ module TeamCity
         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]
+          response = get("buildTypes/#{locator(options)}/#{name_has_dashes}", accept: :json)
+          response[response.keys.first]
         end
       end
+
       private_class_method :make_method
 
       make_method :features
@@ -108,13 +115,10 @@ module TeamCity
       # @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!
+        payload = { 'vcs-root' => { :id => vcs_root_id } }
+
+        post("buildTypes/#{buildtype_id}/vcs-root-entries", :content_type => :json) do |req|
+          req.body = payload.to_json
         end
       end
 
@@ -155,16 +159,14 @@ module TeamCity
       #
       # @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
+        builder = TeamCity::ElementBuilder.new(:id => parameter_name, :type => condition) do |properties|
+          properties['property-name']  = parameter_name
+          properties['property-value'] = parameter_value
         end
+
         path = "buildTypes/#{buildtype_id}/agent-requirements"
-        post(path, :accept => :json, :content_type => :xml) do |req|
-          req.body = builder.target!
+        post(path, :accept => :json, :content_type => :json) do |req|
+          req.body = builder.to_request_body
         end
       end
 
@@ -197,6 +199,23 @@ module TeamCity
         end
       end
 
+      # Set buildtype settings
+      #
+      # @example Cleaning all files between the builds
+      #   TeamCity.set_buildtype_setting('bt3', 'cleanBuild', 'true')
+      # @example Checkout on the server
+      #   TeamCity.set_buildtype_setting('bt3', 'checkoutMode', 'ON_SERVER')
+      # @example Fail the build after 10 Minutes
+      #   Teamcity.set_buildtype_setting('bt3', 'executionTimeoutMin', '10')
+      #
+      # @param buidltype_id [String] the buildtype id
+      # @param setting_name [String] the settings name
+      # @param setting_value [String] the value to set the settings to
+      # @return setting_value [String] value that was set
+      def set_buildtype_setting(buildtype_id, setting_name, setting_value)
+        set_buildtype_field(buildtype_id, "settings/#{setting_name}", setting_value)
+      end
+
       # Delete buildtype (build configuration)
       #
       # @param buildtype_id [String] the id of the buildtype
@@ -218,6 +237,58 @@ module TeamCity
           req.body = field_value
         end
       end
+
+      # Create Build Step
+      #
+      # @param buildtype_id [String] :buildtype_id to create the step under
+      # @option options [String] :name for the step definition (optional)
+      # @option options [String] :type Type of Build Step: 'Maven', 'Ant', etc
+      # @yield [Hash] properties to set on the step, view the official documentation for supported properties
+      # @return [Hashie::Mash] step object that was created
+      #
+      # @example Create a Maven2 step that executes the target verify
+      #   TeamCity.create_build_step(:buildtype_id => 'my-build-type-id', :type => 'Maven', name: 'Unit Tests') do |properties|
+      #     properties['goals'] = 'verify'
+      #     properties['mavenSelection'] = 'mavenSelection:default'
+      #     properties['pomLocation'] = 'pom.xml'
+      #   end
+      def create_build_step(buildtype_id, options = {}, &block)
+        attributes = {
+          :type => options.fetch(:type),
+          :name => options.fetch(:name) { nil }
+        }
+
+        builder = TeamCity::ElementBuilder.new(attributes, &block)
+
+        post("buildTypes/#{buildtype_id}/steps", :content_type => :json) do |req|
+          req.body = builder.to_request_body
+        end
+      end
+
+      # Create Build Trigger
+      #
+      # @param buildtype_id [String] :buildtype_id to create the trigger under
+      # @option options [String] :type Type of Build Trigger: 'vcsTrigger', 'schedulingTrigger', etc
+      # @yield [Hash] properties to set on the trigger, view the official documentation for supported properties
+      # @return [Hashie::Mash] trigger object that was created
+      #
+      # @example Create a a VCS build trigger for checkins
+      #   TeamCity.create_build_step(:buildtype_id => 'my-build-type-id', :type => 'vcsTrigger', name: 'Every Checkin') do |properties|
+      #     properties['groupCheckkinsByCommitter'] = 'true'
+      #     properties['perCheckinTriggering'] = 'true'
+      #     properties['quietPeriodMode'] = 'DO_NOT_USE'
+      #   end
+      def create_build_trigger(buildtype_id, options = {}, &block)
+        attributes = {
+          :type => options.fetch(:type),
+        }
+
+        builder = TeamCity::ElementBuilder.new(attributes, &block)
+
+        post("buildTypes/#{buildtype_id}/triggers", :content_type => :json) do |req|
+          req.body = builder.to_request_body
+        end
+      end
     end
   end
-end
+end

data/lib/teamcity/client/projects.rb

@@ -41,6 +41,18 @@ module TeamCity
         response['property']
       end
 
+      # Get parent project
+      #
+      # @param (see #project)
+      # @return [Hashie::Mash] of the parent project details
+      # @rest_api_version >= 8.0
+      def parent_project(options={})
+        assert_options(options)
+        response = get("projects/#{locator(options)}/parentProject")
+        return nil if response['id'] == '_Root'
+        response
+      end
+
       # Create an empty project
       #
       # @param name [String] Name of the project
@@ -64,12 +76,11 @@ module TeamCity
         attributes = {
           :name => target_project_name
         }
-        builder = Builder::XmlMarkup.new
-        builder.tag!(:newProjectDescription ,options.merge(attributes)) do |node|
-          node.tag!(:sourceProject, locator: source_project_id)
-        end
-        post("projects", :content_type => :xml) do |req|
-          req.body = builder.target!
+
+        payload = { 'sourceProject' => { locator: source_project_id } }.merge(attributes)
+
+        post("projects", :content_type => :json, :accept => :json) do |req|
+          req.body = payload.to_json
         end
       end
 
@@ -80,7 +91,7 @@ module TeamCity
       def delete_project(project_id)
         delete("projects/#{project_id}")
       end
-      
+
       # Delete a project parameter
       #
       # @param project_id [String] the project id
@@ -124,6 +135,24 @@ module TeamCity
           req.body = field_value
         end
       end
+
+      # Set a parent for a given project
+      #
+      # @example Set project1 as parent for project2
+      #   TeamCity.set_parent_project('project2', 'project1')
+      #
+      # @param project_id [String] the project id
+      # @param parent_project_id [String] the parent project id
+      # @return [Hashie::Mash] of child project details
+      # @rest_api_version >= 8.0
+      def set_parent_project(project_id, parent_project_id)
+        path = "projects/#{project_id}/parentProject"
+        payload = { :id => parent_project_id }
+
+        put(path, :content_type => :json, :accept => :json) do |req|
+          req.body = payload.to_json
+        end
+      end
     end
   end
-end
+end

data/lib/teamcity/client/vcs_roots.rb

@@ -2,6 +2,8 @@ module TeamCity
   class Client
     module VCSRoots
 
+      VCS_TYPES = { 'git' => 'jetbrains.git' }
+
       # List of VCS Roots
       #
       # @return [Array<Hashie::Mash>, nil] of vcs roots or nil if no vcs roots exist
@@ -36,25 +38,16 @@ module TeamCity
       def create_vcs_root(options = {}, &block)
         attributes = {
           :name    => options.fetch(:vcs_name),
-          :vcsName => "jetbrains.#{options.fetch(:vcs_type)}",
+          :vcsName => VCS_TYPES[options.fetch(:vcs_type)] || options.fetch(:vcs_type),
           :projectLocator => options.fetch(:project_id)
         }
-        builder = Builder::XmlMarkup.new
-        builder.tag!('vcs-root'.to_sym, 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", :content_type => :xml) do |req|
-          req.body = builder.target!
+
+        builder = TeamCity::ElementBuilder.new(attributes, &block)
+
+        post("vcs-roots", :content_type => :json) do |req|
+          req.body = builder.to_request_body
         end
       end
     end
   end
-end
+end

data/lib/teamcity/element_builder.rb

@@ -0,0 +1,27 @@
+module TeamCity
+  class ElementBuilder
+    def initialize(attributes = {}, &block)
+      @payload = attributes
+
+      if block_given?
+        @payload['properties'] ||= {}
+        @payload['properties']['property'] ||= []
+
+        properties = {}
+
+        yield(properties)
+
+        properties.each do |name, value|
+          @payload['properties']['property'] << {
+            :name  => name,
+            :value => value
+          }
+        end
+      end
+    end
+
+    def to_request_body
+      @payload.to_json
+    end
+  end
+end

data/lib/teamcity/version.rb

@@ -1,3 +1,3 @@
 module TeamCity
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/spec/cassettes/BuildTypes/POST/_attach_vcs_root/should_attach_a_vcs_root_to_a_buildtype.yml

@@ -4,15 +4,17 @@ http_interactions:
     method: post
     uri: http://teamcity-ruby-client:teamcity@localhost:8111/httpAuth/app/rest/buildTypes/BuildTypeTests_PostBuildTypeTests/vcs-root-entries
     body:
-      encoding: US-ASCII
-      string: <vcs-root-entry><vcs-root id="teamcity_ruby_client"/></vcs-root-entry>
+      encoding: UTF-8
+      string: '{"vcs-root":{"id":"teamcity_ruby_client"}}'
     headers:
       User-Agent:
-      - TeamCity Ruby Client 0.4.0
+      - TeamCity Ruby Client 1.1.0
       Accept:
       - application/json; charset=utf-8
       Content-Type:
-      - application/xml
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
   response:
     status:
       code: 200
@@ -22,7 +24,7 @@ http_interactions:
       - Apache-Coyote/1.1
       Set-Cookie:
       - RememberMe=""; Expires=Thu, 01-Jan-1970 00:00:10 GMT; Path=/; HttpOnly
-      - TCSESSIONID=2C57E65BDB7952BC8CE5ED7E65BCBB2E; Path=/; HttpOnly
+      - TCSESSIONID=5762F45291C27BA5471781C5667AE23A; Path=/; HttpOnly
       Pragma:
       - no-cache
       Expires:
@@ -35,11 +37,11 @@ http_interactions:
       Transfer-Encoding:
       - chunked
       Date:
-      - Wed, 14 Aug 2013 13:26:41 GMT
+      - Wed, 27 Nov 2013 19:01:47 GMT
     body:
-      encoding: US-ASCII
-      string: ! '{"id":"teamcity_ruby_client","vcs-root":{"id":"teamcity_ruby_client","name":"teamcity
-        ruby client","href":"/httpAuth/app/rest/vcs-roots/id:teamcity_ruby_client"},"checkout-rules":""}'
+      encoding: UTF-8
+      string: '{"id":"teamcity_ruby_client","vcs-root":{"id":"teamcity_ruby_client","name":"TeamCity
+        Ruby Client","href":"/httpAuth/app/rest/vcs-roots/id:teamcity_ruby_client"},"checkout-rules":""}'
     http_version: 
-  recorded_at: Wed, 14 Aug 2013 13:26:41 GMT
+  recorded_at: Wed, 27 Nov 2013 19:01:47 GMT
 recorded_with: VCR 2.4.0