teamcity-ruby-client 0.4.0 → 1.0.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NzU1YTc3MWEyYzhmZTVjMDRiMGI4MTBlMzg5NmNiODEwM2NmOWY5ZA==
+    YTE4MmFkNGIxMzQ3YTJlNmY4OTRkZGNmNGVkNzcwYmI0MjhiMzZlZQ==
   data.tar.gz: !binary |-
-    YWE3NzczNzUxMmI5ZjJiODRiYjg5M2RjNzNkOTdjYzIzNzc5NzMyNQ==
+    MGRjMjFiMmE5NGJkZmIxNjUzZTczMjRiNzkwMDE5OGFmOGI4NDAxMA==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    OThjYzE5Y2RmYzk2OWFiYjJhZmMzMGU5Zjk2NWQ1MGM2Zjg4ZjU1NTc2M2Ni
-    ZDM0NzVjMDI2OWZjYWEwZjVmMDZkYTg2NmY0MjJkNGIyYmUyZmJiYTU3ODY4
-    OTkwNDk5MzlmYzZiMzY0OWZhNzc5MjRjNWQ2MTk1Y2YyMjEzMGE=
+    Njc4OWRkZjRiMTE1NTkyYjY2YjEyNzZjYjZiZWU0Mzg5NmQwYTE0YzIwN2Y2
+    OTBjNDVjYTdmOTM3ZmM1NjRkM2ZiNzg4YTUwNGI3MDk4OGQ1MTQ0MzJkODJj
+    NmQ1NDA1YjViYTMyNDg1ZjVjNGEwNWZmNWNjNGNjYzkzMGM2MDQ=
   data.tar.gz: !binary |-
-    NjJlZWZhNzkwZjk2YjZmNDUxNmEzZTQ3OWFlNjU1YjM0ZjY2MzgyYTM0NDQ5
-    MTA0YmQyMDY3ZjcxODQxOTVkMzE0NDI0ODM5ZTg4YTU5ZmRkMDZiZTE0M2Iw
-    N2UyNTkzZmQ2YTk4YzE5YWM5NTZkYTViZjliNzEyNGYxMWJhMzc=
+    NDlmMWZjNTJjMzc3YmJhZjM3ODE1NDA4MzdmYjkyYmJmYTgxOWJjZGVhNTlh
+    NjExOWI4YmQ5NDE1ZmIwOTA4MTcxMjhjNGViZWRhNzA1ZDRiZTQ1NDVmYjgy
+    ODFlNjBjMjdjMGU2OGE1YmRlZWUxNGVhYjA1YTlhMzhiMjExNWU=

data/CHANGELOG.md

@@ -1,6 +1,20 @@
+## 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 unbuild a build respectively)
+* 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)
 

data/README.md

@@ -19,19 +19,21 @@ Or install it yourself as:
 
 ## API Usage Examples
 
-* Tested on TeamCity 7.0 and higher
+* Tested on TeamCity 7.X and 8.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'
@@ -121,7 +123,7 @@ puts Teamcity.vcs_roots
 puts TeamCity.vcs_root_details(1)
 
 # Create VCS Root for a project
-TeamCity.create_vcs_root('my-git-vcs-root', 'git', :projectLocator => 'project2') do |properties|
+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'

data/lib/teamcity.rb

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

data/lib/teamcity/client/build_types.rb

@@ -26,11 +26,15 @@ module TeamCity
         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 whether the build is paused or not
+      #
+      # @param options [Hash] option keys, :id => buildtype_id
+      # @return [String] 'true' or 'false' on whether the build is paused
+      def buildtype_state(options={})
+        assert_options(options)
+        path = "buildTypes/#{locator(options)}/paused"
+        get(path, :accept => :text, :content_type => :text)
+      end
 
       # Get build configuration settings
       #
@@ -120,10 +124,12 @@ module TeamCity
       # @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]
+      # @return parameter_value [String] that was set
       def set_buildtype_parameter(buildtype_id, parameter_name, parameter_value)
         path = "buildTypes/#{buildtype_id}/parameters/#{parameter_name}"
-        put_text_request(path, parameter_value)
+        put(path, :accept => :text, :content_type => :text) do |req|
+          req.body = parameter_value
+        end
       end
 
       # Delete a buildtype parameter
@@ -132,10 +138,8 @@ module TeamCity
       # @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
+        path = "buildTypes/#{buildtype_id}/parameters/#{parameter_name}"
+        delete(path, :accept => :text, :content_type => :text)
       end
 
       # Create a buildtype agent requirement (Create)
@@ -144,7 +148,7 @@ module TeamCity
       # @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]
+      # @return [Hashie::Mash]
       #
       # @example Create a condition where a system property equals something
       #    TeamCity.create_agent_requirement('bt1', 'system.os.name', 'Linux', 'equals')
