testrail-ruby 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f9caa436fc854b728843bb5107274faaef88e58
-  data.tar.gz: a62138f2434efeab86cb75e7a06ca5c9c477f54d
+  metadata.gz: 7e752f6f2bfe9993b01a164db160f853b8112344
+  data.tar.gz: 32d0ffd73f570382c12594d51bfa327536d7c194
 SHA512:
-  metadata.gz: 72ed42abf0f6a12ba8fb984e65211e17774c10d33308fd1e3ac3321b7bc37fd0d033c8bba830b33720d0de914a713f181750d24e508dcbb4014070482a4430f8
-  data.tar.gz: 527363bb473a7059fad7e72e301ab2e0c56a0bc734c847ac46c7ad8d93cc7f7cf508188f5768ba6e230377ed38e6c9b9d56cb5f42bf5ba4c2949bd9a1e2e048a
+  metadata.gz: eaa3be02dbbe23ddf73c8512b262d2b06d501d1207ed6fb4caaa180ad1b512369cf4dcb408f6ec99f6898083ff526d72b00492a046473739bfbed05f42830ed4
+  data.tar.gz: fcfcab1bc4bd4c5047cb6115652b30f17ad99f28e04658c071491a42c2150b014ffcc6de855f0c4cb4ec9fd5b0d5adad733b0e6382ee7406e3f4ca9e5518ddcc

data/lib/endpoints.rb

@@ -1,121 +1,237 @@
-
-#
-#  This space left blank intentionally
-#
 module Endpoints
-  def add_result(test_id, opts = {})
-    send_post("add_result/#{test_id}", opts)
-  end
-
-  def add_result_for_case(run_id, case_id, opts = {})
-    send_post("add_result_for_case/#{run_id}/#{case_id}", opts)
-  end
-
-  def get_test(test_id, opts = {})
-    send_get("get_test/#{test_id}", opts)
-  end
-
-  def get_tests(run_id, opts = {})
-    send_get("get_tests/#{run_id}", opts)
-  end
-
+  # Return a single test case
+  # @param case_id [int] The id of the test case you want.
+  # @param opts [hash]
+  # @see http://docs.gurock.com/testrail-api2/reference-cases
   def get_case(case_id, opts = {})
-    send_get("get_case/#{case_id}", opts)
+    send_get("get_case/#{case_id.to_s}", opts)
   end
 
-  def get_cases(project_id, suite_id, opts = {})
-    send_get("get_cases/#{project_id}&suite_id=#{suite_id}", opts)
+  # Return all test cases in a given project
+  # @param project_id [int] The id of the project that contains your tests
+  # @param opts [hash]
+  # @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
 
-  def add_case(section_id, opts = {})
-    send_post("add_case/#{section_id}", opts)
+  # Add results to a geven test case
+  # @param case_id [int] The id of the test case
+  # @param opts [hash]
+  # @see http://docs.gurock.com/testrail-api2/reference-cases
+  def add_case(case_id, opts = {})
+    send_post("add_case/#{case_id.to_s}", opts)
   end
 
+  # Update test result by case id
+  # @param case_id [int] The id of the test case
+  # @param opts [hash]
+  # @see http://docs.gurock.com/testrail-api2/reference-cases
   def update_case(case_id, opts = {})
-    send_post("update_case/#{case_id}", opts)
+    send_post("update_case/#{case_id.to_s}", opts)
   end
 
+  # Delete test case by case id
+  # @param case_id [int] The id of the test case
+  # @param opts [hash]
+  # @see http://docs.gurock.com/testrail-api2/reference-cases
   def delete_case(case_id, opts = {})
-    send_post("delete_case/#{case_id}", opts)
+    send_post("delete_case/#{case_id.to_s}", opts)
   end
 
+  # Return suite by suite id
+  # @param suite_id [int] The suite id
+  # @param opts [hash]
+  # @see http://docs.gurock.com/testrail-api2/reference-suites
   def get_suite(suite_id, opts = {})
