stella 0.5.1 → 0.5.3

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.
Files changed (100) hide show
  1. data/README.txt +84 -24
  2. data/Rakefile +6 -1
  3. data/lib/stella.rb +5 -4
  4. data/lib/stella/adapter/ab.rb +31 -4
  5. data/lib/stella/adapter/base.rb +15 -1
  6. data/lib/stella/adapter/httperf.rb +35 -4
  7. data/lib/stella/adapter/siege.rb +51 -29
  8. data/lib/stella/cli.rb +45 -22
  9. data/lib/stella/cli/agents.rb +73 -0
  10. data/lib/stella/cli/language.rb +2 -0
  11. data/lib/stella/cli/localtest.rb +5 -0
  12. data/lib/stella/command/base.rb +1 -1
  13. data/lib/stella/command/localtest.rb +84 -68
  14. data/lib/stella/test/{summarybase.rb → base.rb} +3 -7
  15. data/lib/stella/test/definition.rb +10 -5
  16. data/lib/stella/test/{runsummary.rb → run/summary.rb} +4 -6
  17. data/lib/stella/test/{testsummary.rb → summary.rb} +27 -29
  18. data/lib/utils/escape.rb +302 -0
  19. data/lib/utils/mathutil.rb +36 -34
  20. data/support/text/en.yaml +7 -1
  21. metadata +8 -102
  22. data/doc/classes/Crypto.html +0 -248
  23. data/doc/classes/Crypto/Key.html +0 -308
  24. data/doc/classes/Enumerable.html +0 -309
  25. data/doc/classes/FileUtil.html +0 -310
  26. data/doc/classes/HTTPUtil.html +0 -530
  27. data/doc/classes/MathUtil.html +0 -210
  28. data/doc/classes/Stella.html +0 -238
  29. data/doc/classes/Stella/Adapter.html +0 -127
  30. data/doc/classes/Stella/Adapter/ApacheBench.html +0 -1076
  31. data/doc/classes/Stella/Adapter/Base.html +0 -432
  32. data/doc/classes/Stella/Adapter/CommandNotReady.html +0 -146
  33. data/doc/classes/Stella/Adapter/Httperf.html +0 -949
  34. data/doc/classes/Stella/Adapter/Siege.html +0 -1011
  35. data/doc/classes/Stella/CLI.html +0 -914
  36. data/doc/classes/Stella/CLI/Base.html +0 -186
  37. data/doc/classes/Stella/CLI/Language.html +0 -149
  38. data/doc/classes/Stella/CLI/LocalTest.html +0 -268
  39. data/doc/classes/Stella/Command.html +0 -111
  40. data/doc/classes/Stella/Command/Base.html +0 -335
  41. data/doc/classes/Stella/Config.html +0 -292
  42. data/doc/classes/Stella/InvalidArgument.html +0 -242
  43. data/doc/classes/Stella/LocalTest.html +0 -450
  44. data/doc/classes/Stella/Logger.html +0 -548
  45. data/doc/classes/Stella/Response.html +0 -846
  46. data/doc/classes/Stella/Storable.html +0 -928
  47. data/doc/classes/Stella/Test.html +0 -142
  48. data/doc/classes/Stella/Test/DaySummary.html +0 -249
  49. data/doc/classes/Stella/Test/Definition.html +0 -294
  50. data/doc/classes/Stella/Test/Definition/Rampup.html +0 -215
  51. data/doc/classes/Stella/Test/RunSummary.html +0 -315
  52. data/doc/classes/Stella/Test/SummaryBase.html +0 -286
  53. data/doc/classes/Stella/Test/TestSummary.html +0 -200
  54. data/doc/classes/Stella/Text.html +0 -581
  55. data/doc/classes/Stella/Text/Resource.html +0 -289
  56. data/doc/classes/Stella/UnavailableAdapter.html +0 -242
  57. data/doc/classes/Stella/UnknownValue.html +0 -242
  58. data/doc/classes/Stella/UnsupportedLanguage.html +0 -115
  59. data/doc/classes/Stella/Util.html +0 -348
  60. data/doc/classes/TextGraph.html +0 -460
  61. data/doc/classes/TimerUtil.html +0 -431
  62. data/doc/created.rid +0 -1
  63. data/doc/files/LICENSE_txt.html +0 -129
  64. data/doc/files/README_txt.html +0 -209
  65. data/doc/files/lib/stella/adapter/ab_rb.html +0 -101
  66. data/doc/files/lib/stella/adapter/base_rb.html +0 -101
  67. data/doc/files/lib/stella/adapter/httperf_rb.html +0 -101
  68. data/doc/files/lib/stella/adapter/siege_rb.html +0 -101
  69. data/doc/files/lib/stella/cli/base_rb.html +0 -101
  70. data/doc/files/lib/stella/cli/language_rb.html +0 -101
  71. data/doc/files/lib/stella/cli/localtest_rb.html +0 -101
  72. data/doc/files/lib/stella/cli_rb.html +0 -112
  73. data/doc/files/lib/stella/command/base_rb.html +0 -101
  74. data/doc/files/lib/stella/command/localtest_rb.html +0 -101
  75. data/doc/files/lib/stella/logger_rb.html +0 -101
  76. data/doc/files/lib/stella/response_rb.html +0 -101
  77. data/doc/files/lib/stella/storable_rb.html +0 -109
  78. data/doc/files/lib/stella/support_rb.html +0 -101
  79. data/doc/files/lib/stella/test/daysummary_rb.html +0 -101
  80. data/doc/files/lib/stella/test/definition_rb.html +0 -101
  81. data/doc/files/lib/stella/test/runsummary_rb.html +0 -101
  82. data/doc/files/lib/stella/test/summarybase_rb.html +0 -101
  83. data/doc/files/lib/stella/test/testsummary_rb.html +0 -108
  84. data/doc/files/lib/stella/text/resource_rb.html +0 -108
  85. data/doc/files/lib/stella/text_rb.html +0 -108
  86. data/doc/files/lib/stella_rb.html +0 -128
  87. data/doc/files/lib/utils/crypto-key_rb.html +0 -116
  88. data/doc/files/lib/utils/fileutil_rb.html +0 -108
  89. data/doc/files/lib/utils/httputil_rb.html +0 -110
  90. data/doc/files/lib/utils/mathutil_rb.html +0 -101
  91. data/doc/files/lib/utils/textgraph_rb.html +0 -138
  92. data/doc/files/lib/utils/timerutil_rb.html +0 -108
  93. data/doc/fr_class_index.html +0 -66
  94. data/doc/fr_file_index.html +0 -62
  95. data/doc/fr_method_index.html +0 -309
  96. data/doc/index.html +0 -24
  97. data/doc/rdoc-style.css +0 -208
  98. data/lib/stella/test/daysummary.rb +0 -93
  99. data/spec/base.rb +0 -26
  100. data/spec/shell_spec.rb +0 -12