@@ -158,8 +162,8 @@ module TeamCity
             p.property(:name => 'property-value', :value => parameter_value)
           end
         end
-        post("buildTypes/#{buildtype_id}/agent-requirements") do |req|
-          req.headers['Content-Type'] = 'application/xml'
+        path = "buildTypes/#{buildtype_id}/agent-requirements"
+        post(path, :accept => :json, :content_type => :xml) do |req|
           req.body = builder.target!
         end
       end
@@ -185,9 +189,12 @@ module TeamCity
       # @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
+      # @return field_value [String] value that was set
       def set_buildtype_field(buildtype_id, field_name, field_value)
         path = "buildTypes/#{buildtype_id}/#{field_name}"
-        put_text_request(path, field_value)
+        put(path, :accept => :text, :content_type => :text) do |req|
+          req.body = field_value
+        end
       end
 
       # Delete buildtype (build configuration)
@@ -207,7 +214,9 @@ module TeamCity
       # @return [nil]
       def set_build_step_field(buildtype_id, step_id, field_name, field_value)
         path = "buildTypes/#{buildtype_id}/steps/#{step_id}/#{field_name}"
-        put_text_request(path, field_value)
+        put(path, :accept => :text, :content_type => :text) do |req|
+          req.body = field_value
+        end
       end
     end
   end

data/lib/teamcity/client/builds.rb

@@ -8,11 +8,11 @@ module TeamCity
       # 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
+      # @return [Array<Hashie::Mash>] of builds (empty array if no builds exist)
       def builds(options={})
         url_params = options.empty? ? '' : "?locator=#{locator(options)}"
         response = get("builds#{url_params}")
-        response['build']
+        response.build
       end
 
       # Get build details
@@ -27,30 +27,31 @@ module TeamCity
       # Get the build tags
       #
       # @param options [Hash] option keys, :id => build_id
-      # @return [Array<Hashie::Mash>, nil] nil if build has not tags
+      # @return [Array<Hashie::Mash>] or empty array if no tags exist
       def build_tags(options={})
         assert_options(options)
         response = get("builds/#{locator(options)}/tags")
-        response['tag']
+        response.fetch(:tag)
       end
 
       # Get build statistics
       #
       # @param build_id [String]
-      # @return [Array<Hashie::Mash>, nil] returns nil if there are no statistics
+      # @return [Array<Hashie::Mash>]
       def build_statistics(build_id)
         response = get("builds/#{build_id}/statistics")
         response['property']
       end
 
-      # TODO: Will need to create a Faraday middleware for this
-      # since the response returns a string not a json object
-      #def build_pinned?(id)
-      #  path = "builds/#{id}/pin"
-      #  get(path) do |req|
-      #    req.headers['Accept'] = 'text/plain'
-      #  end
-      #end
+      # Tells you whether or not a build is pinned
+      #
+      # @param id [String] build to check if it is pinned
+      # @return [Boolean] whether the build is pinned or not
+      def build_pinned?(id)
+        path = "builds/#{id}/pin"
+        response = get(path, :accept => :text, :content_type => :text)
+        response == 'true'
+      end
 
       # HTTP PUT
 
@@ -61,7 +62,9 @@ module TeamCity
       # @return [nil]
       def pin_build(id, comment='')
         path = "builds/#{id}/pin"
-        put_text_request(path, comment)
+        put(path, :accept => :text, :content_type => :text) do |req|
+          req.body = comment
+        end
       end
 
       # HTTP DELETE
@@ -71,7 +74,8 @@ module TeamCity
       # @param id [String] build to unpin
       # @return [nil]
       def unpin_build(id)
-        delete("builds/#{id}/pin")
+        path = "builds/#{id}/pin"
+        delete(path, :content_type => :text)
       end
     end
   end

data/lib/teamcity/client/common.rb

@@ -18,18 +18,6 @@ module TeamCity
           locators << "#{key}:#{value}"
         end.join(',')
       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
 end

data/lib/teamcity/client/projects.rb

@@ -24,7 +24,7 @@ module TeamCity
       # 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
+      # @return [Array<Hashie::Mash> of build types (an empty array will be returne if none exist)
       def project_buildtypes(options={})
         assert_options(options)
         response = get("projects/#{locator(options)}/buildTypes")
@@ -34,7 +34,7 @@ module TeamCity
       # List of parameters defined on a project
       #
       # @param (see #project)
-      # @return [Array<Hashie::Mash>, nil] of parameters or nil if no parameters are defined
+      # @return [Array<Hashie::Mash>] of parameters (empty if none are defined)
       def project_parameters(options={})
         assert_options(options)
         response = get("projects/#{locator(options)}/parameters")
@@ -46,8 +46,7 @@ module TeamCity
       # @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'
