testrail-ruby 0.0.28 → 0.0.29

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bfc411c67bb3d1920e59b1523435c7cd105c7b02
-  data.tar.gz: f73f7dcbccc7f16ede17c3657c0dc5ddec6dbdc5
+  metadata.gz: 9fababdb47877a98b0af381779e41742b0473b9d
+  data.tar.gz: e07143b1223c7bf4b2bedd23ce8b40f7865ac380
 SHA512:
-  metadata.gz: d3c037e5e711b9eeed531a6e2fd6b82629b2cf218eb6d16716c09a7eb7064e44d1cecd9baa469fdc14959c7b67264fff8c9c148a175743a7e31c9e8879f8ec6b
-  data.tar.gz: 4b88dce3fb1bf394bc497eeed5158103a7361b74545cc9ecdbeca53d7cea313d454def42514b99b74ba5c3f12b452a69a4865cbb1cd1ffbaa74f59909afbc590
+  metadata.gz: 9c56f29fdab8c80181aa06aa97254c683ae91da48e0cc61b229471b6625ab7ddabe805e5a45edaeff3cbd46662eeb9a10fc604f20537e2dc5d21289ddb46f26b
+  data.tar.gz: 54f6efd89094778832c9121afaba520c32dadf7d513a3b174a3f1f0b9cbd5b0e429e0c6c7b55c9c75aafd37a8e3b7348e18317bc7f7b7c88cd9095dbe5beef57

data/lib/endpoints.rb

@@ -81,20 +81,22 @@ module Endpoints
 ####add_case################
 ############################
   # Creates a new test case
-  # @param section_id [int] The id of the test case
-  # @param [Hash] opts
-  # @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
+  # @param section_id [int] The ID of the section the test case should be added to
+  # @param [Hash] opts
+  # @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
+  # @option opts [varies]   :custom_fields  Custom fields are supported as well and must be submitted with their system name, prefixed with 'custom_'
   # @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
+  # @note For more information about custom fields, see guroc docs
   def add_case(section_id, opts = {})
     send_post("add_case/#{section_id.to_s}", opts)
   end
@@ -204,17 +206,21 @@ module Endpoints
     send_get("get_section/:#{section_id.to_s}", opts)
   end
 
-############################
+##########################++
 ####get_sections############
 ############################
   # Get sections for suite
-  # @param suite_id [int]
+  # @param project_id [int]
   # @param [Hash] opts
+  # @options opts [int] :suite_id
   # @example Endpoint Example
-  #   index.php?/api/v2/get_sections/:project_id&suite_id=:suite_id
+  #   index.php?/api/v2/get_sections/1&suite_id=2
+  # @example Code Example
+  #   client.get_sections(1, {"suite_id":2})
   # @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}")
+  def get_sections(project_id, opts = {})
+    options = opts.to_a.map { |x| "#{x[0]}=#{x[1]}" }.join("&")
+    send_get("get_sections/#{project_id.to_s}&#{options}")
   end
 
 ############################
@@ -425,13 +431,26 @@ module Endpoints
     send_get("get_project/#{project_id.to_s}&#{options}")
   end
 
-############################
+##########################++
 ####get_projects############
 ############################
   # Get all projects
   # @param [Hash] opts
+  # @option opts [bool] :is_completed 1 == completed projects, 2 == active projects
   # @example Endpoint Example
   #   index.php?/api/v2/get_projects
+  # @example Code Example [get all projects]
+  #   client.get_projects
+  # @example Code Example [get active projects]
+  #   client.get_projects({'is_completed':0})
+  # @example Code Example [get completed projects]
+  #   client.get_projects({'is_completed':1})
+  # @example Response Example
+  #   [
+  #    { "id": 1, "name": "Project1", ... },
+  #    { "id": 2, "name": "Project2", ... },
+  #    ..
+  #   ]
   # @see http://docs.gurock.com/testrail-api2/reference-projects
   def get_projects(opts = {})
     options = opts.to_a.map { |x| "#{x[0]}=#{x[1]}" }.join("&")

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Testrail
-  VERSION = '0.0.28'.freeze
+  VERSION = '0.0.29'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: testrail-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.28
+  version: 0.0.29
 platform: ruby
 authors:
 - Frances Morales
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-14 00:00:00.000000000 Z
+date: 2017-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler