onlyoffice_testrail_wrapper 0.2.0 → 0.4.0

data/lib/onlyoffice_testrail_wrapper/testrail_plan.rb

@@ -3,7 +3,8 @@
 require_relative 'testrail_plan_entry'
 
 module OnlyofficeTestrailWrapper
-  class TestrailPlan
+  # Class for working with testrail plan
+  class TestrailPlan < TestrailApiObject
     # @return [Integer] Id of test plan
     attr_accessor :id
     # @return [String] test run name
@@ -22,8 +23,11 @@ module OnlyofficeTestrailWrapper
     attr_reader :created_on
     # @return [String] url to current test plan
     attr_reader :url
+    # @return [String] error message if any happens
+    attr_reader :error
 
     def initialize(name = '', entries = [], description = '', milestone_id = nil, id = nil)
+      super()
       @name = name
       @entries = entries
       @description = description
@@ -32,10 +36,14 @@ module OnlyofficeTestrailWrapper
     end
 
     def add_entry(name, suite_id, include_all = true, case_ids = [], assigned_to = nil)
-      entry = HashHelper.parse_to_class_variable(Testrail2.http_post("index.php?/api/v2/add_plan_entry/#{@id}", suite_id: suite_id, name: StringHelper.warnstrip!(name.to_s),
-                                                                                                                include_all: include_all, case_ids: case_ids, assigned_to: assigned_to), TestrailPlanEntry)
+      entry = TestrailPlanEntry.new.init_from_hash(Testrail2.http_post("index.php?/api/v2/add_plan_entry/#{@id}",
+                                                                       suite_id: suite_id,
+                                                                       name: StringHelper.warnstrip!(name.to_s),
+                                                                       include_all: include_all,
+                                                                       case_ids: case_ids,
+                                                                       assigned_to: assigned_to))
       OnlyofficeLoggerHelper.log "Added plan entry: #{name.to_s.strip}"
-      entry.runs.each_with_index { |run, index| entry.runs[index] = HashHelper.parse_to_class_variable(run, TestrailRun) }
+      entry.runs.each_with_index { |run, index| entry.runs[index] = TestrailRun.new.init_from_hash(run) }
       entry
     end
 

data/lib/onlyoffice_testrail_wrapper/testrail_plan_entry.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
 module OnlyofficeTestrailWrapper
-  class TestrailPlanEntry
+  # Class for working with testrail plan entry
+  class TestrailPlanEntry < TestrailApiObject
     attr_accessor :suite_id, :name, :assigned_to, :include_all, :case_ids, :runs
 
     def initialize(params = {})
+      super()
       @suite_id = params.fetch(:suite_id, nil)
       @name = params.fetch(:name, '')
       @include_all = params.fetch(:include_all, true)

data/lib/onlyoffice_testrail_wrapper/testrail_project/testrail_project_milestone_methods.rb

@@ -3,9 +3,12 @@
 module OnlyofficeTestrailWrapper
   # Methods to perform operations on milestones
   module TestrailProjectMilestoneMethods
+    # Get milestone data by parameter
+    # @param [String, Integer] name_or_id id or name of milestone
+    # @return [TestrailMilestone]
     def milestone(name_or_id)
       case name_or_id.class.to_s
-      when 'Fixnum'
+      when 'Fixnum', 'Integer'
         get_milestone_by_id name_or_id
       when 'String'
         init_milestone_by_name name_or_id
@@ -14,32 +17,48 @@ module OnlyofficeTestrailWrapper
       end
     end
 
+    # Get milestone data by it's name
+    # Will create a new one if no one found
+    # @param [String] name of milestone
+    # @return [TestrailMilestone]
     def init_milestone_by_name(name)
       found_milestone = get_milestone_by_name name
       found_milestone.nil? ? create_new_milestone(name) : found_milestone
     end
 
+    # Get milestone by it's id
+    # @param [Integer] id of milestone
+    # @return [TestrailMilestone]
     def get_milestone_by_id(id)
-      milestone = HashHelper.parse_to_class_variable(Testrail2.http_get("index.php?/api/v2/get_milestone/#{id}"), TestrailMilestone)
+      milestone = TestrailMilestone.new.init_from_hash(Testrail2.http_get("index.php?/api/v2/get_milestone/#{id}"))
       OnlyofficeLoggerHelper.log("Initialized milestone: #{milestone.name}")
       milestone
     end
 