data/doc/classes/FileUtil.html DELETED
@@ -1,310 +0,0 @@
1
- <?xml version="1.0" encoding="utf-8"?>
2
- <!DOCTYPE html
3
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
-
6
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7
- <head>
8
- <title>Module: FileUtil</title>
9
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
11
- <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
12
- <script type="text/javascript">
13
- // <![CDATA[
14
-
15
- function popupCode( url ) {
16
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
17
- }
18
-
19
- function toggleCode( id ) {
20
- if ( document.getElementById )
21
- elem = document.getElementById( id );
22
- else if ( document.all )
23
- elem = eval( "document.all." + id );
24
- else
25
- return false;
26
-
27
- elemStyle = elem.style;
28
-
29
- if ( elemStyle.display != "block" ) {
30
- elemStyle.display = "block"
31
- } else {
32
- elemStyle.display = "none"
33
- }
34
-
35
- return true;
36
- }
37
-
38
- // Make codeblocks hidden by default
39
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
40
-
41
- // ]]>
42
- </script>
43
-
44
- </head>
45
- <body>
46
-
47
-
48
-
49
- <div id="classHeader">
50
- <table class="header-table">
51
- <tr class="top-aligned-row">
52
- <td><strong>Module</strong></td>
53
- <td class="class-name-in-header">FileUtil</td>
54
- </tr>
55
- <tr class="top-aligned-row">
56
- <td><strong>In:</strong></td>
57
- <td>
58
- <a href="../files/lib/utils/fileutil_rb.html">
59
- lib/utils/fileutil.rb
60
- </a>
61
- <br />
62
- </td>
63
- </tr>
64
-
65
- </table>
66
- </div>
67
- <!-- banner header -->
68
-
69
- <div id="bodyContent">
70
-
71
-
72
-
73
- <div id="contextContent">
74
-
75
-
76
-
77
- </div>
78
-
79
- <div id="method-list">
80
- <h3 class="section-bar">Methods</h3>
81
-
82
- <div class="name-list">
83
- <a href="#M000271">append_file</a>&nbsp;&nbsp;
84
- <a href="#M000273">create_dir</a>&nbsp;&nbsp;
85
- <a href="#M000269">read_binary_file</a>&nbsp;&nbsp;
86
- <a href="#M000267">read_file</a>&nbsp;&nbsp;
87
- <a href="#M000268">read_file_to_array</a>&nbsp;&nbsp;
88
- <a href="#M000270">write_file</a>&nbsp;&nbsp;
89
- <a href="#M000272">write_or_append_file</a>&nbsp;&nbsp;
90
- </div>
91
- </div>
92
-
93
- </div>
94
-
95
-
96
- <!-- if includes -->
97
-
98
- <div id="section">
99
-
100
-
101
-
102
-
103
-
104
-
105
-
106
-
107
- <!-- if method_list -->
108
- <div id="methods">
109
- <h3 class="section-bar">Public Class methods</h3>
110
-
111
- <div id="method-M000271" class="method-detail">
112
- <a name="M000271"></a>
113
-
114
- <div class="method-heading">
115
- <a href="#M000271" class="method-signature">
116
- <span class="method-name">append_file</span><span class="method-args">(path, content, flush=true)</span>
117
- </a>
118
- </div>
119
-
120
- <div class="method-description">
121
- <p><a class="source-toggle" href="#"
122
- onclick="toggleCode('M000271-source');return false;">[Source]</a></p>
123
- <div class="method-source-code" id="M000271-source">
124
- <pre>
125
- <span class="ruby-comment cmt"># File lib/utils/fileutil.rb, line 38</span>
126
- 38: <span class="ruby-keyword kw">def</span> <span class="ruby-constant">FileUtil</span>.<span class="ruby-identifier">append_file</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">content</span>, <span class="ruby-identifier">flush</span>=<span class="ruby-keyword kw">true</span>)
127
- 39: <span class="ruby-constant">FileUtil</span>.<span class="ruby-identifier">write_or_append_file</span>(<span class="ruby-value str">'a'</span>, <span class="ruby-identifier">path</span>, <span class="ruby-identifier">content</span>, <span class="ruby-identifier">flush</span>)
128
- 40: <span class="ruby-keyword kw">end</span>
129
- </pre>
130
- </div>
131
- </div>
132
- </div>
133
-
134
- <div id="method-M000273" class="method-detail">
135
- <a name="M000273"></a>
136
-
137
- <div class="method-heading">
138
- <a href="#M000273" class="method-signature">
139
- <span class="method-name">create_dir</span><span class="method-args">(dirpath)</span>
140
- </a>
141
- </div>
142
-
143
- <div class="method-description">
144
- <p><a class="source-toggle" href="#"
145
- onclick="toggleCode('M000273-source');return false;">[Source]</a></p>
146
- <div class="method-source-code" id="M000273-source">
147
- <pre>
148
- <span class="ruby-comment cmt"># File lib/utils/fileutil.rb, line 53</span>
149
- 53: <span class="ruby-keyword kw">def</span> <span class="ruby-constant">FileUtil</span>.<span class="ruby-identifier">create_dir</span>(<span class="ruby-identifier">dirpath</span>)
150
- 54: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-identifier">dirpath</span>)
151
- 55:
152
- 56: <span class="ruby-comment cmt">#STDERR.puts &quot;Creating #{ dirpath }&quot;</span>
153
- 57: <span class="ruby-constant">File</span>.<span class="ruby-identifier">makedirs</span>(<span class="ruby-identifier">dirpath</span>)
154
- 58: <span class="ruby-keyword kw">end</span>
155
- </pre>
156
- </div>
157
- </div>
158
- </div>
159
-
160
- <div id="method-M000269" class="method-detail">
161
- <a name="M000269"></a>
162
-
163
- <div class="method-heading">
164
- <a href="#M000269" class="method-signature">
165
- <span class="method-name">read_binary_file</span><span class="method-args">(path)</span>
166
- </a>
167
- </div>
168
-
169
- <div class="method-description">
170
- <p><a class="source-toggle" href="#"
171
- onclick="toggleCode('M000269-source');return false;">[Source]</a></p>
172
- <div class="method-source-code" id="M000269-source">
173
- <pre>
174
- <span class="ruby-comment cmt"># File lib/utils/fileutil.rb, line 19</span>
175
- 19: <span class="ruby-keyword kw">def</span> <span class="ruby-constant">FileUtil</span>.<span class="ruby-identifier">read_binary_file</span>(<span class="ruby-identifier">path</span>)
176
- 20: <span class="ruby-identifier">contents</span> = <span class="ruby-value str">''</span>
177
- 21: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">contents</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exists?</span>(<span class="ruby-identifier">path</span>)
178
- 22:
179
- 23: <span class="ruby-identifier">open</span>(<span class="ruby-identifier">path</span>, <span class="ruby-value str">'rb'</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">l</span><span class="ruby-operator">|</span>
180
- 24: <span class="ruby-keyword kw">while</span> (<span class="ruby-operator">!</span><span class="ruby-identifier">l</span>.<span class="ruby-identifier">eof?</span>)
181
- 25: <span class="ruby-identifier">contents</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">l</span>.<span class="ruby-identifier">read</span>(<span class="ruby-value">4096</span>)
182
- 26: <span class="ruby-keyword kw">end</span>
183
- 27: <span class="ruby-keyword kw">end</span>
184
- 28:
185
- 29: <span class="ruby-identifier">contents</span>
186
- 30: <span class="ruby-keyword kw">end</span>
187
- </pre>
188
- </div>
189
- </div>
190
- </div>
191
-
192
- <div id="method-M000267" class="method-detail">
193
- <a name="M000267"></a>
194
-
195
- <div class="method-heading">
196
- <a href="#M000267" class="method-signature">
197
- <span class="method-name">read_file</span><span class="method-args">(path)</span>
198
- </a>
199
- </div>
200
-
201
- <div class="method-description">
202
- <p><a class="source-toggle" href="#"
203
- onclick="toggleCode('M000267-source');return false;">[Source]</a></p>
204
- <div class="method-source-code" id="M000267-source">
205
- <pre>
206
- <span class="ruby-comment cmt"># File lib/utils/fileutil.rb, line 5</span>
207
- 5: <span class="ruby-keyword kw">def</span> <span class="ruby-constant">FileUtil</span>.<span class="ruby-identifier">read_file</span>(<span class="ruby-identifier">path</span>)
208
- 6: <span class="ruby-constant">FileUtil</span>.<span class="ruby-identifier">read_file_to_array</span>(<span class="ruby-identifier">path</span>).<span class="ruby-identifier">join</span>(<span class="ruby-value str">''</span>)
209
- 7: <span class="ruby-keyword kw">end</span>
210
- </pre>
211
- </div>
212
- </div>
213
- </div>
214
-
215
- <div id="method-M000268" class="method-detail">
216
- <a name="M000268"></a>
217
-
218
- <div class="method-heading">
219
- <a href="#M000268" class="method-signature">
220
- <span class="method-name">read_file_to_array</span><span class="method-args">(path)</span>
221
- </a>
222
- </div>
223
-
224
- <div class="method-description">
225
- <p><a class="source-toggle" href="#"
226
- onclick="toggleCode('M000268-source');return false;">[Source]</a></p>
227
- <div class="method-source-code" id="M000268-source">
228
- <pre>
229
- <span class="ruby-comment cmt"># File lib/utils/fileutil.rb, line 9</span>
230
- 9: <span class="ruby-keyword kw">def</span> <span class="ruby-constant">FileUtil</span>.<span class="ruby-identifier">read_file_to_array</span>(<span class="ruby-identifier">path</span>)
231
- 10: <span class="ruby-identifier">contents</span> = []
232
- 11: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">contents</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exists?</span>(<span class="ruby-identifier">path</span>)
233
- 12:
234
- 13: <span class="ruby-identifier">open</span>(<span class="ruby-identifier">path</span>, <span class="ruby-value str">'r'</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">l</span><span class="ruby-operator">|</span>
235
- 14: <span class="ruby-identifier">contents</span> = <span class="ruby-identifier">l</span>.<span class="ruby-identifier">readlines</span>
236
- 15: <span class="ruby-keyword kw">end</span>
237
- 16:
238
- 17: <span class="ruby-identifier">contents</span>
239
- 18: <span class="ruby-keyword kw">end</span>
240
- </pre>
241
- </div>
242
- </div>
243
- </div>
244
-
245
- <div id="method-M000270" class="method-detail">
246
- <a name="M000270"></a>
247
-
248
- <div class="method-heading">
249
- <a href="#M000270" class="method-signature">
250
- <span class="method-name">write_file</span><span class="method-args">(path, content, flush=true)</span>
251
- </a>
252
- </div>
253
-
254
- <div class="method-description">
255
- <p><a class="source-toggle" href="#"
256
- onclick="toggleCode('M000270-source');return false;">[Source]</a></p>
257
- <div class="method-source-code" id="M000270-source">
258
- <pre>
259
- <span class="ruby-comment cmt"># File lib/utils/fileutil.rb, line 34</span>
260
- 34: <span class="ruby-keyword kw">def</span> <span class="ruby-constant">FileUtil</span>.<span class="ruby-identifier">write_file</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">content</span>, <span class="ruby-identifier">flush</span>=<span class="ruby-keyword kw">true</span>)
261
- 35: <span class="ruby-constant">FileUtil</span>.<span class="ruby-identifier">write_or_append_file</span>(<span class="ruby-value str">'w'</span>, <span class="ruby-identifier">path</span>, <span class="ruby-identifier">content</span>, <span class="ruby-identifier">flush</span>)
262
- 36: <span class="ruby-keyword kw">end</span>
263
- </pre>
264
- </div>
265
- </div>
266
- </div>
267
-
268
- <div id="method-M000272" class="method-detail">
269
- <a name="M000272"></a>
270
-
271
- <div class="method-heading">
272
- <a href="#M000272" class="method-signature">
273
- <span class="method-name">write_or_append_file</span><span class="method-args">(write_or_append, path, content = '', flush = true)</span>
274
- </a>
275
- </div>
276
-
277
- <div class="method-description">
278
- <p><a class="source-toggle" href="#"
279
- onclick="toggleCode('M000272-source');return false;">[Source]</a></p>
280
- <div class="method-source-code" id="M000272-source">
281
- <pre>
282
- <span class="ruby-comment cmt"># File lib/utils/fileutil.rb, line 42</span>
283
- 42: <span class="ruby-keyword kw">def</span> <span class="ruby-constant">FileUtil</span>.<span class="ruby-identifier">write_or_append_file</span>(<span class="ruby-identifier">write_or_append</span>, <span class="ruby-identifier">path</span>, <span class="ruby-identifier">content</span> = <span class="ruby-value str">''</span>, <span class="ruby-identifier">flush</span> = <span class="ruby-keyword kw">true</span>)
284
- 43: <span class="ruby-comment cmt">#STDERR.puts &quot;Writing to #{ path }...&quot; </span>
285
- 44: <span class="ruby-constant">FileUtil</span>.<span class="ruby-identifier">create_dir</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">dirname</span>(<span class="ruby-identifier">path</span>))
286
- 45:
287
- 46: <span class="ruby-identifier">open</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">write_or_append</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span>
288
- 47: <span class="ruby-identifier">f</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">content</span>
289
- 48: <span class="ruby-identifier">f</span>.<span class="ruby-identifier">flush</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">flush</span>;
290
- 49: <span class="ruby-keyword kw">end</span>
291
- 50: <span class="ruby-constant">File</span>.<span class="ruby-identifier">chmod</span>(<span class="ruby-value">0600</span>, <span class="ruby-identifier">path</span>)
292
- 51: <span class="ruby-keyword kw">end</span>
293
- </pre>
294
- </div>
295
- </div>
296
- </div>
297
-
298
-
299
- </div>
300
-
301
-
302
- </div>
303
-
304
-
305
- <div id="validator-badges">
306
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
307
- </div>
308
-
309
- </body>
310
- </html>
data/doc/classes/HTTPUtil.html DELETED
@@ -1,530 +0,0 @@
1
- <?xml version="1.0" encoding="utf-8"?>
2
- <!DOCTYPE html
3
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
-
6
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7
- <head>
8
- <title>Module: HTTPUtil</title>
9
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
11
- <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
12
- <script type="text/javascript">
13
- // <![CDATA[
14
-
15
- function popupCode( url ) {
16
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
17
- }
18
-
19
- function toggleCode( id ) {
20
- if ( document.getElementById )
21
- elem = document.getElementById( id );
22
- else if ( document.all )
23
- elem = eval( "document.all." + id );
24
- else
25
- return false;
26
-
27
- elemStyle = elem.style;
28
-
29
- if ( elemStyle.display != "block" ) {
30
- elemStyle.display = "block"
31
- } else {
32
- elemStyle.display = "none"
33
- }
34
-
35
- return true;
36
- }
37
-
38
- // Make codeblocks hidden by default
39
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
40
-
41
- // ]]>
42
- </script>
43
-
44
- </head>
45
- <body>
46
-
47
-
48
-
49
- <div id="classHeader">
50
- <table class="header-table">
51
- <tr class="top-aligned-row">
52
- <td><strong>Module</strong></td>
53
- <td class="class-name-in-header">HTTPUtil</td>
54
- </tr>
55
- <tr class="top-aligned-row">
56
- <td><strong>In:</strong></td>
57
- <td>
58
- <a href="../files/lib/utils/httputil_rb.html">
59
- lib/utils/httputil.rb
60
- </a>
61
- <br />
62
- </td>
63
- </tr>
64
-
65
- </table>
66
- </div>
67
- <!-- banner header -->
68
-
69
- <div id="bodyContent">
70
-
71
-
72
-
73
- <div id="contextContent">
74
-
75
-
76
-
77
- </div>
78
-
79
- <div id="method-list">
80
- <h3 class="section-bar">Methods</h3>
81
-
82
- <div class="name-list">
83
- <a href="#M000279">exists</a>&nbsp;&nbsp;
84
- <a href="#M000277">fetch</a>&nbsp;&nbsp;
85
- <a href="#M000276">fetch_content</a>&nbsp;&nbsp;
86
- <a href="#M000283">hash_to_query</a>&nbsp;&nbsp;
87
- <a href="#M000274">hostname</a>&nbsp;&nbsp;
88
- <a href="#M000275">normalize</a>&nbsp;&nbsp;
89
- <a href="#M000280">parse_query</a>&nbsp;&nbsp;
90
- <a href="#M000278">post</a>&nbsp;&nbsp;
91
- <a href="#M000282">query_to_hash</a>&nbsp;&nbsp;
92
- <a href="#M000281">validate_method</a>&nbsp;&nbsp;
93
- </div>
94
- </div>
95
-
96
- </div>
97
-
98
-
99
- <!-- if includes -->
100
-
101
- <div id="section">
102
-
103
-
104
- <div id="constants-list">
105
- <h3 class="section-bar">Constants</h3>
106
-
107
- <div class="name-list">
108
- <table summary="Constants">
109
- <tr class="top-aligned-row context-row">
110
- <td class="context-item-name">VALID_METHODS</td>
111
- <td>=</td>
112
- <td class="context-item-value">%w{GET HEAD POST PUT DELETE}</td>
113
- </tr>
114
- </table>
115
- </div>
116
- </div>
117
-
118
-
119
-
120
-
121
-
122
-
123
- <!-- if method_list -->
124
- <div id="methods">
125
- <h3 class="section-bar">Public Class methods</h3>
126
-
127
- <div id="method-M000279" class="method-detail">
128
- <a name="M000279"></a>
129
-
130
- <div class="method-heading">
131
- <a href="#M000279" class="method-signature">
132
- <span class="method-name">exists</span><span class="method-args">(uri)</span>
133
- </a>
134
- </div>
135
-
136
- <div class="method-description">
137
- <p><a class="source-toggle" href="#"
138
- onclick="toggleCode('M000279-source');return false;">[Source]</a></p>
139
- <div class="method-source-code" id="M000279-source">
140
- <pre>
141
- <span class="ruby-comment cmt"># File lib/utils/httputil.rb, line 133</span>
142
- 133: <span class="ruby-keyword kw">def</span> <span class="ruby-constant">HTTPUtil</span>.<span class="ruby-identifier">exists</span>(<span class="ruby-identifier">uri</span>)
143
- 134:
144
- 135: <span class="ruby-keyword kw">begin</span>
145
- 136: <span class="ruby-identifier">response</span> = <span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">uri</span>)
146
- 137: <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">response</span>
147
- 138: <span class="ruby-keyword kw">when</span> <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTPSuccess</span> <span class="ruby-keyword kw">then</span> <span class="ruby-keyword kw">true</span>
148
- 139: <span class="ruby-keyword kw">when</span> <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTPRedirection</span> <span class="ruby-keyword kw">then</span> <span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">response</span>[<span class="ruby-value str">'location'</span>], <span class="ruby-identifier">limit</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>)
149
- 140: <span class="ruby-keyword kw">else</span>
150
- 141: <span class="ruby-keyword kw">false</span>
151
- 142: <span class="ruby-keyword kw">end</span>
152
- 143:
153
- 144: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">e</span>
154
- 145: <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span> <span class="ruby-value str">&quot;Problem: &quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">message</span>
155
- 146: <span class="ruby-keyword kw">false</span>
156
- 147: <span class="ruby-keyword kw">end</span>
157
- 148:
158
- 149: <span class="ruby-keyword kw">end</span>
159
- </pre>
160
- </div>
161
- </div>
162
- </div>
163
-
164
- <div id="method-M000277" class="method-detail">
165
- <a name="M000277"></a>
166
-
167
- <div class="method-heading">
168
- <a href="#M000277" class="method-signature">
169
- <span class="method-name">fetch</span><span class="method-args">(uri, limit = 10)</span>
170
- </a>
171
- </div>
172
-
173
- <div class="method-description">
174
- <p><a class="source-toggle" href="#"
175
- onclick="toggleCode('M000277-source');return false;">[Source]</a></p>
176
- <div class="method-source-code" id="M000277-source">
177
- <pre>
178
- <span class="ruby-comment cmt"># File lib/utils/httputil.rb, line 77</span>
179
- 77: <span class="ruby-keyword kw">def</span> <span class="ruby-constant">HTTPUtil</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">uri</span>, <span class="ruby-identifier">limit</span> = <span class="ruby-value">10</span>)
180
- 78:
181
- 79: <span class="ruby-comment cmt"># You should choose better exception.</span>
182
- 80: <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-value str">'HTTP redirect too deep'</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">limit</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
183
- 81: <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;URL: #{uri.to_s}&quot;</span>
184
- 82: <span class="ruby-identifier">uri</span> = <span class="ruby-constant">URI</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">uri</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">String</span>
185
- 83:
186
- 84: <span class="ruby-keyword kw">begin</span>
187
- 85: <span class="ruby-identifier">timeout</span>(<span class="ruby-ivar">@@timeout</span>) <span class="ruby-keyword kw">do</span>
188
- 86: <span class="ruby-identifier">response</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span>.<span class="ruby-identifier">get_response</span>(<span class="ruby-identifier">uri</span>)
189
- 87:
190
- 88:
191
- 89: <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">response</span>
192
- 90: <span class="ruby-keyword kw">when</span> <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTPSuccess</span> <span class="ruby-keyword kw">then</span> <span class="ruby-identifier">response</span>
193
- 91: <span class="ruby-keyword kw">when</span> <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTPRedirection</span> <span class="ruby-keyword kw">then</span> <span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">response</span>[<span class="ruby-value str">'location'</span>], <span class="ruby-identifier">limit</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>)
194
- 92: <span class="ruby-keyword kw">else</span>
195
- 93: <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span> <span class="ruby-value str">&quot;Not found: &quot;</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">to_s</span>
196
- 94: <span class="ruby-keyword kw">end</span>
197
- 95: <span class="ruby-keyword kw">end</span>
198
- 96: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">TimeoutError</span>
199
- 97: <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span> <span class="ruby-value str">&quot;Net::HTTP timed out for &quot;</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">to_s</span>
200
- 98: <span class="ruby-keyword kw">return</span>
201
- 99: <span class="ruby-keyword kw">rescue</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">ex</span>
202
- 100: <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;Error: #{ex.message}&quot;</span>
203
- 101: <span class="ruby-keyword kw">end</span>
204
- 102:
205
- 103: <span class="ruby-keyword kw">end</span>
206
- </pre>
207
- </div>
208
- </div>
209
- </div>
210
-
211
- <div id="method-M000276" class="method-detail">
212
- <a name="M000276"></a>
213
-
214
- <div class="method-heading">
215
- <a href="#M000276" class="method-signature">
216
- <span class="method-name">fetch_content</span><span class="method-args">(uri, limit = 10)</span>
217
- </a>
218
- </div>
219
-
220
- <div class="method-description">
221
- <p><a class="source-toggle" href="#"
222
- onclick="toggleCode('M000276-source');return false;">[Source]</a></p>
223
- <div class="method-source-code" id="M000276-source">
224
- <pre>
225
- <span class="ruby-comment cmt"># File lib/utils/httputil.rb, line 72</span>
226
- 72: <span class="ruby-keyword kw">def</span> <span class="ruby-constant">HTTPUtil</span>.<span class="ruby-identifier">fetch_content</span>(<span class="ruby-identifier">uri</span>, <span class="ruby-identifier">limit</span> = <span class="ruby-value">10</span>)
227
- 73: <span class="ruby-identifier">res</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">uri</span>,<span class="ruby-identifier">limit</span>)
228
- 74: <span class="ruby-keyword kw">return</span> (<span class="ruby-identifier">res</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">res</span>.<span class="ruby-identifier">body</span> <span class="ruby-operator">:</span> <span class="ruby-value str">&quot;&quot;</span>
229
- 75: <span class="ruby-keyword kw">end</span>
230
- </pre>
231
- </div>
232
- </div>
233
- </div>
234
-
235
- <div id="method-M000283" class="method-detail">
236
- <a name="M000283"></a>
237
-
238
- <div class="method-heading">
239
- <a href="#M000283" class="method-signature">
240
- <span class="method-name">hash_to_query</span><span class="method-args">(parameters)</span>
241
- </a>
242
- </div>
243
-
244
- <div class="method-description">
245
- <p><a class="source-toggle" href="#"
246
- onclick="toggleCode('M000283-source');return false;">[Source]</a></p>
247
- <div class="method-source-code" id="M000283-source">
248
- <pre>
249
- <span class="ruby-comment cmt"># File lib/utils/httputil.rb, line 198</span>
250
- 198: <span class="ruby-keyword kw">def</span> <span class="ruby-constant">HTTPUtil</span>.<span class="ruby-identifier">hash_to_query</span>(<span class="ruby-identifier">parameters</span>)
251
- 199: <span class="ruby-keyword kw">return</span> <span class="ruby-value str">''</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">parameters</span>
252
- 200: <span class="ruby-identifier">pairs</span> = []
253
- 201: <span class="ruby-identifier">parameters</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">param</span>, <span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
254
- 202: <span class="ruby-identifier">pairs</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-node">&quot;#{param}=#{URI.escape(value.to_s)}&quot;</span>
255
- 203: <span class="ruby-keyword kw">end</span>
256
- 204: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">pairs</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">'&amp;'</span>)
257
- 205: <span class="ruby-comment cmt">#return pairs.join(&quot;;&quot;)</span>
258
- 206: <span class="ruby-keyword kw">end</span>
259
- </pre>
260
- </div>
261
- </div>
262
- </div>
263
-
264
- <div id="method-M000274" class="method-detail">
265
- <a name="M000274"></a>
266
-
267
- <div class="method-heading">
268
- <a href="#M000274" class="method-signature">
269
- <span class="method-name">hostname</span><span class="method-args">(tmp_uri)</span>
270
- </a>
271
- </div>
272
-
273
- <div class="method-description">
274
- <p><a class="source-toggle" href="#"
275
- onclick="toggleCode('M000274-source');return false;">[Source]</a></p>
276
- <div class="method-source-code" id="M000274-source">
277
- <pre>
278
- <span class="ruby-comment cmt"># File lib/utils/httputil.rb, line 9</span>
279
- 9: <span class="ruby-keyword kw">def</span> <span class="ruby-constant">HTTPUtil</span>.<span class="ruby-identifier">hostname</span>(<span class="ruby-identifier">tmp_uri</span>)
280
- 10: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">tmp_uri</span>.<span class="ruby-identifier">empty?</span>
281
- 11: <span class="ruby-identifier">uri</span> = <span class="ruby-constant">URI</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">tmp_uri</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">tmp_uri</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">String</span>
282
- 12:
283
- 13: <span class="ruby-comment cmt">#STDERR.puts &quot;Hostname for #{ uri.port }&quot;</span>
284
- 14: <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">host</span>
285
- 15: <span class="ruby-keyword kw">end</span>
286
- </pre>
287
- </div>
288
- </div>
289
- </div>
290
-
291
- <div id="method-M000275" class="method-detail">
292
- <a name="M000275"></a>
293
-
294
- <div class="method-heading">
295
- <a href="#M000275" class="method-signature">
296
- <span class="method-name">normalize</span><span class="method-args">(uri_str, scheme = true)</span>
297
- </a>
298
- </div>
299
-
300
- <div class="method-description">
301
- <p>
302
- Normalize all URIs before they are used for anything else
303
- </p>
304
- <p><a class="source-toggle" href="#"
305
- onclick="toggleCode('M000275-source');return false;">[Source]</a></p>
306
- <div class="method-source-code" id="M000275-source">
307
- <pre>
308
- <span class="ruby-comment cmt"># File lib/utils/httputil.rb, line 18</span>
309
- 18: <span class="ruby-keyword kw">def</span> <span class="ruby-constant">HTTPUtil</span>.<span class="ruby-identifier">normalize</span>(<span class="ruby-identifier">uri_str</span>, <span class="ruby-identifier">scheme</span> = <span class="ruby-keyword kw">true</span>)
310
- 19:
311
- 20:
312
- 21: <span class="ruby-comment cmt">#STDERR.puts &quot; BEFORE: &quot; &lt;&lt; uri_str</span>
313
- 22: <span class="ruby-keyword kw">if</span> (<span class="ruby-operator">!</span><span class="ruby-identifier">uri_str</span>.<span class="ruby-identifier">index</span>(<span class="ruby-regexp re">/^https?:\/\//</span>))
314
- 23: <span class="ruby-identifier">uri_str</span> = <span class="ruby-value str">'http://'</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">uri_str</span>
315
- 24: <span class="ruby-keyword kw">end</span>
316
- 25: <span class="ruby-comment cmt">#STDERR.puts &quot; AFTER: &quot; &lt;&lt; uri_str</span>
317
- 26:
318
- 27: <span class="ruby-identifier">uri_str</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-regexp re">/\s/</span>, <span class="ruby-value str">'%20'</span>)
319
- 28:
320
- 29: <span class="ruby-identifier">uri</span> = <span class="ruby-constant">URI</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">uri_str</span>)
321
- 30:
322
- 31: <span class="ruby-identifier">uri_clean</span> = <span class="ruby-value str">&quot;&quot;</span>
323
- 32:
324
- 33: <span class="ruby-comment cmt"># TODO: use URI.to_s instead of manually creating the string</span>
325
- 34:
326
- 35: <span class="ruby-keyword kw">if</span> (<span class="ruby-identifier">scheme</span>)
327
- 36: <span class="ruby-identifier">uri_clean</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">scheme</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator">+</span> <span class="ruby-value str">'://'</span>
328
- 37: <span class="ruby-keyword kw">end</span>
329
- 38:
330
- 39:
331
- 40: <span class="ruby-keyword kw">if</span> (<span class="ruby-operator">!</span><span class="ruby-identifier">uri</span>.<span class="ruby-identifier">userinfo</span>.<span class="ruby-identifier">nil?</span>)
332
- 41: <span class="ruby-identifier">uri_clean</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">userinfo</span>.<span class="ruby-identifier">to_s</span>
333
- 42: <span class="ruby-identifier">uri_clean</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">'@'</span>
334
- 43: <span class="ruby-keyword kw">end</span>
335
- 44:
336
- 45: <span class="ruby-comment cmt">#uri.host.gsub!(/^www\./, '')</span>
337
- 46:
338
- 47: <span class="ruby-identifier">uri_clean</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">host</span>.<span class="ruby-identifier">to_s</span>
339
- 48:
340
- 49: <span class="ruby-keyword kw">if</span> (<span class="ruby-operator">!</span><span class="ruby-identifier">uri</span>.<span class="ruby-identifier">port</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">port</span> <span class="ruby-operator">!=</span> <span class="ruby-value">80</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">port</span> <span class="ruby-operator">!=</span> <span class="ruby-value">443</span>)
341
- 50: <span class="ruby-identifier">uri_clean</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">':'</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">port</span>.<span class="ruby-identifier">to_s</span>
342
- 51: <span class="ruby-keyword kw">end</span>
343
- 52:
344
- 53:
345
- 54:
346
- 55: <span class="ruby-keyword kw">if</span> (<span class="ruby-operator">!</span><span class="ruby-identifier">uri</span>.<span class="ruby-identifier">path</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-operator">!</span><span class="ruby-identifier">uri</span>.<span class="ruby-identifier">path</span>.<span class="ruby-identifier">empty?</span>)
347
- 56: <span class="ruby-identifier">uri_clean</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">path</span>
348
- 57: <span class="ruby-keyword kw">elsif</span>
349
- 58: <span class="ruby-identifier">uri_clean</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">'/'</span>
350
- 59: <span class="ruby-keyword kw">end</span>
351
- 60:
352
- 61:
353
- 62: <span class="ruby-keyword kw">if</span> (<span class="ruby-operator">!</span><span class="ruby-identifier">uri</span>.<span class="ruby-identifier">query</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-operator">!</span><span class="ruby-identifier">uri</span>.<span class="ruby-identifier">path</span>.<span class="ruby-identifier">empty?</span>)
354
- 63: <span class="ruby-identifier">uri_clean</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">&quot;?&quot;</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">query</span>
355
- 64: <span class="ruby-keyword kw">end</span>
356
- 65:
357
- 66: <span class="ruby-comment cmt">#STDERR.puts &quot;IN: &quot; &lt;&lt; uri_str</span>
358
- 67: <span class="ruby-comment cmt">#STDERR.puts &quot;OUT: &quot; &lt;&lt; uri_clean</span>
359
- 68:
360
- 69: <span class="ruby-identifier">uri_clean</span>
361
- 70: <span class="ruby-keyword kw">end</span>
362
- </pre>
363
- </div>
364
- </div>
365
- </div>
366
-
367
- <div id="method-M000280" class="method-detail">
368
- <a name="M000280"></a>
369
-
370
- <div class="method-heading">
371
- <a href="#M000280" class="method-signature">
372
- <span class="method-name">parse_query</span><span class="method-args">(query)</span>
373
- </a>
374
- </div>
375
-
376
- <div class="method-description">
377
- <p><a class="source-toggle" href="#"
378
- onclick="toggleCode('M000280-source');return false;">[Source]</a></p>
379
- <div class="method-source-code" id="M000280-source">
380
- <pre>
381
- <span class="ruby-comment cmt"># File lib/utils/httputil.rb, line 151</span>
382
- 151: <span class="ruby-keyword kw">def</span> <span class="ruby-constant">HTTPUtil</span>.<span class="ruby-identifier">parse_query</span>(<span class="ruby-identifier">query</span>)
383
- 152: <span class="ruby-identifier">params</span> = <span class="ruby-constant">Hash</span>.<span class="ruby-identifier">new</span>([].<span class="ruby-identifier">freeze</span>)
384
- 153:
385
- 154: <span class="ruby-identifier">query</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp re">/[&amp;;]/n</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">pairs</span><span class="ruby-operator">|</span>
386
- 155: <span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span> = <span class="ruby-identifier">pairs</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">'='</span>,<span class="ruby-value">2</span>).<span class="ruby-identifier">collect</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-constant">URI</span>.<span class="ruby-identifier">unescape</span>(<span class="ruby-identifier">v</span>) }
387
- 156: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">params</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-identifier">key</span>)
388
- 157: <span class="ruby-identifier">params</span>[<span class="ruby-identifier">key</span>].<span class="ruby-identifier">push</span>(<span class="ruby-identifier">value</span>)
389
- 158: <span class="ruby-keyword kw">else</span>
390
- 159: <span class="ruby-identifier">params</span>[<span class="ruby-identifier">key</span>] = [<span class="ruby-identifier">value</span>]
391
- 160: <span class="ruby-keyword kw">end</span>
392
- 161: <span class="ruby-keyword kw">end</span>
393
- 162:
394
- 163: <span class="ruby-identifier">params</span>
395
- 164: <span class="ruby-keyword kw">end</span>
396
- </pre>
397
- </div>
398
- </div>
399
- </div>
400
-
401
- <div id="method-M000278" class="method-detail">
402
- <a name="M000278"></a>
403
-
404
- <div class="method-heading">
405
- <a href="#M000278" class="method-signature">
406
- <span class="method-name">post</span><span class="method-args">(uri, params = {}, limit = 10)</span>
407
- </a>
408
- </div>
409
-
410
- <div class="method-description">
411
- <p><a class="source-toggle" href="#"
412
- onclick="toggleCode('M000278-source');return false;">[Source]</a></p>
413
- <div class="method-source-code" id="M000278-source">
414
- <pre>
415
- <span class="ruby-comment cmt"># File lib/utils/httputil.rb, line 105</span>
416
- 105: <span class="ruby-keyword kw">def</span> <span class="ruby-constant">HTTPUtil</span>.<span class="ruby-identifier">post</span>(<span class="ruby-identifier">uri</span>, <span class="ruby-identifier">params</span> = {}, <span class="ruby-identifier">limit</span> = <span class="ruby-value">10</span>)
417
- 106:
418
- 107: <span class="ruby-comment cmt"># You should choose better exception.</span>
419
- 108: <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-value str">'HTTP redirect too deep'</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">limit</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
420
- 109:
421
- 110: <span class="ruby-identifier">uri</span> = <span class="ruby-constant">URI</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">uri</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">String</span>
422
- 111:
423
- 112: <span class="ruby-keyword kw">begin</span>
424
- 113: <span class="ruby-identifier">timeout</span>(<span class="ruby-ivar">@@timeout</span>) <span class="ruby-keyword kw">do</span>
425
- 114: <span class="ruby-identifier">response</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span>.<span class="ruby-identifier">post_form</span>(<span class="ruby-identifier">uri</span>, <span class="ruby-identifier">params</span>)
426
- 115:
427
- 116: <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">response</span>
428
- 117: <span class="ruby-keyword kw">when</span> <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTPSuccess</span> <span class="ruby-keyword kw">then</span> <span class="ruby-identifier">response</span>
429
- 118: <span class="ruby-keyword kw">when</span> <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTPRedirection</span> <span class="ruby-keyword kw">then</span> <span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">response</span>[<span class="ruby-value str">'location'</span>], <span class="ruby-identifier">limit</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>)
430
- 119: <span class="ruby-keyword kw">else</span>
431
- 120: <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span> <span class="ruby-value str">&quot;Error for &quot;</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">to_s</span>
432
- 121: <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">response</span>.<span class="ruby-identifier">body</span>
433
- 122: <span class="ruby-keyword kw">end</span>
434
- 123: <span class="ruby-keyword kw">end</span>
435
- 124: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">TimeoutError</span>
436
- 125: <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">puts</span> <span class="ruby-value str">&quot;Net::HTTP timed out for &quot;</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">to_s</span>
437
- 126: <span class="ruby-keyword kw">return</span>
438
- 127: <span class="ruby-keyword kw">end</span>
439
- 128:
440
- 129:
441
- 130:
442
- 131: <span class="ruby-keyword kw">end</span>
443
- </pre>
444
- </div>
445
- </div>
446
- </div>
447
-
448
- <div id="method-M000282" class="method-detail">
449
- <a name="M000282"></a>
450
-
451
- <div class="method-heading">
452
- <a href="#M000282" class="method-signature">
453
- <span class="method-name">query_to_hash</span><span class="method-args">(query_string)</span>
454
- </a>
455
- </div>
456
-
457
- <div class="method-description">
458
- <p>
459
- Extend the basic query string parser provided by the cgi module. converts
460
- single valued params (the most common case) to objects instead of arrays
461
- </p>
462
- <p>
463
- Input: the query string
464
- </p>
465
- <p>
466
- Output: hash of parameters, contains arrays for multivalued parameters
467
- (multiselect, checkboxes , etc) If no query string is provided (nil or
468
- &quot;&quot;) returns an empty hash.
469
- </p>
470
- <p><a class="source-toggle" href="#"
471
- onclick="toggleCode('M000282-source');return false;">[Source]</a></p>
472
- <div class="method-source-code" id="M000282-source">
473
- <pre>
474
- <span class="ruby-comment cmt"># File lib/utils/httputil.rb, line 182</span>
475
- 182: <span class="ruby-keyword kw">def</span> <span class="ruby-constant">HTTPUtil</span>.<span class="ruby-identifier">query_to_hash</span>(<span class="ruby-identifier">query_string</span>)
476
- 183: <span class="ruby-keyword kw">return</span> {} <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">query_string</span>
477
- 184:
478
- 185: <span class="ruby-identifier">query_parameters</span> = <span class="ruby-constant">HTTPUtil</span>.<span class="ruby-identifier">parse_query</span>(<span class="ruby-identifier">query_string</span>)
479
- 186:
480
- 187: <span class="ruby-identifier">query_parameters</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">key</span>, <span class="ruby-identifier">val</span><span class="ruby-operator">|</span>
481
- 188: <span class="ruby-comment cmt"># replace the array with an object</span>
482
- 189: <span class="ruby-identifier">query_parameters</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">val</span>[<span class="ruby-value">0</span>] <span class="ruby-keyword kw">if</span> <span class="ruby-value">1</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">val</span>.<span class="ruby-identifier">length</span>
483
- 190: }
484
- 191:
485
- 192: <span class="ruby-comment cmt"># set default value to nil! cgi sets this to []</span>
486
- 193: <span class="ruby-identifier">query_parameters</span>.<span class="ruby-identifier">default</span> = <span class="ruby-keyword kw">nil</span>
487
- 194:
488
- 195: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">query_parameters</span>
489
- 196: <span class="ruby-keyword kw">end</span>
490
- </pre>
491
- </div>
492
- </div>
493
- </div>
494
-
495
- <div id="method-M000281" class="method-detail">
496
- <a name="M000281"></a>
497
-
498
- <div class="method-heading">
499
- <a href="#M000281" class="method-signature">
500
- <span class="method-name">validate_method</span><span class="method-args">(meth='GET')</span>
501
- </a>
502
- </div>
503
-
504
- <div class="method-description">
505
- <p><a class="source-toggle" href="#"
506
- onclick="toggleCode('M000281-source');return false;">[Source]</a></p>
507
- <div class="method-source-code" id="M000281-source">
508
- <pre>
509
- <span class="ruby-comment cmt"># File lib/utils/httputil.rb, line 166</span>
510
- 166: <span class="ruby-keyword kw">def</span> <span class="ruby-constant">HTTPUtil</span>.<span class="ruby-identifier">validate_method</span>(<span class="ruby-identifier">meth</span>=<span class="ruby-value str">'GET'</span>)
511
- 167: <span class="ruby-identifier">meth</span> = (<span class="ruby-constant">VALID_METHODS</span>.<span class="ruby-identifier">member?</span> <span class="ruby-identifier">meth</span>.<span class="ruby-identifier">upcase</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">meth</span> <span class="ruby-operator">:</span> <span class="ruby-constant">VALID_METHODS</span>[<span class="ruby-value">0</span>]
512
- 168: <span class="ruby-keyword kw">end</span>
513
- </pre>
514
- </div>
515
- </div>
516
- </div>
517
-
518
-
519
- </div>
520
-
521
-
522
- </div>
523
-
524
-
525
- <div id="validator-badges">
526
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
527
- </div>
528
-
529
- </body>
530
- </html>