testrail-ruby 0.0.16 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 290a3928c5e9715fffec5f817ed4535672ec0094
-  data.tar.gz: 7692c400ebd88ca306fc773f3bfcfa461b079103
+  metadata.gz: 4a4fdc90f8f23049952e82f20ad5f0c18a05df28
+  data.tar.gz: 3b7f6c13d5134c597eae86e606c4db9dcf875e5b
 SHA512:
-  metadata.gz: 3bb482da53163beb434a55f1b3a391219e10e015984e74678e5bbf303714a62eb177fb641a68ff129b4241144b883fb6abd0819df8c423f16dbc355566d757ce
-  data.tar.gz: ae0380d34631fad8d68c85f537196559a8b95e46bc336cf9707537aa2cabd6b855c03c6f8b29785ad89e6d7a7cedfc911abc86c2be44842691c9156832595a29
+  metadata.gz: f8df5db1eb716b5f74b4deeb27fe97d5d6017a0fd79929333399b52feff564eeff72dbb7cb1eb70002cff195eb008c1ccd74c409dcf5a435e69e89536e66e149
+  data.tar.gz: e21496ce60986d9369afbc81acd5a3ea12b6031542e687dd205daffd004c08b25b483bb7d44a94a8564fe713c3cbe47c662cbb49cde5a1fd6a4b1d31021fde33

data/lib/endpoints.rb

@@ -1,492 +1,688 @@
 module Endpoints
+##########################++
+####get_case################
+############################
   # Returns an existing test case
   # @param case_id [int] The id of the test case you want.
-  # @param [Hash] opts
-  # @example Endpoint
-  #   index.php?/api/v2/get_case/:case_id
+  # @example Code Example
+  #   @client.get_case(1)
+  # @example Endpoint Example
+  #   GET index.php?/api/v2/get_case/1
+  # @example Response Example
+  #    {
+  #      "created_by": 5,
+  #      "created_on": 1392300984,
+  #      "custom_expected": "..",
+  #      "custom_preconds": "..",
+  #      "custom_steps": "..",
+  #      "custom_steps_separated": [
+  #          {
+  #              "content": "Step 1",
+  #              "expected": "Expected Result 1"
+  #          },
+  #          {
+  #              "content": "Step 2",
+  #              "expected": "Expected Result 2"
+  #         }
+  #      ],
+  #      "estimate": "1m 5s",
+  #      "estimate_forecast": null,
+  #      "id": 1,
+  #      "milestone_id": 7,
+  #      "priority_id": 2,
+  #      "refs": "RF-1, RF-2",
+  #      "section_id": 1,
+  #      "suite_id": 1,
+  #      "title": "Change document attributes (author, title, organization)",
+  #      "type_id": 4,
+  #      "updated_by": 1,
+  #      "updated_on": 1393586511
+  #    }
   # @see http://docs.gurock.com/testrail-api2/reference-cases
-  def get_case(case_id, opts = {})
-    send_get("get_case/:#{case_id.to_s}", opts)
+  def get_case(case_id)
+    send_get("get_case/:#{case_id.to_s}")
   end
 
+##########################++
+####get_cases###############
+############################
   # Returns a list of test cases for a test suite or specific section in a test suite.
   # @param project_id [int] The id of the project that contains your tests
   # @param [Hash] opts
