badgeville_berlin 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (114) hide show
  1. data/.gitignore +5 -0
  2. data/.rspec +1 -0
  3. data/.rvmrc +1 -0
  4. data/.yardoc/checksums +17 -0
  5. data/.yardoc/objects/root.dat +0 -0
  6. data/.yardoc/proxy_types +0 -0
  7. data/Gemfile +4 -0
  8. data/LICENSE.md +7 -0
  9. data/README.md +150 -0
  10. data/README_ADVANCED.md +120 -0
  11. data/Rakefile +11 -0
  12. data/badgeville.gemspec +36 -0
  13. data/doc/BadgevilleBerlin.html +131 -0
  14. data/doc/BadgevilleBerlin/Activity.html +135 -0
  15. data/doc/BadgevilleBerlin/ActivityDefinition.html +135 -0
  16. data/doc/BadgevilleBerlin/BaseResource.html +462 -0
  17. data/doc/BadgevilleBerlin/Config.html +280 -0
  18. data/doc/BadgevilleBerlin/Errors.html +276 -0
  19. data/doc/BadgevilleBerlin/Group.html +135 -0
  20. data/doc/BadgevilleBerlin/Leaderboard.html +135 -0
  21. data/doc/BadgevilleBerlin/Player.html +135 -0
  22. data/doc/BadgevilleBerlin/Reward.html +135 -0
  23. data/doc/BadgevilleBerlin/RewardDefinition.html +135 -0
  24. data/doc/BadgevilleBerlin/Site.html +135 -0
  25. data/doc/BadgevilleBerlin/Track.html +135 -0
  26. data/doc/BadgevilleBerlin/User.html +135 -0
  27. data/doc/BadgevilleBerlinJsonFormat.html +530 -0
  28. data/doc/_index.html +285 -0
  29. data/doc/class_list.html +47 -0
  30. data/doc/css/common.css +1 -0
  31. data/doc/css/full_list.css +53 -0
  32. data/doc/css/style.css +320 -0
  33. data/doc/file.README.html +182 -0
  34. data/doc/file_list.html +49 -0
  35. data/doc/frames.html +13 -0
  36. data/doc/index.html +182 -0
  37. data/doc/js/app.js +205 -0
  38. data/doc/js/full_list.js +150 -0
  39. data/doc/js/jquery.js +16 -0
  40. data/doc/method_list.html +118 -0
  41. data/doc/top-level-namespace.html +103 -0
  42. data/examples/.DS_Store +0 -0
  43. data/examples/shell/.DS_Store +0 -0
  44. data/examples/shell/lib/.DS_Store +0 -0
  45. data/examples/shell/lib/berlin_shell.rb +34 -0
  46. data/examples/shell/lib/berlin_shell/.DS_Store +0 -0
  47. data/examples/shell/lib/berlin_shell/cd.rb +17 -0
  48. data/examples/shell/lib/berlin_shell/core.rb +118 -0
  49. data/examples/shell/lib/berlin_shell/ls.rb +72 -0
  50. data/examples/shell/lib/berlin_shell/prompt.rb +39 -0
  51. data/examples/shell/shell_demo.rb +319 -0
  52. data/examples/shell/spec/integration/basic_spec.rb +7 -0
  53. data/lib/.yardoc/checksums +0 -0
  54. data/lib/.yardoc/objects/root.dat +0 -0
  55. data/lib/.yardoc/proxy_types +0 -0
  56. data/lib/badgeville_berlin.rb +24 -0
  57. data/lib/badgeville_berlin/.yardoc/checksums +0 -0
  58. data/lib/badgeville_berlin/.yardoc/objects/root.dat +0 -0
  59. data/lib/badgeville_berlin/.yardoc/proxy_types +0 -0
  60. data/lib/badgeville_berlin/activity.rb +5 -0
  61. data/lib/badgeville_berlin/activity_definition.rb +5 -0
  62. data/lib/badgeville_berlin/base_resource.rb +68 -0
  63. data/lib/badgeville_berlin/config.rb +36 -0
  64. data/lib/badgeville_berlin/doc/_index.html +84 -0
  65. data/lib/badgeville_berlin/doc/class_list.html +47 -0
  66. data/lib/badgeville_berlin/doc/css/common.css +1 -0
  67. data/lib/badgeville_berlin/doc/css/full_list.css +53 -0
  68. data/lib/badgeville_berlin/doc/css/style.css +320 -0
  69. data/lib/badgeville_berlin/doc/file_list.html +46 -0
  70. data/lib/badgeville_berlin/doc/frames.html +13 -0
  71. data/lib/badgeville_berlin/doc/index.html +84 -0
  72. data/lib/badgeville_berlin/doc/js/app.js +205 -0
  73. data/lib/badgeville_berlin/doc/js/full_list.js +150 -0
  74. data/lib/badgeville_berlin/doc/js/jquery.js +16 -0
  75. data/lib/badgeville_berlin/doc/method_list.html +46 -0
  76. data/lib/badgeville_berlin/doc/top-level-namespace.html +93 -0
  77. data/lib/badgeville_berlin/errors.rb +28 -0
  78. data/lib/badgeville_berlin/formats/badgeville_berlin_json_format.rb +55 -0
  79. data/lib/badgeville_berlin/group.rb +5 -0
  80. data/lib/badgeville_berlin/leaderboard.rb +5 -0
  81. data/lib/badgeville_berlin/player.rb +5 -0
  82. data/lib/badgeville_berlin/reward.rb +5 -0
  83. data/lib/badgeville_berlin/reward_definition.rb +5 -0
  84. data/lib/badgeville_berlin/site.rb +5 -0
  85. data/lib/badgeville_berlin/track.rb +5 -0
  86. data/lib/badgeville_berlin/user.rb +5 -0
  87. data/lib/badgeville_berlin/version.rb +3 -0
  88. data/lib/doc/_index.html +84 -0
  89. data/lib/doc/class_list.html +47 -0
  90. data/lib/doc/css/common.css +1 -0
  91. data/lib/doc/css/full_list.css +53 -0
  92. data/lib/doc/css/style.css +320 -0
  93. data/lib/doc/file_list.html +46 -0
  94. data/lib/doc/frames.html +13 -0
  95. data/lib/doc/index.html +84 -0
  96. data/lib/doc/js/app.js +205 -0
  97. data/lib/doc/js/full_list.js +150 -0
  98. data/lib/doc/js/jquery.js +16 -0
  99. data/lib/doc/method_list.html +46 -0
  100. data/lib/doc/top-level-namespace.html +93 -0
  101. data/spec/factories.rb +54 -0
  102. data/spec/integration/activity_spec.rb +0 -0
  103. data/spec/integration/basic_spec.rb +68 -0
  104. data/spec/integration/player_spec.rb +6 -0
  105. data/spec/integration/site_spec.rb +11 -0
  106. data/spec/integration/user_spec.rb +3 -0
  107. data/spec/response_json.yml +36 -0
  108. data/spec/spec_helper.rb +60 -0
  109. data/spec/unit/badgeville_berlin_json_format_spec.rb +68 -0
  110. data/spec/unit/base_resource_spec.rb +47 -0
  111. data/spec/unit/config_spec.rb +65 -0
  112. data/spec/unit/errors_spec.rb +47 -0
  113. data/spec/use_case/readme_use_case_spec.rb +262 -0
  114. metadata +286 -0
