eagleplatform 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (55) hide show
  1. data/.autotest +9 -0
  2. data/.gitignore +2 -0
  3. data/.rspec +2 -0
  4. data/.yardoc/checksums +6 -0
  5. data/.yardoc/objects/root.dat +0 -0
  6. data/.yardoc/proxy_types +0 -0
  7. data/doc/.yardoc/checksums +0 -0
  8. data/doc/.yardoc/objects/root.dat +0 -0
  9. data/doc/.yardoc/proxy_types +0 -0
  10. data/doc/Eagleplatform.html +413 -0
  11. data/doc/Eagleplatform/EagleplatformObject.html +224 -0
  12. data/doc/Eagleplatform/Filter.html +1009 -0
  13. data/doc/Eagleplatform/Methods.html +181 -0
  14. data/doc/Eagleplatform/Record.html +1497 -0
  15. data/doc/Eagleplatform/Translation.html +1103 -0
  16. data/doc/Hash.html +210 -0
  17. data/doc/_index.html +157 -0
  18. data/doc/class_list.html +47 -0
  19. data/doc/css/common.css +1 -0
  20. data/doc/css/full_list.css +55 -0
  21. data/doc/css/style.css +322 -0
  22. data/doc/doc/_index.html +84 -0
  23. data/doc/doc/class_list.html +47 -0
  24. data/doc/doc/css/common.css +1 -0
  25. data/doc/doc/css/full_list.css +55 -0
  26. data/doc/doc/css/style.css +322 -0
  27. data/doc/doc/file_list.html +46 -0
  28. data/doc/doc/frames.html +13 -0
  29. data/doc/doc/index.html +84 -0
  30. data/doc/doc/js/app.js +205 -0
  31. data/doc/doc/js/full_list.js +173 -0
  32. data/doc/doc/js/jquery.js +16 -0
  33. data/doc/doc/method_list.html +46 -0
  34. data/doc/doc/top-level-namespace.html +95 -0
  35. data/doc/file_list.html +46 -0
  36. data/doc/frames.html +13 -0
  37. data/doc/index.html +157 -0
  38. data/doc/js/app.js +205 -0
  39. data/doc/js/full_list.js +173 -0
  40. data/doc/js/jquery.js +16 -0
  41. data/doc/method_list.html +262 -0
  42. data/doc/top-level-namespace.html +105 -0
  43. data/eagleplatform.gemspec +22 -0
  44. data/eagleplatform.tmproj +138 -0
  45. data/lib/.yardoc/checksums +1 -0
  46. data/lib/.yardoc/objects/root.dat +0 -0
  47. data/lib/.yardoc/proxy_types +0 -0
  48. data/lib/eagleplatform.rb +135 -0
  49. data/lib/eagleplatform/eagleplatform_object.rb +10 -0
  50. data/lib/eagleplatform/filter.rb +125 -0
  51. data/lib/eagleplatform/record.rb +207 -0
  52. data/lib/eagleplatform/translation.rb +163 -0
  53. data/lib/eagleplatform/version.rb +3 -0
  54. data/spec/eagleplatform_spec.rb +146 -0
  55. metadata +135 -0
