esp_sdk 1.1.0 → 2.0.0.rc1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (199) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +0 -2
  3. data/.rubocop.yml +53 -6
  4. data/.ruby-version +1 -1
  5. data/.travis.yml +8 -2
  6. data/Gemfile.lock +171 -0
  7. data/Guardfile +47 -0
  8. data/README.md +230 -5
  9. data/Rakefile +14 -1
  10. data/assets/logo.png +0 -0
  11. data/bin/esp_console +71 -0
  12. data/esp_sdk.gemspec +27 -18
  13. data/lib/esp/exceptions.rb +3 -0
  14. data/lib/esp/extensions/active_resource/formats/json_api_format.rb +105 -0
  15. data/lib/esp/extensions/active_resource/paginated_collection.rb +198 -0
  16. data/lib/esp/extensions/active_resource/validations.rb +45 -0
  17. data/lib/esp/resources/alert.rb +135 -0
  18. data/lib/esp/resources/cloud_trail_event.rb +45 -0
  19. data/lib/esp/resources/concerns/stat_totals.rb +79 -0
  20. data/lib/esp/resources/contact_request.rb +42 -0
  21. data/lib/esp/resources/custom_signature.rb +224 -0
  22. data/lib/esp/resources/dashboard.rb +31 -0
  23. data/lib/esp/resources/external_account.rb +89 -0
  24. data/lib/esp/resources/organization.rb +61 -0
  25. data/lib/esp/resources/region.rb +46 -0
  26. data/lib/esp/resources/report.rb +100 -0
  27. data/lib/esp/resources/resource.rb +66 -0
  28. data/lib/esp/resources/service.rb +31 -0
  29. data/lib/esp/resources/signature.rb +106 -0
  30. data/lib/esp/resources/stat.rb +124 -0
  31. data/lib/esp/resources/stat_custom_signature.rb +121 -0
  32. data/lib/esp/resources/stat_region.rb +121 -0
  33. data/lib/esp/resources/stat_service.rb +121 -0
  34. data/lib/esp/resources/stat_signature.rb +121 -0
  35. data/lib/esp/resources/sub_organization.rb +69 -0
  36. data/lib/esp/resources/suppression/region.rb +99 -0
  37. data/lib/esp/resources/suppression/signature.rb +107 -0
  38. data/lib/esp/resources/suppression/unique_identifier.rb +60 -0
  39. data/lib/esp/resources/suppression.rb +86 -0
  40. data/lib/esp/resources/tag.rb +45 -0
  41. data/lib/esp/resources/team.rb +79 -0
  42. data/lib/esp/resources/user.rb +46 -0
  43. data/lib/esp/version.rb +3 -0
  44. data/lib/esp.rb +95 -0
  45. data/lib/esp_sdk.rb +9 -45
  46. data/lib/tasks/rubocop.rake +2 -0
  47. data/lib/tasks/testing.rake +3 -0
  48. data/rdoc/ActiveResource/Formats.html +176 -0
  49. data/rdoc/ActiveResource/PaginatedCollection.html +910 -0
  50. data/rdoc/ActiveResource.html +180 -0
  51. data/rdoc/ESP/Alert.html +771 -0
  52. data/rdoc/ESP/CloudTrailEvent.html +375 -0
  53. data/rdoc/ESP/ContactRequest.html +366 -0
  54. data/rdoc/ESP/CustomSignature.html +746 -0
  55. data/rdoc/ESP/Dashboard.html +355 -0
  56. data/rdoc/ESP/ExternalAccount.html +565 -0
  57. data/rdoc/ESP/Organization.html +590 -0
  58. data/rdoc/ESP/Region.html +399 -0
  59. data/rdoc/ESP/Report.html +622 -0
  60. data/rdoc/ESP/Service.html +380 -0
  61. data/rdoc/ESP/Signature.html +555 -0
  62. data/rdoc/ESP/Stat.html +1778 -0
  63. data/rdoc/ESP/StatCustomSignature.html +1599 -0
  64. data/rdoc/ESP/StatRegion.html +1598 -0
  65. data/rdoc/ESP/StatService.html +1598 -0
  66. data/rdoc/ESP/StatSignature.html +1598 -0
  67. data/rdoc/ESP/SubOrganization.html +540 -0
  68. data/rdoc/ESP/Suppression/Region.html +454 -0
  69. data/rdoc/ESP/Suppression/Signature.html +470 -0
  70. data/rdoc/ESP/Suppression/UniqueIdentifier.html +417 -0
  71. data/rdoc/ESP/Suppression.html +649 -0
  72. data/rdoc/ESP/Tag.html +371 -0
  73. data/rdoc/ESP/Team.html +584 -0
  74. data/rdoc/ESP/User.html +483 -0
  75. data/rdoc/ESP.html +546 -0
  76. data/rdoc/README_md.html +501 -0
  77. data/rdoc/created.rid +30 -0
  78. data/rdoc/images/add.png +0 -0
  79. data/rdoc/images/arrow_up.png +0 -0
  80. data/rdoc/images/brick.png +0 -0
  81. data/rdoc/images/brick_link.png +0 -0
  82. data/rdoc/images/bug.png +0 -0
  83. data/rdoc/images/bullet_black.png +0 -0
  84. data/rdoc/images/bullet_toggle_minus.png +0 -0
  85. data/rdoc/images/bullet_toggle_plus.png +0 -0
  86. data/rdoc/images/date.png +0 -0
  87. data/rdoc/images/delete.png +0 -0
  88. data/rdoc/images/find.png +0 -0
  89. data/rdoc/images/loadingAnimation.gif +0 -0
  90. data/rdoc/images/macFFBgHack.png +0 -0
  91. data/rdoc/images/package.png +0 -0
  92. data/rdoc/images/page_green.png +0 -0
  93. data/rdoc/images/page_white_text.png +0 -0
  94. data/rdoc/images/page_white_width.png +0 -0
  95. data/rdoc/images/plugin.png +0 -0
  96. data/rdoc/images/ruby.png +0 -0
  97. data/rdoc/images/tag_blue.png +0 -0
  98. data/rdoc/images/tag_green.png +0 -0
  99. data/rdoc/images/transparent.png +0 -0
  100. data/rdoc/images/wrench.png +0 -0
  101. data/rdoc/images/wrench_orange.png +0 -0
  102. data/rdoc/images/zoom.png +0 -0
  103. data/rdoc/index.html +134 -0
  104. data/rdoc/js/darkfish.js +155 -0
  105. data/rdoc/js/jquery.js +4 -0
  106. data/rdoc/js/navigation.js +142 -0
  107. data/rdoc/js/search.js +94 -0
  108. data/rdoc/js/search_index.js +1 -0
  109. data/rdoc/js/searcher.js +228 -0
  110. data/rdoc/rdoc.css +595 -0
  111. data/rdoc/table_of_contents.html +927 -0
  112. data/test/esp/extensions/active_resource/formats/json_api_format_test.rb +109 -0
  113. data/test/esp/extensions/active_resource/paginated_collection_test.rb +435 -0
  114. data/test/esp/extensions/active_resource/validations_test.rb +59 -0
  115. data/test/esp/resources/alert_test.rb +263 -0
  116. data/test/esp/resources/cloud_trail_event_test.rb +98 -0
  117. data/test/esp/resources/contact_request_test.rb +73 -0
  118. data/test/esp/resources/custom_signature_test.rb +241 -0
  119. data/test/esp/resources/dashboard_test.rb +71 -0
  120. data/test/esp/resources/external_account_test.rb +125 -0
  121. data/test/esp/resources/organization_test.rb +175 -0
  122. data/test/esp/resources/region_test.rb +84 -0
  123. data/test/esp/resources/report_test.rb +180 -0
  124. data/test/esp/resources/resource_test.rb +183 -0
  125. data/test/esp/resources/service_test.rb +64 -0
  126. data/test/esp/resources/signature_test.rb +177 -0
  127. data/test/esp/resources/stat_custom_signature_test.rb +115 -0
  128. data/test/esp/resources/stat_region_test.rb +114 -0
  129. data/test/esp/resources/stat_service_test.rb +114 -0
  130. data/test/esp/resources/stat_signature_test.rb +115 -0
  131. data/test/esp/resources/stat_test.rb +159 -0
  132. data/test/esp/resources/sub_organization_test.rb +127 -0
  133. data/test/esp/resources/suppression/region_test.rb +115 -0
  134. data/test/esp/resources/suppression/signature_test.rb +117 -0
  135. data/test/esp/resources/suppression/unique_identifier_test.rb +79 -0
  136. data/test/esp/resources/suppression_test.rb +226 -0
  137. data/test/esp/resources/tag_test.rb +98 -0
  138. data/test/esp/resources/team_test.rb +140 -0
  139. data/test/esp/resources/user_test.rb +113 -0
  140. data/test/esp_test.rb +139 -0
  141. data/test/factories/alerts.rb +234 -0
  142. data/test/factories/cloud_trail_events.rb +16 -0
  143. data/test/factories/contact_requests.rb +14 -0
  144. data/test/factories/custom_signatures.rb +30 -0
  145. data/test/factories/dashboards.rb +91 -0
  146. data/test/factories/errors.rb +24 -0
  147. data/test/factories/external_accounts.rb +44 -0
  148. data/test/factories/organizations.rb +48 -0
  149. data/test/factories/regions.rb +9 -0
  150. data/test/factories/reports.rb +56 -0
  151. data/test/factories/services.rb +12 -0
  152. data/test/factories/signatures.rb +28 -0
  153. data/test/factories/stat_custom_signatures.rb +97 -0
  154. data/test/factories/stat_regions.rb +97 -0
  155. data/test/factories/stat_services.rb +97 -0
  156. data/test/factories/stat_signautures.rb +97 -0
  157. data/test/factories/stats.rb +129 -0
  158. data/test/factories/sub_organizations.rb +34 -0
  159. data/test/factories/suppression/regions.rb +90 -0
  160. data/test/factories/suppression/signatures.rb +117 -0
  161. data/test/factories/suppression/unique_identifiers.rb +111 -0
  162. data/test/factories/suppressions.rb +71 -0
  163. data/test/factories/tags.rb +12 -0
  164. data/test/factories/teams.rb +32 -0
  165. data/test/factories/users.rb +54 -0
  166. data/test/json_strategy.rb +25 -0
  167. data/test/test_helper.rb +44 -5
  168. metadata +387 -119
  169. data/bin/esp_repl +0 -60
  170. data/lib/esp_sdk/api.rb +0 -33
  171. data/lib/esp_sdk/client.rb +0 -62
  172. data/lib/esp_sdk/configure.rb +0 -40
  173. data/lib/esp_sdk/end_points/base.rb +0 -102
  174. data/lib/esp_sdk/end_points/contact_requests.rb +0 -6
  175. data/lib/esp_sdk/end_points/custom_signatures.rb +0 -41
  176. data/lib/esp_sdk/end_points/dashboard.rb +0 -35
  177. data/lib/esp_sdk/end_points/external_accounts.rb +0 -9
  178. data/lib/esp_sdk/end_points/organizations.rb +0 -6
  179. data/lib/esp_sdk/end_points/reports.rb +0 -6
  180. data/lib/esp_sdk/end_points/services.rb +0 -6
  181. data/lib/esp_sdk/end_points/signatures.rb +0 -39
  182. data/lib/esp_sdk/end_points/sub_organizations.rb +0 -6
  183. data/lib/esp_sdk/end_points/teams.rb +0 -6
  184. data/lib/esp_sdk/end_points/users.rb +0 -6
  185. data/lib/esp_sdk/exceptions.rb +0 -8
  186. data/lib/esp_sdk/extensions/rest_client/request.rb +0 -9
  187. data/lib/esp_sdk/repl.rb +0 -61
  188. data/lib/esp_sdk/version.rb +0 -3
  189. data/test/esp_sdk/api_test.rb +0 -36
  190. data/test/esp_sdk/client_test.rb +0 -129
  191. data/test/esp_sdk/configure_test.rb +0 -65
  192. data/test/esp_sdk/end_points/.keep +0 -0
  193. data/test/esp_sdk/end_points/base_test.rb +0 -230
  194. data/test/esp_sdk/end_points/custom_signatures_test.rb +0 -90
  195. data/test/esp_sdk/end_points/dashboard_test.rb +0 -55
  196. data/test/esp_sdk/end_points/external_accounts_test.rb +0 -20
  197. data/test/esp_sdk/end_points/signatures_test.rb +0 -83
  198. data/test/esp_sdk/exceptions_test.rb +0 -41
  199. data/test/esp_sdk_test.rb +0 -70