+    # Get milestone data by it's name
+    # @param [String] name of milestone
+    # @return [TestrailMilestone, nil] result or nil if not found
     def get_milestone_by_name(name)
       get_milestones if @milestones_names.empty?
       @milestones_names[StringHelper.warnstrip!(name.to_s)].nil? ? nil : get_milestone_by_id(@milestones_names[name])
     end
 
+    # Get list of all milestones
+    # @return [Array<TestrailMilestone>] list of all milestones
     def get_milestones
       milestones = Testrail2.http_get("index.php?/api/v2/get_milestones/#{@id}")
-      @milestones_names = HashHelper.get_hash_from_array_with_two_parameters(milestones, 'name', 'id') if @milestones_names.empty?
+      @milestones_names = name_id_pairs(milestones) if @milestones_names.empty?
       milestones
     end
 
+    # Create new milestone
     # @param [String] name of milestone
     # @param [String] description of milestone
+    # @return [TestrailMilestone]
     def create_new_milestone(name, description = '')
-      new_milestone = HashHelper.parse_to_class_variable(Testrail2.http_post("index.php?/api/v2/add_milestone/#{@id}", :name => StringHelper.warnstrip!(name.to_s), description => description), TestrailMilestone)
+      new_milestone = TestrailMilestone.new.init_from_hash(Testrail2.http_post("index.php?/api/v2/add_milestone/#{@id}",
+                                                                               :name => StringHelper.warnstrip!(name.to_s),
+                                                                               description => description))
       OnlyofficeLoggerHelper.log "Created new milestone: #{new_milestone.name}"
       new_milestone
     end

data/lib/onlyoffice_testrail_wrapper/testrail_project/testrail_project_plan_helper.rb

@@ -5,7 +5,7 @@ module OnlyofficeTestrailWrapper
   module TestrailProjectPlanHelper
     def plan(name_or_id)
       case name_or_id.class.to_s
-      when 'Fixnum'
+      when 'Fixnum', 'Integer'
         get_plan_by_id name_or_id
       when 'String'
         init_plan_by_name name_or_id
@@ -20,14 +20,16 @@ module OnlyofficeTestrailWrapper
     end
 
     def get_plan_by_id(id)
-      plan = HashHelper.parse_to_class_variable(Testrail2.http_get("index.php?/api/v2/get_plan/#{id}"), TestrailPlan)
+      plan = TestrailPlan.new.init_from_hash(Testrail2.http_get("index.php?/api/v2/get_plan/#{id}"))
       OnlyofficeLoggerHelper.log("Initialized plan: #{plan.name}")
+      raise("`get_plan_by_id(#{id})` return an error: `#{plan.error}`") if plan.error
+
       plan.entries.each_with_index do |test_entry, index|
-        entry = HashHelper.parse_to_class_variable(test_entry, TestrailPlanEntry)
-        entry.runs.each_with_index { |run, i| entry.runs[i] = HashHelper.parse_to_class_variable(run, TestrailRun) }
+        entry = TestrailPlanEntry.new.init_from_hash(test_entry)
+        entry.runs.each_with_index { |run, i| entry.runs[i] = TestrailRun.new.init_from_hash(run) }
         plan.entries[index] = entry
       end
-      plan.instance_variable_set '@project', self
+      plan.instance_variable_set :@project, self
       plan
     end
 
@@ -52,7 +54,7 @@ module OnlyofficeTestrailWrapper
       get_url = "index.php?/api/v2/get_plans/#{@id}"
       filters.each { |key, value| get_url += "&#{key}=#{value}" }
       plans = Testrail2.http_get(get_url)
-      @plans_names = HashHelper.get_hash_from_array_with_two_parameters(plans, 'name', 'id') if @plans_names.empty?
+      @plans_names = name_id_pairs(plans) if @plans_names.empty?
       plans
     end
 
@@ -66,19 +68,22 @@ module OnlyofficeTestrailWrapper
       get_url = "index.php?/api/v2/get_plans/#{@id}"
       filters.each { |key, value| get_url += "&#{key}=#{value}" }
       plans = Testrail2.http_get(get_url)
-      plans.map { |suite| HashHelper.parse_to_class_variable(suite, TestrailPlan) }
+      plans.map { |suite| TestrailPlan.new.init_from_hash(suite) }
     end
 
     # @param [String] name of test plan
     # @param [String] description
     # @param [Integer] milestone_id
     def create_new_plan(name, entries = [], description = '', milestone_id = nil)
