vermillion-client 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (103) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +1 -0
  3. data/.hound.yml +2 -0
  4. data/.rubocop.yml +320 -0
  5. data/Gemfile +3 -0
  6. data/Gemfile.lock +26 -0
  7. data/README.md +55 -0
  8. data/Rakefile +10 -0
  9. data/bin/setup +7 -0
  10. data/bin/vermillion +16 -0
  11. data/doc/ChangeBranchTest.html +240 -0
  12. data/doc/ConfigurationTest.html +277 -0
  13. data/doc/CreateTest.html +240 -0
  14. data/doc/Gemfile.html +145 -0
  15. data/doc/Gemfile_lock.html +173 -0
  16. data/doc/README_md.html +216 -0
  17. data/doc/Rakefile.html +151 -0
  18. data/doc/UpdateTest.html +280 -0
  19. data/doc/Vermillion.html +272 -0
  20. data/doc/Vermillion/Cfg.html +362 -0
  21. data/doc/Vermillion/Controller.html +185 -0
  22. data/doc/Vermillion/Controller/Base.html +503 -0
  23. data/doc/Vermillion/Controller/Change.html +301 -0
  24. data/doc/Vermillion/Controller/Create.html +301 -0
  25. data/doc/Vermillion/Controller/Firstrun.html +256 -0
  26. data/doc/Vermillion/Controller/Status.html +308 -0
  27. data/doc/Vermillion/Controller/Update.html +326 -0
  28. data/doc/Vermillion/Helper.html +252 -0
  29. data/doc/Vermillion/Helper/ApiCommunication.html +307 -0
  30. data/doc/Vermillion/Helper/Endpoint.html +506 -0
  31. data/doc/Vermillion/Helper/Formatting.html +250 -0
  32. data/doc/Vermillion/Helper/Network.html +304 -0
  33. data/doc/Vermillion/Helper/Results.html +341 -0
  34. data/doc/Vermillion/Helper/Time.html +295 -0
  35. data/doc/Vermillion/Request.html +332 -0
  36. data/doc/Vermillion/Router.html +351 -0
  37. data/doc/Vermillion/Test.html +183 -0
  38. data/doc/Vermillion/Test/Base.html +260 -0
  39. data/doc/Vermillion/Utils.html +247 -0
  40. data/doc/bin/setup.html +147 -0
  41. data/doc/created.rid +33 -0
  42. data/doc/images/add.png +0 -0
  43. data/doc/images/arrow_up.png +0 -0
  44. data/doc/images/brick.png +0 -0
  45. data/doc/images/brick_link.png +0 -0
  46. data/doc/images/bug.png +0 -0
  47. data/doc/images/bullet_black.png +0 -0
  48. data/doc/images/bullet_toggle_minus.png +0 -0
  49. data/doc/images/bullet_toggle_plus.png +0 -0
  50. data/doc/images/date.png +0 -0
  51. data/doc/images/delete.png +0 -0
  52. data/doc/images/find.png +0 -0
  53. data/doc/images/loadingAnimation.gif +0 -0
  54. data/doc/images/macFFBgHack.png +0 -0
  55. data/doc/images/package.png +0 -0
  56. data/doc/images/page_green.png +0 -0
  57. data/doc/images/page_white_text.png +0 -0
  58. data/doc/images/page_white_width.png +0 -0
  59. data/doc/images/plugin.png +0 -0
  60. data/doc/images/ruby.png +0 -0
  61. data/doc/images/tag_blue.png +0 -0
  62. data/doc/images/tag_green.png +0 -0
  63. data/doc/images/transparent.png +0 -0
  64. data/doc/images/wrench.png +0 -0
  65. data/doc/images/wrench_orange.png +0 -0
  66. data/doc/images/zoom.png +0 -0
  67. data/doc/index.html +138 -0
  68. data/doc/js/darkfish.js +155 -0
  69. data/doc/js/jquery.js +4 -0
  70. data/doc/js/navigation.js +142 -0
  71. data/doc/js/search.js +94 -0
  72. data/doc/js/search_index.js +1 -0
  73. data/doc/js/searcher.js +228 -0
  74. data/doc/rdoc.css +595 -0
  75. data/doc/table_of_contents.html +255 -0
  76. data/doc/vermillion-client_gemspec.html +166 -0
  77. data/lib/client.rb +35 -0
  78. data/lib/client/config.rb +58 -0
  79. data/lib/client/controller.rb +68 -0
  80. data/lib/client/controller/change.rb +26 -0
  81. data/lib/client/controller/create.rb +26 -0
  82. data/lib/client/controller/firstrun.rb +30 -0
  83. data/lib/client/controller/status.rb +43 -0
  84. data/lib/client/controller/update.rb +26 -0
  85. data/lib/client/helper.rb +21 -0
  86. data/lib/client/helper/apicommunication.rb +78 -0
  87. data/lib/client/helper/endpoint.rb +61 -0
  88. data/lib/client/helper/formatting.rb +23 -0
  89. data/lib/client/helper/network.rb +54 -0
  90. data/lib/client/helper/results.rb +28 -0
  91. data/lib/client/helper/time.rb +33 -0
  92. data/lib/client/request.rb +22 -0
  93. data/lib/client/router.rb +56 -0
  94. data/lib/client/utils.rb +18 -0
  95. data/lib/client/version.rb +4 -0
  96. data/lib/test.rb +13 -0
  97. data/lib/test/base.rb +17 -0
  98. data/test/test_change_branch.rb +14 -0
  99. data/test/test_configuration.rb +21 -0
  100. data/test/test_create.rb +14 -0
  101. data/test/test_update.rb +24 -0
  102. data/vermillion-client.gemspec +23 -0
  103. metadata +201 -0
