testrail-ruby 0.0.11 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9cc7b0ecc39a0c7fb9734afebc5b7f9da1ffba66
-  data.tar.gz: 6cf415db8d8203d1f6b54e6ed8ff65ecceca9840
+  metadata.gz: ff8374e2b90c61534c04a2f27dd686a55ef7fa02
+  data.tar.gz: 604940f6e96ecb8bef9ceb2eb3f8eebe14669cc9
 SHA512:
-  metadata.gz: 0565bd90f662ee1cbf1efe574ef906a7e73464b2ea58670f127738cbe304f1276ca88cc09102504d858b6ccf5a8901e41c8e0cf42e1458fc4451d3f3c1ea4669
-  data.tar.gz: 1a2d8c716bbe4263967a43841102922728154d8d7bb5c5a8f7bc10212a0424f3e8ab813304f40b771eca8908341b7dbb2e3f8f8a4c3ce435f75f1ca0454f46b9
+  metadata.gz: 8ed391b36407069c2556fc6aa8c31ca913aa73931c5201ceaca28434a43ad73951ab70c4cd09c8c855c15f9773d8a47c38083fa4fdbbc9432502e377d5719303
+  data.tar.gz: a264129d971f1a1318f060793f074339c7000701f64a90af4224617c86171ca2bb149e5ac8a67c896c5d74b6badf47c69f77a255275eb33725640f5de39d1197

data/lib/endpoints.rb

@@ -1,15 +1,17 @@
 module Endpoints
-  # Return a single test case
+  # Returns an existing test case
   # @param case_id [int] The id of the test case you want.
   # @param opts [hash]
+  # @example GET index.php?/api/v2/get_case/:case_id
   # @see http://docs.gurock.com/testrail-api2/reference-cases
   def get_case(case_id, opts = {})
     send_get("get_case/#{case_id.to_s}", opts)
   end
 
-  # Return all test cases in a given project
+  # 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 opts [hash]
+  # @example GET index.php?/api/v2/get_cases/:project_id
   # @see http://docs.gurock.com/testrail-api2/reference-cases
   def get_cases(project_id, opts = {})
     send_get("get_cases/#{project_id.to_s}", opts)
@@ -20,6 +22,7 @@ module Endpoints
   # @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 opts [hash]
+  # @example GET 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
   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)
@@ -29,22 +32,25 @@ module Endpoints
   # @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 opts [hash]
+  # @example GET index.php?/api/v2/get_cases/:project_id&suite_id=:suite_id
   # @see http://docs.gurock.com/testrail-api2/reference-cases
   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 results to a geven test case
-  # @param case_id [int] The id of the test case
+  # Creates a new test case
+  # @param section_id [int] The id of the test case
   # @param opts [hash]
+  # @example POST index.php?/api/v2/add_case/:section_id
   # @see http://docs.gurock.com/testrail-api2/reference-cases
-  def add_case(case_id, opts = {})
-    send_post("add_case/#{case_id.to_s}", opts)
+  def add_case(section_id, opts = {})
+    send_post("add_case/#{section_id.to_s}", opts)
   end
 
   # Update test result by case id
   # @param case_id [int] The id of the test case
   # @param opts [hash]
+  # @example POST 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)
@@ -53,6 +59,7 @@ module Endpoints
   # Delete test case by case id
   # @param case_id [int] The id of the test case
   # @param opts [hash]
+  # @example POST 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)
@@ -61,6 +68,7 @@ module Endpoints
   # Return suite by suite id
   # @param suite_id [int] The suite id
   # @param opts [hash]
+  # @example GET 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)
@@ -69,6 +77,7 @@ module Endpoints
   # Return all suites in project by project id
   # @param project_id [int] The id of the project containing suites
   # @param opts [hash]
+  # @example GET 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)
@@ -77,14 +86,34 @@ module Endpoints
   # Add a test suite
   # @param project_id [int] The id of the project containing suites
   # @param opts [hash]
+  # @example POST 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 a test suite
+  # @param suite_id [int] The suite id
+  # @param opts [hash]
+  # @example POST 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 a test suite
+  # @param suite_id [int] The suite id
+  # @param opts [hash]
+  # @example POST 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
+
   # Return section by id
   # @param section_id [int]
   # @param opts [hash]
+  # @example GET 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)
@@ -93,22 +122,25 @@ module Endpoints
   # Get sections for suite
   # @param suite_id [int]
   # @param opts [hash]
+  # @example GET index.php?/api/v2/get_sections/:project_id&suite_id=:suite_id
   # @see http://docs.gurock.com/testrail-api2/reference-sections
-  def get_sections(suite_id, opts = {})
-    send_get("get_sections/#{suite_id.to_s}", opts)
+  def get_sections(project_id, suite_id, opts = {})
+    send_get("get_sections/#{project_id.to_s}&#{suite_id.to_s}", opts)
   end
 
   # Add section to suite
-  # @param suite_id [int]
+  # @param project_id [int]
   # @param opts [hash]
+  # @example POST index.php?/api/v2/add_section/:project_id
   # @see http://docs.gurock.com/testrail-api2/reference-sections
-  def add_section(suite_id, opts = {})
-    send_post("add_section/#{suite_id.to_s}", opts)
+  def add_section(project_id, opts = {})
+    send_post("add_section/#{project_id.to_s}", opts)
   end
 
   # Get milestone by milestone id
   # @param milestone_id [int]
   # @param opts [hash]
+  # @example GET 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)
@@ -117,6 +149,7 @@ module Endpoints
   # Get project milestones by project id
   # @param project_id [int]
   # @param opts [hash]