-      new_plan = HashHelper.parse_to_class_variable(Testrail2.http_post("index.php?/api/v2/add_plan/#{@id}", name: StringHelper.warnstrip!(name), description: description,
-                                                                                                             milestone_id: milestone_id, entries: entries), TestrailPlan)
+      new_plan = TestrailPlan.new.init_from_hash(Testrail2.http_post("index.php?/api/v2/add_plan/#{@id}",
+                                                                     name: StringHelper.warnstrip!(name),
+                                                                     description: description,
+                                                                     milestone_id: milestone_id,
+                                                                     entries: entries))
       OnlyofficeLoggerHelper.log "Created new plan: #{new_plan.name}"
       new_plan.entries.each_with_index do |entry, i|
-        new_plan.entries[i] = HashHelper.parse_to_class_variable(entry, TestrailPlanEntry)
-        new_plan.entries[i].runs.each_with_index { |run, j| new_plan.entries[i].runs[j] = HashHelper.parse_to_class_variable(run, TestrailRun) }
+        new_plan.entries[i] = TestrailPlanEntry.new.init_from_hash(entry)
+        new_plan.entries[i].runs.each_with_index { |run, j| new_plan.entries[i].runs[j] = TestrailRun.new.init_from_hash(run) }
       end
       @plans_names[new_plan.name] = new_plan.id
       new_plan

data/lib/onlyoffice_testrail_wrapper/testrail_project/testrail_project_runs_methods.rb

@@ -20,7 +20,7 @@ module OnlyofficeTestrailWrapper
       get_url = "index.php?/api/v2/get_runs/#{@id}"
       filters.each { |key, value| get_url += "&#{key}=#{value}" }
       runs = Testrail2.http_get(get_url)
-      @runs_names = HashHelper.get_hash_from_array_with_two_parameters(runs, 'name', 'id') if @runs_names.empty?
+      @runs_names = name_id_pairs(runs) if @runs_names.empty?
       runs
     end
 
@@ -31,7 +31,7 @@ module OnlyofficeTestrailWrapper
       get_url = "index.php?/api/v2/get_runs/#{@id}"
       filters.each { |key, value| get_url += "&#{key}=#{value}" }
       runs = Testrail2.http_get(get_url)
-      runs.map { |suite| HashHelper.parse_to_class_variable(suite, TestrailRun) }
+      runs.map { |suite| TestrailRun.new.init_from_hash(suite) }
     end
 
     extend Gem::Deprecate
@@ -46,9 +46,9 @@ module OnlyofficeTestrailWrapper
     end
 
     def get_run_by_id(id)
-      run = HashHelper.parse_to_class_variable(Testrail2.http_get("index.php?/api/v2/get_run/#{id}"), TestrailRun)
+      run = TestrailRun.new.init_from_hash(Testrail2.http_get("index.php?/api/v2/get_run/#{id}"))
       OnlyofficeLoggerHelper.log("Initialized run: #{run.name}")
-      run.instance_variable_set('@project', self)
+      run.instance_variable_set(:@project, self)
       run
     end
 
@@ -59,9 +59,12 @@ module OnlyofficeTestrailWrapper
     end
 
     def create_new_run(name, suite_id, description = '')
-      new_run = HashHelper.parse_to_class_variable(Testrail2.http_post("index.php?/api/v2/add_run/#{@id}", name: StringHelper.warnstrip!(name), description: description, suite_id: suite_id), TestrailRun)
+      new_run = TestrailRun.new.init_from_hash(Testrail2.http_post("index.php?/api/v2/add_run/#{@id}",
+                                                                   name: StringHelper.warnstrip!(name),
+                                                                   description: description,
+                                                                   suite_id: suite_id))
       OnlyofficeLoggerHelper.log "Created new run: #{new_run.name}"
-      new_run.instance_variable_set('@project', self)
+      new_run.instance_variable_set(:@project, self)
       @runs_names[new_run.name] = new_run.id
       new_run
     end

data/lib/onlyoffice_testrail_wrapper/testrail_project/testrail_project_suite_methods.rb

@@ -5,7 +5,7 @@ module OnlyofficeTestrailWrapper
   module TestrailProjectSuiteMethods
     def suite(name_or_id)
       case name_or_id.class.to_s
