test_rail_integration 0.0.5.3 → 0.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/doc/Gemfile.html +93 -0
- data/doc/Gemfile_lock.html +109 -0
- data/doc/LICENSE_txt.html +109 -0
- data/doc/README_md.html +150 -0
- data/doc/Rakefile.html +91 -0
- data/doc/TestRail/APIClient.html +295 -0
- data/doc/TestRail/APIError.html +102 -0
- data/doc/TestRail/Connection.html +490 -0
- data/doc/TestRail/Generators.html +95 -0
- data/doc/TestRail/Hook.html +274 -0
- data/doc/TestRail/TestCaseResult.html +265 -0
- data/doc/TestRail/TestRailDataLoad.html +153 -0
- data/doc/TestRail/TestRailTools.html +242 -0
- data/doc/TestRail/TestRunParameters.html +194 -0
- data/doc/TestRail.html +95 -0
- data/doc/TestRailIntegration/CLI.html +154 -0
- data/doc/TestRailIntegration/TestTail/Generators/Project.html +241 -0
- data/doc/TestRailIntegration/TestTail/Generators.html +95 -0
- data/doc/TestRailIntegration/TestTail.html +95 -0
- data/doc/TestRailIntegration.html +109 -0
- data/doc/bin/test_rail_integration.html +54 -0
- data/doc/created.rid +22 -0
- data/doc/css/fonts.css +167 -0
- data/doc/css/rdoc.css +590 -0
- data/doc/fonts/Lato-Light.ttf +0 -0
- data/doc/fonts/Lato-LightItalic.ttf +0 -0
- data/doc/fonts/Lato-Regular.ttf +0 -0
- data/doc/fonts/Lato-RegularItalic.ttf +0 -0
- data/doc/fonts/SourceCodePro-Bold.ttf +0 -0
- data/doc/fonts/SourceCodePro-Regular.ttf +0 -0
- data/doc/images/add.png +0 -0
- data/doc/images/arrow_up.png +0 -0
- data/doc/images/brick.png +0 -0
- data/doc/images/brick_link.png +0 -0
- data/doc/images/bug.png +0 -0
- data/doc/images/bullet_black.png +0 -0
- data/doc/images/bullet_toggle_minus.png +0 -0
- data/doc/images/bullet_toggle_plus.png +0 -0
- data/doc/images/date.png +0 -0
- data/doc/images/delete.png +0 -0
- data/doc/images/find.png +0 -0
- data/doc/images/loadingAnimation.gif +0 -0
- data/doc/images/macFFBgHack.png +0 -0
- data/doc/images/package.png +0 -0
- data/doc/images/page_green.png +0 -0
- data/doc/images/page_white_text.png +0 -0
- data/doc/images/page_white_width.png +0 -0
- data/doc/images/plugin.png +0 -0
- data/doc/images/ruby.png +0 -0
- data/doc/images/tag_blue.png +0 -0
- data/doc/images/tag_green.png +0 -0
- data/doc/images/transparent.png +0 -0
- data/doc/images/wrench.png +0 -0
- data/doc/images/wrench_orange.png +0 -0
- data/doc/images/zoom.png +0 -0
- data/doc/index.html +125 -0
- data/doc/js/darkfish.js +161 -0
- data/doc/js/jquery.js +4 -0
- data/doc/js/navigation.js +142 -0
- data/doc/js/navigation.js.gz +0 -0
- data/doc/js/quicksearch.js +114 -0
- data/doc/js/search.js +109 -0
- data/doc/js/search_index.js +1 -0
- data/doc/js/search_index.js.gz +0 -0
- data/doc/js/searcher.js +228 -0
- data/doc/js/searcher.js.gz +0 -0
- data/doc/js/thickbox-compressed.js +10 -0
- data/doc/lib/test_rail_integration/cli_rb.html +54 -0
- data/doc/lib/test_rail_integration/generator/API_client_rb.html +70 -0
- data/doc/lib/test_rail_integration/generator/connection_rb.html +52 -0
- data/doc/lib/test_rail_integration/generator/project/run_test_run_rb.html +54 -0
- data/doc/lib/test_rail_integration/generator/project_rb.html +56 -0
- data/doc/lib/test_rail_integration/generator/test_case_result_rb.html +52 -0
- data/doc/lib/test_rail_integration/generator/test_rail_hooks_rb.html +52 -0
- data/doc/lib/test_rail_integration/generator/test_rail_tools_rb.html +54 -0
- data/doc/lib/test_rail_integration/generator/test_run_parameters_rb.html +52 -0
- data/doc/lib/test_rail_integration/version_rb.html +52 -0
- data/doc/lib/test_rail_integration_rb.html +56 -0
- data/doc/rdoc.css +763 -0
- data/doc/table_of_contents.html +252 -0
- data/doc/test_rail_integration_gemspec.html +117 -0
- data/lib/test_rail_integration/generator/project/test_rail_data.yml +2 -2
- data/lib/test_rail_integration/generator/test_case_result.rb +1 -1
- data/lib/test_rail_integration/version.rb +1 -1
- metadata +83 -2
|
@@ -0,0 +1,295 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta charset="UTF-8">
|
|
6
|
+
|
|
7
|
+
<title>class TestRail::APIClient - RDoc Documentation</title>
|
|
8
|
+
|
|
9
|
+
<script type="text/javascript">
|
|
10
|
+
var rdoc_rel_prefix = "../";
|
|
11
|
+
</script>
|
|
12
|
+
|
|
13
|
+
<script src="../js/jquery.js"></script>
|
|
14
|
+
<script src="../js/darkfish.js"></script>
|
|
15
|
+
|
|
16
|
+
<link href="../css/fonts.css" rel="stylesheet">
|
|
17
|
+
<link href="../css/rdoc.css" rel="stylesheet">
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
<body id="top" role="document" class="class">
|
|
22
|
+
<nav role="navigation">
|
|
23
|
+
<div id="project-navigation">
|
|
24
|
+
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
|
25
|
+
<h2>
|
|
26
|
+
<a href="../index.html" rel="home">Home</a>
|
|
27
|
+
</h2>
|
|
28
|
+
|
|
29
|
+
<div id="table-of-contents-navigation">
|
|
30
|
+
<a href="../table_of_contents.html#pages">Pages</a>
|
|
31
|
+
<a href="../table_of_contents.html#classes">Classes</a>
|
|
32
|
+
<a href="../table_of_contents.html#methods">Methods</a>
|
|
33
|
+
</div>
|
|
34
|
+
</div>
|
|
35
|
+
|
|
36
|
+
<div id="search-section" role="search" class="project-section initially-hidden">
|
|
37
|
+
<form action="#" method="get" accept-charset="utf-8">
|
|
38
|
+
<div id="search-field-wrapper">
|
|
39
|
+
<input id="search-field" role="combobox" aria-label="Search"
|
|
40
|
+
aria-autocomplete="list" aria-controls="search-results"
|
|
41
|
+
type="text" name="search" placeholder="Search" spellcheck="false"
|
|
42
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
|
43
|
+
</div>
|
|
44
|
+
|
|
45
|
+
<ul id="search-results" aria-label="Search Results"
|
|
46
|
+
aria-busy="false" aria-expanded="false"
|
|
47
|
+
aria-atomic="false" class="initially-hidden"></ul>
|
|
48
|
+
</form>
|
|
49
|
+
</div>
|
|
50
|
+
|
|
51
|
+
</div>
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
<div id="class-metadata">
|
|
56
|
+
|
|
57
|
+
<div id="parent-class-section" class="nav-section">
|
|
58
|
+
<h3>Parent</h3>
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
<p class="link">Object
|
|
62
|
+
|
|
63
|
+
</div>
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
<!-- Method Quickref -->
|
|
68
|
+
<div id="method-list-section" class="nav-section">
|
|
69
|
+
<h3>Methods</h3>
|
|
70
|
+
|
|
71
|
+
<ul class="link-list" role="directory">
|
|
72
|
+
|
|
73
|
+
<li ><a href="#method-c-new">::new</a>
|
|
74
|
+
|
|
75
|
+
<li ><a href="#method-i-send_get">#send_get</a>
|
|
76
|
+
|
|
77
|
+
<li ><a href="#method-i-send_post">#send_post</a>
|
|
78
|
+
|
|
79
|
+
</ul>
|
|
80
|
+
</div>
|
|
81
|
+
|
|
82
|
+
</div>
|
|
83
|
+
</nav>
|
|
84
|
+
|
|
85
|
+
<main role="main" aria-labelledby="class-TestRail::APIClient">
|
|
86
|
+
<h1 id="class-TestRail::APIClient" class="class">
|
|
87
|
+
class TestRail::APIClient
|
|
88
|
+
</h1>
|
|
89
|
+
|
|
90
|
+
<section class="description">
|
|
91
|
+
|
|
92
|
+
</section>
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
<section class="attribute-method-details" class="method-section">
|
|
106
|
+
<header>
|
|
107
|
+
<h3>Attributes</h3>
|
|
108
|
+
</header>
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
<div id="attribute-i-password" class="method-detail">
|
|
112
|
+
<div class="method-heading attribute-method-heading">
|
|
113
|
+
<span class="method-name">password</span><span
|
|
114
|
+
class="attribute-access-type">[RW]</span>
|
|
115
|
+
</div>
|
|
116
|
+
|
|
117
|
+
<div class="method-description">
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
</div>
|
|
122
|
+
</div>
|
|
123
|
+
|
|
124
|
+
<div id="attribute-i-user" class="method-detail">
|
|
125
|
+
<div class="method-heading attribute-method-heading">
|
|
126
|
+
<span class="method-name">user</span><span
|
|
127
|
+
class="attribute-access-type">[RW]</span>
|
|
128
|
+
</div>
|
|
129
|
+
|
|
130
|
+
<div class="method-description">
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
</div>
|
|
135
|
+
</div>
|
|
136
|
+
|
|
137
|
+
</section>
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
|
142
|
+
<header>
|
|
143
|
+
<h3>Public Class Methods</h3>
|
|
144
|
+
</header>
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
<div id="method-c-new" class="method-detail ">
|
|
148
|
+
|
|
149
|
+
<div class="method-heading">
|
|
150
|
+
<span class="method-name">new</span><span
|
|
151
|
+
class="method-args">(connection_data)</span>
|
|
152
|
+
|
|
153
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
154
|
+
|
|
155
|
+
</div>
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
<div class="method-description">
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
<div class="method-source-code" id="new-source">
|
|
166
|
+
<pre><span class="ruby-comment"># File lib/test_rail_integration/generator/API_client.rb, line 24</span>
|
|
167
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">connection_data</span>)
|
|
168
|
+
<span class="ruby-identifier">base_url</span> = <span class="ruby-identifier">connection_data</span>[<span class="ruby-value">:url</span>]
|
|
169
|
+
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">base_url</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp">/\/$/</span>)
|
|
170
|
+
<span class="ruby-identifier">base_url</span> <span class="ruby-operator">+=</span> <span class="ruby-string">'/'</span>
|
|
171
|
+
<span class="ruby-keyword">end</span>
|
|
172
|
+
<span class="ruby-ivar">@url</span> = <span class="ruby-identifier">base_url</span> <span class="ruby-operator">+</span> <span class="ruby-string">'index.php?/api/v2/'</span>
|
|
173
|
+
<span class="ruby-ivar">@user</span> = <span class="ruby-identifier">connection_data</span>[<span class="ruby-value">:username</span>]
|
|
174
|
+
<span class="ruby-ivar">@password</span> = <span class="ruby-identifier">connection_data</span>[<span class="ruby-value">:password</span>]
|
|
175
|
+
<span class="ruby-keyword">end</span></pre>
|
|
176
|
+
</div>
|
|
177
|
+
|
|
178
|
+
</div>
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
</div>
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
</section>
|
|
187
|
+
|
|
188
|
+
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
|
189
|
+
<header>
|
|
190
|
+
<h3>Public Instance Methods</h3>
|
|
191
|
+
</header>
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
<div id="method-i-send_get" class="method-detail ">
|
|
195
|
+
|
|
196
|
+
<div class="method-heading">
|
|
197
|
+
<span class="method-name">send_get</span><span
|
|
198
|
+
class="method-args">(uri)</span>
|
|
199
|
+
|
|
200
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
201
|
+
|
|
202
|
+
</div>
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
<div class="method-description">
|
|
206
|
+
|
|
207
|
+
<p>Send Get</p>
|
|
208
|
+
|
|
209
|
+
<p>Issues a GET request (read) against the API and returns the result (as Ruby
|
|
210
|
+
hash).</p>
|
|
211
|
+
|
|
212
|
+
<p>Arguments:</p>
|
|
213
|
+
|
|
214
|
+
<p>uri The API method to call including parameters</p>
|
|
215
|
+
|
|
216
|
+
<pre class="ruby">(<span class="ruby-identifier">e</span>.<span class="ruby-identifier">g</span>. <span class="ruby-identifier">get_case</span><span class="ruby-operator">/</span><span class="ruby-value">1</span>)
|
|
217
|
+
</pre>
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
<div class="method-source-code" id="send_get-source">
|
|
223
|
+
<pre><span class="ruby-comment"># File lib/test_rail_integration/generator/API_client.rb, line 45</span>
|
|
224
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">send_get</span>(<span class="ruby-identifier">uri</span>)
|
|
225
|
+
<span class="ruby-identifier">_send_request</span>(<span class="ruby-string">'GET'</span>, <span class="ruby-identifier">uri</span>, <span class="ruby-keyword">nil</span>)
|
|
226
|
+
<span class="ruby-keyword">end</span></pre>
|
|
227
|
+
</div>
|
|
228
|
+
|
|
229
|
+
</div>
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
</div>
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
<div id="method-i-send_post" class="method-detail ">
|
|
238
|
+
|
|
239
|
+
<div class="method-heading">
|
|
240
|
+
<span class="method-name">send_post</span><span
|
|
241
|
+
class="method-args">(uri, data)</span>
|
|
242
|
+
|
|
243
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
244
|
+
|
|
245
|
+
</div>
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
<div class="method-description">
|
|
249
|
+
|
|
250
|
+
<p>Send POST</p>
|
|
251
|
+
|
|
252
|
+
<p>Issues a POST request (write) against the API and returns the result (as
|
|
253
|
+
Ruby hash).</p>
|
|
254
|
+
|
|
255
|
+
<p>Arguments:</p>
|
|
256
|
+
|
|
257
|
+
<p>uri The API method to call including parameters</p>
|
|
258
|
+
|
|
259
|
+
<pre class="ruby">(<span class="ruby-identifier">e</span>.<span class="ruby-identifier">g</span>. <span class="ruby-identifier">add_case</span><span class="ruby-operator">/</span><span class="ruby-value">1</span>)
|
|
260
|
+
</pre>
|
|
261
|
+
|
|
262
|
+
<p>data The data to submit as part of the request (as</p>
|
|
263
|
+
|
|
264
|
+
<pre>Ruby hash, strings must be UTF-8 encoded)</pre>
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
<div class="method-source-code" id="send_post-source">
|
|
270
|
+
<pre><span class="ruby-comment"># File lib/test_rail_integration/generator/API_client.rb, line 62</span>
|
|
271
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">send_post</span>(<span class="ruby-identifier">uri</span>, <span class="ruby-identifier">data</span>)
|
|
272
|
+
<span class="ruby-identifier">_send_request</span>(<span class="ruby-string">'POST'</span>, <span class="ruby-identifier">uri</span>, <span class="ruby-identifier">data</span>)
|
|
273
|
+
<span class="ruby-keyword">end</span></pre>
|
|
274
|
+
</div>
|
|
275
|
+
|
|
276
|
+
</div>
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
</div>
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
</section>
|
|
285
|
+
|
|
286
|
+
</section>
|
|
287
|
+
</main>
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
<footer id="validator-badges" role="contentinfo">
|
|
291
|
+
<p><a href="http://validator.w3.org/check/referer">Validate</a>
|
|
292
|
+
<p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.0.
|
|
293
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
294
|
+
</footer>
|
|
295
|
+
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta charset="UTF-8">
|
|
6
|
+
|
|
7
|
+
<title>class TestRail::APIError - RDoc Documentation</title>
|
|
8
|
+
|
|
9
|
+
<script type="text/javascript">
|
|
10
|
+
var rdoc_rel_prefix = "../";
|
|
11
|
+
</script>
|
|
12
|
+
|
|
13
|
+
<script src="../js/jquery.js"></script>
|
|
14
|
+
<script src="../js/darkfish.js"></script>
|
|
15
|
+
|
|
16
|
+
<link href="../css/fonts.css" rel="stylesheet">
|
|
17
|
+
<link href="../css/rdoc.css" rel="stylesheet">
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
<body id="top" role="document" class="class">
|
|
22
|
+
<nav role="navigation">
|
|
23
|
+
<div id="project-navigation">
|
|
24
|
+
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
|
25
|
+
<h2>
|
|
26
|
+
<a href="../index.html" rel="home">Home</a>
|
|
27
|
+
</h2>
|
|
28
|
+
|
|
29
|
+
<div id="table-of-contents-navigation">
|
|
30
|
+
<a href="../table_of_contents.html#pages">Pages</a>
|
|
31
|
+
<a href="../table_of_contents.html#classes">Classes</a>
|
|
32
|
+
<a href="../table_of_contents.html#methods">Methods</a>
|
|
33
|
+
</div>
|
|
34
|
+
</div>
|
|
35
|
+
|
|
36
|
+
<div id="search-section" role="search" class="project-section initially-hidden">
|
|
37
|
+
<form action="#" method="get" accept-charset="utf-8">
|
|
38
|
+
<div id="search-field-wrapper">
|
|
39
|
+
<input id="search-field" role="combobox" aria-label="Search"
|
|
40
|
+
aria-autocomplete="list" aria-controls="search-results"
|
|
41
|
+
type="text" name="search" placeholder="Search" spellcheck="false"
|
|
42
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
|
43
|
+
</div>
|
|
44
|
+
|
|
45
|
+
<ul id="search-results" aria-label="Search Results"
|
|
46
|
+
aria-busy="false" aria-expanded="false"
|
|
47
|
+
aria-atomic="false" class="initially-hidden"></ul>
|
|
48
|
+
</form>
|
|
49
|
+
</div>
|
|
50
|
+
|
|
51
|
+
</div>
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
<div id="class-metadata">
|
|
56
|
+
|
|
57
|
+
<div id="parent-class-section" class="nav-section">
|
|
58
|
+
<h3>Parent</h3>
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
<p class="link">StandardError
|
|
62
|
+
|
|
63
|
+
</div>
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
</div>
|
|
69
|
+
</nav>
|
|
70
|
+
|
|
71
|
+
<main role="main" aria-labelledby="class-TestRail::APIError">
|
|
72
|
+
<h1 id="class-TestRail::APIError" class="class">
|
|
73
|
+
class TestRail::APIError
|
|
74
|
+
</h1>
|
|
75
|
+
|
|
76
|
+
<section class="description">
|
|
77
|
+
|
|
78
|
+
</section>
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
</section>
|
|
94
|
+
</main>
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
<footer id="validator-badges" role="contentinfo">
|
|
98
|
+
<p><a href="http://validator.w3.org/check/referer">Validate</a>
|
|
99
|
+
<p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.0.
|
|
100
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
101
|
+
</footer>
|
|
102
|
+
|