trackerific 0.2.1 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. data/.yardoc/checksums +6 -0
  2. data/.yardoc/objects/root.dat +0 -0
  3. data/.yardoc/proxy_types +0 -0
  4. data/VERSION +1 -1
  5. data/doc/Trackerific.html +258 -0
  6. data/doc/Trackerific/Base.html +390 -0
  7. data/doc/Trackerific/Details.html +514 -0
  8. data/doc/Trackerific/Error.html +127 -0
  9. data/doc/Trackerific/Event.html +601 -0
  10. data/doc/Trackerific/FedEx.html +395 -0
  11. data/doc/Trackerific/UPS.html +360 -0
  12. data/doc/Trackerific/USPS.html +453 -0
  13. data/doc/_index.html +195 -0
  14. data/doc/class_list.html +47 -0
  15. data/doc/css/common.css +1 -0
  16. data/doc/css/full_list.css +53 -0
  17. data/doc/css/style.css +320 -0
  18. data/doc/file.README.html +213 -0
  19. data/doc/file_list.html +49 -0
  20. data/doc/frames.html +13 -0
  21. data/doc/index.html +213 -0
  22. data/doc/js/app.js +205 -0
  23. data/doc/js/full_list.js +150 -0
  24. data/doc/js/jquery.js +16 -0
  25. data/doc/method_list.html +206 -0
  26. data/doc/top-level-namespace.html +103 -0
  27. data/lib/fedex.rb +17 -7
  28. data/lib/trackerific.rb +16 -2
  29. data/lib/trackerific_details.rb +30 -0
  30. data/lib/trackerific_event.rb +38 -0
  31. data/lib/ups.rb +40 -14
  32. data/lib/usps.rb +28 -5
  33. data/spec/lib/fedex_spec.rb +8 -10
  34. data/spec/lib/trackerific_details_spec.rb +19 -0
  35. data/spec/lib/trackerific_event_spec.rb +20 -0
  36. data/spec/lib/ups_spec.rb +8 -6
  37. data/spec/lib/usps_spec.rb +8 -10
  38. data/trackerific.gemspec +32 -1
  39. metadata +35 -4
