testrail_api 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 56946d133f1eaa0e9b2e342c28e6f3b910379b7c
-  data.tar.gz: 1c0a33fa6e867ed4f116a164c8b8d9b67425eb64
+  metadata.gz: 52c66fb3d7da04169026a46c64ee81a9b3678eda
+  data.tar.gz: e9d7db52100d0b6be5fa8935a3082e17555e3435
 SHA512:
-  metadata.gz: 5876e9354a0ec6abbc0cdfdbf443f9a7f1ac494f1c7cb9b37a10cca36f4f06d1d764e4c3333cc126978ca5570ba2ede2e300dbd31d623ba91ad687dab2a34619
-  data.tar.gz: 14dd134a9e8dbcd10bf7db8abe11d147be13fd93ac8992ff4ff0e9e568738269123bef79e0dac6bd987b1e28d8c4c5d27da40040fbb44b90a38c4e9adaef81d3
+  metadata.gz: 1a1669767ea5341ebb7c2079157d79ff89ce84a6fd127944e1b7eb4d54250606ed4c73e28fe0d058fbda57df0bf7b98c1851eab99b7986959d23eef8590e3df0
+  data.tar.gz: afc8b886fbd51b9e642a12baa0e1df756ce0b3244647510db7eb847af0b9d44ef0ea20589300713731b4b8d9f53161efd646c29f8f0bca647994055e4bee7a18

data/.gitignore

@@ -27,7 +27,7 @@ build/
 
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
+ Gemfile.lock
 # .ruby-version
 # .ruby-gemset
 

data/README.md

@@ -1,14 +1,15 @@
-# Testrail API v2 client
+# Testrail API v2
 