-    send_get("get_suite/#{suite_id}", opts)
+    send_get("get_suite/#{suite_id.to_s}", opts)
   end
 
+  # Return all suites in project by project id
+  # @param project_id [int] The id of the project containing suites
+  # @param opts [hash]
+  # @see http://docs.gurock.com/testrail-api2/reference-suites
   def get_suites(project_id, opts = {})
-    send_get("get_suites/#{project_id}", opts)
+    send_get("get_suites/#{project_id.to_s}", opts)
   end
 
-  def get_section(section_id, opts = {})
-    send_get("get_section/#{section_id}", opts)
+  # Add a test suite
+  # @param project_id [int] The id of the project containing suites
+  # @param opts [hash]
+  # @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
 
-  def get_sections(suite_id, opts = {})
-    send_get("get_sections/#{suite_id}", opts)
+  # Return section by id
+  # @param section_id [int]
+  # @param opts [hash]
+  # @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
 
-  def add_suite(project_id, opts = {})
-    send_post("add_suite/#{project_id}", opts)
+  # Get sections for suite
+  # @param suite_id [int]
+  # @param opts [hash]
+  # @see http://docs.gurock.com/testrail-api2/reference-sections
+  def get_sections(suite_id, opts = {})
+    send_get("get_sections/#{suite_id.to_s}", opts)
   end
 
+  # Add section to suite
+  # @param suite_id [int]
+  # @param opts [hash]
+  # @see http://docs.gurock.com/testrail-api2/reference-sections
   def add_section(suite_id, opts = {})
-    send_post("add_section/#{suite_id}", opts)
-  end
-
-  def get_run(run_id, opts = {})
-    send_get("get_run/#{run_id}", opts)
+    send_post("add_section/#{suite_id.to_s}", opts)
   end
 
-  def get_runs(project_id, plan_id, opts = {})
-    send_get("get_runs/#{project_id}/#{plan_id}", opts)
+  # Get milestone by milestone id
+  # @param milestone_id [int]
+  # @param opts [hash]
+  # @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
 
-  def add_run(suite_id, opts = {})
-    send_post("add_run/#{suite_id}", opts)
+  # Get project milestones by project id
+  # @param project_id [int]
+  # @param opts [hash]
+  # @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
 
-  def close_run(run_id, opts = {})
-    send_post("close_run/#{run_id}", opts)
+  # Add milestone to project id
+  # @param project_id [int]
+  # @param opts [hash]
+  # @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
 
+  # Get plan by id
+  # @param plan_id [int]
+  # @param opts [hash]
+  # @see http://docs.gurock.com/testrail-api2/reference-plans
   def get_plan(plan_id, opts = {})
-    send_get("get_plan/#{plan_id}", opts)
+    send_get("get_plan/#{plan_id.to_s}", opts)
   end
 
+  # Get plans in project by project id
+  # @param project_id [int]
+  # @param opts [hash]
+  # @see http://docs.gurock.com/testrail-api2/reference-plans
   def get_plans(project_id, opts = {})
-    send_get("get_plans/#{project_id}", opts)
+    send_get("get_plans/#{project_id.to_s}", opts)
   end
 
+  # Add plan to project by project id
+  # @param project_id [int]
+  # @param opts [hash]
+  # @see http://docs.gurock.com/testrail-api2/reference-plans
   def add_plan(project_id, opts = {})
-    send_post("add_plan/#{project_id}", opts)
+    send_post("add_plan/#{project_id.to_s}", opts)
   end
 
+  # Add plan entries by plan id
+  # @param plan_id [int]
+  # @param opts [hash]
+  # @see http://docs.gurock.com/testrail-api2/reference-plans
   def add_plan_entries(plan_id, opts = {})