-  # @example Endpoint
-  #   index.php?/api/v2/get_cases/:project_id
+  # @option opts [int]            :suite_id       The ID of the test suite (optional if the project is operating in single suite mode)
+  # @option opts [int]            :section_id     The ID of the section (optional)
+  # @option opts [unix timestamp] :created_after  Only return test cases created after this date (as UNIX timestamp).
+  # @option opts [unix timestamp] :created_before Only return test cases created before this date (as UNIX timestamp).
+  # @option opts [int(list)]      :created_by     A comma-separated list of creators (user IDs) to filter by.
+  # @option opts [int(list)]      :milestone_id   A comma-separated list of milestone IDs to filter by (not available if the milestone field is disabled for the project).
+  # @option opts [int(list)]      :priority_id    A comma-separated list of priority IDs to filter by.
+  # @option opts [int(list)]      :template_id    A comma-separated list of template IDs to filter by (requires TestRail 5.2 or later)
+  # @option opts [int(list)]      :type_id        A comma-separated list of case type IDs to filter by.
+  # @option opts [unix timestamp] :updated_after  Only return test cases updated after this date (as UNIX timestamp).
+  # @option opts [unix timestamp] :updated_before Only return test cases updated before this date (as UNIX timestamp).
+  # @option opts [int(list)]      :updated_by     A comma-separated list of users who updated test cases to filter by.
+  # @example Code Example
+  #   @client.get_cases(1, {"suite_id":1, "section_id":1})
+  # @example Endpoint Example
+  #   GET index.php?/api/v2/get_cases/1&suite_id=1&section_id=1
+  # @example Response Example
+  #   [
+  #    { "id": 1, "title": "..", .. },
+  #    { "id": 2, "title": "..", .. },
+  #    ..
+  #   ]
   # @see http://docs.gurock.com/testrail-api2/reference-cases
   def get_cases(project_id, opts = {})
     send_get("get_cases/:#{project_id.to_s}", opts)
   end
 
+##################deprecated
+####get_cases_by_section####
+############################
   # Return all test cases in a given project by suite_id and section_id
-  # @param project_id [int] The id of the project that contains your tests
-  # @param suite_id [int] The id of the suite within the project
-  # @param section_id [int] The id of the section within the suite
-  # @param [Hash] opts
-  # @example Endpoint
-  #   index.php?/api/v2/get_cases/:project_id&suite_id=:suite_id&section_id=:section_id
-  # @see http://docs.gurock.com/testrail-api2/reference-cases
+  # @deprecated use get_cases instead
   def get_cases_by_section(project_id, suite_id, section_id, opts = {})
     send_get("get_cases/:#{project_id.to_s}&suite_id=:#{suite_id.to_s}&section_id=:#{section_id.to_s}", opts)
   end
 
+##################deprecated
+####get_cases_by_suite######
+############################
   # Return all test cases in a given project by suite_id
-  # @param project_id [int] The id of the project that contains your tests
-  # @param suite_id [int] The id of the suite within the project
-  # @param [Hash] opts
-  # @example Endpoint
-  #   index.php?/api/v2/get_cases/:project_id&suite_id=:suite_id
-  # @see http://docs.gurock.com/testrail-api2/reference-cases
+  # @deprecated use get_cases instead
   def get_cases_by_suite(project_id, suite_id, opts = {})
     send_get("get_cases/:#{project_id.to_s}&suite_id=:#{suite_id.to_s}", opts)
   end
 
+############################
+####add_case################
+############################
   # Creates a new test case
   # @param section_id [int] The id of the test case
   # @param [Hash] opts
-  # @example Endpoint
-  #   index.php?/api/v2/add_case/:section_id
+  # @option opts [string]   :title        The title of the test case (required)
+  # @option opts [int]      :template_id  The ID of the template (field layout) (requires TestRail 5.2 or later)
+  # @option opts [int]      :type_id      The ID of the case type
+  # @option opts [int]      :priority_id  The ID of the case priority
+  # @option opts [timespan] :estimate     The estimate, e.g. "30s" or "1m 45s"
+  # @option opts [int]      :milestone_id The ID of the milestone to link to the test case
+  # @option opts [string]   :refs         A comma-separated list of references/requirements
+  # @example Code Example
+  #   @client.add_case(1, {"title":"testCaseName", "type_id":1})
+  # @example Endpoint Example
+  #   index.php?/api/v2/add_case/1&title="foo"&type_id=1
   # @see http://docs.gurock.com/testrail-api2/reference-cases
   def add_case(section_id, opts = {})
     send_post("add_case/:#{section_id.to_s}", opts)
   end
 
+############################
+####update_case#############
+############################
   # Update test result by case id
   # @param case_id [int] The id of the test case
   # @param [Hash] opts
