Class: Testrail::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/testrail/client.rb

Constant Summary collapse

COMMANDS =

COMMANDS.each do |method_name|

define_method method_name

end

%w[add_result
add_result_for_case
get_results
get_results_for_case
get_test
get_tests
get_case
get_cases
add_case
update_case
delete_case
get_suite
get_suites
get_section
get_sections
add_suite
add_section
get_run
get_runs
add_run
close_run
get_plan
get_plans
add_plan
add_plan_entries
close_plan
get_milestone
get_milestones
add_milestone
get_project
get_projects]

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Client

Returns a new instance of Client.



6
7
8
 
# File 'lib/testrail/client.rb', line 6

def initialize
  @request = Testrail::Request
end

Instance Attribute Details

#request ⇒ Object (readonly)

Returns the value of attribute request.



4
5
6
 
# File 'lib/testrail/client.rb', line 4

def request
  @request
end

Instance Method Details

#add_case(section_id, opts = {}) ⇒ Object 



45
46
47
 
# File 'lib/testrail/client.rb', line 45

def add_case(section_id, opts = {})
  request.post(__method__, section_id, opts)
end

#add_milestone(project_id, opts = {}) ⇒ Object 



158
159
160
 
# File 'lib/testrail/client.rb', line 158

def add_milestone(project_id, opts = {})
  request.post(__method__, project_id, opts)
end

#add_plan(project_id, opts = {}) ⇒ Object 



133
134
135
 
# File 'lib/testrail/client.rb', line 133

def add_plan(project_id, opts = {})
  request.post(__method__, project_id, opts)
end

#add_plan_entry(plan_id, opts = {}) ⇒ Object 



137
138
139
 
# File 'lib/testrail/client.rb', line 137

def add_plan_entry(plan_id, opts = {})
  request.post(__method__, plan_id, opts)
end

#add_result(test_id, opts = {}) ⇒ Object

Test Results - see docs.gurock.com/testrail-api/reference-results



11
12
13
 
# File 'lib/testrail/client.rb', line 11

def add_result(test_id, opts = {})
  request.post(__method__, test_id, opts)
end

#add_result_for_case(run_id, case_id, opts = {}) ⇒ Object 



15
16
17
 
# File 'lib/testrail/client.rb', line 15

def add_result_for_case(run_id, case_id, opts = {})
  request.post(__method__, [run_id, case_id], opts)
end

#add_run(project_id, opts = {}) ⇒ Object 



108
109
110
 
# File 'lib/testrail/client.rb', line 108

def add_run(project_id, opts = {})
  request.post(__method__, project_id, opts)
end

#add_section(project_id, opts = {}) ⇒ Object 



87
88
89
 
# File 'lib/testrail/client.rb', line 87

def add_section(project_id, opts = {})
  request.post(__method__, project_id, opts)
end

#add_suite(project_id, opts = {}) ⇒ Object 



66
67
68
 
# File 'lib/testrail/client.rb', line 66

def add_suite(project_id, opts = {})
  request.post(__method__, project_id, opts)
end

#close_plan(plan_id, opts = {}) ⇒ Object 



145
146
147
 
# File 'lib/testrail/client.rb', line 145

def close_plan(plan_id, opts = {})
  request.post(__method__, plan_id, opts)
end

#close_run(run_id, opts = {}) ⇒ Object 



116
117
118
 
# File 'lib/testrail/client.rb', line 116

def close_run(run_id, opts = {})
  request.post(__method__, run_id, opts)
end

#delete_case(case_id, opts = {}) ⇒ Object 



53
54
55
 
# File 'lib/testrail/client.rb', line 53

def delete_case(case_id, opts = {})
  request.post(__method__, case_id, opts)
end

#delete_run(run_id, opts = {}) ⇒ Object 



120
121
122
 
# File 'lib/testrail/client.rb', line 120

def delete_run(run_id, opts = {})
  request.post(__method__, run_id, opts)
end

#delete_section(section_id, opts = {}) ⇒ Object 



95
96
97
 
# File 'lib/testrail/client.rb', line 95

def delete_section(section_id, opts = {})
  request.get(__method__, section_id, opts)
end

#delete_suite(suite_id, opts = {}) ⇒ Object 



74
75
76
 
# File 'lib/testrail/client.rb', line 74

def delete_suite(suite_id, opts = {})
  request.post(__method__, suite_id, opts)
end

#get_case(case_id, opts = {}) ⇒ Object

Test Cases - see docs.gurock.com/testrail-api/reference-cases



37
38
39
 
# File 'lib/testrail/client.rb', line 37

def get_case(case_id, opts = {})
  request.get(__method__, case_id, opts)
end

#get_cases(project_id, suite_id, section_id, opts = {}) ⇒ Object 



41
42
43
 
# File 'lib/testrail/client.rb', line 41

def get_cases(project_id, suite_id, section_id, opts = {})
  request.get(__method__, project_id, suite_id, section_id, opts)
end

#get_milestone(milestone_id, opts = {}) ⇒ Object

Milestones - see docs.gurock.com/testrail-api/reference-milestones



150
151
152
 
# File 'lib/testrail/client.rb', line 150