-    send_post("add_plan_entries/#{plan_id}", opts)
+    send_post("add_plan_entries/#{plan_id.to_s}", opts)
   end
 
+  # Close plan by plan id
+  # @param plan_id [int]
+  # @param opts [hash]
+  # @see http://docs.gurock.com/testrail-api2/reference-plans
   def close_plan(plan_id, opts = {})
-    send_post("close_plan/#{plan_id}", opts)
+    send_post("close_plan/#{plan_id.to_s}", opts)
   end
 
-  def get_milestone(milestone_id, opts = {})
-    send_get("get_milestone/#{milestone_id}", opts)
+  # Get project by project id
+  # @param project_id [int]
+  # @param opts [hash]
+  # @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
 
-  def get_milestones(project_id, opts = {})
-    send_get("get_milestones/#{project_id}", opts)
+  # Get all projects
+  # @param opts [hash]
+  # @see http://docs.gurock.com/testrail-api2/reference-projects
+  def get_projects(opts = {})
+    send_get('get_projects', opts)
   end
 
-  def add_milestone(project_id, opts = {})
-    send_post("add_milestone/#{project_id}", opts)
+  # Add result to test by test id
+  # @param test_id [int]
+  # @param opts [hash]
+  # @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
 
-  def get_project(project_id, opts = {})
-    send_get("get_project/#{project_id}", opts)
+  # Add result to case by case id
+  # @param run_id [int]
+  # @param case_id [int]
+  # @param opts [hash]
+  # @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
 
-  def get_projects(opts = {})
-    send_get('get_projects', opts)
+  # Get run by run id
+  # @param run_id [int]
+  # @param opts [hash]
+  # @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 by project id
+  # @param project_id [int]
+  # @param plan_id [int]
+  # @param opts [hash]
+  # @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)
   end
+
+  # Add run by suite id
+  # @param suite_id [int]
+  # @param opts [hash]
+  # @see http://docs.gurock.com/testrail-api2/reference-runs
+  def add_run(suite_id, opts = {})
+    send_post("add_run/#{suite_id.to_s}", opts)
+  end
+
+
+  # Close run by run id
+  # @param run_id [int]
+  # @param opts [hash]
+  # @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
+  # @param test_id [int]
+  # @param opts [hash]
+  # @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
+  # @param run_id [int]
+  # @param opts [hash]
+  # @see http://docs.gurock.com/testrail-api2/reference-tests
+  def get_tests(run_id, opts = {})
+    send_get("get_tests/#{run_id.to_s}", opts)
+  end
+
 end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Testrail
-  VERSION = '0.0.6'.freeze
+  VERSION = '0.0.7'.freeze
 end

data/spec/testrail/endpoints_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+# RSpec.describe Testrail do
+#   it 'has a version number' do
+#     expect(Testrail::VERSION).not_to be nil
+#   end
+# end

data/spec/testrail/{ruby_spec.rb → version_spec.rb}

@@ -4,5 +4,4 @@ RSpec.describe Testrail do
   it 'has a version number' do
     expect(Testrail::VERSION).not_to be nil
   end
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: testrail-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Frances Morales
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A Ruby client wrapper for the TestRail API (v2)
 email: fmorales@francesmoralespec.com
 executables: []
@@ -99,7 +113,8 @@ files:
 - lib/testrail/deprecated/response.rb
 - lib/version.rb
 - spec/spec_helper.rb
-- spec/testrail/ruby_spec.rb
+- spec/testrail/endpoints_spec.rb
+- spec/testrail/version_spec.rb
 homepage: https://github.com/fmorales/TestRail-Ruby
 licenses:
 - MIT
@@ -126,4 +141,5 @@ specification_version: 4
 summary: Client wrapper in Ruby for TestRail API (v2)
 test_files:
 - spec/spec_helper.rb
-- spec/testrail/ruby_spec.rb
+- spec/testrail/endpoints_spec.rb
+- spec/testrail/version_spec.rb