-      when 'Fixnum'
+      when 'Fixnum', 'Integer'
         get_suite_by_id name_or_id
       when 'String'
         init_suite_by_name name_or_id
@@ -18,7 +18,7 @@ module OnlyofficeTestrailWrapper
     # @return [Array<Hash>] array with suites data in hash
     def get_suites
       suites = Testrail2.http_get("index.php?/api/v2/get_suites/#{@id}")
-      @suites_names = HashHelper.get_hash_from_array_with_two_parameters(suites, 'name', 'id') if @suites_names.empty?
+      @suites_names = name_id_pairs(suites) if @suites_names.empty?
       suites
     end
 
@@ -29,7 +29,7 @@ module OnlyofficeTestrailWrapper
     # @return [Array<TestrailSuite>] array with TestRailSuite
     def suites
       suites = Testrail2.http_get("index.php?/api/v2/get_suites/#{@id}")
-      suites.map { |suite| HashHelper.parse_to_class_variable(suite, TestrailSuite) }
+      suites.map { |suite| TestrailSuite.new.init_from_hash(suite) }
     end
 
     # Get Test Suite by it's name
@@ -41,8 +41,8 @@ module OnlyofficeTestrailWrapper
     end
 
     def get_suite_by_id(id)
-      suite = HashHelper.parse_to_class_variable(Testrail2.http_get("index.php?/api/v2/get_suite/#{id}"), TestrailSuite)
-      suite.instance_variable_set('@project', self)
+      suite = TestrailSuite.new.init_from_hash(Testrail2.http_get("index.php?/api/v2/get_suite/#{id}"))
+      suite.instance_variable_set(:@project, self)
       OnlyofficeLoggerHelper.log("Initialized suite: #{suite.name}")
       suite
     end
@@ -60,8 +60,10 @@ module OnlyofficeTestrailWrapper
     # @param [String] description description of suite
     # @return [TestrailSuite] created suite
     def create_new_suite(name, description = '')
-      new_suite = HashHelper.parse_to_class_variable(Testrail2.http_post("index.php?/api/v2/add_suite/#{@id}", name: StringHelper.warnstrip!(name), description: description), TestrailSuite)
-      new_suite.instance_variable_set('@project', self)
+      new_suite = TestrailSuite.new.init_from_hash(Testrail2.http_post("index.php?/api/v2/add_suite/#{@id}",
+                                                                       name: StringHelper.warnstrip!(name),
+                                                                       description: description))
+      new_suite.instance_variable_set(:@project, self)
       OnlyofficeLoggerHelper.log "Created new suite: #{new_suite.name}"
       @suites_names[new_suite.name] = new_suite.id
       new_suite

data/lib/onlyoffice_testrail_wrapper/testrail_project.rb

@@ -13,7 +13,7 @@ require_relative 'testrail_project/testrail_project_suite_methods'
 module OnlyofficeTestrailWrapper
   # @author Roman.Zagudaev
   # Class for working with Test Projects
-  class TestrailProject
+  class TestrailProject < TestrailApiObject
     include ProjectCleanup
     include TestrailProjectMilestoneMethods
     include TestrailProjectPlanHelper
@@ -49,6 +49,7 @@ module OnlyofficeTestrailWrapper
     # @param is_completed [true, false] is project completed, default = nil
     # @return [TestRunTestRail] new Test run
     def initialize(name = '', announcement = nil, show_announcement = true, is_completed = false, id = nil)
+      super()
       @id = id.to_i
       @name = name
       @announcement = announcement
@@ -61,10 +62,11 @@ module OnlyofficeTestrailWrapper
     end
 
     def update(is_completed = false, name = @name, announcement = @announcement, show_announcement = @show_announcement)
-      @testrail.projects_names.delete[@name]
-      @testrail.projects_names[StringHelper.warnstrip!(name.to_s)] = @id
-      updated_project = HashHelper.parse_to_class_variable(Testrail2.http_post("index.php?/api/v2/update_project/#{@id}", name: name, announcement: announcement,
-                                                                                                                          show_announcement: show_announcement, is_completed: is_completed), TestrailProject)
+      updated_project = TestrailProject.new.init_from_hash(Testrail2.http_post("index.php?/api/v2/update_project/#{@id}",
+                                                                               name: name,
+                                                                               announcement: announcement,
+                                                                               show_announcement: show_announcement,
+                                                                               is_completed: is_completed))
       OnlyofficeLoggerHelper.log "Updated project: #{updated_project.name}"
       updated_project
     end