-This is client for TestRail API v2. See official [documentation](http://docs.gurock.com/testrail-api2/start) for 
-reference.
+[TestRail API v2](http://docs.gurock.com/testrail-api2/start) wrapper, written in Ruby.
+
+[![Gem Version](https://badge.fury.io/rb/testrail_api.svg)](http://badge.fury.io/rb/testrail_api)
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'testrail_api'
+gem 'testrail_api', '~> 0.1.1'
 ```
 
 And then execute:
@@ -26,6 +27,10 @@ client = TestRail::Client.new('example.testrail.com', 'admin@example.com', 'pass
 puts client.projects
 ```
 
+## Documentation
+
+[http://www.rubydoc.info/gems/testrail_api](http://www.rubydoc.info/gems/testrail_api)
+
 ## Development
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
@@ -33,7 +38,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/kirillzh/testrail_api. This project is 
-intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org/) code of conduct.
 
 
 ## License

data/lib/core_ext/array/to_list.rb

@@ -0,0 +1,5 @@
+class Array
+  def to_list
+    join(',')
+  end
+end

data/lib/core_ext/array.rb

@@ -0,0 +1 @@
+require 'array/to_list'

data/lib/testrail_api/api.rb

@@ -0,0 +1,37 @@
+require 'testrail_api/client/case_fields'
+require 'testrail_api/client/case_types'
+require 'testrail_api/client/cases'
+require 'testrail_api/client/milestones'
+require 'testrail_api/client/plans'
+require 'testrail_api/client/priorities'
+require 'testrail_api/client/projects'
+require 'testrail_api/client/result_fields'
+require 'testrail_api/client/results'
+require 'testrail_api/client/runs'
+require 'testrail_api/client/sections'
+require 'testrail_api/client/statuses'
+require 'testrail_api/client/suites'
+require 'testrail_api/client/tests'
+require 'testrail_api/client/users'
+
+module TestRail
+  class Client
+    module API
+      include TestRail::Client::CaseFields
+      include TestRail::Client::CaseTypes
+      include TestRail::Client::Cases
+      include TestRail::Client::Milestones
+      include TestRail::Client::Plans
+      include TestRail::Client::Priorities
+      include TestRail::Client::Projects
+      include TestRail::Client::ResultFields
+      include TestRail::Client::Results
+      include TestRail::Client::Runs
+      include TestRail::Client::Sections
+      include TestRail::Client::Statuses
+      include TestRail::Client::Suites
+      include TestRail::Client::Tests
+      include TestRail::Client::Users
+    end
+  end
+end

data/lib/testrail_api/client/case_fields.rb

@@ -1,17 +1,17 @@
 module TestRail
   class Client
     # Methods for the Case Fields API
+    #
     # Use the following API methods to request details about custom fields for test cases.
-
     # @see http://docs.gurock.com/testrail-api2/reference-cases-fields
-
-    #
-    # Returns a list of available test case custom fields.
-    #
-    # @return [Array<Hash>] a list of available test case custom fields
-    #
-    def case_fields
-      get('get_case_fields')
+    module CaseFields
+      # List all available test case custom fields
+      #
+      # @return [Array<Hash>] a list of available test case custom fields
+      # @see http://docs.gurock.com/testrail-api2/reference-cases-fields#get_case_fields
+      def case_fields
+        get('get_case_fields')
+      end
     end
   end
 end

data/lib/testrail_api/client/case_types.rb

@@ -2,9 +2,17 @@ module TestRail
   class Client
     # Methods for the Case Types API
     #
+    # Use the following API methods to request details about custom types for test cases.
     # @see http://docs.gurock.com/testrail-api2/reference-cases-types
-    def case_types
-      get('get_case_types')
+    module CaseTypes
+      # List all available test case custom types
+      #
+      # @return [Array<Hash>] a list of available test case custom types
+      # @see http://docs.gurock.com/testrail-api2/reference-cases-types#get_case_types
+      def case_types
+        get('get_case_types')
+      end
     end
   end
 end
+

data/lib/testrail_api/client/cases.rb

@@ -2,77 +2,105 @@ module TestRail
   class Client
     # Methods for the Cases API
     #
+    # Use the following API methods to request details about test cases and to create or modify test cases.
     # @see http://docs.gurock.com/testrail-api2/reference-cases
-    #
-    # Returns an existing test case
-    #
-    # @param [Integer, String] case_id  The ID of the test case
-    # @return an existing test case
-    # @see http://docs.gurock.com/testrail-api2/reference-cases#get_case
-    def case(case_id)
-      get("get_case/#{case_id}")
-    end
+    module Cases
+      # Returns an existing test case
+      #
+      # @param case_id [Integer, String] The ID of the test case
+      # @return [Hash] an existing test case
+      # @see http://docs.gurock.com/testrail-api2/reference-cases#get_case
+      def case(case_id)
+        get("get_case/#{case_id}")
+      end
 
-    #
-    # Returns a list of test cases for a test suite or specific section in a test suite.
-    #
-    # @param [Integer, String] project_id  The ID of the project the test run should be added to
-    # @param [Integer, String] suite_id  The ID of the test suite (optional if the project is operating in single suite mode)
-    # @param [Integer, String] section_id  The ID of the section (optional)
-    # @param filters [Hash]: A customizable set of filters
-    # @option filters [Integer] :created_after Only return test cases created after this date (as UNIX timestamp).
-    # @option filters [Integer] :created_before Only return test cases created before this date (as UNIX timestamp).
-    # @option filters [Array<Integer>] :created_by A comma-separated list of creators (user IDs) to filter by.
-    # @option filters [Array<Integer>] :milestone_id A comma-separated list of milestone IDs to filter by (not available if the milestone field is disabled for the project).
-    # @option filters [Array<Integer>] :priority_id A comma-separated list of priority IDs to filter by.
-    # @option filters [Array<Integer>] :type_id A comma-separated list of case type IDs to filter by.
-    # @option filters [Integer] :updated_after Only return test cases updated after this date (as UNIX timestamp).
-    # @option filters [Integer] :updated_before Only return test cases updated before this date (as UNIX timestamp).
-    # @option filters [Array<Integer>] :updated_by A comma-separated list of users who updated test cases to filter by.
-    # @return a list of test cases for a test suite or specific section in a test suite. The response includes an array of test cases. Each test case in this list follows the same format as TestRail#Client#get_case
-    # @see http://docs.gurock.com/testrail-api2/reference-cases#get_cases
-    def cases(project_id, suite_id, section_id = '', filters = {})
-      get("get_cases/#{project_id}&suite_id=#{suite_id}&section_id=#{section_id}", filters)
-    end
+      #
+      # Returns a list of test cases for a test suite or specific section in a test suite.
+      #
+      # @param project_id [Integer, String] The ID of the project the test run should be added to
+      # @param suite_id [Integer, String] The ID of the test suite (optional if the project is operating in single suite mode)
+      # @param filters [Hash] A customizable set of filters
+      # @option filters [Integer, String]   :section_id       The ID of the section
+      # @option filters [Integer, String]   :created_after    Only return test cases created after this date (as UNIX timestamp).
+      # @option filters [Integer, String]   :created_before   Only return test cases created before this date (as UNIX timestamp).
+      # @option filters [Array<Integer>]    :created_by       A comma-separated list of creators (user IDs) to filter by.
+      # @option filters [Array<Integer>]    :milestone_id     A comma-separated list of milestone IDs to filter by (not available if the milestone field is disabled for the project).
+      # @option filters [Array<Integer>]    :priority_id      A comma-separated list of priority IDs to filter by.
+      # @option filters [Array<Integer>]    :type_id          A comma-separated list of case type IDs to filter by.
+      # @option filters [Integer, String]   :updated_after    Only return test cases updated after this date (as UNIX timestamp).
+      # @option filters [Integer, String]   :updated_before   Only return test cases updated before this date (as UNIX timestamp).
+      # @option filters [Array<Integer>]    :updated_by       A comma-separated list of users who updated test cases to filter by.
+      # @return a list of test cases for a test suite or specific section in a test suite.
+      # The response includes an array of test cases.
+      # Each test case in this list follows the same format as TestRail#Client#Cases#case
+      # @see http://docs.gurock.com/testrail-api2/reference-cases#get_cases
+      def cases(project_id, suite_id, filters = {})
+        get("get_cases/#{project_id}&suite_id=#{suite_id}",
+            params: {
+                section_id:     filters[:section_id],
+                created_after:  filters[:created_after],
+                created_before: filters[:created_before],
+                created_by:     filters[:created_by].to_list,
+                milestone_id:   filters[:milestone_id].to_list,
+                priority_id:    filters[:priority_id].to_list,
+                type_id:        filters[:type_id].to_list,
+                updated_after:  filters[:updated_after],
+                updated_before: filters[:updated_before],
+                updated_by:     filters[:updated_by].to_list
+            })
+      end
 
-    #
-    # Creates a new test case.
-    #
-    # @param [Integer, String] section_id  The ID of the section the test case should be added to
-    # @param payload [Hash]: A customizable payload
-    # @option payload [String] :title The title of the test case (required)
-    # @option payload [Integer] :type_id The ID of the case type
-    # @option payload [Integer] :priority_id The ID of the case priority
-    # @option payload [String] :estimate The estimate, e.g. "30s" or "1m 45s"
-    # @option payload [Integer] :milestone_id The ID of the milestone to link to the test case
-    # @option payload [String] :refs A comma-separated list of references/requirements
-    # TODO: finish docs
-    # @return
-    # @see http://docs.gurock.com/testrail-api2/reference-cases#add_case
-    def add_case(section_id, payload)
-      post("get_case/#{section_id}", payload)
-    end
+      #
+      # Creates a new test case.
+      #
+      # @param section_id [Integer, String] The ID of the section the test case should be added to
+      # @param filters [Hash] A customizable set of filters
+      # @option filters [String]            :title          The title of the test case (required)
+      # @option filters [Integer]           :type_id        The ID of the case type
+      # @option filters [Integer]           :priority_id    The ID of the case priority
+      # @option filters [String, Integer]   :estimate       The estimate, e.g. "30s" or "1m 45s"
+      # @option filters [Integer]           :milestone_id   The ID of the milestone to link to the test case
+      # @option filters [String]            :refs           A comma-separated list of references/requirements
+      # @return [Hash] created case
+      # TODO: finish custom fields
+      # @see http://docs.gurock.com/testrail-api2/reference-cases#add_case
+      def add_case(section_id, filters)
+        post("add_case/#{section_id}",
+             body: {
+                       title:        filters[:title],
+                       type_id:      filters[:type_id].to_list,
+                       priority_id:  filters[:priority_id].to_list,
+                       estimate:     filters[:estimate],
+                       milestone_id: filters[:milestone_id],
+                       refs:         filters[:refs]
+                   }.to_json)
+      end
 
-    #
-    # Returns an existing test case by its name.
-    # :case_name  The ID of the test case if number provided
-    #
-    def case_by_name(_case_name)
-      # TODO: implement get_case_by_name
-    end
+      # @return [Array] array of cases IDs using TestRail#Client#Case#cases method (parameters are the same)
+      def cases_ids(project_id, suite_id, filters = {})
+        cases(project_id, suite_id, filters).map { |x| x['id'] }
+      end
 
-    # Custom method
-    # TODO: finish docs
-    def cases_ids(project_id, suite_id, section_id = '')
-      cases(project_id, suite_id, section_id).map { |x| x['id'] }
-    end
+      def cases_by_title(title, project_id, suite_id, filters = {})
+        cases(project_id, suite_id, filters).find { |test_case| test_case['title'] == title }
+      end
 
-    def update_case(_case_id, _payload)
-      # TODO: finish
-    end
+      # Updates an existing test case (partial updates are supported, i.e. you can submit and update specific fields only).
+      # This method supports the same POST fields as TestRail#Client#Case#add_case (except section_id)
+      def update_case(case_id, body)
+        body[:type_id]     = body[:type_id].to_list if body[:type_id]
+        body[:priority_id] = body[:priority_id].to_list if body[:type_id]
+        post("update_case/#{case_id}", body: body)
+      end
 
-    def delete_case(_case_id)
-      # TODO: finish
+      # Deletes an existing test case.
+      # Please note: Deleting a test case cannot be undone and also permanently deletes all test results in active test
+      # runs (i.e. test runs that haven't been closed (archived) yet).
+      #
+      # @param case_id [Integer, String] The ID of the test case
+      def delete_case(case_id)
+        post("delete_case/#{case_id}")
+      end
     end
   end
 end

data/lib/testrail_api/client/milestones.rb

@@ -3,6 +3,8 @@ module TestRail
     # Methods for the Milestones API
     #
     # @see http://docs.gurock.com/testrail-api2/reference-milestones
-    # TODO: implement
+    module Milestones
+      # TODO: implement
+    end
   end
 end

data/lib/testrail_api/client/plans.rb

@@ -3,6 +3,8 @@ module TestRail
     # Methods for the Plans API
     #
     # @see http://docs.gurock.com/testrail-api2/reference-plans
-    # TODO: implement
+    module Plans
+      # TODO: implement
+    end
   end
 end

data/lib/testrail_api/client/priorities.rb

@@ -3,11 +3,13 @@ module TestRail
     # Methods for the Priorities API
     #
     # @see http://docs.gurock.com/testrail-api2/reference-priorities
-    #
-    # Returns a list of available priorities
-    #
-    def priorities
-      get('get_priorities')
+    module Priorities
+      #
+      # Returns a list of available priorities
+      #
+      def priorities
+        get('get_priorities')
+      end
     end
   end
 end

data/lib/testrail_api/client/projects.rb

@@ -3,32 +3,35 @@ module TestRail
     # Methods for the Projects API
     #
     # @see http://docs.gurock.com/testrail-api2/reference-projects
-    #
-    # Returns the list of available projects.
-    #
-    def projects
-      get('get_projects')
-    end
+    module Projects
+      #
+      # Returns the list of available projects.
+      #
+      def projects
+        get('get_projects')
+      end
 
-    #
-    # Returns an existing project by its ID.
-    #
-    # :project_id  The ID of the project
-    #
-    def project(project_id)
-      get("get_project/#{project_id}")
-    end
+      # TODO: finish docs
+      def projects_ids
+        projects.map { |x| x['id'] }
+      end
 
-    #
-    # Returns an existing project by its name.
-    #
-    # :project_name  The name of the project
-    #
-    def project_by_name(project_name, ignore_case = true)
-      if ignore_case
+      #
+      # Returns an existing project by its ID.
+      #
+      # :project_id  The ID of the project
+      #
+      def project(project_id)
+        get("get_project/#{project_id}")
+      end
+
+      #
+      # Returns an existing project by its name.
+      #
+      # :project_name  The name of the project
+      #
+      def project_by_name(project_name)
         projects.find { |project| project['name'].casecmp(project_name) == 0 }
-      else
-        projects.find { |project| project['name'] == project_name }
       end
     end
   end

data/lib/testrail_api/client/result_fields.rb

@@ -3,6 +3,8 @@ module TestRail
     # Methods for the Result Fields API
     #
     # @see http://docs.gurock.com/testrail-api2/reference-results-fields
-    # TODO: implement
+    module ResultFields
+      # TODO: implement
+    end
   end
 end

data/lib/testrail_api/client/results.rb

@@ -5,104 +5,106 @@ module TestRail
     # Use the following API methods to request details about test results and to add new test results.
     #
     # @see http://docs.gurock.com/testrail-api2/reference-results
-    #
-    # Returns a list of test results for a test.
-    #
-    # @param [Integer, String] test_id  The ID of the test
-    # @return a list of test results for a test
-    # @see http://docs.gurock.com/testrail-api2/reference-results#get_results
-    def results(test_id)
-      get("get_results/#{test_id}")
-    end
+    module Results
+      #
+      # Returns a list of test results for a test.
+      #
+      # @param [Integer, String] test_id  The ID of the test
+      # @return a list of test results for a test
+      # @see http://docs.gurock.com/testrail-api2/reference-results#get_results
+      def results(test_id)
+        get("get_results/#{test_id}")
+      end
 
-    #
-    # Returns a list of test results for a test run and case combination.
-    # The difference to get_results is that this method expects a test run + test case instead of a test. In TestRail,
-    # tests are part of a test run and the test cases are part of the related test suite.
-    # So, when you create a new test run, TestRail creates a test for each test case found in the test suite of the run.
-    # You can therefore think of a test as an “instance” of a test case which can have test results, comments and a test status.
-    # Please also see TestRail's getting started guide for more details about the differences between test cases and tests.
-    #
-    # This method uses the same response format as get_results.
-    #
-    # :run_id	The ID of the test run
-    # :case_id	The ID of the test case
-    #
-    def results_for_case(run_id, case_id)
-      get("get_results_for_case/#{run_id}/#{case_id}")
-    end
+      #
+      # Returns a list of test results for a test run and case combination.
+      # The difference to get_results is that this method expects a test run + test case instead of a test. In TestRail,
+      # tests are part of a test run and the test cases are part of the related test suite.
+      # So, when you create a new test run, TestRail creates a test for each test case found in the test suite of the run.
+      # You can therefore think of a test as an “instance” of a test case which can have test results, comments and a test status.
+      # Please also see TestRail's getting started guide for more details about the differences between test cases and tests.
+      #
+      # This method uses the same response format as get_results.
+      #
+      # :run_id	The ID of the test run
+      # :case_id	The ID of the test case
+      #
+      def results_for_case(run_id, case_id)
+        get("get_results_for_case/#{run_id}/#{case_id}")
+      end
 
-    #
-    # Returns a list of test results for a test run.
-    #
-    # :run_id	The ID of the test run
-    #
-    def results_for_run(run_id)
-      get("get_results_for_run/#{run_id}")
-    end
+      #
+      # Returns a list of test results for a test run.
+      #
+      # :run_id	The ID of the test run
+      #
+      def results_for_run(run_id)
+        get("get_results_for_run/#{run_id}")
+      end
 
-    # TODO: add custom fields docs
-    #
-    # Adds a new test result, comment or assigns a test.
-    # It's recommended to use #add_results instead if you plan to add results for multiple tests.
-    #
-    # @param [Integer, String] test_id  The ID of the test the result should be added to
-    # @param data [Hash]: Optional query data
-    # @option data [Integer, String] :status_id The ID of the test status. The built-in system statuses have the
-    # following IDs:
-    # 1 Passed
-    # 2 Blocked
-    # 3 Untested (not allowed when adding a result)
-    # 4 Retest
-    # 5 Failed
-    # You can get a full list of system and custom statuses via #TestRail#Client#Statuses#get_statuses.
-    # @option data [String] :comment The comment / description for the test result
-    # @option data [String] :version The version or build you tested against
-    # @option data [String] :elapsed The time it took to execute the test, e.g. "30s" or "1m 45s"
-    # @option data [Array<Integer>, Array<String>] :defects A comma-separated list of defects to link to the test result
-    # @option data [Integer, String] :assignedto_id The ID of a user the test should be assigned to
-    # @return the new test result using the same response format as get_results, but with a single result instead of a list of results.
-    # @see http://docs.gurock.com/testrail-api2/reference-results#add_result
-    def add_result(test_id, data)
-      post("add_result/#{test_id}", data)
-    end
+      # TODO: add custom fields docs
+      #
+      # Adds a new test result, comment or assigns a test.
+      # It's recommended to use #add_results instead if you plan to add results for multiple tests.
+      #
+      # @param [Integer, String] test_id  The ID of the test the result should be added to
+      # @param data [Hash]: Optional query data
+      # @option data [Integer, String] :status_id The ID of the test status. The built-in system statuses have the
+      # following IDs:
+      # 1 Passed
+      # 2 Blocked
+      # 3 Untested (not allowed when adding a result)
+      # 4 Retest
+      # 5 Failed
+      # You can get a full list of system and custom statuses via #TestRail#Client#Statuses#get_statuses.
+      # @option data [String] :comment The comment / description for the test result
+      # @option data [String] :version The version or build you tested against
+      # @option data [String] :elapsed The time it took to execute the test, e.g. "30s" or "1m 45s"
+      # @option data [Array<Integer>, Array<String>] :defects A comma-separated list of defects to link to the test result
+      # @option data [Integer, String] :assignedto_id The ID of a user the test should be assigned to
+      # @return the new test result using the same response format as get_results, but with a single result instead of a list of results.
+      # @see http://docs.gurock.com/testrail-api2/reference-results#add_result
+      def add_result(test_id, data)
+        post("add_result/#{test_id}", data)
+      end
 
-    #
-    # Adds a new test result, comment or assigns a test (for a test run and case combination).
-    # It's recommended to use add_results_for_cases instead if you plan to add results for multiple test cases.
-    # The difference to add_result is that this method expects a test run + test case instead of a test.
-    # In TestRail, tests are part of a test run and the test cases are part of the related test suite.
-    # So, when you create a new test run, TestRail creates a test for each test case found in the test suite of the run.
-    # You can therefore think of a test as an “instance” of a test case which can have test results, comments and a test status.
-    # Please also see TestRail's getting started guide for more details about the differences between test cases and tests.
-    #
-    # This method supports the same POST fields as add_result.
-    #
-    # :run_id   The ID of the test run
-    # :case_id  The ID of the test case
-    #
-    def add_result_for_case(run_id, case_id, data)
-      post("add_result_for_case/#{run_id}/#{case_id}", data)
-    end
+      #
+      # Adds a new test result, comment or assigns a test (for a test run and case combination).
+      # It's recommended to use add_results_for_cases instead if you plan to add results for multiple test cases.
+      # The difference to add_result is that this method expects a test run + test case instead of a test.
+      # In TestRail, tests are part of a test run and the test cases are part of the related test suite.
+      # So, when you create a new test run, TestRail creates a test for each test case found in the test suite of the run.
+      # You can therefore think of a test as an “instance” of a test case which can have test results, comments and a test status.
+      # Please also see TestRail's getting started guide for more details about the differences between test cases and tests.
+      #
+      # This method supports the same POST fields as add_result.
+      #
+      # :run_id   The ID of the test run
+      # :case_id  The ID of the test case
+      #
+      def add_result_for_case(run_id, case_id, data)
+        post("add_result_for_case/#{run_id}/#{case_id}", data)
+      end
 
-    #
-    # Adds a new test result, comment or assigns a test.
-    # It's recommended to use add_results instead if you plan to add results for multiple tests.
-    #
-    # :run_id	The ID of the test run
-    #
-    def add_results(run_id, data)
-      post("add_results/#{run_id}", data)
-    end
+      #
+      # Adds a new test result, comment or assigns a test.
+      # It's recommended to use add_results instead if you plan to add results for multiple tests.
+      #
+      # :run_id	The ID of the test run
+      #
+      def add_results(run_id, data)
+        post("add_results/#{run_id}", data)
+      end
 
-    #
-    # Adds one or more new test results, comments or assigns one or more tests (using the case IDs).
-    # Ideal for test automation to bulk-add multiple test results in one step.
-    #
-    # :run_id The ID of the test run the results should be added to
-    #
-    def add_results_for_cases(run_id, data)
-      post("add_results_for_cases/#{run_id}", data)
+      #
+      # Adds one or more new test results, comments or assigns one or more tests (using the case IDs).
+      # Ideal for test automation to bulk-add multiple test results in one step.
+      #
+      # :run_id The ID of the test run the results should be added to
+      #
+      def add_results_for_cases(run_id, data)
+        post("add_results_for_cases/#{run_id}", data)
+      end
     end
   end
 end