def get_milestone(milestone_id, opts = {})
  request.get(__method__, milestone_id, opts)
end

#get_milestones(project_id, opts = {}) ⇒ Object 



154
155
156
 
# File 'lib/testrail/client.rb', line 154

def get_milestones(project_id, opts = {})
  request.get(__method__, project_id, opts)
end

#get_plan(plan_id, opts = {}) ⇒ Object

Test Plans - see docs.gurock.com/testrail-api/reference-plans



125
126
127
 
# File 'lib/testrail/client.rb', line 125

def get_plan(plan_id, opts = {})
  request.get(__method__, plan_id, opts)
end

#get_plans(project_id, opts = {}) ⇒ Object 



129
130
131
 
# File 'lib/testrail/client.rb', line 129

def get_plans(project_id, opts = {})
  request.get(__method__, project_id, opts)
end

#get_project(project_id, opts = {}) ⇒ Object

Projects - see docs.gurock.com/testrail-api/reference-projects



163
164
165
 
# File 'lib/testrail/client.rb', line 163

def get_project(project_id, opts = {})
  request.get(__method__, project_id, opts)
end

#get_projects(opts = {}) ⇒ Object 



167
168
169
 
# File 'lib/testrail/client.rb', line 167

def get_projects(opts = {})
  request.get(__method__, opts)
end

#get_results(test_id, limit, opts = {}) ⇒ Object 



19
20
21
 
# File 'lib/testrail/client.rb', line 19

def get_results(test_id, limit, opts = {})
  request.get(__method__, test_id, limit, opts)
end

#get_results_for_case(run_id, case_id, limit, opts = {}) ⇒ Object 



23
24
25
 
# File 'lib/testrail/client.rb', line 23

def get_results_for_case(run_id, case_id, limit, opts = {})
  request.get(__method__, [run_id, case_id], limit, opts)
end

#get_run(run_id, opts = {}) ⇒ Object

Test Runs - see docs.gurock.com/testrail-api/reference-runs



100
101
102
 
# File 'lib/testrail/client.rb', line 100

def get_run(run_id, opts = {})
  request.get(__method__, run_id, opts)
end

#get_runs(project_id, opts = {}) ⇒ Object 



104
105
106
 
# File 'lib/testrail/client.rb', line 104

def get_runs(project_id, opts = {})
  request.get(__method__, project_id, opts)
end

#get_section(section_id, opts = {}) ⇒ Object

Sections



79
80
81
 
# File 'lib/testrail/client.rb', line 79

def get_section(section_id, opts = {})
  request.get(__method__, section_id, opts)
end

#get_sections(project_id, suite_id, opts = {}) ⇒ Object 



83
84
85
 
# File 'lib/testrail/client.rb', line 83

def get_sections(project_id, suite_id, opts = {})
  request.get(__method__, project_id, suite_id, opts)
end

#get_statuses(opts = {}) ⇒ Object

Statuses



172
173
174
 
# File 'lib/testrail/client.rb', line 172

def get_statuses(opts = {})
  request.get(__method__, opts)
end

#get_suite(suite_id, opts = {}) ⇒ Object

Suites - see docs.gurock.com/testrail-api/reference-suites



58
59
60
 
# File 'lib/testrail/client.rb', line 58

def get_suite(suite_id, opts = {})
  request.get(__method__, suite_id, opts)
end

#get_suites(project_id, opts = {}) ⇒ Object 



62
63
64
 
# File 'lib/testrail/client.rb', line 62

def get_suites(project_id, opts = {})
  request.get(__method__, project_id, opts)
end

#get_test(test_id, opts = {}) ⇒ Object

Test - see docs.gurock.com/testrail-api/reference-tests



28
29
30
 
# File 'lib/testrail/client.rb', line 28

def get_test(test_id, opts = {})
  request.get(__method__, test_id, opts)
end

#get_tests(run_id, opts = {}) ⇒ Object 



32
33
34
 
# File 'lib/testrail/client.rb', line 32

def get_tests(run_id, opts = {})
  request.get(__method__, run_id, opts)
end

#update_case(case_id, opts = {}) ⇒ Object 



49
50
51
 
# File 'lib/testrail/client.rb', line 49

def update_case(case_id, opts = {})
  request.post(__method__, case_id, opts)
end

#update_plan(plan_id, opts = {}) ⇒ Object 



141
142
143
 
# File 'lib/testrail/client.rb', line 141

def update_plan(plan_id, opts = {})
  request.post(__method__, plan_id, opts)
end

#update_run(run_id, opts = {}) ⇒ Object 



112
113
114
 
# File 'lib/testrail/client.rb', line 112

def update_run(run_id, opts = {})
  request.post(__method__, run_id, opts)
end

#update_section(section_id, opts = {}) ⇒ Object 



91
92
93
 
# File 'lib/testrail/client.rb', line 91

def update_section(section_id, opts = {})
  request.get(__method__, section_id, opts)
end

#update_suite(suite_id, opts = {}) ⇒ Object 



70
71
72
 
# File 'lib/testrail/client.rb', line 70

def update_suite(suite_id, opts = {})
  request.post(__method__, suite_id, opts)
end