@@ -72,7 +74,6 @@ module OnlyofficeTestrailWrapper
     def delete
       Testrail2.http_post "index.php?/api/v2/delete_project/#{@id}", {}
       OnlyofficeLoggerHelper.log "Deleted project: #{@name}"
-      @testrail.projects_names.delete @name
     end
   end
 end

data/lib/onlyoffice_testrail_wrapper/testrail_result.rb

@@ -3,7 +3,7 @@
 module OnlyofficeTestrailWrapper
   # @author Roman.Zagudaev
   # Class for working with Test results
-  class TestrailResult
+  class TestrailResult < TestrailApiObject
     RESULT_STATUSES = { passed: 1, blocked: 2, untested: 3, retest: 4, failed: 5, passed_2: 6, work_for_me: 7,
                         pending: 8, aborted: 9, js_error: 10, lpv: 11, service_unavailable: 12 }.freeze
     # @return [Integer] Id of test result
@@ -28,6 +28,7 @@ module OnlyofficeTestrailWrapper
     # @param [String] version Version
     # @return [TestResultTestRail] new Test result
     def initialize(status = nil, comment = nil, version = nil)
+      super()
       @title = status.to_s
       @status_id = RESULT_STATUSES[status]
       @comment = comment

data/lib/onlyoffice_testrail_wrapper/testrail_run.rb

@@ -5,7 +5,7 @@ require_relative 'testrail_test'
 module OnlyofficeTestrailWrapper
   # @author Roman.Zagudaev
   # Class for working with TestRun in TestRail
-  class TestrailRun
+  class TestrailRun < TestrailApiObject
     # @return [String] Name of test Run
     attr_accessor :name
     # @return [Integer] Id of test run
@@ -49,6 +49,7 @@ module OnlyofficeTestrailWrapper
     # @param [Hash] params all other params
     # @return [TestRunTestRail] new Test run
     def initialize(name = '', description = '', suite_id = nil, id = nil, params = {})
+      super()
       @id = id
       @name = name
       @description = description
@@ -71,7 +72,7 @@ module OnlyofficeTestrailWrapper
 
     def close
       OnlyofficeLoggerHelper.log("Starting to send command to close run: #{@name}")
-      test_run = HashHelper.parse_to_class_variable(Testrail2.http_post("index.php?/api/v2/close_run/#{@id}", {}), TestrailRun)
+      test_run = TestrailRun.new.init_from_hash(Testrail2.http_post("index.php?/api/v2/close_run/#{@id}", {}))
       OnlyofficeLoggerHelper.log("Run is closed: #{@name}")
       test_run
     end
@@ -88,14 +89,14 @@ module OnlyofficeTestrailWrapper
     end
 
     def get_test_by_id(id)
-      HashHelper.parse_to_class_variable(Testrail2.http_get("index.php?/api/v2/get_test/#{id}"), TestrailTest)
+      TestrailTest.new.init_from_hash(Testrail2.http_get("index.php?/api/v2/get_test/#{id}"))
     end
 
     # Get all tests
     # @return [Array, TestCaseTestrail] array of test cases
     def get_tests
       tests = Testrail2.http_get "index.php?/api/v2/get_tests/#{@id}"
-      @tests_names = HashHelper.get_hash_from_array_with_two_parameters(tests, 'title', 'id') if @tests_names.empty?
+      @tests_names = name_id_pairs(tests, 'title') if @tests_names.empty?
       tests
     end
 
@@ -105,8 +106,10 @@ module OnlyofficeTestrailWrapper
     end
 
     def add_result_by_case_id(result, case_id, comment = '', version = '')
-      HashHelper.parse_to_class_variable(Testrail2.http_post("index.php?/api/v2/add_result_for_case/#{@id}/#{case_id}",
-                                                             status_id: TestrailResult[result], comment: comment, version: version), TestrailResult)
+      TestrailResult.new.init_from_hash(Testrail2.http_post("index.php?/api/v2/add_result_for_case/#{@id}/#{case_id}",
+                                                            status_id: TestrailResult[result],
+                                                            comment: comment,
+                                                            version: version))
     end
 
     def parent_suite
@@ -116,7 +119,9 @@ module OnlyofficeTestrailWrapper
     def update(name = @name, description = @description)
       @project.runs_names.delete @name
       @project.runs_names[StringHelper.warnstrip!(name.to_s)] = @id