-  # @example Endpoint
+  # @example Endpoint Example
   #   index.php?/api/v2/update_case/:case_id
   # @see http://docs.gurock.com/testrail-api2/reference-cases
   def update_case(case_id, opts = {})
     send_post("update_case/:#{case_id.to_s}", opts)
   end
 
+############################
+####delete_case################
+############################
   # Delete test case by case id
   # @param case_id [int] The id of the test case
   # @param [Hash] opts
-  # @example Endpoint
+  # @example Endpoint Example
   #   index.php?/api/v2/delete_case/:case_id
   # @see http://docs.gurock.com/testrail-api2/reference-cases
   def delete_case(case_id, opts = {})
     send_post("delete_case/:#{case_id.to_s}", opts)
   end
 
+############################
+####get_suite###############
+############################
   # Return suite by suite id
   # @param suite_id [int] The suite id
   # @param [Hash] opts
-  # @example Endpoint
+  # @example Endpoint Example
   #   index.php?/api/v2/get_suite/:suite_id
   # @see http://docs.gurock.com/testrail-api2/reference-suites
   def get_suite(suite_id, opts = {})
     send_get("get_suite/:#{suite_id.to_s}", opts)
   end
 
+############################
+####get_suites##############
+############################
   # Return all suites in project by project id
-  # @param project_id [int] The id of the project containing suites
+  # @param project_id (see get_cases)
   # @param [Hash] opts
-  # @example Endpoint
+  # @example Endpoint Example
   #   index.php?/api/v2/get_suites/:project_id
   # @see http://docs.gurock.com/testrail-api2/reference-suites
   def get_suites(project_id, opts = {})
     send_get("get_suites/:#{project_id.to_s}", opts)
   end
 
+############################
+####add_suite###############
+############################
   # Add a test suite
   # @param project_id [int] The id of the project containing suites
   # @param [Hash] opts
-  # @example Endpoint
+  # @example Endpoint Example
   #   index.php?/api/v2/add_suite/:project_id
   # @see http://docs.gurock.com/testrail-api2/reference-suites
   def add_suite(project_id, opts = {})
     send_post("add_suite/:#{project_id.to_s}", opts)
   end
 
+############################
+####update_suite############
+############################
   # update a test suite
   # @param suite_id [int] The suite id
   # @param [Hash] opts
-  # @example Endpoint
+  # @example Endpoint Example
   #   index.php?/api/v2/update_suite/:suite_id
   # @see http://docs.gurock.com/testrail-api2/reference-suites
   def update_suite(suite_id, opts = {})
     send_post("update_suite/:#{suite_id.to_s}", opts)
   end
 
+############################
+####delete_suite############
+############################
   # Delete a test suite
   # @param suite_id [int] The suite id
   # @param [Hash] opts
-  # @example Endpoint
+  # @example Endpoint Example
   #   index.php?/api/v2/delete_suite/:suite_id
   # @see http://docs.gurock.com/testrail-api2/reference-suites
   def delete_suite(suite_id, opts = {})
     send_post("delete_suite/:#{suite_id.to_s}", opts)
   end
 
+
+############################
+####get_section#############
+############################
   # Return section by id
   # @param section_id [int]
   # @param [Hash] opts
-  # @example Endpoint
+  # @example Endpoint Example
   #   index.php?/api/v2/get_section/:section_id
   # @see http://docs.gurock.com/testrail-api2/reference-sections
   def get_section(section_id, opts = {})
     send_get("get_section/:#{section_id.to_s}", opts)
   end
 
+############################
+####get_sections############
+############################
   # Get sections for suite
   # @param suite_id [int]
   # @param [Hash] opts
-  # @example Endpoint
+  # @example Endpoint Example
   #   index.php?/api/v2/get_sections/:project_id&suite_id=:suite_id
   # @see http://docs.gurock.com/testrail-api2/reference-sections
   def get_sections(project_id, suite_id, opts = {})
     send_get("get_sections/#{project_id.to_s}&suite_id=#{suite_id.to_s}", opts)
   end
 