data/doc/BadgevilleBerlin/Activity.html ADDED
@@ -0,0 +1,135 @@
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::Activity
8
+
9
+ &mdash; 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 (A)</a> &raquo;
37
+ <span class='title'><span class='object_link'><a href="../BadgevilleBerlin.html" title="BadgevilleBerlin (module)">BadgevilleBerlin</a></span></span>
38
+ &raquo;
39
+ <span class="title">Activity</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::Activity
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::Activity</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/activity.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
+
115
+
116
+
117
+
118
+
119
+ <h2>Method Summary</h2>
120
+
121
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="BaseResource.html" title="BadgevilleBerlin::BaseResource (class)">BaseResource</a></span></h3>
122
+ <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>
123
+
124
+
125
+
126
+ </div>
127
+
128
+ <div id="footer">
129
+ Generated on Tue Jan 24 14:21:13 2012 by
130
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
131
+ 0.7.1 (ruby-1.9.2).
132
+ </div>
133
+
134
+ </body>
135
+ </html>
data/doc/BadgevilleBerlin/ActivityDefinition.html ADDED
@@ -0,0 +1,135 @@
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::ActivityDefinition
8
+
9
+ &mdash; 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 (A)</a> &raquo;
37
+ <span class='title'><span class='object_link'><a href="../BadgevilleBerlin.html" title="BadgevilleBerlin (module)">BadgevilleBerlin</a></span></span>
38
+ &raquo;
39
+ <span class="title">ActivityDefinition</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::ActivityDefinition
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::ActivityDefinition</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/activity_definition.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
+
115
+
116
+
117
+
118
+
119
+ <h2>Method Summary</h2>
120
+
121
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="BaseResource.html" title="BadgevilleBerlin::BaseResource (class)">BaseResource</a></span></h3>
122
+ <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>
123
+
124
+
125
+
126
+ </div>
127
+
128
+ <div id="footer">
129
+ Generated on Tue Jan 24 14:21:13 2012 by
130
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
131
+ 0.7.1 (ruby-1.9.2).
132
+ </div>
133
+
134
+ </body>
135
+ </html>
data/doc/BadgevilleBerlin/BaseResource.html ADDED
@@ -0,0 +1,462 @@
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::BaseResource
8
+
9
+ &mdash; 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 (B)</a> &raquo;
37
+ <span class='title'><span class='object_link'><a href="../BadgevilleBerlin.html" title="BadgevilleBerlin (module)">BadgevilleBerlin</a></span></span>
38
+ &raquo;
39
+ <span class="title">BaseResource</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::BaseResource
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::Base</span>
70
+
71
+ <ul class="fullTree">
72
+ <li>Object</li>
73
+
74
+ <li class="next">ActiveResource::Base</li>
75
+
76
+ <li class="next">BadgevilleBerlin::BaseResource</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/base_resource.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::Base as BaseResource
101
+ </p>
102
+
103
+
104
+ </div>
105
+ </div>
106
+ <div class="tags">
107
+
108
+ </div><div id="subclasses">
109
+ <h2>Direct Known Subclasses</h2>
110
+ <p class="children"><span class='object_link'><a href="Activity.html" title="BadgevilleBerlin::Activity (class)">Activity</a></span>, <span class='object_link'><a href="ActivityDefinition.html" title="BadgevilleBerlin::ActivityDefinition (class)">ActivityDefinition</a></span>, <span class='object_link'><a href="Config.html" title="BadgevilleBerlin::Config (class)">Config</a></span>, <span class='object_link'><a href="Group.html" title="BadgevilleBerlin::Group (class)">Group</a></span>, <span class='object_link'><a href="Leaderboard.html" title="BadgevilleBerlin::Leaderboard (class)">Leaderboard</a></span>, <span class='object_link'><a href="Player.html" title="BadgevilleBerlin::Player (class)">Player</a></span>, <span class='object_link'><a href="Reward.html" title="BadgevilleBerlin::Reward (class)">Reward</a></span>, <span class='object_link'><a href="RewardDefinition.html" title="BadgevilleBerlin::RewardDefinition (class)">RewardDefinition</a></span>, <span class='object_link'><a href="Site.html" title="BadgevilleBerlin::Site (class)">Site</a></span>, <span class='object_link'><a href="Track.html" title="BadgevilleBerlin::Track (class)">Track</a></span>, <span class='object_link'><a href="User.html" title="BadgevilleBerlin::User (class)">User</a></span></p>
111
+ </div>
112
+
113
+
114
+
115
+
116
+
117
+
118
+
119
+
120
+ <h2>
121
+ Class Method Summary
122
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
123
+ </h2>
124
+
125
+ <ul class="summary">
126
+
127
+ <li class="public ">
128
+ <span class="summary_signature">
129
+
130
+ <a href="#primary_key-class_method" title="primary_key (class method)">+ (String) <strong>primary_key</strong> </a>
131
+
132
+
133
+
134
+ </span>
135
+
136
+
137
+
138
+
139
+
140
+
141
+
142
+
143
+ <span class="summary_desc"><div class='inline'><p>
144
+ Overrides the ActiveResource class method primary_key to be
145
+ &#8216;_id&#8217; instead of &#8216;id.&#8217;.
146
+ </p>
147
+ </div></span>
148
+
149
+ </li>
150
+
151
+
152
+ </ul>
153
+
154
+ <h2>
155
+ Instance Method Summary
156
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
157
+ </h2>
158
+
159
+ <ul class="summary">
160
+
161
+ <li class="public ">
162
+ <span class="summary_signature">
163
+
164
+ <a href="#errors-instance_method" title="#errors (instance method)">- (BadgevilleBerlin::Errors) <strong>errors</strong> </a>
165
+
166
+
167
+
168
+ </span>
169
+
170
+
171
+
172
+
173
+
174
+
175
+
176
+
177
+ <span class="summary_desc"><div class='inline'><p>
178
+ Overrides the ActiveResource instance method in module Validations in order
179
+ to call the BadgevilleBerlin::Errors constructor instead of the
180
+ ActiveResource::Errors constructor.
181
+ </p>
182
+ </div></span>
183
+
184
+ </li>
185
+
186
+
187
+ <li class="public ">
188
+ <span class="summary_signature">
189
+
190
+ <a href="#load_remote_errors-instance_method" title="#load_remote_errors (instance method)">- (Object) <strong>load_remote_errors</strong>(remote_errors, save_cache = false) </a>
191
+
192
+
193
+
194
+ </span>
195
+
196
+
197
+
198
+
199
+
200
+
201
+
202
+
203
+ <span class="summary_desc"><div class='inline'><p>
204
+ Overrides the ActiveResource isntance method in module Validations in order
205
+ to load_remote_errors() for the case where the format is the custom
206
+ BadgevilleJson format.
207
+ </p>
208
+ </div></span>
209
+
210
+ </li>
211
+
212
+
213
+ </ul>
214
+
215
+
216
+
217
+
218
+
219
+ <div id="class_method_details" class="method_details_list">
220
+ <h2>Class Method Details</h2>
221
+
222
+
223
+ <div class="method_details first">
224
+ <p class="signature first" id="primary_key-class_method">
225
+
226
+ + (<tt>String</tt>) <strong>primary_key</strong>
227
+
228
+
229
+
230
+ </p><div class="docstring">
231
+ <div class="discussion">
232
+ <p>
233
+ Overrides the ActiveResource class method primary_key to be
234
+ &#8216;_id&#8217; instead of &#8216;id.&#8217;
235
+ </p>
236
+
237
+
238
+ </div>
239
+ </div>
240
+ <div class="tags">
241
+ <h3>Returns:</h3>
242
+ <ul class="return">
243
+
244
+ <li>
245
+
246
+
247
+ <span class='type'>(<tt>String</tt>)</span>
248
+
249
+
250
+
251
+ &mdash;
252
+ <div class='inline'><p>
253
+ primary key name &#8216;_id&#8217;
254
+ </p>
255
+ </div>
256
+
257
+ </li>
258
+
259
+ </ul>
260
+
261
+ </div><table class="source_code">
262
+ <tr>
263
+ <td>
264
+ <pre class="lines">
265
+
266
+
267
+ 13
268
+ 14
269
+ 15</pre>
270
+ </td>
271
+ <td>
272
+ <pre class="code"><span class="info file"># File 'lib/badgeville-berlin/base_resource.rb', line 13</span>
273
+
274
+ <span class='kw'>def</span> <span class='id primary_key'>primary_key</span>
275
+ <span class='ivar'>@primary_key</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>_id</span><span class='tstring_end'>'</span></span>
276
+ <span class='kw'>end</span></pre>
277
+ </td>
278
+ </tr>
279
+ </table>
280
+ </div>
281
+
282
+ </div>
283
+
284
+ <div id="instance_method_details" class="method_details_list">
285
+ <h2>Instance Method Details</h2>
286
+
287
+
288
+ <div class="method_details first">
289
+ <p class="signature first" id="errors-instance_method">
290
+
291
+ - (<tt><span class='object_link'><a href="Errors.html" title="BadgevilleBerlin::Errors (class)">BadgevilleBerlin::Errors</a></span></tt>) <strong>errors</strong>
292
+
293
+
294
+
295
+ </p><div class="docstring">
296
+ <div class="discussion">
297
+ <p>
298
+ Overrides the ActiveResource instance method in module Validations in order
299
+ to call the BadgevilleBerlin::Errors constructor instead of the
300
+ ActiveResource::Errors constructor.
301
+ </p>
302
+ <p>
303
+ errors messages from the remote server and mimics the interface of the
304
+ errors provided by ActiveRecord::Errors.
305
+ </p>
306
+
307
+
308
+ </div>
309
+ </div>
310
+ <div class="tags">
311
+ <h3>Returns:</h3>
312
+ <ul class="return">
313
+
314
+ <li>
315
+
316
+
317
+ <span class='type'>(<tt><span class='object_link'><a href="Errors.html" title="BadgevilleBerlin::Errors (class)">BadgevilleBerlin::Errors</a></span></tt>)</span>
318
+
319
+
320
+
321
+ &mdash;
322
+ <div class='inline'><p>
323
+ object that holds information about
324
+ </p>
325
+ </div>
326
+
327
+ </li>
328
+
329
+ </ul>
330
+
331
+ </div><table class="source_code">
332
+ <tr>
333
+ <td>
334
+ <pre class="lines">
335
+
336
+
337
+ 25
338
+ 26
339
+ 27</pre>
340
+ </td>
341
+ <td>
342
+ <pre class="code"><span class="info file"># File 'lib/badgeville-berlin/base_resource.rb', line 25</span>
343
+
344
+ <span class='kw'>def</span> <span class='id errors'>errors</span>
345
+ <span class='ivar'>@errors</span> <span class='op'>||=</span> <span class='const'>BadgevilleBerlin</span><span class='op'>::</span><span class='const'>Errors</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
346
+ <span class='kw'>end</span></pre>
347
+ </td>
348
+ </tr>
349
+ </table>
350
+ </div>
351
+
352
+ <div class="method_details ">
353
+ <p class="signature " id="load_remote_errors-instance_method">
354
+
355
+ - (<tt>Object</tt>) <strong>load_remote_errors</strong>(remote_errors, save_cache = false)
356
+
357
+
358
+
359
+ </p><div class="docstring">
360
+ <div class="discussion">
361
+ <p>
362
+ Overrides the ActiveResource isntance method in module Validations in order
363
+ to load_remote_errors() for the case where the format is the custom
364
+ BadgevilleJson format. Loads the set of remote errors into the object???s
365
+ Errors collection based on the content-type of the error-block received.
366
+ </p>
367
+ <p>
368
+ cleared by default
369
+ </p>
370
+
371
+
372
+ </div>
373
+ </div>
374
+ <div class="tags">
375
+ <h3>Parameters:</h3>
376
+ <ul class="param">
377
+
378
+ <li>
379
+
380
+ <span class='name'>remote_errors</span>
381
+
382
+
383
+ <span class='type'></span>
384
+
385
+
386
+
387
+ &mdash;
388
+ <div class='inline'><p>
389
+ errors from teh remote server
390
+ </p>
391
+ </div>
392
+
393
+ </li>
394
+
395
+ <li>
396
+
397
+ <span class='name'>save_cache</span>
398
+
399
+
400
+ <span class='type'>(<tt>Object</tt>)</span>
401
+
402
+
403
+ <em class="default">(defaults to: <tt>false</tt>)</em>
404
+
405
+
406
+ &mdash;
407
+ <div class='inline'><p>
408
+ flag that directs the errors cache to be
409
+ </p>
410
+ </div>
411
+
412
+ </li>
413
+
414
+ </ul>
415
+
416
+ </div><table class="source_code">
417
+ <tr>
418
+ <td>
419
+ <pre class="lines">
420
+
421
+
422
+ 38
423
+ 39
424
+ 40
425
+ 41
426
+ 42
427
+ 43
428
+ 44
429
+ 45
430
+ 46
431
+ 47</pre>
432
+ </td>
433
+ <td>
434
+ <pre class="code"><span class="info file"># File 'lib/badgeville-berlin/base_resource.rb', line 38</span>
435
+
436
+ <span class='kw'>def</span> <span class='id load_remote_errors'>load_remote_errors</span><span class='lparen'>(</span><span class='id remote_errors'>remote_errors</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> <span class='comment'>#:nodoc:
437
+ </span> <span class='kw'>case</span> <span class='kw'>self</span><span class='period'>.</span><span class='id class'>class</span><span class='period'>.</span><span class='id format'>format</span>
438
+ <span class='kw'>when</span> <span class='const'>ActiveResource</span><span class='op'>::</span><span class='const'>Formats</span><span class='lbracket'>[</span><span class='symbol'>:xml</span><span class='rbracket'>]</span>
439
+ <span class='id errors'>errors</span><span class='period'>.</span><span class='id from_xml'>from_xml</span><span class='lparen'>(</span><span class='id remote_errors'>remote_errors</span><span class='period'>.</span><span class='id response'>response</span><span class='period'>.</span><span class='id body'>body</span><span class='comma'>,</span> <span class='id save_cache'>save_cache</span><span class='rparen'>)</span>
440
+ <span class='kw'>when</span> <span class='const'>ActiveResource</span><span class='op'>::</span><span class='const'>Formats</span><span class='lbracket'>[</span><span class='symbol'>:json</span><span class='rbracket'>]</span>
441
+ <span class='id errors'>errors</span><span class='period'>.</span><span class='id from_json'>from_json</span><span class='lparen'>(</span><span class='id remote_errors'>remote_errors</span><span class='period'>.</span><span class='id response'>response</span><span class='period'>.</span><span class='id body'>body</span><span class='comma'>,</span> <span class='id save_cache'>save_cache</span><span class='rparen'>)</span>
442
+ <span class='kw'>when</span> <span class='const'>ActiveResource</span><span class='op'>::</span><span class='const'>Formats</span><span class='lbracket'>[</span><span class='symbol'>:badgeville_berlin_json</span><span class='rbracket'>]</span>
443
+ <span class='id errors'>errors</span><span class='period'>.</span><span class='id from_badgeville_berlin_json'>from_badgeville_berlin_json</span><span class='lparen'>(</span><span class='id remote_errors'>remote_errors</span><span class='period'>.</span><span class='id response'>response</span><span class='period'>.</span><span class='id body'>body</span><span class='comma'>,</span> <span class='id save_cache'>save_cache</span><span class='rparen'>)</span>
444
+ <span class='kw'>end</span>
445
+ <span class='kw'>end</span></pre>
446
+ </td>
447
+ </tr>
448
+ </table>
449
+ </div>
450
+
451
+ </div>
452
+
453
+ </div>
454
+
455
+ <div id="footer">
456
+ Generated on Tue Jan 24 14:21:13 2012 by
457
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
458
+ 0.7.1 (ruby-1.9.2).
459
+ </div>
460
+
461
+ </body>
462
+ </html>