-      updated_plan = HashHelper.parse_to_class_variable(Testrail2.http_post("index.php?/api/v2/update_run/#{@id}", name: name, description: description), TestrailRun)
+      updated_plan = TestrailRun.new.init_from_hash(Testrail2.http_post("index.php?/api/v2/update_run/#{@id}",
+                                                                        name: name,
+                                                                        description: description))
       OnlyofficeLoggerHelper.log "Updated run: #{updated_plan.name}"
       updated_plan
     end

data/lib/onlyoffice_testrail_wrapper/testrail_section.rb

@@ -5,7 +5,7 @@ require_relative 'testrail_case'
 module OnlyofficeTestrailWrapper
   # @author Roman.Zagudaev
   # Class for description of test sections
-  class TestrailSection
+  class TestrailSection < TestrailApiObject
     # @return [Integer] Id of test section
     attr_accessor :id
     # @return [Integer] Id of parent test section
@@ -24,6 +24,7 @@ module OnlyofficeTestrailWrapper
     # @param [Integer] suite_id id of test suite
     # @return [TestSectionTestRail] new Test section
     def initialize(name = '', parent_id = nil, suite_id = nil, id = nil)
+      super()
       @id = id
       @name = name
       @suite_id = suite_id
@@ -46,8 +47,8 @@ module OnlyofficeTestrailWrapper
     end
 
     def get_case_by_id(id)
-      test_case = HashHelper.parse_to_class_variable(Testrail2.http_get("index.php?/api/v2/get_case/#{id}"), TestrailCase)
-      test_case.instance_variable_set '@section', self
+      test_case = TestrailCase.new.init_from_hash(Testrail2.http_get("index.php?/api/v2/get_case/#{id}"))
+      test_case.instance_variable_set :@section, self
       test_case
     end
 
@@ -56,7 +57,7 @@ module OnlyofficeTestrailWrapper
     def get_cases
       # raise 'Project id is not identified' if @project_id.nil?
       cases = Testrail2.http_get("index.php?/api/v2/get_cases/#{@project_id}&suite_id=#{@suite_id}&section_id=#{@id}")
-      @cases_names = HashHelper.get_hash_from_array_with_two_parameters(cases, 'title', 'id') if @cases_names.nil?
+      @cases_names = name_id_pairs(cases, 'title') if @cases_names.nil?
       cases
     end
 
@@ -83,9 +84,12 @@ module OnlyofficeTestrailWrapper
     # @param [String] custom_steps steps to perform
     # @return [TestCaseTestrail] created test case
     def create_new_case(title, type_id = 3, priority_id = 4, custom_steps = '')
-      new_case = HashHelper.parse_to_class_variable(Testrail2.http_post("index.php?/api/v2/add_case/#{@id}", title: StringHelper.warnstrip!(title.to_s), type_id: type_id,
-                                                                                                             priority_id: priority_id, custom_steps: custom_steps), TestrailCase)
-      new_case.instance_variable_set('@section', self)
+      new_case = TestrailCase.new.init_from_hash(Testrail2.http_post("index.php?/api/v2/add_case/#{@id}",
+                                                                     title: StringHelper.warnstrip!(title.to_s),
+                                                                     type_id: type_id,
+                                                                     priority_id: priority_id,
+                                                                     custom_steps: custom_steps))
+      new_case.instance_variable_set(:@section, self)
       OnlyofficeLoggerHelper.log "Created new case: #{new_case.title}"
       @cases_names[new_case.title] = new_case.id
       new_case
@@ -94,7 +98,9 @@ module OnlyofficeTestrailWrapper
     def update(name = @name, parent_id = @parent_id)
       @suite.sections_names.delete @name
       @suite.sections_names[StringHelper.warnstrip!(name.to_s)] = @id
-      updated_section = HashHelper.parse_to_class_variable(Testrail2.http_post("index.php?/api/v2/update_section/#{@id}", name: name, parent_id: parent_id), TestrailSection)
+      updated_section = TestrailSection.new.init_from_hash(Testrail2.http_post("index.php?/api/v2/update_section/#{@id}",
+                                                                               name: name,
+                                                                               parent_id: parent_id))
       OnlyofficeLoggerHelper.log "Updated section: #{updated_section.name}"
       updated_section
     end