+############################
+####add_section#############
+############################
   # Add section to suite
   # @param project_id [int]
   # @param [Hash] opts
   # @option opts [Int] suite_id
   # @option opts [String] name
   # @option opts [Int] parent_id
-  # @example Endpoint
+  # @example Endpoint Example
   #   index.php?/api/v2/add_section/:project_id
-  # @example Code
+  # @example Code Example
   #   @client.add_section(1, {"suite_id": 5, "name": "This is a new section", "parent_id": 10})
   # @see http://docs.gurock.com/testrail-api2/reference-sections
   def add_section(project_id, opts = {})
     send_post("add_section/#{project_id.to_s}", opts)
   end
 
+############################
+####get_milestone###########
+############################
   # Get milestone by milestone id
   # @param milestone_id [int]
   # @param [Hash] opts
-  # @example Endpoint
+  # @example Endpoint Example
   #   index.php?/api/v2/get_milestone/:milestone_id
   # @see http://docs.gurock.com/testrail-api2/reference-milestones
   def get_milestone(milestone_id, opts = {})
     send_get("get_milestone/:#{milestone_id.to_s}", opts)
   end
 
+############################
+####get_milestones##########
+############################
   # Get project milestones by project id
   # @param project_id [int]
   # @param [Hash] opts
-  # @example Endpoint
+  # @example Endpoint Example
   #   index.php?/api/v2/get_milestones/:project_id
   # @see http://docs.gurock.com/testrail-api2/reference-milestones
   def get_milestones(project_id, opts = {})
     send_get("get_milestones/:#{project_id.to_s}", opts)
   end
 
+############################
+####add_milestone###########
+############################
   # Add milestone to project id
   # @param project_id [int]
   # @param [Hash] opts
-  # @example Endpoint
+  # @example Endpoint Example
   #   index.php?/api/v2/add_milestone/:project_id
   # @see http://docs.gurock.com/testrail-api2/reference-milestones
   def add_milestone(project_id, opts = {})
     send_post("add_milestone/:#{project_id.to_s}", opts)
   end
 
+############################
+####update_milestone########
+############################
   # Add milestone to project id
   # @param milestone_id [int]
   # @param [Hash] opts
-  # @example Endpoint
+  # @example Endpoint Example
   #   index.php?/api/v2/update_milestone/:milestone_id
   # @see http://docs.gurock.com/testrail-api2/reference-milestones
   def update_milestone(milestone_id, opts = {})
     send_post("update_milestone/:#{milestone_id.to_s}", opts)
   end
 
+############################
+####delete_milestone########
+############################
   # Add milestone to project id
   # @param milestone_id [int]
   # @param [Hash] opts
-  # @example Endpoint
+  # @example Endpoint Example
   #   index.php?/api/v2/delete_milestone/:milestone_id
   # @see http://docs.gurock.com/testrail-api2/reference-milestones
   def delete_milestone(milestone_id, opts = {})
     send_post("delete_milestone/:#{milestone_id.to_s}", opts)
   end
 
+############################
+####get_plan################
+############################
   # Get plan by id
   # @param plan_id [int]
   # @param [Hash] opts
-  # @example Endpoint
+  # @example Endpoint Example
   #   index.php?/api/v2/get_plan/:plan_id
   # @see http://docs.gurock.com/testrail-api2/reference-plans
   def get_plan(plan_id, opts = {})
     send_get("get_plan/:#{plan_id.to_s}", opts)
   end
 
+############################
+####get_plans###############
+############################
   # Get plans in project by project id
   # @param project_id [int]
   # @param [Hash] opts
-  # @example Endpoint
+  # @example Endpoint Example
   #   index.php?/api/v2/get_plans/:project_id
   # @see http://docs.gurock.com/testrail-api2/reference-plans
   def get_plans(project_id, opts = {})
     send_get("get_plans/:#{project_id.to_s}", opts)
   end
 
+############################
+####add_plan################
+############################
   # Add plan to project by project id
   # @param project_id [int]
   # @param [Hash] opts