data/rdoc/ActiveResource/PaginatedCollection.html ADDED
@@ -0,0 +1,910 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
6
+
7
+ <title>class ActiveResource::PaginatedCollection - ESPSDK</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/esp/extensions/active_resource/paginated_collection.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">ActiveResource::Collection
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-current_page_number">#current_page_number</a>
77
+
78
+ <li ><a href="#method-i-first_page">#first_page</a>
79
+
80
+ <li ><a href="#method-i-first_page-21">#first_page!</a>
81
+
82
+ <li ><a href="#method-i-last_page">#last_page</a>
83
+
84
+ <li ><a href="#method-i-last_page-21">#last_page!</a>
85
+
86
+ <li ><a href="#method-i-last_page-3F">#last_page?</a>
87
+
88
+ <li ><a href="#method-i-last_page_number">#last_page_number</a>
89
+
90
+ <li ><a href="#method-i-next_page">#next_page</a>
91
+
92
+ <li ><a href="#method-i-next_page-21">#next_page!</a>
93
+
94
+ <li ><a href="#method-i-next_page-3F">#next_page?</a>
95
+
96
+ <li ><a href="#method-i-next_page_number">#next_page_number</a>
97
+
98
+ <li ><a href="#method-i-page">#page</a>
99
+
100
+ <li ><a href="#method-i-page-21">#page!</a>
101
+
102
+ <li ><a href="#method-i-previous_page">#previous_page</a>
103
+
104
+ <li ><a href="#method-i-previous_page-21">#previous_page!</a>
105
+
106
+ <li ><a href="#method-i-previous_page-3F">#previous_page?</a>
107
+
108
+ <li ><a href="#method-i-previous_page_number">#previous_page_number</a>
109
+
110
+ </ul>
111
+ </nav>
112
+
113
+ </div>
114
+
115
+ <div id="project-metadata">
116
+ <nav id="fileindex-section" class="section project-section">
117
+ <h3 class="section-header">Pages</h3>
118
+
119
+ <ul>
120
+
121
+ <li class="file"><a href="../README_md.html">README</a>
122
+
123
+ </ul>
124
+ </nav>
125
+
126
+ <nav id="classindex-section" class="section project-section">
127
+ <h3 class="section-header">Class and Module Index</h3>
128
+
129
+ <ul class="link-list">
130
+
131
+ <li><a href="../ActiveResource.html">ActiveResource</a>
132
+
133
+ <li><a href="../ActiveResource/Formats.html">ActiveResource::Formats</a>
134
+
135
+ <li><a href="../ActiveResource/PaginatedCollection.html">ActiveResource::PaginatedCollection</a>
136
+
137
+ <li><a href="../ESP.html">ESP</a>
138
+
139
+ <li><a href="../ESP/Alert.html">ESP::Alert</a>
140
+
141
+ <li><a href="../ESP/CloudTrailEvent.html">ESP::CloudTrailEvent</a>
142
+
143
+ <li><a href="../ESP/ContactRequest.html">ESP::ContactRequest</a>
144
+
145
+ <li><a href="../ESP/CustomSignature.html">ESP::CustomSignature</a>
146
+
147
+ <li><a href="../ESP/Dashboard.html">ESP::Dashboard</a>
148
+
149
+ <li><a href="../ESP/ExternalAccount.html">ESP::ExternalAccount</a>
150
+
151
+ <li><a href="../ESP/Organization.html">ESP::Organization</a>
152
+
153
+ <li><a href="../ESP/Region.html">ESP::Region</a>
154
+
155
+ <li><a href="../ESP/Report.html">ESP::Report</a>
156
+
157
+ <li><a href="../ESP/Service.html">ESP::Service</a>
158
+
159
+ <li><a href="../ESP/Signature.html">ESP::Signature</a>
160
+
161
+ <li><a href="../ESP/Stat.html">ESP::Stat</a>
162
+
163
+ <li><a href="../ESP/StatCustomSignature.html">ESP::StatCustomSignature</a>
164
+
165
+ <li><a href="../ESP/StatRegion.html">ESP::StatRegion</a>
166
+
167
+ <li><a href="../ESP/StatService.html">ESP::StatService</a>
168
+
169
+ <li><a href="../ESP/StatSignature.html">ESP::StatSignature</a>
170
+
171
+ <li><a href="../ESP/SubOrganization.html">ESP::SubOrganization</a>
172
+
173
+ <li><a href="../ESP/Suppression.html">ESP::Suppression</a>
174
+
175
+ <li><a href="../ESP/Suppression/Region.html">ESP::Suppression::Region</a>
176
+
177
+ <li><a href="../ESP/Suppression/Signature.html">ESP::Suppression::Signature</a>
178
+
179
+ <li><a href="../ESP/Suppression/UniqueIdentifier.html">ESP::Suppression::UniqueIdentifier</a>
180
+
181
+ <li><a href="../ESP/Tag.html">ESP::Tag</a>
182
+
183
+ <li><a href="../ESP/Team.html">ESP::Team</a>
184
+
185
+ <li><a href="../ESP/User.html">ESP::User</a>
186
+
187
+ </ul>
188
+ </nav>
189
+
190
+ </div>
191
+ </nav>
192
+
193
+ <div id="documentation">
194
+ <h1 class="class">class ActiveResource::PaginatedCollection</h1>
195
+
196
+ <div id="description" class="description">
197
+
198
+ <p>Provides a mean to call the Evident.io API to easily retrieve paginated
199
+ data</p>
200
+
201
+ </div><!-- description -->
202
+
203
+
204
+
205
+
206
+ <section id="5Buntitled-5D" class="documentation-section">
207
+
208
+
209
+
210
+
211
+
212
+
213
+
214
+
215
+ <!-- Methods -->
216
+
217
+ <section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
218
+ <h3 class="section-header">Public Instance Methods</h3>
219
+
220
+
221
+ <div id="method-i-current_page_number" class="method-detail ">
222
+
223
+ <div class="method-heading">
224
+ <span class="method-name">current_page_number</span><span
225
+ class="method-args">()</span>
226
+
227
+ <span class="method-click-advice">click to toggle source</span>
228
+
229
+ </div>
230
+
231
+
232
+ <div class="method-description">
233
+
234
+ <p>The current page number of data.</p>
235
+
236
+
237
+
238
+
239
+ <div class="method-source-code" id="current_page_number-source">
240
+ <pre><span class="ruby-comment"># File lib/esp/extensions/active_resource/paginated_collection.rb, line 146</span>
241
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">current_page_number</span>
242
+ (<span class="ruby-identifier">previous_page_number</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>).<span class="ruby-identifier">to_s</span>
243
+ <span class="ruby-keyword">end</span></pre>
244
+ </div><!-- current_page_number-source -->
245
+
246
+ </div>
247
+
248
+
249
+
250
+
251
+ </div><!-- current_page_number-method -->
252
+
253
+
254
+ <div id="method-i-first_page" class="method-detail ">
255
+
256
+ <div class="method-heading">
257
+ <span class="method-name">first_page</span><span
258
+ class="method-args">()</span>
259
+
260
+ <span class="method-click-advice">click to toggle source</span>
261
+
262
+ </div>
263
+
264
+
265
+ <div class="method-description">
266
+
267
+ <p>Returns a new <a href="PaginatedCollection.html">PaginatedCollection</a>
268
+ with the first page of results.</p>
269
+
270
+ <p>Returns self when on the first page and no API call is made.</p>
271
+
272
+ <h4 id="method-i-first_page-label-Example">Example<span><a href="#method-i-first_page-label-Example">&para;</a> <a href="#documentation">&uarr;</a></span></h4>
273
+
274
+ <pre class="ruby"><span class="ruby-identifier">alerts</span>.<span class="ruby-identifier">current_page_number</span> <span class="ruby-comment"># =&gt; 5</span>
275
+ <span class="ruby-identifier">first_page</span> = <span class="ruby-identifier">alerts</span>.<span class="ruby-identifier">first_page</span>
276
+ <span class="ruby-identifier">alerts</span>.<span class="ruby-identifier">current_page_number</span> <span class="ruby-comment"># =&gt; 5</span>
277
+ <span class="ruby-identifier">first_page</span>.<span class="ruby-identifier">current_page_number</span> <span class="ruby-comment"># =&gt; 1</span>
278
+ </pre>
279
+
280
+
281
+
282
+
283
+ <div class="method-source-code" id="first_page-source">
284
+ <pre><span class="ruby-comment"># File lib/esp/extensions/active_resource/paginated_collection.rb, line 28</span>
285
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">first_page</span>
286
+ <span class="ruby-identifier">previous_page?</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">resource_class</span>.<span class="ruby-identifier">all</span>(<span class="ruby-identifier">from</span><span class="ruby-operator">:</span> <span class="ruby-identifier">from</span>, <span class="ruby-identifier">params</span><span class="ruby-operator">:</span> { <span class="ruby-identifier">page</span><span class="ruby-operator">:</span> { <span class="ruby-identifier">number</span><span class="ruby-operator">:</span> <span class="ruby-value">1</span> } }) <span class="ruby-operator">:</span> <span class="ruby-keyword">self</span>
287
+ <span class="ruby-keyword">end</span></pre>
288
+ </div><!-- first_page-source -->
289
+
290
+ </div>
291
+
292
+
293
+
294
+
295
+ </div><!-- first_page-method -->
296
+
297
+
298
+ <div id="method-i-first_page-21" class="method-detail ">
299
+
300
+ <div class="method-heading">
301
+ <span class="method-name">first_page!</span><span
302
+ class="method-args">()</span>
303
+
304
+ <span class="method-click-advice">click to toggle source</span>
305
+
306
+ </div>
307
+
308
+
309
+ <div class="method-description">
310
+
311
+ <p>Updates the existing <a
312
+ href="PaginatedCollection.html">PaginatedCollection</a> object with the
313
+ first page of data when not on the first page.</p>
314
+
315
+ <h4 id="method-i-first_page-21-label-Example">Example<span><a href="#method-i-first_page-21-label-Example">&para;</a> <a href="#documentation">&uarr;</a></span></h4>
316
+
317
+ <pre class="ruby"><span class="ruby-identifier">alerts</span>.<span class="ruby-identifier">current_page_number</span> <span class="ruby-comment"># =&gt; 5</span>
318
+ <span class="ruby-identifier">alerts</span>.<span class="ruby-identifier">first_page!</span>
319
+ <span class="ruby-identifier">alerts</span>.<span class="ruby-identifier">current_page_number</span> <span class="ruby-comment"># =&gt; 1</span>
320
+ </pre>
321
+
322
+
323
+
324
+
325
+ <div class="method-source-code" id="first_page-21-source">
326
+ <pre><span class="ruby-comment"># File lib/esp/extensions/active_resource/paginated_collection.rb, line 38</span>
327
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">first_page!</span>
328
+ <span class="ruby-identifier">first_page</span>.<span class="ruby-identifier">tap</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">page</span><span class="ruby-operator">|</span> <span class="ruby-identifier">update_self</span>(<span class="ruby-identifier">page</span>) }
329
+ <span class="ruby-keyword">end</span></pre>
330
+ </div><!-- first_page-21-source -->
331
+
332
+ </div>
333
+
334
+
335
+
336
+
337
+ </div><!-- first_page-21-method -->
338
+
339
+
340
+ <div id="method-i-last_page" class="method-detail ">
341
+
342
+ <div class="method-heading">
343
+ <span class="method-name">last_page</span><span
344
+ class="method-args">()</span>
345
+
346
+ <span class="method-click-advice">click to toggle source</span>
347
+
348
+ </div>
349
+
350
+
351
+ <div class="method-description">
352
+
353
+ <p>Returns a new <a href="PaginatedCollection.html">PaginatedCollection</a>
354
+ with the last page of results.</p>
355
+
356
+ <p>Returns self when on the last page and no API call is made.</p>
357
+
358
+ <h4 id="method-i-last_page-label-Example">Example<span><a href="#method-i-last_page-label-Example">&para;</a> <a href="#documentation">&uarr;</a></span></h4>
359
+
360
+ <pre class="ruby"><span class="ruby-identifier">alerts</span>.<span class="ruby-identifier">current_page_number</span> <span class="ruby-comment"># =&gt; 5</span>
361
+ <span class="ruby-identifier">last_page</span> = <span class="ruby-identifier">alerts</span>.<span class="ruby-identifier">last_page</span>
362
+ <span class="ruby-identifier">alerts</span>.<span class="ruby-identifier">current_page_number</span> <span class="ruby-comment"># =&gt; 5</span>
363
+ <span class="ruby-identifier">last_page</span>.<span class="ruby-identifier">current_page_number</span> <span class="ruby-comment"># =&gt; 25</span>
364
+ </pre>
365
+
366
+
367
+
368
+
369
+ <div class="method-source-code" id="last_page-source">
370
+ <pre><span class="ruby-comment"># File lib/esp/extensions/active_resource/paginated_collection.rb, line 97</span>
371
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">last_page</span>
372
+ <span class="ruby-operator">!</span><span class="ruby-identifier">last_page?</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">resource_class</span>.<span class="ruby-identifier">all</span>(<span class="ruby-identifier">from</span><span class="ruby-operator">:</span> <span class="ruby-identifier">from</span>, <span class="ruby-identifier">params</span><span class="ruby-operator">:</span> <span class="ruby-identifier">last_page_params</span>) <span class="ruby-operator">:</span> <span class="ruby-keyword">self</span>
373
+ <span class="ruby-keyword">end</span></pre>
374
+ </div><!-- last_page-source -->
375
+
376
+ </div>
377
+
378
+
379
+
380
+
381
+ </div><!-- last_page-method -->
382
+
383
+
384
+ <div id="method-i-last_page-21" class="method-detail ">
385
+
386
+ <div class="method-heading">
387
+ <span class="method-name">last_page!</span><span
388
+ class="method-args">()</span>
389
+
390
+ <span class="method-click-advice">click to toggle source</span>
391
+
392
+ </div>
393
+
394
+
395
+ <div class="method-description">
396
+
397
+ <p>Updates the existing <a
398
+ href="PaginatedCollection.html">PaginatedCollection</a> object with the
399
+ last page of data when not on the last page.</p>
400
+
401
+ <h4 id="method-i-last_page-21-label-Example">Example<span><a href="#method-i-last_page-21-label-Example">&para;</a> <a href="#documentation">&uarr;</a></span></h4>
402
+
403
+ <pre class="ruby"><span class="ruby-identifier">alerts</span>.<span class="ruby-identifier">current_page_number</span> <span class="ruby-comment"># =&gt; 5</span>
404
+ <span class="ruby-identifier">alerts</span>.<span class="ruby-identifier">last_page!</span>
405
+ <span class="ruby-identifier">alerts</span>.<span class="ruby-identifier">current_page_number</span> <span class="ruby-comment"># =&gt; 25</span>
406
+ </pre>
407
+
408
+
409
+
410
+
411
+ <div class="method-source-code" id="last_page-21-source">
412
+ <pre><span class="ruby-comment"># File lib/esp/extensions/active_resource/paginated_collection.rb, line 107</span>
413
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">last_page!</span>
414
+ <span class="ruby-identifier">last_page</span>.<span class="ruby-identifier">tap</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">page</span><span class="ruby-operator">|</span> <span class="ruby-identifier">update_self</span>(<span class="ruby-identifier">page</span>) }
415
+ <span class="ruby-keyword">end</span></pre>
416
+ </div><!-- last_page-21-source -->
417
+
418
+ </div>
419
+
420
+
421
+
422
+
423
+ </div><!-- last_page-21-method -->
424
+
425
+
426
+ <div id="method-i-last_page-3F" class="method-detail ">
427
+
428
+ <div class="method-heading">
429
+ <span class="method-name">last_page?</span><span
430
+ class="method-args">()</span>
431
+
432
+ <span class="method-click-advice">click to toggle source</span>
433
+
434
+ </div>
435
+
436
+
437
+ <div class="method-description">
438
+
439
+ <p>Returns whether or not the collection is on the last page.</p>
440
+
441
+
442
+
443
+
444
+ <div class="method-source-code" id="last_page-3F-source">
445
+ <pre><span class="ruby-comment"># File lib/esp/extensions/active_resource/paginated_collection.rb, line 176</span>
446
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">last_page?</span>
447
+ <span class="ruby-identifier">last_page_number</span>.<span class="ruby-identifier">nil?</span>
448
+ <span class="ruby-keyword">end</span></pre>
449
+ </div><!-- last_page-3F-source -->
450
+
451
+ </div>
452
+
453
+
454
+
455
+
456
+ </div><!-- last_page-3F-method -->
457
+
458
+
459
+ <div id="method-i-last_page_number" class="method-detail ">
460
+
461
+ <div class="method-heading">
462
+ <span class="method-name">last_page_number</span><span
463
+ class="method-args">()</span>
464
+
465
+ <span class="method-click-advice">click to toggle source</span>
466
+
467
+ </div>
468
+
469
+
470
+ <div class="method-description">
471
+
472
+ <p>The last page number of data.</p>
473
+
474
+
475
+
476
+
477
+ <div class="method-source-code" id="last_page_number-source">
478
+ <pre><span class="ruby-comment"># File lib/esp/extensions/active_resource/paginated_collection.rb, line 161</span>
479
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">last_page_number</span>
480
+ <span class="ruby-constant">Hash</span>(<span class="ruby-identifier">last_page_params</span>).<span class="ruby-identifier">fetch</span>(<span class="ruby-string">&#39;page&#39;</span>, {}).<span class="ruby-identifier">fetch</span>(<span class="ruby-string">&#39;number&#39;</span>, <span class="ruby-keyword">nil</span>)
481
+ <span class="ruby-keyword">end</span></pre>
482
+ </div><!-- last_page_number-source -->
483
+
484
+ </div>
485
+
486
+
487
+
488
+
489
+ </div><!-- last_page_number-method -->
490
+
491
+
492
+ <div id="method-i-next_page" class="method-detail ">
493
+
494
+ <div class="method-heading">
495
+ <span class="method-name">next_page</span><span
496
+ class="method-args">()</span>
497
+
498
+ <span class="method-click-advice">click to toggle source</span>
499
+
500
+ </div>
501
+
502
+
503
+ <div class="method-description">
504
+
505
+ <p>Returns a new <a href="PaginatedCollection.html">PaginatedCollection</a>
506
+ with the next page of results.</p>
507
+
508
+ <p>Returns self when on the last page and no API call is made.</p>
509
+
510
+ <h4 id="method-i-next_page-label-Example">Example<span><a href="#method-i-next_page-label-Example">&para;</a> <a href="#documentation">&uarr;</a></span></h4>
511
+
512
+ <pre class="ruby"><span class="ruby-identifier">alerts</span>.<span class="ruby-identifier">current_page_number</span> <span class="ruby-comment"># =&gt; 5</span>
513
+ <span class="ruby-identifier">next_page</span> = <span class="ruby-identifier">alerts</span>.<span class="ruby-identifier">next_page</span>
514
+ <span class="ruby-identifier">alerts</span>.<span class="ruby-identifier">current_page_number</span> <span class="ruby-comment"># =&gt; 5</span>
515
+ <span class="ruby-identifier">next_page</span>.<span class="ruby-identifier">current_page_number</span> <span class="ruby-comment"># =&gt; 6</span>
516
+ </pre>
517
+
518
+
519
+
520
+
521
+ <div class="method-source-code" id="next_page-source">
522
+ <pre><span class="ruby-comment"># File lib/esp/extensions/active_resource/paginated_collection.rb, line 74</span>
523
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">next_page</span>
524
+ <span class="ruby-identifier">next_page?</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">resource_class</span>.<span class="ruby-identifier">all</span>(<span class="ruby-identifier">from</span><span class="ruby-operator">:</span> <span class="ruby-identifier">from</span>, <span class="ruby-identifier">params</span><span class="ruby-operator">:</span> <span class="ruby-identifier">next_page_params</span>) <span class="ruby-operator">:</span> <span class="ruby-keyword">self</span>
525
+ <span class="ruby-keyword">end</span></pre>
526
+ </div><!-- next_page-source -->
527
+
528
+ </div>
529
+
530
+
531
+
532
+
533
+ </div><!-- next_page-method -->
534
+
535
+
536
+ <div id="method-i-next_page-21" class="method-detail ">
537
+
538
+ <div class="method-heading">
539
+ <span class="method-name">next_page!</span><span
540
+ class="method-args">()</span>
541
+
542
+ <span class="method-click-advice">click to toggle source</span>
543
+
544
+ </div>
545
+
546
+
547
+ <div class="method-description">
548
+
549
+ <p>Updates the existing <a
550
+ href="PaginatedCollection.html">PaginatedCollection</a> object with the
551
+ last page of data when not on the last page.</p>
552
+
553
+ <h4 id="method-i-next_page-21-label-Example">Example<span><a href="#method-i-next_page-21-label-Example">&para;</a> <a href="#documentation">&uarr;</a></span></h4>
554
+
555
+ <pre class="ruby"><span class="ruby-identifier">alerts</span>.<span class="ruby-identifier">current_page_number</span> <span class="ruby-comment"># =&gt; 5</span>
556
+ <span class="ruby-identifier">alerts</span>.<span class="ruby-identifier">next_page!</span>
557
+ <span class="ruby-identifier">alerts</span>.<span class="ruby-identifier">current_page_number</span> <span class="ruby-comment"># =&gt; 6</span>
558
+ </pre>
559
+
560
+
561
+
562
+
563
+ <div class="method-source-code" id="next_page-21-source">
564
+ <pre><span class="ruby-comment"># File lib/esp/extensions/active_resource/paginated_collection.rb, line 84</span>
565
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">next_page!</span>
566
+ <span class="ruby-identifier">next_page</span>.<span class="ruby-identifier">tap</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">page</span><span class="ruby-operator">|</span> <span class="ruby-identifier">update_self</span>(<span class="ruby-identifier">page</span>) }
567
+ <span class="ruby-keyword">end</span></pre>
568
+ </div><!-- next_page-21-source -->
569
+
570
+ </div>
571
+
572
+
573
+
574
+
575
+ </div><!-- next_page-21-method -->
576
+
577
+
578
+ <div id="method-i-next_page-3F" class="method-detail ">
579
+
580
+ <div class="method-heading">
581
+ <span class="method-name">next_page?</span><span
582
+ class="method-args">()</span>
583
+
584
+ <span class="method-click-advice">click to toggle source</span>
585
+
586
+ </div>
587
+
588
+
589
+ <div class="method-description">
590
+
591
+ <p>Returns whether or not there is a next page of data in the collection.</p>
592
+
593
+
594
+
595
+
596
+ <div class="method-source-code" id="next_page-3F-source">
597
+ <pre><span class="ruby-comment"># File lib/esp/extensions/active_resource/paginated_collection.rb, line 171</span>
598
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">next_page?</span>
599
+ <span class="ruby-operator">!</span><span class="ruby-identifier">next_page_number</span>.<span class="ruby-identifier">nil?</span>
600
+ <span class="ruby-keyword">end</span></pre>
601
+ </div><!-- next_page-3F-source -->
602
+
603
+ </div>
604
+
605
+
606
+
607
+
608
+ </div><!-- next_page-3F-method -->
609
+
610
+
611
+ <div id="method-i-next_page_number" class="method-detail ">
612
+
613
+ <div class="method-heading">
614
+ <span class="method-name">next_page_number</span><span
615
+ class="method-args">()</span>
616
+
617
+ <span class="method-click-advice">click to toggle source</span>
618
+
619
+ </div>
620
+
621
+
622
+ <div class="method-description">
623
+
624
+ <p>The next page number of data.</p>
625
+
626
+
627
+
628
+
629
+ <div class="method-source-code" id="next_page_number-source">
630
+ <pre><span class="ruby-comment"># File lib/esp/extensions/active_resource/paginated_collection.rb, line 156</span>
631
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">next_page_number</span>
632
+ <span class="ruby-constant">Hash</span>(<span class="ruby-identifier">next_page_params</span>).<span class="ruby-identifier">fetch</span>(<span class="ruby-string">&#39;page&#39;</span>, {}).<span class="ruby-identifier">fetch</span>(<span class="ruby-string">&#39;number&#39;</span>, <span class="ruby-keyword">nil</span>)
633
+ <span class="ruby-keyword">end</span></pre>
634
+ </div><!-- next_page_number-source -->
635
+
636
+ </div>
637
+
638
+
639
+
640
+
641
+ </div><!-- next_page_number-method -->
642
+
643
+
644
+ <div id="method-i-page" class="method-detail ">
645
+
646
+ <div class="method-heading">
647
+ <span class="method-name">page</span><span
648
+ class="method-args">(page_number = nil)</span>
649
+
650
+ <span class="method-click-advice">click to toggle source</span>
651
+
652
+ </div>
653
+
654
+
655
+ <div class="method-description">
656
+
657
+ <p>Returns a new <a href="PaginatedCollection.html">PaginatedCollection</a>
658
+ with the <code>page_number</code> page of data.</p>
659
+
660
+ <p>Returns self when <code>page_number</code> == <a
661
+ href="PaginatedCollection.html#method-i-current_page_number">current_page_number</a></p>
662
+
663
+ <h4 id="method-i-page-label-Attribute">Attribute<span><a href="#method-i-page-label-Attribute">&para;</a> <a href="#documentation">&uarr;</a></span></h4>
664
+
665
+ <p><code>page_number</code> - The page number of the data wanted.
666
+ <code>page_number</code> must be between 1 and <a
667
+ href="PaginatedCollection.html#method-i-last_page_number">last_page_number</a>.</p>
668
+
669
+ <h4 id="method-i-page-label-Example">Example<span><a href="#method-i-page-label-Example">&para;</a> <a href="#documentation">&uarr;</a></span></h4>
670
+
671
+ <pre class="ruby"><span class="ruby-identifier">alerts</span>.<span class="ruby-identifier">current_page_number</span> <span class="ruby-comment"># =&gt; 5</span>
672
+ <span class="ruby-identifier">page</span> = <span class="ruby-identifier">alerts</span>.<span class="ruby-identifier">page</span>(<span class="ruby-value">2</span>)
673
+ <span class="ruby-identifier">alerts</span>.<span class="ruby-identifier">current_page_number</span> <span class="ruby-comment"># =&gt; 5</span>
674
+ <span class="ruby-identifier">page</span>.<span class="ruby-identifier">current_page_number</span> <span class="ruby-comment"># =&gt; 2</span>
675
+ </pre>
676
+
677
+
678
+
679
+
680
+ <div class="method-source-code" id="page-source">
681
+ <pre><span class="ruby-comment"># File lib/esp/extensions/active_resource/paginated_collection.rb, line 124</span>
682
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">page</span>(<span class="ruby-identifier">page_number</span> = <span class="ruby-keyword">nil</span>)
683
+ <span class="ruby-identifier">fail</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">&quot;You must supply a page number.&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">page_number</span>.<span class="ruby-identifier">present?</span>
684
+ <span class="ruby-identifier">fail</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">&quot;Page number cannot be less than 1.&quot;</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">page_number</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">&lt;</span> <span class="ruby-value">1</span>
685
+ <span class="ruby-identifier">fail</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">&quot;Page number cannot be greater than the last page number.&quot;</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">page_number</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">&gt;</span> <span class="ruby-identifier">last_page_number</span>.<span class="ruby-identifier">to_i</span>
686
+ <span class="ruby-identifier">page_number</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">current_page_number</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">resource_class</span>.<span class="ruby-identifier">all</span>(<span class="ruby-identifier">from</span><span class="ruby-operator">:</span> <span class="ruby-identifier">from</span>, <span class="ruby-identifier">params</span><span class="ruby-operator">:</span> { <span class="ruby-identifier">page</span><span class="ruby-operator">:</span> { <span class="ruby-identifier">number</span><span class="ruby-operator">:</span> <span class="ruby-identifier">page_number</span>, <span class="ruby-identifier">size</span><span class="ruby-operator">:</span> (<span class="ruby-identifier">next_page_params</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">previous_page_params</span>)[<span class="ruby-string">&#39;page&#39;</span>][<span class="ruby-string">&#39;size&#39;</span>] } }) <span class="ruby-operator">:</span> <span class="ruby-keyword">self</span>
687
+ <span class="ruby-keyword">end</span></pre>
688
+ </div><!-- page-source -->
689
+
690
+ </div>
691
+
692
+
693
+
694
+
695
+ </div><!-- page-method -->
696
+
697
+
698
+ <div id="method-i-page-21" class="method-detail ">
699
+
700
+ <div class="method-heading">
701
+ <span class="method-name">page!</span><span
702
+ class="method-args">(page_number)</span>
703
+
704
+ <span class="method-click-advice">click to toggle source</span>
705
+
706
+ </div>
707
+
708
+
709
+ <div class="method-description">
710
+
711
+ <p>Returns a new <a href="PaginatedCollection.html">PaginatedCollection</a>
712
+ with the <code>page_number</code> page of data when not already on page
713
+ <code>page_number</code>.</p>
714
+
715
+ <h4 id="method-i-page-21-label-Attribute">Attribute<span><a href="#method-i-page-21-label-Attribute">&para;</a> <a href="#documentation">&uarr;</a></span></h4>
716
+
717
+ <p><code>page_number</code> - The page number of the data wanted.
718
+ <code>page_number</code> must be between 1 and <a
719
+ href="PaginatedCollection.html#method-i-last_page_number">last_page_number</a>.</p>
720
+
721
+ <h4 id="method-i-page-21-label-Example">Example<span><a href="#method-i-page-21-label-Example">&para;</a> <a href="#documentation">&uarr;</a></span></h4>
722
+
723
+ <pre class="ruby"><span class="ruby-identifier">alerts</span>.<span class="ruby-identifier">current_page_number</span> <span class="ruby-comment"># =&gt; 5</span>
724
+ <span class="ruby-identifier">alerts</span>.<span class="ruby-identifier">page!</span>(<span class="ruby-value">2</span>)
725
+ <span class="ruby-identifier">alerts</span>.<span class="ruby-identifier">current_page_number</span> <span class="ruby-comment"># =&gt; 2</span>
726
+ </pre>
727
+
728
+
729
+
730
+
731
+ <div class="method-source-code" id="page-21-source">
732
+ <pre><span class="ruby-comment"># File lib/esp/extensions/active_resource/paginated_collection.rb, line 141</span>
733
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">page!</span>(<span class="ruby-identifier">page_number</span>)
734
+ <span class="ruby-identifier">page</span>(<span class="ruby-identifier">page_number</span>).<span class="ruby-identifier">tap</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">page</span><span class="ruby-operator">|</span> <span class="ruby-identifier">update_self</span>(<span class="ruby-identifier">page</span>) }
735
+ <span class="ruby-keyword">end</span></pre>
736
+ </div><!-- page-21-source -->
737
+
738
+ </div>
739
+
740
+
741
+
742
+
743
+ </div><!-- page-21-method -->
744
+
745
+
746
+ <div id="method-i-previous_page" class="method-detail ">
747
+
748
+ <div class="method-heading">
749
+ <span class="method-name">previous_page</span><span
750
+ class="method-args">()</span>
751
+
752
+ <span class="method-click-advice">click to toggle source</span>
753
+
754
+ </div>
755
+
756
+
757
+ <div class="method-description">
758
+
759
+ <p>Returns a new <a href="PaginatedCollection.html">PaginatedCollection</a>
760
+ with the previous page of results.</p>
761
+
762
+ <p>Returns self when on the first page and no API call is made.</p>
763
+
764
+ <h4 id="method-i-previous_page-label-Example">Example<span><a href="#method-i-previous_page-label-Example">&para;</a> <a href="#documentation">&uarr;</a></span></h4>
765
+
766
+ <pre class="ruby"><span class="ruby-identifier">alerts</span>.<span class="ruby-identifier">current_page_number</span> <span class="ruby-comment"># =&gt; 5</span>
767
+ <span class="ruby-identifier">previous_page</span> = <span class="ruby-identifier">alerts</span>.<span class="ruby-identifier">previous_page</span>
768
+ <span class="ruby-identifier">alerts</span>.<span class="ruby-identifier">current_page_number</span> <span class="ruby-comment"># =&gt; 5</span>
769
+ <span class="ruby-identifier">previous_page</span>.<span class="ruby-identifier">current_page_number</span> <span class="ruby-comment"># =&gt; 4</span>
770
+ </pre>
771
+
772
+
773
+
774
+
775
+ <div class="method-source-code" id="previous_page-source">
776
+ <pre><span class="ruby-comment"># File lib/esp/extensions/active_resource/paginated_collection.rb, line 51</span>
777
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">previous_page</span>
778
+ <span class="ruby-identifier">previous_page?</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">resource_class</span>.<span class="ruby-identifier">all</span>(<span class="ruby-identifier">from</span><span class="ruby-operator">:</span> <span class="ruby-identifier">from</span>, <span class="ruby-identifier">params</span><span class="ruby-operator">:</span> <span class="ruby-identifier">previous_page_params</span>) <span class="ruby-operator">:</span> <span class="ruby-keyword">self</span>
779
+ <span class="ruby-keyword">end</span></pre>
780
+ </div><!-- previous_page-source -->
781
+
782
+ </div>
783
+
784
+
785
+
786
+
787
+ </div><!-- previous_page-method -->
788
+
789
+
790
+ <div id="method-i-previous_page-21" class="method-detail ">
791
+
792
+ <div class="method-heading">
793
+ <span class="method-name">previous_page!</span><span
794
+ class="method-args">()</span>
795
+
796
+ <span class="method-click-advice">click to toggle source</span>
797
+
798
+ </div>
799
+
800
+
801
+ <div class="method-description">
802
+
803
+ <p>Updates the existing <a
804
+ href="PaginatedCollection.html">PaginatedCollection</a> object with the
805
+ previous page of data when not on the first page.</p>
806
+
807
+ <h4 id="method-i-previous_page-21-label-Example">Example<span><a href="#method-i-previous_page-21-label-Example">&para;</a> <a href="#documentation">&uarr;</a></span></h4>
808
+
809
+ <pre class="ruby"><span class="ruby-identifier">alerts</span>.<span class="ruby-identifier">current_page_number</span> <span class="ruby-comment"># =&gt; 5</span>
810
+ <span class="ruby-identifier">alerts</span>.<span class="ruby-identifier">previous_page!</span>
811
+ <span class="ruby-identifier">alerts</span>.<span class="ruby-identifier">current_page_number</span> <span class="ruby-comment"># =&gt; 4</span>
812
+ </pre>
813
+
814
+
815
+
816
+
817
+ <div class="method-source-code" id="previous_page-21-source">
818
+ <pre><span class="ruby-comment"># File lib/esp/extensions/active_resource/paginated_collection.rb, line 61</span>
819
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">previous_page!</span>
820
+ <span class="ruby-identifier">previous_page</span>.<span class="ruby-identifier">tap</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">page</span><span class="ruby-operator">|</span> <span class="ruby-identifier">update_self</span>(<span class="ruby-identifier">page</span>) }
821
+ <span class="ruby-keyword">end</span></pre>
822
+ </div><!-- previous_page-21-source -->
823
+
824
+ </div>
825
+
826
+
827
+
828
+
829
+ </div><!-- previous_page-21-method -->
830
+
831
+
832
+ <div id="method-i-previous_page-3F" class="method-detail ">
833
+
834
+ <div class="method-heading">
835
+ <span class="method-name">previous_page?</span><span
836
+ class="method-args">()</span>
837
+
838
+ <span class="method-click-advice">click to toggle source</span>
839
+
840
+ </div>
841
+
842
+
843
+ <div class="method-description">
844
+
845
+ <p>Returns whether or not there is a previous page of data in the collection.</p>
846
+
847
+
848
+
849
+
850
+ <div class="method-source-code" id="previous_page-3F-source">
851
+ <pre><span class="ruby-comment"># File lib/esp/extensions/active_resource/paginated_collection.rb, line 166</span>
852
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">previous_page?</span>
853
+ <span class="ruby-operator">!</span><span class="ruby-identifier">previous_page_number</span>.<span class="ruby-identifier">nil?</span>
854
+ <span class="ruby-keyword">end</span></pre>
855
+ </div><!-- previous_page-3F-source -->
856
+
857
+ </div>
858
+
859
+
860
+
861
+
862
+ </div><!-- previous_page-3F-method -->
863
+
864
+
865
+ <div id="method-i-previous_page_number" class="method-detail ">
866
+
867
+ <div class="method-heading">
868
+ <span class="method-name">previous_page_number</span><span
869
+ class="method-args">()</span>
870
+
871
+ <span class="method-click-advice">click to toggle source</span>
872
+
873
+ </div>
874
+
875
+
876
+ <div class="method-description">
877
+
878
+ <p>The previous page number of data.</p>
879
+
880
+
881
+
882
+
883
+ <div class="method-source-code" id="previous_page_number-source">
884
+ <pre><span class="ruby-comment"># File lib/esp/extensions/active_resource/paginated_collection.rb, line 151</span>
885
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">previous_page_number</span>
886
+ <span class="ruby-constant">Hash</span>(<span class="ruby-identifier">previous_page_params</span>).<span class="ruby-identifier">fetch</span>(<span class="ruby-string">&#39;page&#39;</span>, {}).<span class="ruby-identifier">fetch</span>(<span class="ruby-string">&#39;number&#39;</span>, <span class="ruby-keyword">nil</span>)
887
+ <span class="ruby-keyword">end</span></pre>
888
+ </div><!-- previous_page_number-source -->
889
+
890
+ </div>
891
+
892
+
893
+
894
+
895
+ </div><!-- previous_page_number-method -->
896
+
897
+
898
+ </section><!-- public-instance-method-details -->
899
+
900
+ </section><!-- 5Buntitled-5D -->
901
+
902
+ </div><!-- documentation -->
903
+
904
+
905
+ <footer id="validator-badges">
906
+ <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
907
+ <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 4.0.0.
908
+ <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
909
+ </footer>
910
+