data/doc/Trackerific/Error.html ADDED
@@ -0,0 +1,127 @@
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
+ Exception: Trackerific::Error
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 (E)</a> &raquo;
37
+ <span class='title'><span class='object_link'><a href="../Trackerific.html" title="Trackerific (module)">Trackerific</a></span></span>
38
+ &raquo;
39
+ <span class="title">Error</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>Exception: Trackerific::Error
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">StandardError</span>
70
+
71
+ <ul class="fullTree">
72
+ <li>Object</li>
73
+
74
+ <li class="next">StandardError</li>
75
+
76
+ <li class="next">Trackerific::Error</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/trackerific.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
+ Raised if something other than tracking information is returned.
101
+ </p>
102
+
103
+
104
+ </div>
105
+ </div>
106
+ <div class="tags">
107
+
108
+ </div>
109
+
110
+
111
+
112
+
113
+
114
+
115
+
116
+
117
+
118
+ </div>
119
+
120
+ <div id="footer">
121
+ Generated on Mon Jun 13 13:53:34 2011 by
122
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
123
+ 0.7.1 (ruby-1.9.2).
124
+ </div>
125
+
126
+ </body>
127
+ </html>
data/doc/Trackerific/Event.html ADDED
@@ -0,0 +1,601 @@
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: Trackerific::Event
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 (E)</a> &raquo;
37
+ <span class='title'><span class='object_link'><a href="../Trackerific.html" title="Trackerific (module)">Trackerific</a></span></span>
38
+ &raquo;
39
+ <span class="title">Event</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: Trackerific::Event
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">Trackerific::Event</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/trackerific_event.rb</dd>
91
+
92
+ </dl>
93
+ <div class="clear"></div>
94
+
95
+ <h2>Overview</h2><div class="docstring">
96
+ <div class="discussion">
97
+ <p>
98
+ Provides details for a tracking event
99
+ </p>
100
+
101
+
102
+ </div>
103
+ </div>
104
+ <div class="tags">
105
+
106
+ </div>
107
+
108
+
109
+
110
+
111
+
112
+ <h2>
113
+ Instance Method Summary
114
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
115
+ </h2>
116
+
117
+ <ul class="summary">
118
+
119
+ <li class="public ">
120
+ <span class="summary_signature">
121
+
122
+ <a href="#date-instance_method" title="#date (instance method)">- (Time) <strong>date</strong> </a>
123
+
124
+
125
+
126
+ </span>
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+ <span class="summary_desc"><div class='inline'><p>
136
+ The date / time of the event.
137
+ </p>
138
+ </div></span>
139
+
140
+ </li>
141
+
142
+
143
+ <li class="public ">
144
+ <span class="summary_signature">
145
+
146
+ <a href="#description-instance_method" title="#description (instance method)">- (String) <strong>description</strong> </a>
147
+
148
+
149
+
150
+ </span>
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+
159
+ <span class="summary_desc"><div class='inline'><p>
160
+ The event&#8217;s description.
161
+ </p>
162
+ </div></span>
163
+
164
+ </li>
165
+
166
+
167
+ <li class="public ">
168
+ <span class="summary_signature">
169
+
170
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (Event) <strong>initialize</strong>(date, description, location) </a>
171
+
172
+
173
+
174
+ </span>
175
+
176
+ <span class="note title constructor">constructor</span>
177
+
178
+
179
+
180
+
181
+
182
+
183
+
184
+
185
+ <span class="summary_desc"><div class='inline'><p>
186
+ Provides a new instance of Event.
187
+ </p>
188
+ </div></span>
189
+
190
+ </li>
191
+
192
+
193
+ <li class="public ">
194
+ <span class="summary_signature">
195
+
196
+ <a href="#location-instance_method" title="#location (instance method)">- (String) <strong>location</strong> </a>
197
+
198
+
199
+
200
+ </span>
201
+
202
+
203
+
204
+
205
+
206
+
207
+
208
+
209
+ <span class="summary_desc"><div class='inline'><p>
210
+ Where the event took place (usually in City State Zip format).
211
+ </p>
212
+ </div></span>
213
+
214
+ </li>
215
+
216
+
217
+ <li class="public ">
218
+ <span class="summary_signature">
219
+
220
+ <a href="#to_s-instance_method" title="#to_s (instance method)">- (String) <strong>to_s</strong> </a>
221
+
222
+
223
+
224
+ </span>
225
+
226
+
227
+
228
+
229
+
230
+
231
+
232
+
233
+ <span class="summary_desc"><div class='inline'><p>
234
+ Converts the event into a string.
235
+ </p>
236
+ </div></span>
237
+
238
+ </li>
239
+
240
+
241
+ </ul>
242
+
243
+
244
+ <div id="constructor_details" class="method_details_list">
245
+ <h2>Constructor Details</h2>
246
+
247
+ <div class="method_details first">
248
+ <p class="signature first" id="initialize-instance_method">
249
+
250
+ - (<tt><span class='object_link'><a href="" title="Trackerific::Event (class)">Event</a></span></tt>) <strong>initialize</strong>(date, description, location)
251
+
252
+
253
+
254
+ </p><div class="docstring">
255
+ <div class="discussion">
256
+ <p>
257
+ Provides a new instance of Event
258
+ </p>
259
+
260
+
261
+ </div>
262
+ </div>
263
+ <div class="tags">
264
+ <h3>Parameters:</h3>
265
+ <ul class="param">
266
+
267
+ <li>
268
+
269
+ <span class='name'>the</span>
270
+
271
+
272
+ <span class='type'>(<tt>Time</tt>)</span>
273
+
274
+
275
+
276
+ &mdash;
277
+ <div class='inline'><p>
278
+ date / time of the event
279
+ </p>
280
+ </div>
281
+
282
+ </li>
283
+
284
+ <li>
285
+
286
+ <span class='name'>the</span>
287
+
288
+
289
+ <span class='type'>(<tt>String</tt>)</span>
290
+
291
+
292
+
293
+ &mdash;
294
+ <div class='inline'><p>
295
+ event&#8217;s description
296
+ </p>
297
+ </div>
298
+
299
+ </li>
300
+
301
+ <li>
302
+
303
+ <span class='name'>where</span>
304
+
305
+
306
+ <span class='type'>(<tt>String</tt>)</span>
307
+
308
+
309
+
310
+ &mdash;
311
+ <div class='inline'><p>
312
+ the event took place
313
+ </p>
314
+ </div>
315
+
316
+ </li>
317
+
318
+ </ul>
319
+
320
+ </div><table class="source_code">
321
+ <tr>
322
+ <td>
323
+ <pre class="lines">
324
+
325
+
326
+ 8
327
+ 9
328
+ 10
329
+ 11
330
+ 12</pre>
331
+ </td>
332
+ <td>
333
+ <pre class="code"><span class="info file"># File 'lib/trackerific_event.rb', line 8</span>
334
+
335
+ <span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id date'>date</span><span class='comma'>,</span> <span class='id description'>description</span><span class='comma'>,</span> <span class='id location'>location</span><span class='rparen'>)</span>
336
+ <span class='ivar'>@date</span> <span class='op'>=</span> <span class='id date'>date</span>
337
+ <span class='ivar'>@description</span> <span class='op'>=</span> <span class='id description'>description</span>
338
+ <span class='ivar'>@location</span> <span class='op'>=</span> <span class='id location'>location</span>
339
+ <span class='kw'>end</span></pre>
340
+ </td>
341
+ </tr>
342
+ </table>
343
+ </div>
344
+
345
+ </div>
346
+
347
+
348
+ <div id="instance_method_details" class="method_details_list">
349
+ <h2>Instance Method Details</h2>
350
+
351
+
352
+ <div class="method_details first">
353
+ <p class="signature first" id="date-instance_method">
354
+
355
+ - (<tt>Time</tt>) <strong>date</strong>
356
+
357
+
358
+
359
+ </p><div class="docstring">
360
+ <div class="discussion">
361
+ <p>
362
+ The date / time of the event
363
+ </p>
364
+
365
+
366
+ </div>
367
+ </div>
368
+ <div class="tags">
369
+ <h3>Returns:</h3>
370
+ <ul class="return">
371
+
372
+ <li>
373
+
374
+
375
+ <span class='type'>(<tt>Time</tt>)</span>
376
+
377
+
378
+
379
+ &mdash;
380
+ <div class='inline'><p>
381
+ the date / time of the event
382
+ </p>
383
+ </div>
384
+
385
+ </li>
386
+
387
+ </ul>
388
+
389
+ </div><table class="source_code">
390
+ <tr>
391
+ <td>
392
+ <pre class="lines">
393
+
394
+
395
+ 15
396
+ 16
397
+ 17</pre>
398
+ </td>
399
+ <td>
400
+ <pre class="code"><span class="info file"># File 'lib/trackerific_event.rb', line 15</span>
401
+
402
+ <span class='kw'>def</span> <span class='id date'>date</span>
403
+ <span class='ivar'>@date</span>
404
+ <span class='kw'>end</span></pre>
405
+ </td>
406
+ </tr>
407
+ </table>
408
+ </div>
409
+
410
+ <div class="method_details ">
411
+ <p class="signature " id="description-instance_method">
412
+
413
+ - (<tt>String</tt>) <strong>description</strong>
414
+
415
+
416
+
417
+ </p><div class="docstring">
418
+ <div class="discussion">
419
+ <p>
420
+ The event&#8217;s description.
421
+ </p>
422
+
423
+
424
+ </div>
425
+ </div>
426
+ <div class="tags">
427
+ <h3>Returns:</h3>
428
+ <ul class="return">
429
+
430
+ <li>
431
+
432
+
433
+ <span class='type'>(<tt>String</tt>)</span>
434
+
435
+
436
+
437
+ &mdash;
438
+ <div class='inline'><p>
439
+ the event&#8217;s description.
440
+ </p>
441
+ </div>
442
+
443
+ </li>
444
+
445
+ </ul>
446
+
447
+ </div><table class="source_code">
448
+ <tr>
449
+ <td>
450
+ <pre class="lines">
451
+
452
+
453
+ 20
454
+ 21
455
+ 22</pre>
456
+ </td>
457
+ <td>
458
+ <pre class="code"><span class="info file"># File 'lib/trackerific_event.rb', line 20</span>
459
+
460
+ <span class='kw'>def</span> <span class='id description'>description</span>
461
+ <span class='ivar'>@description</span>
462
+ <span class='kw'>end</span></pre>
463
+ </td>
464
+ </tr>
465
+ </table>
466
+ </div>
467
+
468
+ <div class="method_details ">
469
+ <p class="signature " id="location-instance_method">
470
+
471
+ - (<tt>String</tt>) <strong>location</strong>
472
+
473
+
474
+
475
+ </p><div class="docstring">
476
+ <div class="discussion">
477
+ <p>
478
+ Where the event took place (usually in City State Zip format)
479
+ </p>
480
+
481
+
482
+ </div>
483
+ </div>
484
+ <div class="tags">
485
+ <h3>Returns:</h3>
486
+ <ul class="return">
487
+
488
+ <li>
489
+
490
+
491
+ <span class='type'>(<tt>String</tt>)</span>
492
+
493
+
494
+
495
+ &mdash;
496
+ <div class='inline'><p>
497
+ where the event took place (usually in City State Zip format)
498
+ </p>
499
+ </div>
500
+
501
+ </li>
502
+
503
+ </ul>
504
+
505
+ </div><table class="source_code">
506
+ <tr>
507
+ <td>
508
+ <pre class="lines">
509
+
510
+
511
+ 26
512
+ 27
513
+ 28</pre>
514
+ </td>
515
+ <td>
516
+ <pre class="code"><span class="info file"># File 'lib/trackerific_event.rb', line 26</span>
517
+
518
+ <span class='kw'>def</span> <span class='id location'>location</span>
519
+ <span class='ivar'>@location</span>
520
+ <span class='kw'>end</span></pre>
521
+ </td>
522
+ </tr>
523
+ </table>
524
+ </div>
525
+
526
+ <div class="method_details ">
527
+ <p class="signature " id="to_s-instance_method">
528
+
529
+ - (<tt>String</tt>) <strong>to_s</strong>
530
+
531
+
532
+
533
+ </p><div class="docstring">
534
+ <div class="discussion">
535
+ <p>
536
+ Converts the event into a string
537
+ </p>
538
+
539
+
540
+ </div>
541
+ </div>
542
+ <div class="tags">
543
+ <h3>Returns:</h3>
544
+ <ul class="return">
545
+
546
+ <li>
547
+
548
+
549
+ <span class='type'>(<tt>String</tt>)</span>
550
+
551
+
552
+
553
+ &mdash;
554
+ <div class='inline'><p>
555
+ converts the event into a string
556
+ </p>
557
+ </div>
558
+
559
+ </li>
560
+
561
+ </ul>
562
+
563
+ </div><table class="source_code">
564
+ <tr>
565
+ <td>
566
+ <pre class="lines">
567
+
568
+
569
+ 31
570
+ 32
571
+ 33
572
+ 34
573
+ 35
574
+ 36</pre>
575
+ </td>
576
+ <td>
577
+ <pre class="code"><span class="info file"># File 'lib/trackerific_event.rb', line 31</span>
578
+
579
+ <span class='kw'>def</span> <span class='id to_s'>to_s</span>
580
+ <span class='id dte'>dte</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id date'>date</span><span class='period'>.</span><span class='id strftime'>strftime</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>%b %d %I:%M %P</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
581
+ <span class='id des'>des</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id description'>description</span>
582
+ <span class='id loc'>loc</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id location'>location</span>
583
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id dte'>dte</span><span class='rbrace'>}</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='id des'>des</span><span class='rbrace'>}</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='id loc'>loc</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span>
584
+ <span class='kw'>end</span></pre>
585
+ </td>
586
+ </tr>
587
+ </table>
588
+ </div>
589
+
590
+ </div>
591
+
592
+ </div>
593
+
594
+ <div id="footer">
595
+ Generated on Mon Jun 13 13:53:34 2011 by
596
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
597
+ 0.7.1 (ruby-1.9.2).
598
+ </div>
599
+
600
+ </body>
601
+ </html>