badgeville_berlin 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +5 -0
- data/.rspec +1 -0
- data/.rvmrc +1 -0
- data/.yardoc/checksums +17 -0
- data/.yardoc/objects/root.dat +0 -0
- data/.yardoc/proxy_types +0 -0
- data/Gemfile +4 -0
- data/LICENSE.md +7 -0
- data/README.md +150 -0
- data/README_ADVANCED.md +120 -0
- data/Rakefile +11 -0
- data/badgeville.gemspec +36 -0
- data/doc/BadgevilleBerlin.html +131 -0
- data/doc/BadgevilleBerlin/Activity.html +135 -0
- data/doc/BadgevilleBerlin/ActivityDefinition.html +135 -0
- data/doc/BadgevilleBerlin/BaseResource.html +462 -0
- data/doc/BadgevilleBerlin/Config.html +280 -0
- data/doc/BadgevilleBerlin/Errors.html +276 -0
- data/doc/BadgevilleBerlin/Group.html +135 -0
- data/doc/BadgevilleBerlin/Leaderboard.html +135 -0
- data/doc/BadgevilleBerlin/Player.html +135 -0
- data/doc/BadgevilleBerlin/Reward.html +135 -0
- data/doc/BadgevilleBerlin/RewardDefinition.html +135 -0
- data/doc/BadgevilleBerlin/Site.html +135 -0
- data/doc/BadgevilleBerlin/Track.html +135 -0
- data/doc/BadgevilleBerlin/User.html +135 -0
- data/doc/BadgevilleBerlinJsonFormat.html +530 -0
- data/doc/_index.html +285 -0
- data/doc/class_list.html +47 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +53 -0
- data/doc/css/style.css +320 -0
- data/doc/file.README.html +182 -0
- data/doc/file_list.html +49 -0
- data/doc/frames.html +13 -0
- data/doc/index.html +182 -0
- data/doc/js/app.js +205 -0
- data/doc/js/full_list.js +150 -0
- data/doc/js/jquery.js +16 -0
- data/doc/method_list.html +118 -0
- data/doc/top-level-namespace.html +103 -0
- data/examples/.DS_Store +0 -0
- data/examples/shell/.DS_Store +0 -0
- data/examples/shell/lib/.DS_Store +0 -0
- data/examples/shell/lib/berlin_shell.rb +34 -0
- data/examples/shell/lib/berlin_shell/.DS_Store +0 -0
- data/examples/shell/lib/berlin_shell/cd.rb +17 -0
- data/examples/shell/lib/berlin_shell/core.rb +118 -0
- data/examples/shell/lib/berlin_shell/ls.rb +72 -0
- data/examples/shell/lib/berlin_shell/prompt.rb +39 -0
- data/examples/shell/shell_demo.rb +319 -0
- data/examples/shell/spec/integration/basic_spec.rb +7 -0
- data/lib/.yardoc/checksums +0 -0
- data/lib/.yardoc/objects/root.dat +0 -0
- data/lib/.yardoc/proxy_types +0 -0
- data/lib/badgeville_berlin.rb +24 -0
- data/lib/badgeville_berlin/.yardoc/checksums +0 -0
- data/lib/badgeville_berlin/.yardoc/objects/root.dat +0 -0
- data/lib/badgeville_berlin/.yardoc/proxy_types +0 -0
- data/lib/badgeville_berlin/activity.rb +5 -0
- data/lib/badgeville_berlin/activity_definition.rb +5 -0
- data/lib/badgeville_berlin/base_resource.rb +68 -0
- data/lib/badgeville_berlin/config.rb +36 -0
- data/lib/badgeville_berlin/doc/_index.html +84 -0
- data/lib/badgeville_berlin/doc/class_list.html +47 -0
- data/lib/badgeville_berlin/doc/css/common.css +1 -0
- data/lib/badgeville_berlin/doc/css/full_list.css +53 -0
- data/lib/badgeville_berlin/doc/css/style.css +320 -0
- data/lib/badgeville_berlin/doc/file_list.html +46 -0
- data/lib/badgeville_berlin/doc/frames.html +13 -0
- data/lib/badgeville_berlin/doc/index.html +84 -0
- data/lib/badgeville_berlin/doc/js/app.js +205 -0
- data/lib/badgeville_berlin/doc/js/full_list.js +150 -0
- data/lib/badgeville_berlin/doc/js/jquery.js +16 -0
- data/lib/badgeville_berlin/doc/method_list.html +46 -0
- data/lib/badgeville_berlin/doc/top-level-namespace.html +93 -0
- data/lib/badgeville_berlin/errors.rb +28 -0
- data/lib/badgeville_berlin/formats/badgeville_berlin_json_format.rb +55 -0
- data/lib/badgeville_berlin/group.rb +5 -0
- data/lib/badgeville_berlin/leaderboard.rb +5 -0
- data/lib/badgeville_berlin/player.rb +5 -0
- data/lib/badgeville_berlin/reward.rb +5 -0
- data/lib/badgeville_berlin/reward_definition.rb +5 -0
- data/lib/badgeville_berlin/site.rb +5 -0
- data/lib/badgeville_berlin/track.rb +5 -0
- data/lib/badgeville_berlin/user.rb +5 -0
- data/lib/badgeville_berlin/version.rb +3 -0
- data/lib/doc/_index.html +84 -0
- data/lib/doc/class_list.html +47 -0
- data/lib/doc/css/common.css +1 -0
- data/lib/doc/css/full_list.css +53 -0
- data/lib/doc/css/style.css +320 -0
- data/lib/doc/file_list.html +46 -0
- data/lib/doc/frames.html +13 -0
- data/lib/doc/index.html +84 -0
- data/lib/doc/js/app.js +205 -0
- data/lib/doc/js/full_list.js +150 -0
- data/lib/doc/js/jquery.js +16 -0
- data/lib/doc/method_list.html +46 -0
- data/lib/doc/top-level-namespace.html +93 -0
- data/spec/factories.rb +54 -0
- data/spec/integration/activity_spec.rb +0 -0
- data/spec/integration/basic_spec.rb +68 -0
- data/spec/integration/player_spec.rb +6 -0
- data/spec/integration/site_spec.rb +11 -0
- data/spec/integration/user_spec.rb +3 -0
- data/spec/response_json.yml +36 -0
- data/spec/spec_helper.rb +60 -0
- data/spec/unit/badgeville_berlin_json_format_spec.rb +68 -0
- data/spec/unit/base_resource_spec.rb +47 -0
- data/spec/unit/config_spec.rb +65 -0
- data/spec/unit/errors_spec.rb +47 -0
- data/spec/use_case/readme_use_case_spec.rb +262 -0
- metadata +286 -0
@@ -0,0 +1,280 @@
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
3
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
4
|
+
<head>
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
6
|
+
<title>
|
7
|
+
Class: BadgevilleBerlin::Config
|
8
|
+
|
9
|
+
— Documentation by YARD 0.7.1
|
10
|
+
|
11
|
+
</title>
|
12
|
+
|
13
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
|
14
|
+
|
15
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
|
16
|
+
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
18
|
+
relpath = '..';
|
19
|
+
if (relpath != '') relpath += '/';
|
20
|
+
</script>
|
21
|
+
|
22
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
23
|
+
|
24
|
+
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
25
|
+
|
26
|
+
|
27
|
+
</head>
|
28
|
+
<body>
|
29
|
+
<script type="text/javascript" charset="utf-8">
|
30
|
+
if (window.top.frames.main) document.body.className = 'frames';
|
31
|
+
</script>
|
32
|
+
|
33
|
+
<div id="header">
|
34
|
+
<div id="menu">
|
35
|
+
|
36
|
+
<a href="../_index.html">Index (C)</a> »
|
37
|
+
<span class='title'><span class='object_link'><a href="../BadgevilleBerlin.html" title="BadgevilleBerlin (module)">BadgevilleBerlin</a></span></span>
|
38
|
+
»
|
39
|
+
<span class="title">Config</span>
|
40
|
+
|
41
|
+
|
42
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
43
|
+
</div>
|
44
|
+
|
45
|
+
<div id="search">
|
46
|
+
|
47
|
+
<a id="class_list_link" href="#">Class List</a>
|
48
|
+
|
49
|
+
<a id="method_list_link" href="#">Method List</a>
|
50
|
+
|
51
|
+
<a id="file_list_link" href="#">File List</a>
|
52
|
+
|
53
|
+
</div>
|
54
|
+
<div class="clear"></div>
|
55
|
+
</div>
|
56
|
+
|
57
|
+
<iframe id="search_frame"></iframe>
|
58
|
+
|
59
|
+
<div id="content"><h1>Class: BadgevilleBerlin::Config
|
60
|
+
|
61
|
+
|
62
|
+
|
63
|
+
</h1>
|
64
|
+
|
65
|
+
<dl class="box">
|
66
|
+
|
67
|
+
<dt class="r1">Inherits:</dt>
|
68
|
+
<dd class="r1">
|
69
|
+
<span class="inheritName"><span class='object_link'><a href="BaseResource.html" title="BadgevilleBerlin::BaseResource (class)">BaseResource</a></span></span>
|
70
|
+
|
71
|
+
<ul class="fullTree">
|
72
|
+
<li>Object</li>
|
73
|
+
|
74
|
+
<li class="next">ActiveResource::Base</li>
|
75
|
+
|
76
|
+
<li class="next"><span class='object_link'><a href="BaseResource.html" title="BadgevilleBerlin::BaseResource (class)">BaseResource</a></span></li>
|
77
|
+
|
78
|
+
<li class="next">BadgevilleBerlin::Config</li>
|
79
|
+
|
80
|
+
</ul>
|
81
|
+
<a href="#" class="inheritanceTree">show all</a>
|
82
|
+
|
83
|
+
</dd>
|
84
|
+
|
85
|
+
|
86
|
+
|
87
|
+
|
88
|
+
|
89
|
+
|
90
|
+
|
91
|
+
|
92
|
+
|
93
|
+
<dt class="r2 last">Defined in:</dt>
|
94
|
+
<dd class="r2 last">lib/badgeville-berlin/config.rb</dd>
|
95
|
+
|
96
|
+
</dl>
|
97
|
+
<div class="clear"></div>
|
98
|
+
|
99
|
+
|
100
|
+
|
101
|
+
|
102
|
+
|
103
|
+
|
104
|
+
|
105
|
+
|
106
|
+
|
107
|
+
|
108
|
+
|
109
|
+
|
110
|
+
|
111
|
+
|
112
|
+
|
113
|
+
|
114
|
+
<h2>
|
115
|
+
Class Method Summary
|
116
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
117
|
+
</h2>
|
118
|
+
|
119
|
+
<ul class="summary">
|
120
|
+
|
121
|
+
<li class="public ">
|
122
|
+
<span class="summary_signature">
|
123
|
+
|
124
|
+
<a href="#conf-class_method" title="conf (class method)">+ (Object) <strong>conf</strong>(options = {}) </a>
|
125
|
+
|
126
|
+
|
127
|
+
|
128
|
+
</span>
|
129
|
+
|
130
|
+
|
131
|
+
|
132
|
+
|
133
|
+
|
134
|
+
|
135
|
+
|
136
|
+
|
137
|
+
<span class="summary_desc"><div class='inline'><p>
|
138
|
+
This class method configures the BaseResource members: format, site and
|
139
|
+
prefix.
|
140
|
+
</p>
|
141
|
+
</div></span>
|
142
|
+
|
143
|
+
</li>
|
144
|
+
|
145
|
+
|
146
|
+
</ul>
|
147
|
+
|
148
|
+
|
149
|
+
|
150
|
+
|
151
|
+
|
152
|
+
|
153
|
+
|
154
|
+
|
155
|
+
|
156
|
+
|
157
|
+
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="BaseResource.html" title="BadgevilleBerlin::BaseResource (class)">BaseResource</a></span></h3>
|
158
|
+
<p class="inherited"><span class='object_link'><a href="BaseResource.html#errors-instance_method" title="BadgevilleBerlin::BaseResource#errors (method)">#errors</a></span>, <span class='object_link'><a href="BaseResource.html#load_remote_errors-instance_method" title="BadgevilleBerlin::BaseResource#load_remote_errors (method)">#load_remote_errors</a></span>, <span class='object_link'><a href="BaseResource.html#primary_key-class_method" title="BadgevilleBerlin::BaseResource.primary_key (method)">primary_key</a></span></p>
|
159
|
+
|
160
|
+
|
161
|
+
|
162
|
+
<div id="class_method_details" class="method_details_list">
|
163
|
+
<h2>Class Method Details</h2>
|
164
|
+
|
165
|
+
|
166
|
+
<div class="method_details first">
|
167
|
+
<p class="signature first" id="conf-class_method">
|
168
|
+
|
169
|
+
+ (<tt>Object</tt>) <strong>conf</strong>(options = {})
|
170
|
+
|
171
|
+
|
172
|
+
|
173
|
+
</p><div class="docstring">
|
174
|
+
<div class="discussion">
|
175
|
+
<p>
|
176
|
+
This class method configures the BaseResource members: format, site and
|
177
|
+
prefix
|
178
|
+
</p>
|
179
|
+
|
180
|
+
|
181
|
+
</div>
|
182
|
+
</div>
|
183
|
+
<div class="tags">
|
184
|
+
<h3>Parameters:</h3>
|
185
|
+
<ul class="param">
|
186
|
+
|
187
|
+
<li>
|
188
|
+
|
189
|
+
<span class='name'>options</span>
|
190
|
+
|
191
|
+
|
192
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
193
|
+
|
194
|
+
|
195
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
196
|
+
|
197
|
+
|
198
|
+
—
|
199
|
+
<div class='inline'><p>
|
200
|
+
the options hash which holds values for the keys `:api_key` and `:site`
|
201
|
+
</p>
|
202
|
+
</div>
|
203
|
+
|
204
|
+
</li>
|
205
|
+
|
206
|
+
</ul>
|
207
|
+
|
208
|
+
</div><table class="source_code">
|
209
|
+
<tr>
|
210
|
+
<td>
|
211
|
+
<pre class="lines">
|
212
|
+
|
213
|
+
|
214
|
+
10
|
215
|
+
11
|
216
|
+
12
|
217
|
+
13
|
218
|
+
14
|
219
|
+
15
|
220
|
+
16
|
221
|
+
17
|
222
|
+
18
|
223
|
+
19
|
224
|
+
20
|
225
|
+
21
|
226
|
+
22
|
227
|
+
23
|
228
|
+
24
|
229
|
+
25
|
230
|
+
26
|
231
|
+
27
|
232
|
+
28
|
233
|
+
29
|
234
|
+
30
|
235
|
+
31
|
236
|
+
32</pre>
|
237
|
+
</td>
|
238
|
+
<td>
|
239
|
+
<pre class="code"><span class="info file"># File 'lib/badgeville-berlin/config.rb', line 10</span>
|
240
|
+
|
241
|
+
<span class='kw'>def</span> <span class='id conf'>conf</span> <span class='lparen'>(</span> <span class='id options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span> <span class='rparen'>)</span>
|
242
|
+
|
243
|
+
<span class='const'>BaseResource</span><span class='period'>.</span><span class='id format'>format</span> <span class='op'>=</span> <span class='symbol'>:badgeville_berlin_json</span>
|
244
|
+
|
245
|
+
<span class='kw'>if</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:site</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='kw'>nil</span> <span class='op'>||</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:site</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id empty?'>empty?</span>
|
246
|
+
<span class='id raise'>raise</span> <span class='const'>ArgumentError</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Please enter the URL for the Badgeville site where you want to make your request ( e.g. :site => 'http://staging.badgeville-berlin.com' ).</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
247
|
+
<span class='kw'>else</span>
|
248
|
+
<span class='const'>BaseResource</span><span class='period'>.</span><span class='id site'>site</span> <span class='op'>=</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:site</span><span class='rbracket'>]</span>
|
249
|
+
<span class='kw'>if</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:site</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>://</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='kw'>nil</span>
|
250
|
+
<span class='id raise'>raise</span> <span class='const'>ArgumentError</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Please include the scheme for the request site ( e.g. http:// ).</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
251
|
+
<span class='kw'>end</span>
|
252
|
+
<span class='kw'>end</span>
|
253
|
+
|
254
|
+
<span class='kw'>if</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:api_key</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='kw'>nil</span> <span class='op'>||</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:api_key</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id empty?'>empty?</span>
|
255
|
+
<span class='id raise'>raise</span> <span class='const'>ArgumentError</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Please enter a Badgeville API Key ( e.g. :api_key => '[your Badgeville API Key]' ).</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
256
|
+
<span class='kw'>else</span>
|
257
|
+
<span class='ivar'>@api_key</span> <span class='op'>=</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:api_key</span><span class='rbracket'>]</span>
|
258
|
+
<span class='kw'>end</span>
|
259
|
+
|
260
|
+
|
261
|
+
<span class='comment'># set a path that goes between the URL and the resource
|
262
|
+
</span> <span class='const'>BaseResource</span><span class='period'>.</span><span class='id prefix'>prefix</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/api/berlin/</span><span class='embvar'>#</span><span class='ivar'>@api_key</span><span class='tstring_content'>/</span><span class='tstring_end'>"</span></span>
|
263
|
+
<span class='kw'>end</span></pre>
|
264
|
+
</td>
|
265
|
+
</tr>
|
266
|
+
</table>
|
267
|
+
</div>
|
268
|
+
|
269
|
+
</div>
|
270
|
+
|
271
|
+
</div>
|
272
|
+
|
273
|
+
<div id="footer">
|
274
|
+
Generated on Tue Jan 24 14:21:13 2012 by
|
275
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
276
|
+
0.7.1 (ruby-1.9.2).
|
277
|
+
</div>
|
278
|
+
|
279
|
+
</body>
|
280
|
+
</html>
|
@@ -0,0 +1,276 @@
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
3
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
4
|
+
<head>
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
6
|
+
<title>
|
7
|
+
Class: BadgevilleBerlin::Errors
|
8
|
+
|
9
|
+
— Documentation by YARD 0.7.1
|
10
|
+
|
11
|
+
</title>
|
12
|
+
|
13
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
|
14
|
+
|
15
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
|
16
|
+
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
18
|
+
relpath = '..';
|
19
|
+
if (relpath != '') relpath += '/';
|
20
|
+
</script>
|
21
|
+
|
22
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
23
|
+
|
24
|
+
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
25
|
+
|
26
|
+
|
27
|
+
</head>
|
28
|
+
<body>
|
29
|
+
<script type="text/javascript" charset="utf-8">
|
30
|
+
if (window.top.frames.main) document.body.className = 'frames';
|
31
|
+
</script>
|
32
|
+
|
33
|
+
<div id="header">
|
34
|
+
<div id="menu">
|
35
|
+
|
36
|
+
<a href="../_index.html">Index (E)</a> »
|
37
|
+
<span class='title'><span class='object_link'><a href="../BadgevilleBerlin.html" title="BadgevilleBerlin (module)">BadgevilleBerlin</a></span></span>
|
38
|
+
»
|
39
|
+
<span class="title">Errors</span>
|
40
|
+
|
41
|
+
|
42
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
43
|
+
</div>
|
44
|
+
|
45
|
+
<div id="search">
|
46
|
+
|
47
|
+
<a id="class_list_link" href="#">Class List</a>
|
48
|
+
|
49
|
+
<a id="method_list_link" href="#">Method List</a>
|
50
|
+
|
51
|
+
<a id="file_list_link" href="#">File List</a>
|
52
|
+
|
53
|
+
</div>
|
54
|
+
<div class="clear"></div>
|
55
|
+
</div>
|
56
|
+
|
57
|
+
<iframe id="search_frame"></iframe>
|
58
|
+
|
59
|
+
<div id="content"><h1>Class: BadgevilleBerlin::Errors
|
60
|
+
|
61
|
+
|
62
|
+
|
63
|
+
</h1>
|
64
|
+
|
65
|
+
<dl class="box">
|
66
|
+
|
67
|
+
<dt class="r1">Inherits:</dt>
|
68
|
+
<dd class="r1">
|
69
|
+
<span class="inheritName">ActiveResource::Errors</span>
|
70
|
+
|
71
|
+
<ul class="fullTree">
|
72
|
+
<li>Object</li>
|
73
|
+
|
74
|
+
<li class="next">ActiveResource::Errors</li>
|
75
|
+
|
76
|
+
<li class="next">BadgevilleBerlin::Errors</li>
|
77
|
+
|
78
|
+
</ul>
|
79
|
+
<a href="#" class="inheritanceTree">show all</a>
|
80
|
+
|
81
|
+
</dd>
|
82
|
+
|
83
|
+
|
84
|
+
|
85
|
+
|
86
|
+
|
87
|
+
|
88
|
+
|
89
|
+
|
90
|
+
|
91
|
+
<dt class="r2 last">Defined in:</dt>
|
92
|
+
<dd class="r2 last">lib/badgeville-berlin/errors.rb</dd>
|
93
|
+
|
94
|
+
</dl>
|
95
|
+
<div class="clear"></div>
|
96
|
+
|
97
|
+
<h2>Overview</h2><div class="docstring">
|
98
|
+
<div class="discussion">
|
99
|
+
<p>
|
100
|
+
Subclasses ActiveResource::Errors to be used by BaseResource as
|
101
|
+
BadgevilleBerlin::Errors.
|
102
|
+
</p>
|
103
|
+
|
104
|
+
|
105
|
+
</div>
|
106
|
+
</div>
|
107
|
+
<div class="tags">
|
108
|
+
|
109
|
+
</div>
|
110
|
+
|
111
|
+
|
112
|
+
|
113
|
+
|
114
|
+
|
115
|
+
|
116
|
+
|
117
|
+
<h2>
|
118
|
+
Instance Method Summary
|
119
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
120
|
+
</h2>
|
121
|
+
|
122
|
+
<ul class="summary">
|
123
|
+
|
124
|
+
<li class="public ">
|
125
|
+
<span class="summary_signature">
|
126
|
+
|
127
|
+
<a href="#from_badgeville_berlin_json-instance_method" title="#from_badgeville_berlin_json (instance method)">- (Object) <strong>from_badgeville_berlin_json</strong>(json, save_cache = false) </a>
|
128
|
+
|
129
|
+
|
130
|
+
|
131
|
+
</span>
|
132
|
+
|
133
|
+
|
134
|
+
|
135
|
+
|
136
|
+
|
137
|
+
|
138
|
+
|
139
|
+
|
140
|
+
<span class="summary_desc"><div class='inline'><p>
|
141
|
+
Grabs errors from the :badgeville_berlin_json response remote model
|
142
|
+
originating from teh remote class.
|
143
|
+
</p>
|
144
|
+
</div></span>
|
145
|
+
|
146
|
+
</li>
|
147
|
+
|
148
|
+
|
149
|
+
</ul>
|
150
|
+
|
151
|
+
|
152
|
+
|
153
|
+
|
154
|
+
|
155
|
+
<div id="instance_method_details" class="method_details_list">
|
156
|
+
<h2>Instance Method Details</h2>
|
157
|
+
|
158
|
+
|
159
|
+
<div class="method_details first">
|
160
|
+
<p class="signature first" id="from_badgeville_berlin_json-instance_method">
|
161
|
+
|
162
|
+
- (<tt>Object</tt>) <strong>from_badgeville_berlin_json</strong>(json, save_cache = false)
|
163
|
+
|
164
|
+
|
165
|
+
|
166
|
+
</p><div class="docstring">
|
167
|
+
<div class="discussion">
|
168
|
+
<p>
|
169
|
+
Grabs errors from the :badgeville_berlin_json response remote model
|
170
|
+
originating from teh remote class. The custom JSON error response format
|
171
|
+
may not have a root key :errors.
|
172
|
+
</p>
|
173
|
+
<p>
|
174
|
+
BadgevilleBerlinJsonFormat cleared by default
|
175
|
+
</p>
|
176
|
+
|
177
|
+
|
178
|
+
</div>
|
179
|
+
</div>
|
180
|
+
<div class="tags">
|
181
|
+
<h3>Parameters:</h3>
|
182
|
+
<ul class="param">
|
183
|
+
|
184
|
+
<li>
|
185
|
+
|
186
|
+
<span class='name'>json</span>
|
187
|
+
|
188
|
+
|
189
|
+
<span class='type'>(<tt>String</tt>)</span>
|
190
|
+
|
191
|
+
|
192
|
+
|
193
|
+
—
|
194
|
+
<div class='inline'><p>
|
195
|
+
the JSON response data in custom
|
196
|
+
</p>
|
197
|
+
</div>
|
198
|
+
|
199
|
+
</li>
|
200
|
+
|
201
|
+
<li>
|
202
|
+
|
203
|
+
<span class='name'>save_cache</span>
|
204
|
+
|
205
|
+
|
206
|
+
<span class='type'>(<tt>Object</tt>)</span>
|
207
|
+
|
208
|
+
|
209
|
+
<em class="default">(defaults to: <tt>false</tt>)</em>
|
210
|
+
|
211
|
+
|
212
|
+
—
|
213
|
+
<div class='inline'><p>
|
214
|
+
flag that directs the errors cache to be
|
215
|
+
</p>
|
216
|
+
</div>
|
217
|
+
|
218
|
+
</li>
|
219
|
+
|
220
|
+
</ul>
|
221
|
+
|
222
|
+
</div><table class="source_code">
|
223
|
+
<tr>
|
224
|
+
<td>
|
225
|
+
<pre class="lines">
|
226
|
+
|
227
|
+
|
228
|
+
13
|
229
|
+
14
|
230
|
+
15
|
231
|
+
16
|
232
|
+
17
|
233
|
+
18
|
234
|
+
19
|
235
|
+
20
|
236
|
+
21
|
237
|
+
22
|
238
|
+
23
|
239
|
+
24
|
240
|
+
25
|
241
|
+
26</pre>
|
242
|
+
</td>
|
243
|
+
<td>
|
244
|
+
<pre class="code"><span class="info file"># File 'lib/badgeville-berlin/errors.rb', line 13</span>
|
245
|
+
|
246
|
+
<span class='kw'>def</span> <span class='id from_badgeville_berlin_json'>from_badgeville_berlin_json</span><span class='lparen'>(</span><span class='id json'>json</span><span class='comma'>,</span> <span class='id save_cache'>save_cache</span> <span class='op'>=</span> <span class='kw'>false</span><span class='rparen'>)</span>
|
247
|
+
<span class='id formatted_json_decoded'>formatted_json_decoded</span> <span class='op'>=</span> <span class='const'>Array</span><span class='period'>.</span><span class='id new'>new</span>
|
248
|
+
<span class='id json_decoded'>json_decoded</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='const'>ActiveSupport</span><span class='op'>::</span><span class='const'>JSON</span><span class='period'>.</span><span class='id decode'>decode</span><span class='lparen'>(</span><span class='id json'>json</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>errors</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='const'>ActiveSupport</span><span class='op'>::</span><span class='const'>JSON</span><span class='period'>.</span><span class='id decode'>decode</span><span class='lparen'>(</span><span class='id json'>json</span><span class='rparen'>)</span> <span class='kw'>rescue</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
249
|
+
<span class='id json_decoded'>json_decoded</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id attribute_name'>attribute_name</span><span class='comma'>,</span> <span class='id err_msgs'>err_msgs</span><span class='op'>|</span>
|
250
|
+
<span class='kw'>if</span> <span class='id err_msgs'>err_msgs</span><span class='period'>.</span><span class='id is_a?'>is_a?</span> <span class='const'>Array</span>
|
251
|
+
<span class='id err_msgs'>err_msgs</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id err_msg'>err_msg</span><span class='op'>|</span>
|
252
|
+
<span class='id formatted_json_decoded'>formatted_json_decoded</span><span class='period'>.</span><span class='id push'>push</span><span class='lparen'>(</span><span class='id attribute_name'>attribute_name</span><span class='period'>.</span><span class='id humanize'>humanize</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='id err_msg'>err_msg</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
253
|
+
<span class='kw'>end</span>
|
254
|
+
<span class='kw'>elsif</span> <span class='id err_msgs'>err_msgs</span><span class='period'>.</span><span class='id is_a?'>is_a?</span> <span class='const'>String</span>
|
255
|
+
<span class='id formatted_json_decoded'>formatted_json_decoded</span><span class='period'>.</span><span class='id push'>push</span><span class='lparen'>(</span><span class='id attribute_name'>attribute_name</span><span class='comma'>,</span> <span class='id err_msgs'>err_msgs</span><span class='rparen'>)</span>
|
256
|
+
<span class='kw'>end</span>
|
257
|
+
<span class='kw'>end</span>
|
258
|
+
<span class='id from_array'>from_array</span> <span class='id formatted_json_decoded'>formatted_json_decoded</span><span class='comma'>,</span> <span class='id save_cache'>save_cache</span>
|
259
|
+
<span class='kw'>end</span></pre>
|
260
|
+
</td>
|
261
|
+
</tr>
|
262
|
+
</table>
|
263
|
+
</div>
|
264
|
+
|
265
|
+
</div>
|
266
|
+
|
267
|
+
</div>
|
268
|
+
|
269
|
+
<div id="footer">
|
270
|
+
Generated on Tue Jan 24 14:21:13 2012 by
|
271
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
272
|
+
0.7.1 (ruby-1.9.2).
|
273
|
+
</div>
|
274
|
+
|
275
|
+
</body>
|
276
|
+
</html>
|