data/doc/Vermillion/Controller.html ADDED
@@ -0,0 +1,185 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
6
+
7
+ <title>module Vermillion::Controller - RDoc Documentation</title>
8
+
9
+ <link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet">
10
+
11
+ <script type="text/javascript">
12
+ var rdoc_rel_prefix = "../";
13
+ </script>
14
+
15
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
16
+ <script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script>
17
+ <script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script>
18
+ <script type="text/javascript" charset="utf-8" src="../js/search.js"></script>
19
+ <script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script>
20
+ <script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script>
21
+
22
+
23
+ <body id="top" class="module">
24
+ <nav id="metadata">
25
+ <nav id="home-section" class="section">
26
+ <h3 class="section-header">
27
+ <a href="../index.html">Home</a>
28
+ <a href="../table_of_contents.html#classes">Classes</a>
29
+ <a href="../table_of_contents.html#methods">Methods</a>
30
+ </h3>
31
+ </nav>
32
+
33
+
34
+ <nav id="search-section" class="section project-section" class="initially-hidden">
35
+ <form action="#" method="get" accept-charset="utf-8">
36
+ <h3 class="section-header">
37
+ <input type="text" name="search" placeholder="Search" id="search-field"
38
+ title="Type to search, Up and Down to navigate, Enter to load">
39
+ </h3>
40
+ </form>
41
+
42
+ <ul id="search-results" class="initially-hidden"></ul>
43
+ </nav>
44
+
45
+
46
+
47
+
48
+ <div id="file-metadata">
49
+ <nav id="file-list-section" class="section">
50
+ <h3 class="section-header">Defined In</h3>
51
+ <ul>
52
+ <li>lib/client/controller.rb
53
+ <li>lib/client/controller/change.rb
54
+ <li>lib/client/controller/create.rb
55
+ <li>lib/client/controller/firstrun.rb
56
+ <li>lib/client/controller/status.rb
57
+ <li>lib/client/controller/update.rb
58
+ </ul>
59
+ </nav>
60
+
61
+
62
+ </div>
63
+
64
+ <div id="class-metadata">
65
+
66
+
67
+
68
+
69
+
70
+ </div>
71
+
72
+ <div id="project-metadata">
73
+ <nav id="fileindex-section" class="section project-section">
74
+ <h3 class="section-header">Pages</h3>
75
+
76
+ <ul>
77
+
78
+ <li class="file"><a href="../Gemfile.html">Gemfile</a>
79
+
80
+ <li class="file"><a href="../Gemfile_lock.html">Gemfile.lock</a>
81
+
82
+ <li class="file"><a href="../README_md.html">README</a>
83
+
84
+ <li class="file"><a href="../Rakefile.html">Rakefile</a>
85
+
86
+ <li class="file"><a href="../bin/setup.html">setup</a>
87
+
88
+ <li class="file"><a href="../vermillion-client_gemspec.html">vermillion-client.gemspec</a>
89
+
90
+ </ul>
91
+ </nav>
92
+
93
+ <nav id="classindex-section" class="section project-section">
94
+ <h3 class="section-header">Class and Module Index</h3>
95
+
96
+ <ul class="link-list">
97
+
98
+ <li><a href="../ChangeBranchTest.html">ChangeBranchTest</a>
99
+
100
+ <li><a href="../ConfigurationTest.html">ConfigurationTest</a>
101
+
102
+ <li><a href="../CreateTest.html">CreateTest</a>
103
+
104
+ <li><a href="../UpdateTest.html">UpdateTest</a>
105
+
106
+ <li><a href="../Vermillion.html">Vermillion</a>
107
+
108
+ <li><a href="../Vermillion/Cfg.html">Vermillion::Cfg</a>
109
+
110
+ <li><a href="../Vermillion/Controller.html">Vermillion::Controller</a>
111
+
112
+ <li><a href="../Vermillion/Controller/Base.html">Vermillion::Controller::Base</a>
113
+
114
+ <li><a href="../Vermillion/Controller/Change.html">Vermillion::Controller::Change</a>
115
+
116
+ <li><a href="../Vermillion/Controller/Create.html">Vermillion::Controller::Create</a>
117
+
118
+ <li><a href="../Vermillion/Controller/Firstrun.html">Vermillion::Controller::Firstrun</a>
119
+
120
+ <li><a href="../Vermillion/Controller/Status.html">Vermillion::Controller::Status</a>
121
+
122
+ <li><a href="../Vermillion/Controller/Update.html">Vermillion::Controller::Update</a>
123
+
124
+ <li><a href="../Vermillion/Helper.html">Vermillion::Helper</a>
125
+
126
+ <li><a href="../Vermillion/Helper/ApiCommunication.html">Vermillion::Helper::ApiCommunication</a>
127
+
128
+ <li><a href="../Vermillion/Helper/Endpoint.html">Vermillion::Helper::Endpoint</a>
129
+
130
+ <li><a href="../Vermillion/Helper/Formatting.html">Vermillion::Helper::Formatting</a>
131
+
132
+ <li><a href="../Vermillion/Helper/Network.html">Vermillion::Helper::Network</a>
133
+
134
+ <li><a href="../Vermillion/Helper/Results.html">Vermillion::Helper::Results</a>
135
+
136
+ <li><a href="../Vermillion/Helper/Time.html">Vermillion::Helper::Time</a>
137
+
138
+ <li><a href="../Vermillion/Request.html">Vermillion::Request</a>
139
+
140
+ <li><a href="../Vermillion/Router.html">Vermillion::Router</a>
141
+
142
+ <li><a href="../Vermillion/Test.html">Vermillion::Test</a>
143
+
144
+ <li><a href="../Vermillion/Test/Base.html">Vermillion::Test::Base</a>
145
+
146
+ <li><a href="../Vermillion/Utils.html">Vermillion::Utils</a>
147
+
148
+ </ul>
149
+ </nav>
150
+
151
+ </div>
152
+ </nav>
153
+
154
+ <div id="documentation">
155
+ <h1 class="module">module Vermillion::Controller</h1>
156
+
157
+ <div id="description" class="description">
158
+
159
+ </div><!-- description -->
160
+
161
+
162
+
163
+
164
+ <section id="5Buntitled-5D" class="documentation-section">
165
+
166
+
167
+
168
+
169
+
170
+
171
+
172
+
173
+ <!-- Methods -->
174
+
175
+ </section><!-- 5Buntitled-5D -->
176
+
177
+ </div><!-- documentation -->
178
+
179
+
180
+ <footer id="validator-badges">
181
+ <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
182
+ <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 4.0.0.
183
+ <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
184
+ </footer>
185
+
data/doc/Vermillion/Controller/Base.html ADDED
@@ -0,0 +1,503 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
6
+
7
+ <title>class Vermillion::Controller::Base - RDoc Documentation</title>
8
+
9
+ <link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet">
10
+
11
+ <script type="text/javascript">
12
+ var rdoc_rel_prefix = "../../";
13
+ </script>
14
+
15
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
16
+ <script type="text/javascript" charset="utf-8" src="../../js/navigation.js"></script>
17
+ <script type="text/javascript" charset="utf-8" src="../../js/search_index.js"></script>
18
+ <script type="text/javascript" charset="utf-8" src="../../js/search.js"></script>
19
+ <script type="text/javascript" charset="utf-8" src="../../js/searcher.js"></script>
20
+ <script type="text/javascript" charset="utf-8" src="../../js/darkfish.js"></script>
21
+
22
+
23
+ <body id="top" class="class">
24
+ <nav id="metadata">
25
+ <nav id="home-section" class="section">
26
+ <h3 class="section-header">
27
+ <a href="../../index.html">Home</a>
28
+ <a href="../../table_of_contents.html#classes">Classes</a>
29
+ <a href="../../table_of_contents.html#methods">Methods</a>
30
+ </h3>
31
+ </nav>
32
+
33
+
34
+ <nav id="search-section" class="section project-section" class="initially-hidden">
35
+ <form action="#" method="get" accept-charset="utf-8">
36
+ <h3 class="section-header">
37
+ <input type="text" name="search" placeholder="Search" id="search-field"
38
+ title="Type to search, Up and Down to navigate, Enter to load">
39
+ </h3>
40
+ </form>
41
+
42
+ <ul id="search-results" class="initially-hidden"></ul>
43
+ </nav>
44
+
45
+
46
+
47
+
48
+ <div id="file-metadata">
49
+ <nav id="file-list-section" class="section">
50
+ <h3 class="section-header">Defined In</h3>
51
+ <ul>
52
+ <li>lib/client/controller.rb
53
+ </ul>
54
+ </nav>
55
+
56
+
57
+ </div>
58
+
59
+ <div id="class-metadata">
60
+
61
+ <nav id="parent-class-section" class="section">
62
+ <h3 class="section-header">Parent</h3>
63
+
64
+ <p class="link">Object
65
+
66
+ </nav>
67
+
68
+
69
+
70
+ <!-- Method Quickref -->
71
+ <nav id="method-list-section" class="section">
72
+ <h3 class="section-header">Methods</h3>
73
+
74
+ <ul class="link-list">
75
+
76
+ <li ><a href="#method-c-new">::new</a>
77
+
78
+ <li ><a href="#method-i-can_exec-3F">#can_exec?</a>
79
+
80
+ <li ><a href="#method-i-exec">#exec</a>
81
+
82
+ <li ><a href="#method-i-post_exec">#post_exec</a>
83
+
84
+ <li ><a href="#method-i-pre_exec">#pre_exec</a>
85
+
86
+ <li ><a href="#method-i-sample">#sample</a>
87
+
88
+ </ul>
89
+ </nav>
90
+
91
+ </div>
92
+
93
+ <div id="project-metadata">
94
+ <nav id="fileindex-section" class="section project-section">
95
+ <h3 class="section-header">Pages</h3>
96
+
97
+ <ul>
98
+
99
+ <li class="file"><a href="../../Gemfile.html">Gemfile</a>
100
+
101
+ <li class="file"><a href="../../Gemfile_lock.html">Gemfile.lock</a>
102
+
103
+ <li class="file"><a href="../../README_md.html">README</a>
104
+
105
+ <li class="file"><a href="../../Rakefile.html">Rakefile</a>
106
+
107
+ <li class="file"><a href="../../bin/setup.html">setup</a>
108
+
109
+ <li class="file"><a href="../../vermillion-client_gemspec.html">vermillion-client.gemspec</a>
110
+
111
+ </ul>
112
+ </nav>
113
+
114
+ <nav id="classindex-section" class="section project-section">
115
+ <h3 class="section-header">Class and Module Index</h3>
116
+
117
+ <ul class="link-list">
118
+
119
+ <li><a href="../../ChangeBranchTest.html">ChangeBranchTest</a>
120
+
121
+ <li><a href="../../ConfigurationTest.html">ConfigurationTest</a>
122
+
123
+ <li><a href="../../CreateTest.html">CreateTest</a>
124
+
125
+ <li><a href="../../UpdateTest.html">UpdateTest</a>
126
+
127
+ <li><a href="../../Vermillion.html">Vermillion</a>
128
+
129
+ <li><a href="../../Vermillion/Cfg.html">Vermillion::Cfg</a>
130
+
131
+ <li><a href="../../Vermillion/Controller.html">Vermillion::Controller</a>
132
+
133
+ <li><a href="../../Vermillion/Controller/Base.html">Vermillion::Controller::Base</a>
134
+
135
+ <li><a href="../../Vermillion/Controller/Change.html">Vermillion::Controller::Change</a>
136
+
137
+ <li><a href="../../Vermillion/Controller/Create.html">Vermillion::Controller::Create</a>
138
+
139
+ <li><a href="../../Vermillion/Controller/Firstrun.html">Vermillion::Controller::Firstrun</a>
140
+
141
+ <li><a href="../../Vermillion/Controller/Status.html">Vermillion::Controller::Status</a>
142
+
143
+ <li><a href="../../Vermillion/Controller/Update.html">Vermillion::Controller::Update</a>
144
+
145
+ <li><a href="../../Vermillion/Helper.html">Vermillion::Helper</a>
146
+
147
+ <li><a href="../../Vermillion/Helper/ApiCommunication.html">Vermillion::Helper::ApiCommunication</a>
148
+
149
+ <li><a href="../../Vermillion/Helper/Endpoint.html">Vermillion::Helper::Endpoint</a>
150
+
151
+ <li><a href="../../Vermillion/Helper/Formatting.html">Vermillion::Helper::Formatting</a>
152
+
153
+ <li><a href="../../Vermillion/Helper/Network.html">Vermillion::Helper::Network</a>
154
+
155
+ <li><a href="../../Vermillion/Helper/Results.html">Vermillion::Helper::Results</a>
156
+
157
+ <li><a href="../../Vermillion/Helper/Time.html">Vermillion::Helper::Time</a>
158
+
159
+ <li><a href="../../Vermillion/Request.html">Vermillion::Request</a>
160
+
161
+ <li><a href="../../Vermillion/Router.html">Vermillion::Router</a>
162
+
163
+ <li><a href="../../Vermillion/Test.html">Vermillion::Test</a>
164
+
165
+ <li><a href="../../Vermillion/Test/Base.html">Vermillion::Test::Base</a>
166
+
167
+ <li><a href="../../Vermillion/Utils.html">Vermillion::Utils</a>
168
+
169
+ </ul>
170
+ </nav>
171
+
172
+ </div>
173
+ </nav>
174
+
175
+ <div id="documentation">
176
+ <h1 class="class">class Vermillion::Controller::Base</h1>
177
+
178
+ <div id="description" class="description">
179
+
180
+ </div><!-- description -->
181
+
182
+
183
+
184
+
185
+ <section id="5Buntitled-5D" class="documentation-section">
186
+
187
+
188
+
189
+
190
+
191
+ <!-- Constants -->
192
+ <section id="constants-list" class="section">
193
+ <h3 class="section-header">Constants</h3>
194
+ <dl>
195
+
196
+ <dt id="OK">OK
197
+
198
+ <dd class="description"><p>Exit code to indicate everything is ok!</p>
199
+
200
+
201
+ <dt id="QUIT">QUIT
202
+
203
+ <dd class="description"><p>Exit code to indicate a force quit (exit) call, meaning the program quit
204
+ with an error</p>
205
+
206
+
207
+ <dt id="QUIT_SOFT">QUIT_SOFT
208
+
209
+ <dd class="description"><p>Exit code to indicate that the program exited with a non-zero exit code,
210
+ but not one that resulted in a force quit</p>
211
+
212
+
213
+ </dl>
214
+ </section>
215
+
216
+
217
+
218
+ <!-- Attributes -->
219
+ <section id="attribute-method-details" class="method-section section">
220
+ <h3 class="section-header">Attributes</h3>
221
+
222
+
223
+ <div id="attribute-i-config" class="method-detail">
224
+ <div class="method-heading attribute-method-heading">
225
+ <span class="method-name">config</span><span
226
+ class="attribute-access-type">[RW]</span>
227
+ </div>
228
+
229
+ <div class="method-description">
230
+
231
+
232
+
233
+ </div>
234
+ </div>
235
+
236
+ <div id="attribute-i-request" class="method-detail">
237
+ <div class="method-heading attribute-method-heading">
238
+ <span class="method-name">request</span><span
239
+ class="attribute-access-type">[RW]</span>
240
+ </div>
241
+
242
+ <div class="method-description">
243
+
244
+
245
+
246
+ </div>
247
+ </div>
248
+
249
+ </section><!-- attribute-method-details -->
250
+
251
+
252
+ <!-- Methods -->
253
+
254
+ <section id="public-class-5Buntitled-5D-method-details" class="method-section section">
255
+ <h3 class="section-header">Public Class Methods</h3>
256
+
257
+
258
+ <div id="method-c-new" class="method-detail ">
259
+
260
+ <div class="method-heading">
261
+ <span class="method-name">new</span><span
262
+ class="method-args">(config, request)</span>
263
+
264
+ <span class="method-click-advice">click to toggle source</span>
265
+
266
+ </div>
267
+
268
+
269
+ <div class="method-description">
270
+
271
+ <p>Setup internal variables that will be used in subclasses Params:</p>
272
+ <dl class="rdoc-list note-list"><dt><code>config</code>
273
+ <dd>
274
+ <p>Instance of <a href="../Cfg.html">Vermillion::Cfg</a> to enable access to
275
+ config file</p>
276
+ </dd><dt><code>request</code>
277
+ <dd>
278
+ <p>Instance of <a href="../Request.html">Vermillion::Request</a>, enables
279
+ access to request parameters</p>
280
+ </dd></dl>
281
+
282
+
283
+
284
+
285
+ <div class="method-source-code" id="new-source">
286
+ <pre><span class="ruby-comment"># File lib/client/controller.rb, line 20</span>
287
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">config</span>, <span class="ruby-identifier">request</span>)
288
+ <span class="ruby-ivar">@config</span> = <span class="ruby-identifier">config</span>
289
+ <span class="ruby-ivar">@request</span> = <span class="ruby-identifier">request</span>
290
+
291
+ <span class="ruby-identifier">pre_exec</span>
292
+ <span class="ruby-keyword">end</span></pre>
293
+ </div><!-- new-source -->
294
+
295
+ </div>
296
+
297
+
298
+
299
+
300
+ </div><!-- new-method -->
301
+
302
+
303
+ </section><!-- public-class-method-details -->
304
+
305
+ <section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
306
+ <h3 class="section-header">Public Instance Methods</h3>
307
+
308
+
309
+ <div id="method-i-can_exec-3F" class="method-detail ">
310
+
311
+ <div class="method-heading">
312
+ <span class="method-name">can_exec?</span><span
313
+ class="method-args">(command)</span>
314
+
315
+ <span class="method-click-advice">click to toggle source</span>
316
+
317
+ </div>
318
+
319
+
320
+ <div class="method-description">
321
+
322
+ <p>Determines if the command can execute Params:</p>
323
+ <dl class="rdoc-list note-list"><dt><code>command</code>
324
+ <dd>
325
+ <p>Symbol containing the command we want to execute</p>
326
+ </dd></dl>
327
+
328
+
329
+
330
+
331
+ <div class="method-source-code" id="can_exec-3F-source">
332
+ <pre><span class="ruby-comment"># File lib/client/controller.rb, line 50</span>
333
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">can_exec?</span>(<span class="ruby-identifier">command</span>)
334
+ <span class="ruby-comment"># no command was passed, check if controller has a default method</span>
335
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">command</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:default</span>)
336
+ <span class="ruby-ivar">@method</span> = <span class="ruby-value">:default</span>
337
+ <span class="ruby-keyword">elsif</span> <span class="ruby-identifier">respond_to?</span> <span class="ruby-identifier">command</span>
338
+ <span class="ruby-comment"># check the controller for the requested method</span>
339
+ <span class="ruby-ivar">@method</span> = <span class="ruby-identifier">command</span>
340
+ <span class="ruby-keyword">else</span>
341
+ <span class="ruby-identifier">raise</span> <span class="ruby-constant">NoMethodError</span>, <span class="ruby-node">&quot;Invalid method: #{command}&quot;</span>
342
+ <span class="ruby-keyword">end</span>
343
+ <span class="ruby-keyword">end</span></pre>
344
+ </div><!-- can_exec-3F-source -->
345
+
346
+ </div>
347
+
348
+
349
+
350
+
351
+ </div><!-- can_exec-3F-method -->
352
+
353
+
354
+ <div id="method-i-exec" class="method-detail ">
355
+
356
+ <div class="method-heading">
357
+ <span class="method-name">exec</span><span
358
+ class="method-args">()</span>
359
+
360
+ <span class="method-click-advice">click to toggle source</span>
361
+
362
+ </div>
363
+
364
+
365
+ <div class="method-description">
366
+
367
+ <p>Handle the request</p>
368
+
369
+
370
+
371
+
372
+ <div class="method-source-code" id="exec-source">
373
+ <pre><span class="ruby-comment"># File lib/client/controller.rb, line 35</span>
374
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">exec</span>
375
+ <span class="ruby-keyword">if</span> <span class="ruby-ivar">@request</span>.<span class="ruby-identifier">param</span>.<span class="ruby-identifier">nil?</span>
376
+ <span class="ruby-identifier">send</span>(<span class="ruby-ivar">@method</span>.<span class="ruby-identifier">to_sym</span>)
377
+ <span class="ruby-keyword">else</span>
378
+ <span class="ruby-identifier">send</span>(<span class="ruby-ivar">@method</span>.<span class="ruby-identifier">to_sym</span>, <span class="ruby-ivar">@request</span>.<span class="ruby-identifier">param</span>)
379
+ <span class="ruby-keyword">end</span>
380
+ <span class="ruby-keyword">end</span></pre>
381
+ </div><!-- exec-source -->
382
+
383
+ </div>
384
+
385
+
386
+
387
+
388
+ </div><!-- exec-method -->
389
+
390
+
391
+ <div id="method-i-post_exec" class="method-detail ">
392
+
393
+ <div class="method-heading">
394
+ <span class="method-name">post_exec</span><span
395
+ class="method-args">()</span>
396
+
397
+ <span class="method-click-advice">click to toggle source</span>
398
+
399
+ </div>
400
+
401
+
402
+ <div class="method-description">
403
+
404
+ <p>Perform post-run cleanup tasks, such as deleting old logs</p>
405
+
406
+
407
+
408
+
409
+ <div class="method-source-code" id="post_exec-source">
410
+ <pre><span class="ruby-comment"># File lib/client/controller.rb, line 44</span>
411
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">post_exec</span>
412
+ <span class="ruby-keyword">end</span></pre>
413
+ </div><!-- post_exec-source -->
414
+
415
+ </div>
416
+
417
+
418
+
419
+
420
+ </div><!-- post_exec-method -->
421
+
422
+
423
+ <div id="method-i-pre_exec" class="method-detail ">
424
+
425
+ <div class="method-heading">
426
+ <span class="method-name">pre_exec</span><span
427
+ class="method-args">()</span>
428
+
429
+ <span class="method-click-advice">click to toggle source</span>
430
+
431
+ </div>
432
+
433
+
434
+ <div class="method-description">
435
+
436
+ <p>Perform pre-run tasks</p>
437
+
438
+
439
+
440
+
441
+ <div class="method-source-code" id="pre_exec-source">
442
+ <pre><span class="ruby-comment"># File lib/client/controller.rb, line 28</span>
443
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">pre_exec</span>
444
+ <span class="ruby-ivar">@format</span> = <span class="ruby-constant">Vermillion</span><span class="ruby-operator">::</span><span class="ruby-constant">Helper</span>.<span class="ruby-identifier">load</span>(<span class="ruby-string">&#39;formatting&#39;</span>)
445
+ <span class="ruby-ivar">@network</span> = <span class="ruby-constant">Vermillion</span><span class="ruby-operator">::</span><span class="ruby-constant">Helper</span>.<span class="ruby-identifier">load</span>(<span class="ruby-string">&#39;network&#39;</span>)
446
+ <span class="ruby-ivar">@network</span>.<span class="ruby-identifier">config</span> = <span class="ruby-ivar">@config</span>
447
+ <span class="ruby-keyword">end</span></pre>
448
+ </div><!-- pre_exec-source -->
449
+
450
+ </div>
451
+
452
+
453
+
454
+
455
+ </div><!-- pre_exec-method -->
456
+
457
+
458
+ <div id="method-i-sample" class="method-detail ">
459
+
460
+ <div class="method-heading">
461
+ <span class="method-name">sample</span><span
462
+ class="method-args">()</span>
463
+
464
+ <span class="method-click-advice">click to toggle source</span>
465
+
466
+ </div>
467
+
468
+
469
+ <div class="method-description">
470
+
471
+ <p>Default method called by exec if no argument is passed</p>
472
+
473
+
474
+
475
+
476
+ <div class="method-source-code" id="sample-source">
477
+ <pre><span class="ruby-comment"># File lib/client/controller.rb, line 63</span>
478
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">sample</span>
479
+ <span class="ruby-constant">Notify</span>.<span class="ruby-identifier">warning</span>(<span class="ruby-string">&quot;Method not implemented&quot;</span>)
480
+ <span class="ruby-keyword">end</span></pre>
481
+ </div><!-- sample-source -->
482
+
483
+ </div>
484
+
485
+
486
+
487
+
488
+ </div><!-- sample-method -->
489
+
490
+
491
+ </section><!-- public-instance-method-details -->
492
+
493
+ </section><!-- 5Buntitled-5D -->
494
+
495
+ </div><!-- documentation -->
496
+
497
+
498
+ <footer id="validator-badges">
499
+ <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
500
+ <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 4.0.0.
501
+ <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
502
+ </footer>
503
+