+  # @example GET 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)
@@ -125,14 +158,34 @@ module Endpoints
   # Add milestone to project id
   # @param project_id [int]
   # @param opts [hash]
+  # @example POST 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
 
+  # Add milestone to project id
+  # @param milestone_id [int]
+  # @param opts [hash]
+  # @example POST 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
+
+  # Add milestone to project id
+  # @param milestone_id [int]
+  # @param opts [hash]
+  # @example POST 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 by id
   # @param plan_id [int]
   # @param opts [hash]
+  # @example GET 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)
@@ -141,6 +194,7 @@ module Endpoints
   # Get plans in project by project id
   # @param project_id [int]
   # @param opts [hash]
+  # @example GET 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)
@@ -149,6 +203,7 @@ module Endpoints
   # Add plan to project by project id
   # @param project_id [int]
   # @param opts [hash]
+  # @example POST 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)
@@ -157,22 +212,55 @@ module Endpoints
   # Add plan entries by plan id
   # @param plan_id [int]
   # @param opts [hash]
+  # @example POST 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 by plan id
+  # @param plan_id [int]
+  # @param opts [hash]
+  # @example POST 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 by plan id
+  # @param plan_id [int]
+  # @param entry_id [int] Id of entry
+  # @param opts [hash]
+  # @example POST index.php?/api/v2/update_plan_entry/:plan_id/:entry_id
   # @see http://docs.gurock.com/testrail-api2/reference-plans
-  def add_plan_entries(plan_id, opts = {})
-    send_post("add_plan_entries/#{plan_id.to_s}", opts)
+  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 by plan id
   # @param plan_id [int]
   # @param opts [hash]
+  # @example POST 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 POST 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 POST 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 by project id
   # @param project_id [int]
   # @param opts [hash]
+  # @example GET 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)
@@ -180,31 +268,108 @@ module Endpoints
 
   # Get all projects
   # @param opts [hash]
+  # @example GET 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 result to test by test id
+  # Add a project
+  # @param opts [hash]
+  # @example POST 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 a project
+  # @param project_id [int] The project you want to update
+  # @param opts [hash]
+  # @example POST 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 a project
+  # @param project_id [int] The project you want to delete
+  # @param opts [hash]
+  # @example POST 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
+
+  # Returns a list of test results for a test
   # @param test_id [int]
   # @param opts [hash]
+  # @example GET 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
+
+  # Returns a list of test results for a test run and case combination
+  # @param run_id [int]
+  # @param case_id [int]
+  # @param opts [hash]
+  # @example GET 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
+
+  # Returns a list of test results for a test run
+  # @param run_id [int]
+  # @param opts [hash]
+  # @example GET 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
+
+  # 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 opts [hash]
+  # @example POST 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 to case by case id
+  # 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 opts [hash]
+  # @example POST 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
 
+  # Adds one or more new test results, comments or assigns one or more tests
+  # @param run_id [int]
+  # @param opts [hash]
+  # @example POST 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
+
+  # Adds one or more new test results, comments or assigns one or more tests (using the case IDs)
+  # @param run_id [int]
+  # @param opts [hash]
+  # @example POST 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 by run id
   # @param run_id [int]
   # @param opts [hash]
+  # @example GET 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)
@@ -214,40 +379,61 @@ module Endpoints
   # @param project_id [int]
   # @param plan_id [int]
   # @param opts [hash]
+  # @example GET index.php?/api/v2/get_runs/:project_id
   # @see http://docs.gurock.com/testrail-api2/reference-runs
-  # @note Might be broken
   def get_runs(project_id, plan_id, opts = {})
-    send_get("get_runs/#{project_id.to_s}/#{plan_id.to_s}", opts)
+    send_get("get_runs/#{project_id.to_s}", opts)
   end
 
   # Add run by suite id
-  # @param suite_id [int]
+  # @param project_id [int]
   # @param opts [hash]
+  # @example POST index.php?/api/v2/add_run/:project_id
   # @see http://docs.gurock.com/testrail-api2/reference-runs
-  def add_run(suite_id, opts = {})
-    send_post("add_run/#{suite_id.to_s}", opts)
+  def add_run(project_id, opts = {})
+    send_post("add_run/#{project_id.to_s}", opts)
   end
 
+  # Updates existing test run
+  # @param run_id [int]
+  # @param opts [hash]
+  # @example POST 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 by run id
+  # Closes an existing test run and archives its tests & results
   # @param run_id [int]
   # @param opts [hash]
+  # @example POST 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
 
-  # Get test by test id
+  # Deletes an existing test run.
+  # @param run_id [int]
+  # @param opts [hash]
+  # @example POST 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
+
+  # Returns an existing test
   # @param test_id [int]
   # @param opts [hash]
+  # @example GET 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 by run id
+  # Returns a list of tests for a test run
   # @param run_id [int]
   # @param opts [hash]
+  # @example GET index.php?/api/v2/get_tests/:run_id
   # @see http://docs.gurock.com/testrail-api2/reference-tests
   def get_tests(run_id, opts = {})
     send_get("get_tests/#{run_id.to_s}", opts)

data/lib/testrail-ruby.rb

@@ -5,10 +5,10 @@ require 'net/https'
 require 'uri'
 require 'json'
 
-# USAGE:
-# @client = TestRail::APIClient.new('YourBaseURLHere')
-# @client.user = 'UserName'
-# @client.password = 'Password'
+## #USAGE:
+## #@client = TestRail::APIClient.new('YourBaseURLHere')
+## #@client.user = 'UserName'
+## #@client.password = 'Password'
 
 module TestRail
   class APIClient

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Testrail
-  VERSION = '0.0.11'.freeze
+  VERSION = '0.0.12'.freeze
 end

metadata

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