testrail_api 0.1.1 → 1.0.0

data/lib/testrail_api/client/runs.rb

@@ -4,69 +4,71 @@ module TestRail
     #
     # @see http://docs.gurock.com/testrail-api2/reference-runs
     # Use the following API methods to request details about test runs and to create or modify test runs.
+    module Runs
+      #
+      # Returns an existing test run. Please see get_tests for the list of included tests in this run.
+      #
+      # :run_id  The ID of the test run
+      #
+      def run(run_id)
+        get("get_run/#{run_id}")
+      end
 
-    #
-    # Returns an existing test run. Please see get_tests for the list of included tests in this run.
-    #
-    # :run_id  The ID of the test run
-    #
-    def run(run_id)
-      get("get_run/#{run_id}")
-    end
+      #
+      # Returns a list of test runs for a project.
+      # Only returns those test runs that are not part of a test plan (please see get_plans/get_plan for this).
+      #
+      # :project_id  The ID of the project
+      #
+      def runs(project_id)
+        get("get_runs/#{project_id}")
+      end
 
-    #
-    # Returns a list of test runs for a project.
-    # Only returns those test runs that are not part of a test plan (please see get_plans/get_plan for this).
-    #
-    # :project_id  The ID of the project
-    #
-    def runs(project_id)
-      get("get_runs/#{project_id}")
-    end
+      #
+      # Creates a new test run.
+      #
+      # @param [Integer, String] project_id  The ID of the project the test run should be added to
+      # @param data [Hash]: A customizable set of options
+      # @option data [Integer]          :suite_id       The ID of the test suite for the test run (optional if the project is operating in single suite mode, required otherwise)
+      # @option data [String]           :name           The name of the test run
+      # @option data [String]           :description    The description of the test run
+      # @option data [Integer]          :milestone_id   The ID of the milestone to link to the test run
+      # @option data [Integer]          :assignedto_id  The ID of the user the test run should be assigned to
+      # @option data [Boolean]          :include_all    True for including all test cases of the test suite and false for a custom case selection (default: true)
+      # @option data [Array<Integer>]   :case_ids       An array of case IDs for the custom case selection
+      # @return # TODO:
+      # @see http://docs.gurock.com/testrail-api2/reference-runs#add_run
+      def add_run(project_id, data)
+        post("add_run/#{project_id}", body: data.to_json)
+      end
 
-    #
-    # Creates a new test run.
-    #
-    # @param [Integer, String] project_id  The ID of the project the test run should be added to
-    # @param data [Hash]: A customizable set of options
-    # @option data [Integer] :suite_id  The ID of the test suite for the test run (optional if the project is operating in single suite mode, required otherwise)
-    # @option data [String] :name The name of the test run
-    # @option data [String] :description The description of the test run
-    # @option data [Integer] :milestone_id The ID of the milestone to link to the test run
-    # @option data [Integer] :assignedto_id The ID of the user the test run should be assigned to
-    # @option data [Boolean] :include_all True for including all test cases of the test suite and false for a custom case selection (default: true)
-    # @option data [Array<Integer>] :case_ids An array of case IDs for the custom case selection
-    # @return # TODO:
-    # @see http://docs.gurock.com/testrail-api2/reference-runs#add_run
-    def add_run(project_id, data)
-      post("add_run/#{project_id}", data)
-    end
+      #
+      # Updates an existing test run (partial updates are supported, i.e. you can submit and update specific fields only).
+      # With the exception of the suite_id and assignedto_id fields, this method supports the same POST fields as add_run.
+      #
+      # :run_id    The ID of the test run
+      #
+      def update_run(run_id, data)
+        post("update_run/#{run_id}", body: data.to_json)
+      end
 
-    #
-    # Updates an existing test run (partial updates are supported, i.e. you can submit and update specific fields only).
-    #
-    # :run_id    The ID of the test run
-    #
-    def update_run(run_id, data)
-      post("update_run/#{run_id}", data)
-    end
+      #
+      # Closes an existing test run and archives its tests & results.
+      #
+      # :run_id The ID of the test run
+      #
+      def close_run(run_id, data)
+        post("close_run/#{run_id}", data)
+      end
 
-    #
-    # Closes an existing test run and archives its tests & results.
-    #
-    # :run_id The ID of the test run
-    #
-    def close_run(run_id, data)
-      post("close_run/#{run_id}", data)
-    end
-
-    #
-    # Deletes an existing test run.
-    #
-    # :run_id The ID of the test run
-    #
-    def delete_run(run_id, data)
-      post("delete_run/#{run_id}", data)
+      #
+      # Deletes an existing test run.
+      #
+      # :run_id The ID of the test run
+      #
+      def delete_run(run_id, data)
+        post("delete_run/#{run_id}", data)
+      end
     end
   end
 end

data/lib/testrail_api/client/sections.rb