data/doc/Eagleplatform/EagleplatformObject.html ADDED
@@ -0,0 +1,224 @@
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: Eagleplatform::EagleplatformObject
8
+
9
+ &mdash; Documentation by YARD 0.7.5
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> &raquo;
37
+ <span class='title'><span class='object_link'><a href="../Eagleplatform.html" title="Eagleplatform (module)">Eagleplatform</a></span></span>
38
+ &raquo;
39
+ <span class="title">EagleplatformObject</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: Eagleplatform::EagleplatformObject
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">Struct</span>
70
+
71
+ <ul class="fullTree">
72
+ <li>Object</li>
73
+
74
+ <li class="next">Struct</li>
75
+
76
+ <li class="next">Eagleplatform::EagleplatformObject</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/eagleplatform.rb</dd>
93
+
94
+ </dl>
95
+ <div class="clear"></div>
96
+
97
+ <h2>Overview</h2><div class="docstring">
98
+ <div class="discussion">
99
+
100
+ <p>Class provides methods for all Eagleplatform Objects</p>
101
+
102
+
103
+ </div>
104
+ </div>
105
+ <div class="tags">
106
+
107
+
108
+ </div>
109
+
110
+
111
+
112
+
113
+
114
+
115
+
116
+ <h2>
117
+ Instance Method Summary
118
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
119
+ </h2>
120
+
121
+ <ul class="summary">
122
+
123
+ <li class="public ">
124
+ <span class="summary_signature">
125
+
126
+ <a href="#to_hash-instance_method" title="#to_hash (instance method)">- (Hash) <strong>to_hash</strong> </a>
127
+
128
+
129
+
130
+ </span>
131
+
132
+
133
+
134
+
135
+
136
+
137
+
138
+
139
+ <span class="summary_desc"><div class='inline'>
140
+ <p>Convert Struct to Hash.</p>
141
+ </div></span>
142
+
143
+ </li>
144
+
145
+
146
+ </ul>
147
+
148
+
149
+
150
+
151
+
152
+ <div id="instance_method_details" class="method_details_list">
153
+ <h2>Instance Method Details</h2>
154
+
155
+
156
+ <div class="method_details first">
157
+ <p class="signature first" id="to_hash-instance_method">
158
+
159
+ - (<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>) <strong>to_hash</strong>
160
+
161
+
162
+
163
+ </p><div class="docstring">
164
+ <div class="discussion">
165
+
166
+ <p>Convert Struct to Hash</p>
167
+
168
+
169
+ </div>
170
+ </div>
171
+ <div class="tags">
172
+
173
+ <h3>Returns:</h3>
174
+ <ul class="return">
175
+
176
+ <li>
177
+
178
+
179
+ <span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
180
+
181
+
182
+
183
+ &mdash;
184
+ <div class='inline'>
185
+ <p>convert Struct to Hash</p>
186
+ </div>
187
+
188
+ </li>
189
+
190
+ </ul>
191
+
192
+ </div><table class="source_code">
193
+ <tr>
194
+ <td>
195
+ <pre class="lines">
196
+
197
+
198
+ 62
199
+ 63
200
+ 64</pre>
201
+ </td>
202
+ <td>
203
+ <pre class="code"><span class="info file"># File 'lib/eagleplatform.rb', line 62</span>
204
+
205
+ <span class='kw'>def</span> <span class='id identifier rubyid_to_hash'>to_hash</span>
206
+ <span class='const'>Hash</span><span class='lbracket'>[</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_each_pair'>each_pair</span><span class='period'>.</span><span class='id identifier rubyid_to_a'>to_a</span><span class='rbracket'>]</span>
207
+ <span class='kw'>end</span></pre>
208
+ </td>
209
+ </tr>
210
+ </table>
211
+ </div>
212
+
213
+ </div>
214
+
215
+ </div>
216
+
217
+ <div id="footer">
218
+ Generated on Thu May 24 14:05:36 2012 by
219
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
220
+ 0.7.5 (ruby-1.9.3).
221
+ </div>
222
+
223
+ </body>
224
+ </html>
data/doc/Eagleplatform/Filter.html ADDED
@@ -0,0 +1,1009 @@
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: Eagleplatform::Filter
8
+
9
+ &mdash; Documentation by YARD 0.7.5
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 (F)</a> &raquo;
37
+ <span class='title'><span class='object_link'><a href="../Eagleplatform.html" title="Eagleplatform (module)">Eagleplatform</a></span></span>
38
+ &raquo;
39
+ <span class="title">Filter</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: Eagleplatform::Filter
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">Object</span>
70
+
71
+ <ul class="fullTree">
72
+ <li>Object</li>
73
+
74
+ <li class="next">Eagleplatform::Filter</li>
75
+
76
+ </ul>
77
+ <a href="#" class="inheritanceTree">show all</a>
78
+
79
+ </dd>
80
+
81
+
82
+
83
+
84
+
85
+
86
+
87
+
88
+
89
+ <dt class="r2 last">Defined in:</dt>
90
+ <dd class="r2 last">lib/eagleplatform/filter.rb</dd>
91
+
92
+ </dl>
93
+ <div class="clear"></div>
94
+
95
+ <h2>Overview</h2><div class="docstring">
96
+ <div class="discussion">
97
+
98
+ <p>Filters</p>
99
+
100
+
101
+ </div>
102
+ </div>
103
+ <div class="tags">
104
+
105
+ <div class="examples">
106
+ <h3>Examples:</h3>
107
+
108
+ <h4><div class='inline'></div></h4>
109
+ <pre class="example code"># Simple request:
110
+ f = Eagleplatform::Filter.find(54321)
111
+
112
+ # With custom records count per page:
113
+ f = Eagleplatform::Filter.find(54321, 100 )
114
+
115
+ # With custom records count per page and custom page number:
116
+ f = Eagleplatform::Filter.find(54321, 50, 3 )
117
+
118
+ f.current_page
119
+ =&gt; '3'
120
+ f.records.count
121
+ =&gt; '50'
122
+
123
+ f.next_page
124
+ =&gt; '+ 50 records loaded'
125
+
126
+ f.current_page
127
+ =&gt; '4'
128
+ # f.records.count
129
+ =&gt; '100'
130
+
131
+ # List of records name with create date :
132
+ f.records.each { |rec| puts &quot;name: #{rec.name} created_at: #{rec.created_at}&quot; }</pre>
133
+
134
+ </div>
135
+
136
+
137
+ </div>
138
+
139
+
140
+
141
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
142
+ <ul class="summary">
143
+
144
+ <li class="public ">
145
+ <span class="summary_signature">
146
+
147
+ <a href="#current_page-instance_method" title="#current_page (instance method)">- (Object) <strong>current_page</strong> </a>
148
+
149
+
150
+
151
+ </span>
152
+
153
+
154
+ <span class="note title readonly">readonly</span>
155
+
156
+
157
+
158
+
159
+
160
+
161
+
162
+
163
+ <span class="summary_desc"><div class='inline'>
164
+ <p>Returns the value of attribute current_page.</p>
165
+ </div></span>
166
+
167
+ </li>
168
+
169
+
170
+ <li class="public ">
171
+ <span class="summary_signature">
172
+
173
+ <a href="#id-instance_method" title="#id (instance method)">- (Object) <strong>id</strong> </a>
174
+
175
+
176
+
177
+ </span>
178
+
179
+
180
+ <span class="note title readonly">readonly</span>
181
+
182
+
183
+
184
+
185
+
186
+
187
+
188
+
189
+ <span class="summary_desc"><div class='inline'>
190
+ <p>Returns the value of attribute id.</p>
191
+ </div></span>
192
+
193
+ </li>
194
+
195
+
196
+ <li class="public ">
197
+ <span class="summary_signature">
198
+
199
+ <a href="#name-instance_method" title="#name (instance method)">- (Object) <strong>name</strong> </a>
200
+
201
+
202
+
203
+ </span>
204
+
205
+
206
+ <span class="note title readonly">readonly</span>
207
+
208
+
209
+
210
+
211
+
212
+
213
+
214
+
215
+ <span class="summary_desc"><div class='inline'>
216
+ <p>Returns the value of attribute name.</p>
217
+ </div></span>
218
+
219
+ </li>
220
+
221
+
222
+ <li class="public ">
223
+ <span class="summary_signature">
224
+
225
+ <a href="#per_page-instance_method" title="#per_page (instance method)">- (Object) <strong>per_page</strong> </a>
226
+
227
+
228
+
229
+ </span>
230
+
231
+
232
+ <span class="note title readonly">readonly</span>
233
+
234
+
235
+
236
+
237
+
238
+
239
+
240
+
241
+ <span class="summary_desc"><div class='inline'>
242
+ <p>Returns the value of attribute per_page.</p>
243
+ </div></span>
244
+
245
+ </li>
246
+
247
+
248
+ <li class="public ">
249
+ <span class="summary_signature">
250
+
251
+ <a href="#total_entries-instance_method" title="#total_entries (instance method)">- (Object) <strong>total_entries</strong> </a>
252
+
253
+
254
+
255
+ </span>
256
+
257
+
258
+ <span class="note title readonly">readonly</span>
259
+
260
+
261
+
262
+
263
+
264
+
265
+
266
+
267
+ <span class="summary_desc"><div class='inline'>
268
+ <p>Returns the value of attribute total_entries.</p>
269
+ </div></span>
270
+
271
+ </li>
272
+
273
+
274
+ <li class="public ">
275
+ <span class="summary_signature">
276
+
277
+ <a href="#total_pages-instance_method" title="#total_pages (instance method)">- (Object) <strong>total_pages</strong> </a>
278
+
279
+
280
+
281
+ </span>
282
+
283
+
284
+ <span class="note title readonly">readonly</span>
285
+
286
+
287
+
288
+
289
+
290
+
291
+
292
+
293
+ <span class="summary_desc"><div class='inline'>
294
+ <p>Returns the value of attribute total_pages.</p>
295
+ </div></span>
296
+
297
+ </li>
298
+
299
+
300
+ </ul>
301
+
302
+
303
+
304
+
305
+
306
+ <h2>
307
+ Class Method Summary
308
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
309
+ </h2>
310
+
311
+ <ul class="summary">
312
+
313
+ <li class="public ">
314
+ <span class="summary_signature">
315
+
316
+ <a href="#find-class_method" title="find (class method)">+ (Eagleplatform::Filter) <strong>find</strong>(id, per_page = 50, page = 1) </a>
317
+
318
+
319
+
320
+ </span>
321
+
322
+
323
+
324
+
325
+
326
+
327
+
328
+
329
+ <span class="summary_desc"><div class='inline'>
330
+ <p>Get records form filter.</p>
331
+ </div></span>
332
+
333
+ </li>
334
+
335
+
336
+ </ul>
337
+
338
+ <h2>
339
+ Instance Method Summary
340
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
341
+ </h2>
342
+
343
+ <ul class="summary">
344
+
345
+ <li class="public ">
346
+ <span class="summary_signature">
347
+
348
+ <a href="#next_page-instance_method" title="#next_page (instance method)">- (String) <strong>next_page</strong> </a>
349
+
350
+
351
+
352
+ </span>
353
+
354
+
355
+
356
+
357
+
358
+
359
+
360
+
361
+ <span class="summary_desc"><div class='inline'>
362
+ <p>Load records form filter next page.</p>
363
+ </div></span>
364
+
365
+ </li>
366
+
367
+
368
+ <li class="public ">
369
+ <span class="summary_signature">
370
+
371
+ <a href="#records-instance_method" title="#records (instance method)">- (Array) <strong>records</strong> </a>
372
+
373
+
374
+
375
+ </span>
376
+
377
+
378
+
379
+
380
+
381
+
382
+
383
+
384
+ <span class="summary_desc"><div class='inline'>
385
+ <p>List of loaded records.</p>
386
+ </div></span>
387
+
388
+ </li>
389
+
390
+
391
+ </ul>
392
+
393
+
394
+
395
+ <div id="instance_attr_details" class="attr_details">
396
+ <h2>Instance Attribute Details</h2>
397
+
398
+
399
+ <span id=""></span>
400
+ <span id="current_page-instance_method"></span>
401
+ <div class="method_details first">
402
+ <p class="signature first" id="current_page-instance_method">
403
+
404
+ - (<tt>Object</tt>) <strong>current_page</strong> <span class="extras">(readonly)</span>
405
+
406
+
407
+
408
+ </p><div class="docstring">
409
+ <div class="discussion">
410
+
411
+ <p>Returns the value of attribute current_page</p>
412
+
413
+
414
+ </div>
415
+ </div>
416
+ <div class="tags">
417
+
418
+
419
+ </div><table class="source_code">
420
+ <tr>
421
+ <td>
422
+ <pre class="lines">
423
+
424
+
425
+ 29
426
+ 30
427
+ 31</pre>
428
+ </td>
429
+ <td>
430
+ <pre class="code"><span class="info file"># File 'lib/eagleplatform/filter.rb', line 29</span>
431
+
432
+ <span class='kw'>def</span> <span class='id identifier rubyid_current_page'>current_page</span>
433
+ <span class='ivar'>@current_page</span>
434
+ <span class='kw'>end</span></pre>
435
+ </td>
436
+ </tr>
437
+ </table>
438
+ </div>
439
+
440
+
441
+ <span id=""></span>
442
+ <span id="id-instance_method"></span>
443
+ <div class="method_details ">
444
+ <p class="signature " id="id-instance_method">
445
+
446
+ - (<tt>Object</tt>) <strong>id</strong> <span class="extras">(readonly)</span>
447
+
448
+
449
+
450
+ </p><div class="docstring">
451
+ <div class="discussion">
452
+
453
+ <p>Returns the value of attribute id</p>
454
+
455
+
456
+ </div>
457
+ </div>
458
+ <div class="tags">
459
+
460
+
461
+ </div><table class="source_code">
462
+ <tr>
463
+ <td>
464
+ <pre class="lines">
465
+
466
+
467
+ 29
468
+ 30
469
+ 31</pre>
470
+ </td>
471
+ <td>
472
+ <pre class="code"><span class="info file"># File 'lib/eagleplatform/filter.rb', line 29</span>
473
+
474
+ <span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
475
+ <span class='ivar'>@id</span>
476
+ <span class='kw'>end</span></pre>
477
+ </td>
478
+ </tr>
479
+ </table>
480
+ </div>
481
+
482
+
483
+ <span id=""></span>
484
+ <span id="name-instance_method"></span>
485
+ <div class="method_details ">
486
+ <p class="signature " id="name-instance_method">
487
+
488
+ - (<tt>Object</tt>) <strong>name</strong> <span class="extras">(readonly)</span>
489
+
490
+
491
+
492
+ </p><div class="docstring">
493
+ <div class="discussion">
494
+
495
+ <p>Returns the value of attribute name</p>
496
+
497
+
498
+ </div>
499
+ </div>
500
+ <div class="tags">
501
+
502
+
503
+ </div><table class="source_code">
504
+ <tr>
505
+ <td>
506
+ <pre class="lines">
507
+
508
+
509
+ 29
510
+ 30
511
+ 31</pre>
512
+ </td>
513
+ <td>
514
+ <pre class="code"><span class="info file"># File 'lib/eagleplatform/filter.rb', line 29</span>
515
+
516
+ <span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
517
+ <span class='ivar'>@name</span>
518
+ <span class='kw'>end</span></pre>
519
+ </td>
520
+ </tr>
521
+ </table>
522
+ </div>
523
+
524
+
525
+ <span id=""></span>
526
+ <span id="per_page-instance_method"></span>
527
+ <div class="method_details ">
528
+ <p class="signature " id="per_page-instance_method">
529
+
530
+ - (<tt>Object</tt>) <strong>per_page</strong> <span class="extras">(readonly)</span>
531
+
532
+
533
+
534
+ </p><div class="docstring">
535
+ <div class="discussion">
536
+
537
+ <p>Returns the value of attribute per_page</p>
538
+
539
+
540
+ </div>
541
+ </div>
542
+ <div class="tags">
543
+
544
+
545
+ </div><table class="source_code">
546
+ <tr>
547
+ <td>
548
+ <pre class="lines">
549
+
550
+
551
+ 29
552
+ 30
553
+ 31</pre>
554
+ </td>
555
+ <td>
556
+ <pre class="code"><span class="info file"># File 'lib/eagleplatform/filter.rb', line 29</span>
557
+
558
+ <span class='kw'>def</span> <span class='id identifier rubyid_per_page'>per_page</span>
559
+ <span class='ivar'>@per_page</span>
560
+ <span class='kw'>end</span></pre>
561
+ </td>
562
+ </tr>
563
+ </table>
564
+ </div>
565
+
566
+
567
+ <span id=""></span>
568
+ <span id="total_entries-instance_method"></span>
569
+ <div class="method_details ">
570
+ <p class="signature " id="total_entries-instance_method">
571
+
572
+ - (<tt>Object</tt>) <strong>total_entries</strong> <span class="extras">(readonly)</span>
573
+
574
+
575
+
576
+ </p><div class="docstring">
577
+ <div class="discussion">
578
+
579
+ <p>Returns the value of attribute total_entries</p>
580
+
581
+
582
+ </div>
583
+ </div>
584
+ <div class="tags">
585
+
586
+
587
+ </div><table class="source_code">
588
+ <tr>
589
+ <td>
590
+ <pre class="lines">
591
+
592
+
593
+ 29
594
+ 30
595
+ 31</pre>
596
+ </td>
597
+ <td>
598
+ <pre class="code"><span class="info file"># File 'lib/eagleplatform/filter.rb', line 29</span>
599
+
600
+ <span class='kw'>def</span> <span class='id identifier rubyid_total_entries'>total_entries</span>
601
+ <span class='ivar'>@total_entries</span>
602
+ <span class='kw'>end</span></pre>
603
+ </td>
604
+ </tr>
605
+ </table>
606
+ </div>
607
+
608
+
609
+ <span id=""></span>
610
+ <span id="total_pages-instance_method"></span>
611
+ <div class="method_details ">
612
+ <p class="signature " id="total_pages-instance_method">
613
+
614
+ - (<tt>Object</tt>) <strong>total_pages</strong> <span class="extras">(readonly)</span>
615
+
616
+
617
+
618
+ </p><div class="docstring">
619
+ <div class="discussion">
620
+
621
+ <p>Returns the value of attribute total_pages</p>
622
+
623
+
624
+ </div>
625
+ </div>
626
+ <div class="tags">
627
+
628
+
629
+ </div><table class="source_code">
630
+ <tr>
631
+ <td>
632
+ <pre class="lines">
633
+
634
+
635
+ 29
636
+ 30
637
+ 31</pre>
638
+ </td>
639
+ <td>
640
+ <pre class="code"><span class="info file"># File 'lib/eagleplatform/filter.rb', line 29</span>
641
+
642
+ <span class='kw'>def</span> <span class='id identifier rubyid_total_pages'>total_pages</span>
643
+ <span class='ivar'>@total_pages</span>
644
+ <span class='kw'>end</span></pre>
645
+ </td>
646
+ </tr>
647
+ </table>
648
+ </div>
649
+
650
+ </div>
651
+
652
+
653
+ <div id="class_method_details" class="method_details_list">
654
+ <h2>Class Method Details</h2>
655
+
656
+
657
+ <div class="method_details first">
658
+ <p class="signature first" id="find-class_method">
659
+
660
+ + (<tt><span class='object_link'><a href="" title="Eagleplatform::Filter (class)">Eagleplatform::Filter</a></span></tt>) <strong>find</strong>(id, per_page = 50, page = 1)
661
+
662
+
663
+
664
+ </p><div class="docstring">
665
+ <div class="discussion">
666
+
667
+ <p>Get records form filter</p>
668
+
669
+
670
+ </div>
671
+ </div>
672
+ <div class="tags">
673
+
674
+ <div class="examples">
675
+ <h3>Examples:</h3>
676
+
677
+ <h4><div class='inline'></div></h4>
678
+ <pre class="example code"><span class='comment'># Simple request:
679
+ </span><span class='id identifier rubyid_f'>f</span> <span class='op'>=</span> <span class='const'>Eagleplatform</span><span class='op'>::</span><span class='const'>Filter</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='int'>54321</span><span class='rparen'>)</span>
680
+
681
+ <span class='comment'># With custom records count per page:
682
+ </span><span class='id identifier rubyid_f'>f</span> <span class='op'>=</span> <span class='const'>Eagleplatform</span><span class='op'>::</span><span class='const'>Filter</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='int'>54321</span><span class='comma'>,</span> <span class='int'>100</span> <span class='rparen'>)</span>
683
+
684
+ <span class='comment'># With custom records count per page and custom page number:
685
+ </span><span class='id identifier rubyid_f'>f</span> <span class='op'>=</span> <span class='const'>Eagleplatform</span><span class='op'>::</span><span class='const'>Filter</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='int'>54321</span><span class='comma'>,</span> <span class='int'>50</span><span class='comma'>,</span> <span class='int'>3</span> <span class='rparen'>)</span></pre>
686
+
687
+ </div>
688
+ <h3>Parameters:</h3>
689
+ <ul class="param">
690
+
691
+ <li>
692
+
693
+ <span class='name'>id</span>
694
+
695
+
696
+ <span class='type'>(<tt>Numeric</tt>)</span>
697
+
698
+
699
+
700
+ &mdash;
701
+ <div class='inline'>
702
+ <p>ID of filter</p>
703
+ </div>
704
+
705
+ </li>
706
+
707
+ <li>
708
+
709
+ <span class='name'>per_page</span>
710
+
711
+
712
+ <span class='type'>(<tt>Numeric</tt>)</span>
713
+
714
+
715
+ <em class="default">(defaults to: <tt>50</tt>)</em>
716
+
717
+
718
+ &mdash;
719
+ <div class='inline'>
720
+ <p>Records per page</p>
721
+ </div>
722
+
723
+ </li>
724
+
725
+ <li>
726
+
727
+ <span class='name'>page</span>
728
+
729
+
730
+ <span class='type'>(<tt>Numeric</tt>)</span>
731
+
732
+
733
+ <em class="default">(defaults to: <tt>1</tt>)</em>
734
+
735
+
736
+ &mdash;
737
+ <div class='inline'>
738
+ <p>Records page number</p>
739
+ </div>
740
+
741
+ </li>
742
+
743
+ </ul>
744
+
745
+ <h3>Returns:</h3>
746
+ <ul class="return">
747
+
748
+ <li>
749
+
750
+
751
+ <span class='type'>(<tt><span class='object_link'><a href="" title="Eagleplatform::Filter (class)">Eagleplatform::Filter</a></span></tt>)</span>
752
+
753
+
754
+
755
+ &mdash;
756
+ <div class='inline'>
757
+ <p>if filetr present</p>
758
+ </div>
759
+
760
+ </li>
761
+
762
+ </ul>
763
+ <h3>Raises:</h3>
764
+ <ul class="raise">
765
+
766
+ <li>
767
+
768
+
769
+ <span class='type'>(<tt>ArgumentError</tt>)</span>
770
+
771
+
772
+
773
+ &mdash;
774
+ <div class='inline'>
775
+ <p>id must be numeric</p>
776
+ </div>
777
+
778
+ </li>
779
+
780
+ </ul>
781
+
782
+ </div><table class="source_code">
783
+ <tr>
784
+ <td>
785
+ <pre class="lines">
786
+
787
+
788
+ 110
789
+ 111
790
+ 112
791
+ 113
792
+ 114
793
+ 115
794
+ 116
795
+ 117
796
+ 118
797
+ 119
798
+ 120
799
+ 121
800
+ 122
801
+ 123</pre>
802
+ </td>
803
+ <td>
804
+ <pre class="code"><span class="info file"># File 'lib/eagleplatform/filter.rb', line 110</span>
805
+
806
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='id identifier rubyid_per_page'>per_page</span> <span class='op'>=</span> <span class='int'>50</span><span class='comma'>,</span> <span class='id identifier rubyid_page'>page</span> <span class='op'>=</span> <span class='int'>1</span><span class='rparen'>)</span>
807
+ <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>per_page must be betwen 1 to 1000</span><span class='tstring_end'>'</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_per_page'>per_page</span><span class='period'>.</span><span class='id identifier rubyid_between?'>between?</span><span class='lparen'>(</span><span class='int'>1</span><span class='comma'>,</span><span class='int'>1000</span><span class='rparen'>)</span>
808
+ <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>id must be numeric</span><span class='tstring_end'>'</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_id'>id</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>Numeric</span>
809
+ <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span>
810
+ <span class='label'>page:</span> <span class='id identifier rubyid_page'>page</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='comma'>,</span>
811
+ <span class='label'>per_page:</span> <span class='id identifier rubyid_per_page'>per_page</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
812
+ <span class='rbrace'>}</span>
813
+ <span class='id identifier rubyid_api_method'>api_method</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='label'>method:</span> <span class='const'>Methods</span><span class='op'>::</span><span class='const'>FILTER_GET_RECORDS</span><span class='lbracket'>[</span><span class='symbol'>:method</span><span class='rbracket'>]</span><span class='comma'>,</span>
814
+ <span class='label'>path:</span> <span class='const'>Methods</span><span class='op'>::</span><span class='const'>FILTER_GET_RECORDS</span><span class='lbracket'>[</span><span class='symbol'>:path</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>:id</span><span class='tstring_end'>'</span></span><span class='comma'>,</span><span class='id identifier rubyid_id'>id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span><span class='rbrace'>}</span>
815
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='const'>Eagleplatform</span><span class='period'>.</span><span class='id identifier rubyid_call_api'>call_api</span><span class='lparen'>(</span><span class='id identifier rubyid_api_method'>api_method</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
816
+ <span class='id identifier rubyid_filter'>filter</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
817
+ <span class='id identifier rubyid_filter'>filter</span><span class='period'>.</span><span class='id identifier rubyid_instance_eval'>instance_eval</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>@per_page = </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_per_page'>per_page</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
818
+ <span class='id identifier rubyid_filter'>filter</span>
819
+ <span class='kw'>end</span></pre>
820
+ </td>
821
+ </tr>
822
+ </table>
823
+ </div>
824
+
825
+ </div>
826
+
827
+ <div id="instance_method_details" class="method_details_list">
828
+ <h2>Instance Method Details</h2>
829
+
830
+
831
+ <div class="method_details first">
832
+ <p class="signature first" id="next_page-instance_method">
833
+
834
+ - (<tt>String</tt>) <strong>next_page</strong>
835
+
836
+
837
+
838
+ </p><div class="docstring">
839
+ <div class="discussion">
840
+
841
+ <p>Load records form filter next page</p>
842
+
843
+
844
+ </div>
845
+ </div>
846
+ <div class="tags">
847
+
848
+ <div class="examples">
849
+ <h3>Examples:</h3>
850
+
851
+ <h4><div class='inline'></div></h4>
852
+ <pre class="example code"><span class='id identifier rubyid_f'>f</span> <span class='op'>=</span> <span class='const'>Eagleplatform</span><span class='op'>::</span><span class='const'>Filter</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='int'>54321</span><span class='rparen'>)</span>
853
+ <span class='id identifier rubyid_f'>f</span><span class='period'>.</span><span class='id identifier rubyid_next_page'>next_page</span></pre>
854
+
855
+ </div>
856
+
857
+ <h3>Returns:</h3>
858
+ <ul class="return">
859
+
860
+ <li>
861
+
862
+
863
+ <span class='type'>(<tt>String</tt>)</span>
864
+
865
+
866
+
867
+ &mdash;
868
+ <div class='inline'>
869
+ <p>Count of loaded records</p>
870
+ </div>
871
+
872
+ </li>
873
+
874
+ </ul>
875
+
876
+ </div><table class="source_code">
877
+ <tr>
878
+ <td>
879
+ <pre class="lines">
880
+
881
+
882
+ 68
883
+ 69
884
+ 70
885
+ 71
886
+ 72
887
+ 73
888
+ 74
889
+ 75
890
+ 76
891
+ 77
892
+ 78
893
+ 79
894
+ 80
895
+ 81
896
+ 82
897
+ 83
898
+ 84
899
+ 85
900
+ 86
901
+ 87
902
+ 88
903
+ 89
904
+ 90
905
+ 91
906
+ 92</pre>
907
+ </td>
908
+ <td>
909
+ <pre class="code"><span class="info file"># File 'lib/eagleplatform/filter.rb', line 68</span>
910
+
911
+ <span class='kw'>def</span> <span class='id identifier rubyid_next_page'>next_page</span>
912
+ <span class='kw'>if</span> <span class='ivar'>@current_page</span> <span class='op'>&lt;</span> <span class='ivar'>@total_pages</span>
913
+ <span class='kw'>begin</span>
914
+ <span class='ivar'>@current_page</span> <span class='op'>+=</span> <span class='int'>1</span>
915
+ <span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span>
916
+ <span class='label'>page:</span> <span class='ivar'>@current_page</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='comma'>,</span>
917
+ <span class='label'>per_page:</span> <span class='ivar'>@per_page</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
918
+ <span class='rbrace'>}</span>
919
+ <span class='id identifier rubyid_api_method'>api_method</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='label'>method:</span> <span class='const'>Methods</span><span class='op'>::</span><span class='const'>FILTER_GET_RECORDS</span><span class='lbracket'>[</span><span class='symbol'>:method</span><span class='rbracket'>]</span><span class='comma'>,</span>
920
+ <span class='label'>path:</span> <span class='const'>Methods</span><span class='op'>::</span><span class='const'>FILTER_GET_RECORDS</span><span class='lbracket'>[</span><span class='symbol'>:path</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>:id</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span><span class='rbrace'>}</span>
921
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='const'>Eagleplatform</span><span class='period'>.</span><span class='id identifier rubyid_call_api'>call_api</span><span class='lparen'>(</span><span class='id identifier rubyid_api_method'>api_method</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
922
+ <span class='id identifier rubyid_result'>result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>records</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_record'>record</span><span class='op'>|</span>
923
+ <span class='id identifier rubyid_rec'>rec</span> <span class='op'>=</span> <span class='const'>Eagleplatform</span><span class='op'>::</span><span class='const'>Record</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
924
+ <span class='id identifier rubyid_rec'>rec</span><span class='period'>.</span><span class='id identifier rubyid_each_pair'>each_pair</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_k'>k</span><span class='comma'>,</span><span class='id identifier rubyid_v'>v</span><span class='op'>|</span> <span class='id identifier rubyid_rec'>rec</span><span class='lbracket'>[</span><span class='id identifier rubyid_k'>k</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_record'>record</span><span class='lbracket'>[</span><span class='id identifier rubyid_k'>k</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rbracket'>]</span><span class='rbrace'>}</span>
925
+ <span class='ivar'>@records</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span><span class='lparen'>(</span><span class='id identifier rubyid_rec'>rec</span><span class='rparen'>)</span>
926
+ <span class='kw'>end</span>
927
+ <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>+</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_result'>result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>records</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_count'>count</span><span class='rbrace'>}</span><span class='tstring_content'> records loaded.</span><span class='tstring_end'>&quot;</span></span>
928
+ <span class='kw'>rescue</span> <span class='const'>Exception</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
929
+ <span class='ivar'>@current_page</span> <span class='op'>-=</span> <span class='int'>1</span>
930
+ <span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_e'>e</span>
931
+ <span class='kw'>end</span>
932
+ <span class='kw'>elsif</span> <span class='ivar'>@current_page</span> <span class='op'>==</span> <span class='ivar'>@total_pages</span>
933
+ <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>@current_page == @total_pages. Nothing to load</span><span class='tstring_end'>&quot;</span></span>
934
+ <span class='kw'>end</span>
935
+ <span class='kw'>end</span></pre>
936
+ </td>
937
+ </tr>
938
+ </table>
939
+ </div>
940
+
941
+ <div class="method_details ">
942
+ <p class="signature " id="records-instance_method">
943
+
944
+ - (<tt>Array</tt>) <strong>records</strong>
945
+
946
+
947
+
948
+ </p><div class="docstring">
949
+ <div class="discussion">
950
+
951
+ <p>List of loaded records</p>
952
+
953
+
954
+ </div>
955
+ </div>
956
+ <div class="tags">
957
+
958
+ <h3>Returns:</h3>
959
+ <ul class="return">
960
+
961
+ <li>
962
+
963
+
964
+ <span class='type'>(<tt>Array</tt>)</span>
965
+
966
+
967
+
968
+ &mdash;
969
+ <div class='inline'>
970
+ <p>List of loaded records</p>
971
+ </div>
972
+
973
+ </li>
974
+
975
+ </ul>
976
+
977
+ </div><table class="source_code">
978
+ <tr>
979
+ <td>
980
+ <pre class="lines">
981
+
982
+
983
+ 33
984
+ 34
985
+ 35</pre>
986
+ </td>
987
+ <td>
988
+ <pre class="code"><span class="info file"># File 'lib/eagleplatform/filter.rb', line 33</span>
989
+
990
+ <span class='kw'>def</span> <span class='id identifier rubyid_records'>records</span>
991
+ <span class='ivar'>@records</span>
992
+ <span class='kw'>end</span></pre>
993
+ </td>
994
+ </tr>
995
+ </table>
996
+ </div>
997
+
998
+ </div>
999
+
1000
+ </div>
1001
+
1002
+ <div id="footer">
1003
+ Generated on Thu May 24 16:50:21 2012 by
1004
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1005
+ 0.7.5 (ruby-1.9.3).
1006
+ </div>
1007
+
1008
+ </body>
1009
+ </html>