+        post("projects", :content_type => :text) do |req|
           req.body = name
         end
       end
@@ -58,17 +57,18 @@ module TeamCity
       # @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
+      # @options options [String] :parentProject used to define the parent project to create this project under (root will be use by default)
+      # @options options [String] :id to use for the new project
       # @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}",
+          :name => target_project_name
         }
-        post("projects") do |req|
-          req.headers['Content-Type'] = 'application/xml'
-          builder = Builder::XmlMarkup.new
-          builder.newProjectDescription(options.merge(attributes))
+        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!
         end
       end
@@ -87,10 +87,8 @@ module TeamCity
       # @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
+        path = "projects/#{project_id}/parameters/#{parameter_name}"
+        delete(path, :accept => :text)
       end
 
       # Set a project parameter (Create or Update)
@@ -99,9 +97,12 @@ module TeamCity
       # @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
+      # @return [String] parameter_value that was set
       def set_project_parameter(project_id, parameter_name, parameter_value)
         path = "projects/#{project_id}/parameters/#{parameter_name}"
-        put_text_request(path, parameter_value)
+        put(path, :content_type => :text, :accept => :text) do |req|
+          req.body = parameter_value
+        end
       end
 
       # Set a project field
@@ -116,9 +117,12 @@ module TeamCity
       # @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
+      # @return [String] project_field_value that was set
       def set_project_field(project_id, field_name, field_value)
         path = "projects/#{project_id}/#{field_name}"
-        put_text_request(path, field_value)
+        put(path, :content_type => :text, :accept => :text) do |req|
+          req.body = field_value
+        end
       end
     end
   end

data/lib/teamcity/client/vcs_roots.rb

@@ -20,28 +20,27 @@ module TeamCity
 
       # 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
+      # @option options [String] :vcs_name Name of the vcs root
+      # @option options [String] :vcs_type Type of VCS: 'git', 'perforce', etc
+      # @option options [String] :project_id to create the vcs root under
       # @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|
+      # @example Create a Git VCS Root that pulls from master that is only shared with it's project and sub-projecdts and uses the default private key
+      #   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
-      def create_vcs_root(vcs_name, vcs_type, options = {}, &block)
+      def create_vcs_root(options = {}, &block)
         attributes = {
-          :name    => vcs_name,
-          :vcsName => "jetbrains.#{vcs_type}"
+          :name    => options.fetch(:vcs_name),
+          :vcsName => "jetbrains.#{options.fetch(:vcs_type)}",
+          :projectLocator => options.fetch(:project_id)
         }
         builder = Builder::XmlMarkup.new
-        builder.tag!('vcs-root'.to_sym, options.merge(attributes)) do |node|
+        builder.tag!('vcs-root'.to_sym, attributes) do |node|
           node.properties do |p|
             if block_given?
               properties = {}
@@ -52,8 +51,7 @@ module TeamCity
             end
           end
         end
-        post("vcs-roots") do |req|
-          req.headers['Content-Type'] = 'application/xml'
+        post("vcs-roots", :content_type => :xml) do |req|
           req.body = builder.target!
         end
       end

data/lib/teamcity/configuration.rb

@@ -7,16 +7,13 @@ module TeamCity
       :adapter,
       :endpoint,
       :user_agent,
-      :format,
       :http_user,
       :http_password
     ].freeze
 
-    VALID_FORMATS = [:json].freeze
-
     DEFAULT_ADAPTER = Faraday.default_adapter
 
-    DEFAULT_ENDPOINT = 'http://teamcity:8111/httpAuth/app/rest/7.0/'.freeze
+    DEFAULT_ENDPOINT = 'http://teamcity:8111/httpAuth/app/rest/'.freeze
 
     DEFAULT_USER_AGENT = "TeamCity Ruby Client #{TeamCity::VERSION}".freeze
 
@@ -47,7 +44,6 @@ module TeamCity
       self.adapter        = DEFAULT_ADAPTER
       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

data/lib/teamcity/connection.rb

@@ -6,19 +6,19 @@ module TeamCity
   module Connection
     private
 
-    def connection
-      options = {
-        :headers => {'Accept' => "application/#{format}; charset=utf-8", 'User-Agent' => user_agent},
+    def connection(options={})
+      faraday_options = {
+        :headers => {
+          'User-Agent' => user_agent
+        }.merge((headers = Headers.build(options)).to_hash),
         :ssl => {:verify => false},
         :url => endpoint
       }
 
-      Faraday::Connection.new(options) do |connection|
+      Faraday::Connection.new(faraday_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::ParseJson if headers.accept =~ /json/
         connection.use FaradayMiddleware::NullResponseBody
         connection.adapter(adapter)
         connection.basic_auth(http_user, http_password)