-  # @example Endpoint
+  # @example Endpoint Example
   #   index.php?/api/v2/add_plan/:project_id
   # @see http://docs.gurock.com/testrail-api2/reference-plans
   def add_plan(project_id, opts = {})
     send_post("add_plan/:#{project_id.to_s}", opts)
   end
 
+############################
+####add_plan_entry##########
+############################
   # Add plan entries by plan id
   # @param plan_id [int]
   # @param [Hash] opts
-  # @example Endpoint
+  # @example Endpoint Example
   #   index.php?/api/v2/add_plan_entry/:plan_id
   # @see http://docs.gurock.com/testrail-api2/reference-plans
   def add_plan_entry(plan_id, opts = {})
     send_post("add_plan_entry/:#{plan_id.to_s}", opts)
   end
 
+############################
+####update_plan#############
+############################
   # Update plan by plan id
   # @param plan_id [int]
   # @param [Hash] opts
-  # @example Endpoint
+  # @example Endpoint Example
   #   index.php?/api/v2/update_plan/:plan_id
   # @see http://docs.gurock.com/testrail-api2/reference-plans
   def update_plan(plan_id, opts = {})
     send_post("update_plan/:#{plan_id.to_s}", opts)
   end
 
+############################
+####update_plan_entry#######
+############################
   # Update plan entry by plan id
   # @param plan_id [int]
   # @param entry_id [int] Id of entry
   # @param [Hash] opts
-  # @example Endpoint
+  # @example Endpoint Example
   #   index.php?/api/v2/update_plan_entry/:plan_id/:entry_id
   # @see http://docs.gurock.com/testrail-api2/reference-plans
   def update_plan_entry(plan_id, entry_id, opts = {})
     send_post("update_plan_entry/:#{plan_id.to_s}/:#{entry_id.to_s}", opts)
   end
 
+############################
+####close_plan##############
+############################
   # Close plan by plan id
   # @param plan_id [int]
   # @param [Hash] opts
-  # @example Endpoint
+  # @example Endpoint Example
   #   index.php?/api/v2/close_plan/:plan_id
   # @see http://docs.gurock.com/testrail-api2/reference-plans
   def close_plan(plan_id, opts = {})
     send_post("close_plan/:#{plan_id.to_s}", opts)
   end
 
-  # @example Endpoint
+############################
+####delete_plan#############
+############################
+  # @example Endpoint Example
   #   index.php?/api/v2/delete_plan/:plan_id
   # @see http://docs.gurock.com/testrail-api2/reference-plans
   def delete_plan(plan_id, opts)
     send_post("delete_plan/:#{plan_id.to_s}", opts)
   end
 
-  # @example Endpoint
+############################
+####delete_plan_by_entry####
+############################
+  # @example Endpoint Example
   #   index.php?/api/v2/delete_plan_entry/:plan_id/:entry_id
   def delete_plan_entry(plan_id, entry_id, opts = {})
     send_post("delete_plan_entry/:#{plan_id.to_s}/:#{entry_id.to_s}", opts)
   end
 
+############################
+####get_project#############
+############################
   # Get project by project id
   # @param project_id [int]
   # @param [Hash] opts
-  # @example Endpoint
+  # @example Endpoint Example
   #   index.php?/api/v2/get_project/:project_id
   # @see http://docs.gurock.com/testrail-api2/reference-projects
   def get_project(project_id, opts = {})
     send_get("get_project/:#{project_id.to_s}", opts)
   end
 
+############################
+####get_projects############
+############################
   # Get all projects
   # @param [Hash] opts
-  # @example Endpoint
+  # @example Endpoint Example
   #   index.php?/api/v2/get_projects
   # @see http://docs.gurock.com/testrail-api2/reference-projects
   def get_projects(opts = {})
     send_get('get_projects', opts)
   end
 
+############################
+####add_project#############
+############################
   # Add a project
   # @param [Hash] opts
-  # @example Endpoint
+  # @example Endpoint Example
   #   index.php?/api/v2/add_project
   # @see http://docs.gurock.com/testrail-api2/reference-projects
   def add_project(opts = {})
     send_post("add_project", opts)
   end
 
