vermillion-client 1.0.0

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 (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.html ADDED
@@ -0,0 +1,272 @@
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 - 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>bin/vermillion
53
+ <li>lib/client.rb
54
+ <li>lib/client/config.rb
55
+ <li>lib/client/controller.rb
56
+ <li>lib/client/controller/change.rb
57
+ <li>lib/client/controller/create.rb
58
+ <li>lib/client/controller/firstrun.rb
59
+ <li>lib/client/controller/status.rb
60
+ <li>lib/client/controller/update.rb
61
+ <li>lib/client/helper.rb
62
+ <li>lib/client/helper/apicommunication.rb
63
+ <li>lib/client/helper/endpoint.rb
64
+ <li>lib/client/helper/formatting.rb
65
+ <li>lib/client/helper/network.rb
66
+ <li>lib/client/helper/results.rb
67
+ <li>lib/client/helper/time.rb
68
+ <li>lib/client/request.rb
69
+ <li>lib/client/router.rb
70
+ <li>lib/client/utils.rb
71
+ <li>lib/client/version.rb
72
+ <li>lib/test.rb
73
+ <li>lib/test/base.rb
74
+ <li>test/test_change_branch.rb
75
+ <li>test/test_configuration.rb
76
+ <li>test/test_create.rb
77
+ <li>test/test_update.rb
78
+ </ul>
79
+ </nav>
80
+
81
+
82
+ </div>
83
+
84
+ <div id="class-metadata">
85
+
86
+
87
+
88
+
89
+ <!-- Method Quickref -->
90
+ <nav id="method-list-section" class="section">
91
+ <h3 class="section-header">Methods</h3>
92
+
93
+ <ul class="link-list">
94
+
95
+ <li ><a href="#method-c-test-3F">::test?</a>
96
+
97
+ </ul>
98
+ </nav>
99
+
100
+ </div>
101
+
102
+ <div id="project-metadata">
103
+ <nav id="fileindex-section" class="section project-section">
104
+ <h3 class="section-header">Pages</h3>
105
+
106
+ <ul>
107
+
108
+ <li class="file"><a href="./Gemfile.html">Gemfile</a>
109
+
110
+ <li class="file"><a href="./Gemfile_lock.html">Gemfile.lock</a>
111
+
112
+ <li class="file"><a href="./README_md.html">README</a>
113
+
114
+ <li class="file"><a href="./Rakefile.html">Rakefile</a>
115
+
116
+ <li class="file"><a href="./bin/setup.html">setup</a>
117
+
118
+ <li class="file"><a href="./vermillion-client_gemspec.html">vermillion-client.gemspec</a>
119
+
120
+ </ul>
121
+ </nav>
122
+
123
+ <nav id="classindex-section" class="section project-section">
124
+ <h3 class="section-header">Class and Module Index</h3>
125
+
126
+ <ul class="link-list">
127
+
128
+ <li><a href="./ChangeBranchTest.html">ChangeBranchTest</a>
129
+
130
+ <li><a href="./ConfigurationTest.html">ConfigurationTest</a>
131
+
132
+ <li><a href="./CreateTest.html">CreateTest</a>
133
+
134
+ <li><a href="./UpdateTest.html">UpdateTest</a>
135
+
136
+ <li><a href="./Vermillion.html">Vermillion</a>
137
+
138
+ <li><a href="./Vermillion/Cfg.html">Vermillion::Cfg</a>
139
+
140
+ <li><a href="./Vermillion/Controller.html">Vermillion::Controller</a>
141
+
142
+ <li><a href="./Vermillion/Controller/Base.html">Vermillion::Controller::Base</a>
143
+
144
+ <li><a href="./Vermillion/Controller/Change.html">Vermillion::Controller::Change</a>
145
+
146
+ <li><a href="./Vermillion/Controller/Create.html">Vermillion::Controller::Create</a>
147
+
148
+ <li><a href="./Vermillion/Controller/Firstrun.html">Vermillion::Controller::Firstrun</a>
149
+
150
+ <li><a href="./Vermillion/Controller/Status.html">Vermillion::Controller::Status</a>
151
+
152
+ <li><a href="./Vermillion/Controller/Update.html">Vermillion::Controller::Update</a>
153
+
154
+ <li><a href="./Vermillion/Helper.html">Vermillion::Helper</a>
155
+
156
+ <li><a href="./Vermillion/Helper/ApiCommunication.html">Vermillion::Helper::ApiCommunication</a>
157
+
158
+ <li><a href="./Vermillion/Helper/Endpoint.html">Vermillion::Helper::Endpoint</a>
159
+
160
+ <li><a href="./Vermillion/Helper/Formatting.html">Vermillion::Helper::Formatting</a>
161
+
162
+ <li><a href="./Vermillion/Helper/Network.html">Vermillion::Helper::Network</a>
163
+
164
+ <li><a href="./Vermillion/Helper/Results.html">Vermillion::Helper::Results</a>
165
+
166
+ <li><a href="./Vermillion/Helper/Time.html">Vermillion::Helper::Time</a>
167
+
168
+ <li><a href="./Vermillion/Request.html">Vermillion::Request</a>
169
+
170
+ <li><a href="./Vermillion/Router.html">Vermillion::Router</a>
171
+
172
+ <li><a href="./Vermillion/Test.html">Vermillion::Test</a>
173
+
174
+ <li><a href="./Vermillion/Test/Base.html">Vermillion::Test::Base</a>
175
+
176
+ <li><a href="./Vermillion/Utils.html">Vermillion::Utils</a>
177
+
178
+ </ul>
179
+ </nav>
180
+
181
+ </div>
182
+ </nav>
183
+
184
+ <div id="documentation">
185
+ <h1 class="module">module Vermillion</h1>
186
+
187
+ <div id="description" class="description">
188
+
189
+ </div><!-- description -->
190
+
191
+
192
+
193
+
194
+ <section id="5Buntitled-5D" class="documentation-section">
195
+
196
+
197
+
198
+
199
+
200
+ <!-- Constants -->
201
+ <section id="constants-list" class="section">
202
+ <h3 class="section-header">Constants</h3>
203
+ <dl>
204
+
205
+ <dt id="DEBUG">DEBUG
206
+
207
+ <dd class="description"><p>Flag for enabling more verbose output from certain methods</p>
208
+
209
+
210
+ <dt id="VERSION">VERSION
211
+
212
+ <dd class="description"><p>Program version</p>
213
+
214
+
215
+ </dl>
216
+ </section>
217
+
218
+
219
+
220
+
221
+ <!-- Methods -->
222
+
223
+ <section id="public-class-5Buntitled-5D-method-details" class="method-section section">
224
+ <h3 class="section-header">Public Class Methods</h3>
225
+
226
+
227
+ <div id="method-c-test-3F" class="method-detail ">
228
+
229
+ <div class="method-heading">
230
+ <span class="method-name">test?</span><span
231
+ class="method-args">()</span>
232
+
233
+ <span class="method-click-advice">click to toggle source</span>
234
+
235
+ </div>
236
+
237
+
238
+ <div class="method-description">
239
+
240
+ <p>Flag to determine if module is running in test mode</p>
241
+
242
+
243
+
244
+
245
+ <div class="method-source-code" id="test-3F-source">
246
+ <pre><span class="ruby-comment"># File lib/client.rb, line 32</span>
247
+ <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">test?</span>
248
+ <span class="ruby-keyword">false</span>
249
+ <span class="ruby-keyword">end</span></pre>
250
+ </div><!-- test-3F-source -->
251
+
252
+ </div>
253
+
254
+
255
+
256
+
257
+ </div><!-- test-3F-method -->
258
+
259
+
260
+ </section><!-- public-class-method-details -->
261
+
262
+ </section><!-- 5Buntitled-5D -->
263
+
264
+ </div><!-- documentation -->
265
+
266
+
267
+ <footer id="validator-badges">
268
+ <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
269
+ <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 4.0.0.
270
+ <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
271
+ </footer>
272
+
data/doc/Vermillion/Cfg.html ADDED
@@ -0,0 +1,362 @@
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::Cfg - 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/config.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-i-bootstrap-21">#bootstrap!</a>
77
+
78
+ <li ><a href="#method-i-get">#get</a>
79
+
80
+ <li ><a href="#method-i-options">#options</a>
81
+
82
+ <li ><a href="#method-i-populate_config">#populate_config</a>
83
+
84
+ </ul>
85
+ </nav>
86
+
87
+ </div>
88
+
89
+ <div id="project-metadata">
90
+ <nav id="fileindex-section" class="section project-section">
91
+ <h3 class="section-header">Pages</h3>
92
+
93
+ <ul>
94
+
95
+ <li class="file"><a href="../Gemfile.html">Gemfile</a>
96
+
97
+ <li class="file"><a href="../Gemfile_lock.html">Gemfile.lock</a>
98
+
99
+ <li class="file"><a href="../README_md.html">README</a>
100
+
101
+ <li class="file"><a href="../Rakefile.html">Rakefile</a>
102
+
103
+ <li class="file"><a href="../bin/setup.html">setup</a>
104
+
105
+ <li class="file"><a href="../vermillion-client_gemspec.html">vermillion-client.gemspec</a>
106
+
107
+ </ul>
108
+ </nav>
109
+
110
+ <nav id="classindex-section" class="section project-section">
111
+ <h3 class="section-header">Class and Module Index</h3>
112
+
113
+ <ul class="link-list">
114
+
115
+ <li><a href="../ChangeBranchTest.html">ChangeBranchTest</a>
116
+
117
+ <li><a href="../ConfigurationTest.html">ConfigurationTest</a>
118
+
119
+ <li><a href="../CreateTest.html">CreateTest</a>
120
+
121
+ <li><a href="../UpdateTest.html">UpdateTest</a>
122
+
123
+ <li><a href="../Vermillion.html">Vermillion</a>
124
+
125
+ <li><a href="../Vermillion/Cfg.html">Vermillion::Cfg</a>
126
+
127
+ <li><a href="../Vermillion/Controller.html">Vermillion::Controller</a>
128
+
129
+ <li><a href="../Vermillion/Controller/Base.html">Vermillion::Controller::Base</a>
130
+
131
+ <li><a href="../Vermillion/Controller/Change.html">Vermillion::Controller::Change</a>
132
+
133
+ <li><a href="../Vermillion/Controller/Create.html">Vermillion::Controller::Create</a>
134
+
135
+ <li><a href="../Vermillion/Controller/Firstrun.html">Vermillion::Controller::Firstrun</a>
136
+
137
+ <li><a href="../Vermillion/Controller/Status.html">Vermillion::Controller::Status</a>
138
+
139
+ <li><a href="../Vermillion/Controller/Update.html">Vermillion::Controller::Update</a>
140
+
141
+ <li><a href="../Vermillion/Helper.html">Vermillion::Helper</a>
142
+
143
+ <li><a href="../Vermillion/Helper/ApiCommunication.html">Vermillion::Helper::ApiCommunication</a>
144
+
145
+ <li><a href="../Vermillion/Helper/Endpoint.html">Vermillion::Helper::Endpoint</a>
146
+
147
+ <li><a href="../Vermillion/Helper/Formatting.html">Vermillion::Helper::Formatting</a>
148
+
149
+ <li><a href="../Vermillion/Helper/Network.html">Vermillion::Helper::Network</a>
150
+
151
+ <li><a href="../Vermillion/Helper/Results.html">Vermillion::Helper::Results</a>
152
+
153
+ <li><a href="../Vermillion/Helper/Time.html">Vermillion::Helper::Time</a>
154
+
155
+ <li><a href="../Vermillion/Request.html">Vermillion::Request</a>
156
+
157
+ <li><a href="../Vermillion/Router.html">Vermillion::Router</a>
158
+
159
+ <li><a href="../Vermillion/Test.html">Vermillion::Test</a>
160
+
161
+ <li><a href="../Vermillion/Test/Base.html">Vermillion::Test::Base</a>
162
+
163
+ <li><a href="../Vermillion/Utils.html">Vermillion::Utils</a>
164
+
165
+ </ul>
166
+ </nav>
167
+
168
+ </div>
169
+ </nav>
170
+
171
+ <div id="documentation">
172
+ <h1 class="class">class Vermillion::Cfg</h1>
173
+
174
+ <div id="description" class="description">
175
+
176
+ </div><!-- description -->
177
+
178
+
179
+
180
+
181
+ <section id="5Buntitled-5D" class="documentation-section">
182
+
183
+
184
+
185
+
186
+
187
+
188
+
189
+
190
+ <!-- Methods -->
191
+
192
+ <section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
193
+ <h3 class="section-header">Public Instance Methods</h3>
194
+
195
+
196
+ <div id="method-i-bootstrap-21" class="method-detail ">
197
+
198
+ <div class="method-heading">
199
+ <span class="method-name">bootstrap!</span><span
200
+ class="method-args">()</span>
201
+
202
+ <span class="method-click-advice">click to toggle source</span>
203
+
204
+ </div>
205
+
206
+
207
+ <div class="method-description">
208
+
209
+ <p>Perform first run tasks and create or read config file values</p>
210
+
211
+
212
+
213
+
214
+ <div class="method-source-code" id="bootstrap-21-source">
215
+ <pre><span class="ruby-comment"># File lib/client/config.rb, line 7</span>
216
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">bootstrap!</span>
217
+ <span class="ruby-identifier">populate_config</span>
218
+
219
+ <span class="ruby-keyword">return</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">valid_config?</span>
220
+
221
+ <span class="ruby-comment"># no config file found, lets create one using the firstrun controller</span>
222
+ <span class="ruby-identifier">require</span> <span class="ruby-string">&#39;client/controller/firstrun&#39;</span>
223
+
224
+ <span class="ruby-identifier">controller</span> = <span class="ruby-constant">Vermillion</span><span class="ruby-operator">::</span><span class="ruby-constant">Controller</span><span class="ruby-operator">::</span><span class="ruby-constant">Firstrun</span>.<span class="ruby-identifier">new</span>
225
+ <span class="ruby-identifier">controller</span>.<span class="ruby-identifier">default</span>
226
+
227
+ <span class="ruby-identifier">populate_config</span>
228
+ <span class="ruby-keyword">end</span></pre>
229
+ </div><!-- bootstrap-21-source -->
230
+
231
+ </div>
232
+
233
+
234
+
235
+
236
+ </div><!-- bootstrap-21-method -->
237
+
238
+
239
+ <div id="method-i-get" class="method-detail ">
240
+
241
+ <div class="method-heading">
242
+ <span class="method-name">get</span><span
243
+ class="method-args">(name)</span>
244
+
245
+ <span class="method-click-advice">click to toggle source</span>
246
+
247
+ </div>
248
+
249
+
250
+ <div class="method-description">
251
+
252
+ <p>Get a specific value from the config file data Params:</p>
253
+ <dl class="rdoc-list note-list"><dt><code>name</code>
254
+ <dd>
255
+ <p>String/symbol key value</p>
256
+ </dd></dl>
257
+
258
+
259
+
260
+
261
+ <div class="method-source-code" id="get-source">
262
+ <pre><span class="ruby-comment"># File lib/client/config.rb, line 42</span>
263
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">get</span>(<span class="ruby-identifier">name</span>)
264
+ <span class="ruby-ivar">@yml</span>[<span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_sym</span>]
265
+ <span class="ruby-keyword">end</span></pre>
266
+ </div><!-- get-source -->
267
+
268
+ </div>
269
+
270
+
271
+
272
+
273
+ </div><!-- get-method -->
274
+
275
+
276
+ <div id="method-i-options" class="method-detail ">
277
+
278
+ <div class="method-heading">
279
+ <span class="method-name">options</span><span
280
+ class="method-args">()</span>
281
+
282
+ <span class="method-click-advice">click to toggle source</span>
283
+
284
+ </div>
285
+
286
+
287
+ <div class="method-description">
288
+
289
+ <p>Returns a hash of all module constants and their values</p>
290
+
291
+
292
+
293
+
294
+ <div class="method-source-code" id="options-source">
295
+ <pre><span class="ruby-comment"># File lib/client/config.rb, line 22</span>
296
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">options</span>
297
+ <span class="ruby-identifier">keys</span> = <span class="ruby-constant">Vermillion</span>.<span class="ruby-identifier">constants</span>.<span class="ruby-identifier">select</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">name</span><span class="ruby-operator">|</span> <span class="ruby-identifier">constant?</span>(<span class="ruby-identifier">name</span>) }
298
+ <span class="ruby-identifier">hash</span> = {}
299
+
300
+ <span class="ruby-identifier">keys</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">key</span><span class="ruby-operator">|</span> <span class="ruby-identifier">hash</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-constant">Vermillion</span>.<span class="ruby-identifier">const_get</span>(<span class="ruby-identifier">key</span>) }
301
+ <span class="ruby-identifier">hash</span>
302
+ <span class="ruby-keyword">end</span></pre>
303
+ </div><!-- options-source -->
304
+
305
+ </div>
306
+
307
+
308
+
309
+
310
+ </div><!-- options-method -->
311
+
312
+
313
+ <div id="method-i-populate_config" class="method-detail ">
314
+
315
+ <div class="method-heading">
316
+ <span class="method-name">populate_config</span><span
317
+ class="method-args">()</span>
318
+
319
+ <span class="method-click-advice">click to toggle source</span>
320
+
321
+ </div>
322
+
323
+
324
+ <div class="method-description">
325
+
326
+ <p>Populates the internal hash which stores any values set in the config file</p>
327
+
328
+
329
+
330
+
331
+ <div class="method-source-code" id="populate_config-source">
332
+ <pre><span class="ruby-comment"># File lib/client/config.rb, line 31</span>
333
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">populate_config</span>
334
+ <span class="ruby-identifier">file</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-string">&quot;~/.vermillion.yml&quot;</span>)
335
+ <span class="ruby-identifier">fmt</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>)
336
+
337
+ <span class="ruby-ivar">@yml</span> = <span class="ruby-identifier">fmt</span>.<span class="ruby-identifier">symbolize</span>(<span class="ruby-operator">::</span><span class="ruby-constant">YAML</span>.<span class="ruby-identifier">load_file</span>(<span class="ruby-identifier">file</span>))
338
+ <span class="ruby-keyword">self</span>
339
+ <span class="ruby-keyword">end</span></pre>
340
+ </div><!-- populate_config-source -->
341
+
342
+ </div>
343
+
344
+
345
+
346
+
347
+ </div><!-- populate_config-method -->
348
+
349
+
350
+ </section><!-- public-instance-method-details -->
351
+
352
+ </section><!-- 5Buntitled-5D -->
353
+
354
+ </div><!-- documentation -->
355
+
356
+
357
+ <footer id="validator-badges">
358
+ <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
359
+ <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 4.0.0.
360
+ <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
361
+ </footer>
362
+