@@ -5,61 +5,58 @@ module TestRail
     # @see http://docs.gurock.com/testrail-api2/reference-sections
     # Use the following API methods to request details about sections and to create or modify sections.
     # Sections are used to group and organize test cases in test suites.
+    module Sections
+      #
+      # Returns an existing section.
+      #
+      # :section_id The ID of the section
+      #
+      def section(section_id)
+        get("get_section/#{section_id}")
+      end
 
-    #
-    # Returns an existing section.
-    #
-    # :section_id The ID of the section
-    #
-    def section(section_id)
-      get("get_section/#{section_id}")
-    end
-
-    #
-    # Returns a list of sections for a project and test suite.
-    #
-    # :project_id The ID of the project
-    # :suite_id The ID of the test suite (optional if the project is operating in single suite mode)
-    #
-    def sections(project_id, suite_id)
-      get("get_sections/#{project_id}&suite_id=#{suite_id}")
-    end
+      #
+      # Returns a list of sections for a project and test suite.
+      #
+      # :project_id The ID of the project
+      # :suite_id The ID of the test suite (optional if the project is operating in single suite mode)
+      #
+      def sections(project_id, suite_id)
+        get("get_sections/#{project_id}&suite_id=#{suite_id}")
+      end
 
-    def section_by_name(project_id, suite_id, section_name, ignore_case = true)
-      if ignore_case
-        sections(project_id, suite_id).find { |section| section['name'].casecmp(section_name) == 0 }
-      else
+      def section_by_name(project_id, suite_id, section_name)
         sections(project_id, suite_id).find { |section| section['name'] == section_name }
       end
-    end
 
-    #
-    # Creates a new section.
-    #
-    # :project_id The ID of the project
-    #
-    def add_section(project_id, data)
-      post("add_section/#{project_id}", data)
-    end
+      #
+      # Creates a new section.
+      #
+      # :project_id The ID of the project
+      #
+      def add_section(project_id, data)
+        post("add_section/#{project_id}", data)
+      end
 
-    #
-    # Updates an existing section (partial updates are supported, i.e. you can submit and update specific fields only).
-    #
-    # :section_id The ID of the section
-    #
-    def update_section(section_id, data)
-      post("update_section/#{section_id}", data)
-    end
+      #
+      # Updates an existing section (partial updates are supported, i.e. you can submit and update specific fields only).
+      #
+      # :section_id The ID of the section
+      #
+      def update_section(section_id, data)
+        post("update_section/#{section_id}", data)
+      end
 
-    #
-    # Updates an existing section (partial updates are supported, i.e. you can submit and update specific fields only).
-    # Please note: Deleting a section cannot be undone and also deletes all related test cases
-    # as well as active tests & results, i.e. tests & results that weren't closed (archived) yet.
-    #
-    # :section_id The ID of the section
-    #
-    def delete_section(section_id)
-      post("delete_section/#{section_id}")
+      #
+      # Updates an existing section (partial updates are supported, i.e. you can submit and update specific fields only).
+      # Please note: Deleting a section cannot be undone and also deletes all related test cases
+      # as well as active tests & results, i.e. tests & results that weren't closed (archived) yet.
+      #
+      # :section_id The ID of the section
+      #
+      def delete_section(section_id)
+        post("delete_section/#{section_id}")
+      end
     end
   end
 end

data/lib/testrail_api/client/statuses.rb

@@ -4,16 +4,17 @@ module TestRail
     #
     # @see http://docs.gurock.com/testrail-api2/reference-statuses
     # Use the following API methods to request details about test statuses.
-
     # Each status has a unique ID, a name (system name) as well as a label (display name).
     # The color related fields specify the different colors used for a status and are RGB colors.
     # The following system statuses are available by default.
     # You can add additional custom statuses under Administration > Customizations in TestRail.
-
-    # @return a list of available_contexts test statuses.
-    # @see http://docs.gurock.com/testrail-api2/reference-statuses#get_statuses
-    def statuses
-      get('get_statuses')
+    module Statuses
+      #
+      # @return a list of available_contexts test statuses.
+      # @see http://docs.gurock.com/testrail-api2/reference-statuses#get_statuses
+      def statuses
+        get('get_statuses')
+      end
     end
   end
 end

data/lib/testrail_api/client/suites.rb

@@ -4,40 +4,42 @@ module TestRail
     #
     # @see http://docs.gurock.com/testrail-api2/reference-suites
     # Use the following API methods to request details about test suites and to create or modify test suites.
+    module Suites
+      #
+      # Returns an existing test suite.
+      #
+      # :suite_id	The ID of the test suite
+      #
+      def suite(suite_id)
+        get("get_suite/#{suite_id}")
+      end
 