data/lib/onlyoffice_testrail_wrapper/testrail_suite.rb

@@ -7,7 +7,7 @@ require_relative 'testrail_run'
 module OnlyofficeTestrailWrapper
   # @author Roman.Zagudaev
   # Class for description of test suites
-  class TestrailSuite
+  class TestrailSuite < TestrailApiObject
     # @return [Integer] Id of test suite
     attr_accessor :id
     # @return [String] Name of test suite
@@ -28,6 +28,7 @@ module OnlyofficeTestrailWrapper
     # @param [Integer] project_id id of project of test suite
     # @return [TestrailSuite] new Test suite
     def initialize(name = nil, description = nil, project_id = nil, id = nil)
+      super()
       @id = id
       @name = name
       @description = description
@@ -39,7 +40,10 @@ module OnlyofficeTestrailWrapper
     # @param [String] description description of test run
     # @return [TestRunTestRail] created test run
     def start_test_run(name, description = '')
-      HashHelper.parse_to_class_variable(Testrail2.http_post("index.php?/api/v2/add_run/#{@project_id}", name: StringHelper.warnstrip!(name.to_s), description: description, suite_id: @id), TestrailRun)
+      TestrailRun.new.init_from_hash(Testrail2.http_post("index.php?/api/v2/add_run/#{@project_id}",
+                                                         name: StringHelper.warnstrip!(name.to_s),
+                                                         description: description,
+                                                         suite_id: @id))
     end
 
     def section(name_or_id = 'All Test Cases')
@@ -58,12 +62,14 @@ module OnlyofficeTestrailWrapper
     # @param [Integer] parent_section id of parent section, default = nil
     def create_new_section(name, parent_section = nil)
       parent_section = get_section_by_name(parent_section).id if parent_section.is_a?(String)
-      new_section = HashHelper.parse_to_class_variable(Testrail2.http_post("index.php?/api/v2/add_section/#{@project_id}", name: StringHelper.warnstrip!(name.to_s),
-                                                                                                                           parent_id: parent_section, suite_id: @id), TestrailSection)
+      new_section = TestrailSection.new.init_from_hash(Testrail2.http_post("index.php?/api/v2/add_section/#{@project_id}",
+                                                                           name: StringHelper.warnstrip!(name.to_s),
+                                                                           parent_id: parent_section,
+                                                                           suite_id: @id))
       OnlyofficeLoggerHelper.log "Created new section: #{new_section.name}"
       @sections_names[new_section.name] = new_section.id
-      new_section.instance_variable_set '@project_id', @project_id
-      new_section.instance_variable_set '@suite', self
+      new_section.instance_variable_set :@project_id, @project_id
+      new_section.instance_variable_set :@suite, self
       new_section
     end
 
@@ -71,14 +77,14 @@ module OnlyofficeTestrailWrapper
     # @return [Array, TestrailSuite] array with sections
     def get_sections
       sections = Testrail2.http_get("index.php?/api/v2/get_sections/#{@project_id}&suite_id=#{@id}")
-      @sections_names = HashHelper.get_hash_from_array_with_two_parameters(sections, 'name', 'id') if @sections_names.nil?
+      @sections_names = name_id_pairs(sections) if @sections_names.nil?
       sections
     end
 
     def get_section_by_id(id)
-      section = HashHelper.parse_to_class_variable(Testrail2.http_get("index.php?/api/v2/get_section/#{id}"), TestrailSection)
-      section.instance_variable_set '@project_id', @project_id
-      section.instance_variable_set '@suite', self
+      section = TestrailSection.new.init_from_hash(Testrail2.http_get("index.php?/api/v2/get_section/#{id}"))
+      section.instance_variable_set :@project_id, @project_id
+      section.instance_variable_set :@suite, self
       section
     end
 
@@ -107,7 +113,9 @@ module OnlyofficeTestrailWrapper
     def update(name, description = nil)
       @project.suites_names.delete @name
       @project.suites_names[StringHelper.warnstrip!(name.to_s)] = @id
-      updated_suite = HashHelper.parse_to_class_variable(Testrail2.http_post("index.php?/api/v2/update_suite/#{@id}", name: name, description: description), TestrailSuite)
+      updated_suite = TestrailSuite.new.init_from_hash(Testrail2.http_post("index.php?/api/v2/update_suite/#{@id}",
+                                                                           name: name,
+                                                                           description: description))
       OnlyofficeLoggerHelper.log "Updated suite: #{updated_suite.name}"
       updated_suite
     end