+############################
+####update_project##########
+############################
   # Update a project
   # @param project_id [int] The project you want to update
   # @param [Hash] opts
-  # @example Endpoint
+  # @example Endpoint Example
   #   index.php?/api/v2/update_project/:project_id
   # @see http://docs.gurock.com/testrail-api2/reference-projects
   def update_project(project_id, opts)
     send_post("update_project/:#{project_id.to_s}", opts)
   end
 
-
+############################
+####delete_project##########
+############################
   # Delete a project
   # @param project_id [int] The project you want to delete
   # @param [Hash] opts
-  # @example Endpoint
+  # @example Endpoint Example
   #   index.php?/api/v2/delete_project/:project_id
   # @see http://docs.gurock.com/testrail-api2/reference-projects
   def delete_project(project_id, opts)
     send_post("delete_project/:#{project_id.to_s}", opts)
   end
 
+############################
+####get_results#############
+############################
   # Returns a list of test results for a test
   # @param test_id [int]
   # @param [Hash] opts
-  # @example Endpoint
+  # @example Endpoint Example
   #   index.php?/api/v2/get_results/:test_id
   # @see http://docs.gurock.com/testrail-api2/reference-results
   def get_results(test_id, opts = {})
     send_get("get_results/:#{test_id.to_s}", opts)
   end
 
+############################
+####get_results_for_case####
+############################
   # Returns a list of test results for a test run and case combination
   # @param run_id [int]
   # @param case_id [int]
   # @param [Hash] opts
-  # @example Endpoint
+  # @example Endpoint Example
   #   index.php?/api/v2/get_results_for_case/:run_id/:case_id
   # @see http://docs.gurock.com/testrail-api2/reference-results
   def get_results_for_case(run_id, case_id, opts = {})
     send_get("get_results_for_case/:#{run_id.to_s}/:#{case_id.to_s}", opts)
   end
 
+############################
+####get_results_for_run#####
+############################
   # Returns a list of test results for a test run
   # @param run_id [int]
   # @param [Hash] opts
-  # @example Endpoint
+  # @example Endpoint Example
   #   index.php?/api/v2/get_results_for_run/:run_id
   # @see http://docs.gurock.com/testrail-api2/reference-results
   def get_results_for_run(run_id, opts = {})
     send_get("get_results_for_run/:#{run_id.to_s}", opts)
   end
 
+############################
+####add_result##############
+############################
   # 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 test_id [int]
   # @param [Hash] opts
-  # @example Endpoint
+  # @example Endpoint Example
   #   index.php?/api/v2/add_result/:test_id
   # @see http://docs.gurock.com/testrail-api2/reference-results
   def add_result(test_id, opts = {})
     send_post("add_result/:#{test_id.to_s}", opts)
   end
 
+############################
+####add_result_for_case#####
+############################
   # Adds a new test result, comment or assigns a test (for a test run and case combination)
   # @param run_id [int]
   # @param case_id [int]
   # @param [Hash] opts
-  # @example Endpoint
+  # @example Endpoint Example
   #   index.php?/api/v2/add_result_for_case/:run_id/:case_id
   # @see http://docs.gurock.com/testrail-api2/reference-results
   def add_result_for_case(run_id, case_id, opts = {})
     send_post("add_result_for_case/:#{run_id.to_s}/:#{case_id.to_s}", opts)
   end
 
+############################
+####add_results#############
+############################
   # Adds one or more new test results, comments or assigns one or more tests
   # @param run_id [int]
   # @param [Hash] opts
-  # @example Endpoint
+  # @example Endpoint Example
   #   index.php?/api/v2/add_results/:run_id
   # @see http://docs.gurock.com/testrail-api2/reference-results
   def add_results(run_id, opts = {})
     send_post("add_results/:#{run_id.to_s}", opts)
   end
 
+############################
+####add_results_for_cases###
+############################
   # Adds one or more new test results, comments or assigns one or more tests (using the case IDs)
   # @param run_id [int]
   # @param [Hash] opts