-    #
-    # Returns an existing test suite.
-    #
-    # :suite_id	The ID of the test suite
-    #
-    def suite(suite_id)
-      get("get_suite/#{suite_id}")
-    end
-
-    def suite_by_name(project_id, suite_name, ignore_case = true)
-      if ignore_case
+      def suite_by_name(project_id, suite_name)
         suites(project_id).find { |suite| suite['name'].casecmp(suite_name) == 0 }
-      else
-        suites(project_id).find { |suite| suite['name'] == suite_name }
       end
-    end
 
-    #
-    # Returns a list of test suites for a project.
-    #
-    # :project_id	The ID of the project
-    #
-    def suites(project_id)
-      get("get_suites/#{project_id}")
-    end
+      #
+      # Returns a list of test suites for a project.
+      #
+      # :project_id	The ID of the project
+      #
+      def suites(project_id)
+        get("get_suites/#{project_id}")
+      end
 
-    #
-    # Creates a new test suite.
-    #
-    # :project_id	The ID of the project the test suite should be added to
-    #
-    def add_suite(project_id, data)
-      post("add_suite/#{project_id}", data)
+      def suites_by_project_name(project_name)
+        project_id = project_by_name(project_name).fetch('id')
+        suites(project_id)
+      end
+
+      #
+      # Creates a new test suite.
+      #
+      # :project_id	The ID of the project the test suite should be added to
+      #
+      def add_suite(project_id, data)
+        post("add_suite/#{project_id}", data)
+      end
     end
   end
 end

data/lib/testrail_api/client/tests.rb

@@ -4,41 +4,38 @@ module TestRail
     # Use the following API methods to request details about tests.
     #
     # @see http://docs.gurock.com/testrail-api2/reference-tests
-    #
-    # Returns an existing test by its ID
-    ##
-    # @param [Integer, String] test_id  The ID of the test
-    # @return an existing test by its ID
-    # @see http://docs.gurock.com/testrail-api2/reference-runs#add_run
-    def test(test_id)
-      get("get_test/#{test_id}")
-    end
+    module Tests
+      #
+      # Returns an existing test by its ID
+      #
+      # @param [Integer, String] test_id  The ID of the test
+      # @return an existing test by its ID
+      # @see http://docs.gurock.com/testrail-api2/reference-runs#add_run
+      def test(test_id)
+        get("get_test/#{test_id}")
+      end
 
-    # TODO: add documentation
-    def test_by_title(run_id, test_title, ignore_case = true)
-      if ignore_case
+      # TODO: add documentation
+      def test_by_title(run_id, test_title)
         tests(run_id).find { |test| test['title'].casecmp(test_title) == 0 }
-      else
-        tests(run_id).find { |test| test['title'] == test_title }
-
       end
-    end
 
-    # TODO: add documentation
-    def test_id_by_title(run_id, test_title)
-      test_by_title(run_id, test_title)['id']
-    end
+      # TODO: add documentation
+      def test_id_by_title(run_id, test_title)
+        test_by_title(run_id, test_title)['id']
+      end
 
-    #
-    # Returns a list of tests for a test run.
-    #
-    # # TODO: finish method and documentation
-    # @param [Integer, String] run_id The ID of the test run
-    # @option [String] status_id
-    # @return an existing test by its ID
-    # @see http://docs.gurock.com/testrail-api2/reference-runs#add_run
-    def tests(run_id)
-      get("get_tests/#{run_id}")
+      #
+      # Returns a list of tests for a test run.
+      #
+      # TODO: finish method and documentation
+      # @param [Integer, String] run_id The ID of the test run
+      # @option [String] status_id
+      # @return an existing test by its ID
+      # @see http://docs.gurock.com/testrail-api2/reference-runs#add_run
+      def tests(run_id)
+        get("get_tests/#{run_id}")
+      end
     end
   end
 end

data/lib/testrail_api/client/users.rb

@@ -3,30 +3,31 @@ module TestRail
     # Methods for the Users API
     #
     # @see http://docs.gurock.com/testrail-api2/reference-users
-    #
+    module Users
+      #
+      # Returns an existing user.
+      #
+      # :user_id  The ID of the user
+      #
+      def user(user_id)
+        get("get_user/#{user_id}")
+      end
 
-    # Returns an existing user.
-    #
-    # :user_id  The ID of the user
-    #
-    def user(user_id)
-      get("get_user/#{user_id}")
-    end
+      #
+      # Returns a list of users.
+      #
+      def users
+        get('get_users')
+      end
 
-    #
-    # Returns a list of users.
-    #
-    def users
-      get('get_users')
-    end
-
-    #
-    # Returns an existing user by his/her email address.
-    #
-    # :email  The email address to get the user for
-    #
-    def user_by_email(email)
-      get("get_user_by_email&email=#{email}")
+      #
+      # Returns an existing user by his/her email address.
+      #
+      # :email  The email address to get the user for
+      #
+      def user_by_email(email)
+        get("get_user_by_email&email=#{email}")
+      end
     end
   end
 end