data/lib/onlyoffice_testrail_wrapper/testrail_test.rb

@@ -3,7 +3,8 @@
 require_relative 'testrail_result'
 
 module OnlyofficeTestrailWrapper
-  class TestrailTest
+  # Class for working with single testrail case
+  class TestrailTest < TestrailApiObject
     # @return [Integer] test id
     attr_accessor :id
     # @return [Integer] test run id
@@ -18,23 +19,34 @@ module OnlyofficeTestrailWrapper
     attr_accessor :assignedto_id
 
     def initialize(id = nil, run_id = nil, case_id = nil, title = '')
+      super()
       @id = id
       @title = title
       @case_id = case_id
       @run_id = run_id
     end
 
+    # Get all results of single test
+    # @return [Array<TestrailResult>] list of results
     def get_results
       @results.nil? ? @results = Testrail2.http_get("index.php?/api/v2/get_results/#{@id}") : (return @results)
-      @results.each_with_index { |result, index| @results[index] = HashHelper.parse_to_class_variable(result, TestrailResult) }
+      @results.each_with_index { |result, index| @results[index] = TestrailResult.new.init_from_hash(result) }
       @results
     end
 
-    def add_result(result, comment = '', version = '')
-      result = TestrailResult::RESULT_STATUSES[result] if result.is_a?(Symbol)
-      HashHelper.parse_to_class_variable(Testrail2.http_post("index.php?/api/v2/add_result/#{@id}", status_id: result,
-                                                                                                    comment: comment, version: version), TestrailResult)
-      OnlyofficeLoggerHelper.log "Set test result: #{result}"
+    # Add result to current Test
+    # @param [Integer, Symbol] status of result
+    # @param [String] comment of result
+    # @param [String] version of result
+    # @return [TestrailResult] result of adding
+    def add_result(status, comment = '', version = '')
+      status = TestrailResult::RESULT_STATUSES[status] if status.is_a?(Symbol)
+      result = TestrailResult.new.init_from_hash(Testrail2.http_post("index.php?/api/v2/add_result/#{@id}",
+                                                                     status_id: status,
+                                                                     comment: comment,
+                                                                     version: version))
+      OnlyofficeLoggerHelper.log "Set test result: #{status}"
+      result
     end
   end
 end

data/lib/onlyoffice_testrail_wrapper/testrail_tools/testrail_tools.rb

@@ -15,7 +15,9 @@ require_relative '../testrail'
 #  TestrailTools.close_all_runs
 #
 module OnlyofficeTestrailWrapper
+  # Module for Tools for Testrail
   module TestrailTools
+    # Class for Testrail configuration
     class TestrailConfig
       attr_accessor :project, :plan, :suite, :run
     end
@@ -56,7 +58,7 @@ module OnlyofficeTestrailWrapper
 
     def self.get_tests_report(status)
       check_config(__method__, :@project, :@plan)
-      { plan.name => plan.entries.inject({}) { |a, e| a.merge!({ e.name => e.runs.first.get_tests.map { |test| test['title'] if TestrailResult::RESULT_STATUSES.key(test['status_id']) == status }.compact }.delete_if { |_, value| value.empty? }) } }
+      { plan.name => plan.entries.inject({}) { |a, e| a.merge!({ e.name => e.runs.first.get_tests.filter_map { |test| test['title'] if TestrailResult::RESULT_STATUSES.key(test['status_id']) == status } }.delete_if { |_, value| value.empty? }) } }
     end
 
     def self.get_runs_durations
@@ -84,7 +86,7 @@ module OnlyofficeTestrailWrapper
     end
 
     def self.check_config(*args)
-      return if @testrail_config && (@testrail_config.instance_variables & args[1..-1]) == args[1..-1]
+      return if @testrail_config && (@testrail_config.instance_variables & args[1..]) == args[1..]
 
       raise "Method: #{args.shift} - some of needed parameters are missing: #{args.join(', ')}. To configure them, type:\n
              TestrailTools.configure do |config|\n\t\tconfig.param_name = value\n\tend"

data/lib/onlyoffice_testrail_wrapper/version.rb

@@ -2,6 +2,6 @@
 
 module OnlyofficeTestrailWrapper
   module Version
-    STRING = '0.2.0'
+    STRING = '0.4.0'
   end
 end