-  # @example Endpoint
+  # @example Endpoint Example
   #   index.php?/api/v2/add_results_for_cases/:run_id
   # @see http://docs.gurock.com/testrail-api2/reference-results
   def add_results_for_cases(run_id, opts = {})
     send_post("add_results_for_cases/:#{run_id.to_s}", opts)
   end
 
+############################
+####get_run#################
+############################
   # Get run by run id
   # @param run_id [int]
   # @param [Hash] opts
-  # @example Endpoint
+  # @example Endpoint Example
   #   index.php?/api/v2/get_run/:run_id
   # @see http://docs.gurock.com/testrail-api2/reference-runs
   def get_run(run_id, opts = {})
     send_get("get_run/:#{run_id.to_s}", opts)
   end
 
+############################
+####get_runs################
+############################
   # Get runs by project id
   # @param project_id [int]
   # @param plan_id [int]
   # @param [Hash] opts
-  # @example Endpoint
+  # @example Endpoint Example
   #   index.php?/api/v2/get_runs/:project_id
   # @see http://docs.gurock.com/testrail-api2/reference-runs
   def get_runs(project_id, opts = {})
     send_get("get_runs/#{project_id.to_s}", opts)
   end
 
+############################
+####add_run#################
+############################
   # Add run by suite id
   # @param project_id [int]
   # @param [Hash] opts
-  # @example Endpoint
+  # @example Endpoint Example
   #   index.php?/api/v2/add_run/:project_id
   # @see http://docs.gurock.com/testrail-api2/reference-runs
   def add_run(project_id, opts = {})
     send_post("add_run/:#{project_id.to_s}", opts)
   end
 
+############################
+####update_run##############
+############################
   # Updates existing test run
   # @param run_id [int]
   # @param [Hash] opts
-  # @example Endpoint
+  # @example Endpoint Example
   #   index.php?/api/v2/update_run/:run_id
   # @see http://docs.gurock.com/testrail-api2/reference-runs
   def update_run(run_id, opts = {})
     send_post("update_run/:#{run_id.to_s}", opts)
   end
 
+############################
+####close_run###############
+############################
   # Closes an existing test run and archives its tests & results
   # @param run_id [int]
   # @param [Hash] opts
-  # @example Endpoint
+  # @example Endpoint Example
   #   index.php?/api/v2/close_run/:run_id
   # @see http://docs.gurock.com/testrail-api2/reference-runs
   def close_run(run_id, opts = {})
     send_post("close_run/#{run_id.to_s}", opts)
   end
 
+############################
+####delete_run##############
+############################
   # Deletes an existing test run.
   # @param run_id [int]
   # @param [Hash] opts
-  # @example Endpoint
+  # @example Endpoint Example
   #   index.php?/api/v2/delete_run/:run_id
   # @see http://docs.gurock.com/testrail-api2/reference-runs
   def delete_run(run_id, opts = {})
     send_post("delete_run/:#{run_id.to_s}", opts)
   end
 
+############################
+####get_test################
+############################
   # Returns an existing test
   # @param test_id [int]
   # @param [Hash] opts
-  # @example Endpoint
+  # @example Endpoint Example
   #   index.php?/api/v2/get_test/:test_id
   # @see http://docs.gurock.com/testrail-api2/reference-tests
   def get_test(test_id, opts = {})
     send_get("get_test/:#{test_id.to_s}", opts)
   end
 
+############################
+####get_tests###############
+############################
   # Returns a list of tests for a test run
   # @param run_id [int]
   # @param [Hash] opts
-  # @example Endpoint
+  # @example Endpoint Example
   #   index.php?/api/v2/get_tests/:run_id
   # @see http://docs.gurock.com/testrail-api2/reference-tests
   def get_tests(run_id, opts = {})

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Testrail
-  VERSION = '0.0.16'.freeze
+  VERSION = '0.0.17'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: testrail-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.17
 platform: ruby
 authors:
 - Frances Morales