trackerific 0.5.5 → 0.6.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 (49) hide show
  1. data/README.rdoc +62 -44
  2. data/Rakefile +1 -1
  3. data/VERSION +1 -1
  4. data/changelog +9 -0
  5. data/lib/trackerific/configuration.rb +2 -2
  6. data/lib/trackerific/details.rb +36 -10
  7. data/lib/trackerific/event.rb +9 -7
  8. data/lib/trackerific/service.rb +22 -6
  9. data/lib/trackerific/services/fedex.rb +11 -7
  10. data/lib/trackerific/services/mock_service.rb +23 -14
  11. data/lib/trackerific/services/ups.rb +12 -8
  12. data/lib/trackerific/services/usps.rb +114 -21
  13. data/spec/fixtures/usps_city_state_lookup_response.xml +8 -0
  14. data/spec/lib/helpers/options_helper_spec.rb +3 -3
  15. data/spec/lib/trackerific/configuration_spec.rb +35 -0
  16. data/spec/lib/trackerific/details_spec.rb +71 -11
  17. data/spec/lib/trackerific/event_spec.rb +34 -19
  18. data/spec/lib/trackerific/service_spec.rb +3 -3
  19. data/spec/lib/trackerific/services/fedex_spec.rb +16 -3
  20. data/spec/lib/trackerific/services/mock_service_spec.rb +19 -4
  21. data/spec/lib/trackerific/services/ups_spec.rb +17 -2
  22. data/spec/lib/trackerific/services/usps_spec.rb +60 -11
  23. data/spec/lib/trackerific_spec.rb +7 -5
  24. data/trackerific.gemspec +5 -27
  25. metadata +8 -30
  26. data/doc/OptionsHelper.html +0 -287
  27. data/doc/Trackerific/Configuration.html +0 -354
  28. data/doc/Trackerific/Details.html +0 -565
  29. data/doc/Trackerific/Error.html +0 -127
  30. data/doc/Trackerific/Event.html +0 -639
  31. data/doc/Trackerific/FedEx.html +0 -558
  32. data/doc/Trackerific/Service.html +0 -579
  33. data/doc/Trackerific/UPS.html +0 -532
  34. data/doc/Trackerific/USPS.html +0 -568
  35. data/doc/Trackerific.html +0 -833
  36. data/doc/_index.html +0 -226
  37. data/doc/class_list.html +0 -47
  38. data/doc/css/common.css +0 -1
  39. data/doc/css/full_list.css +0 -53
  40. data/doc/css/style.css +0 -320
  41. data/doc/file.README.html +0 -288
  42. data/doc/file_list.html +0 -49
  43. data/doc/frames.html +0 -13
  44. data/doc/index.html +0 -288
  45. data/doc/js/app.js +0 -205
  46. data/doc/js/full_list.js +0 -150
  47. data/doc/js/jquery.js +0 -16
  48. data/doc/method_list.html +0 -294
  49. data/doc/top-level-namespace.html +0 -103
@@ -1,565 +0,0 @@
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::Details
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 (D)</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">Details</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::Details
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::Details</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/details.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
- Details returned when tracking a package. Stores the package identifier, a
99
- summary, and the events.
100
- </p>
101
-
102
-
103
- </div>
104
- </div>
105
- <div class="tags">
106
-
107
- </div>
108
-
109
-
110
-
111
-
112
-
113
- <h2>
114
- Instance Method Summary
115
- <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
116
- </h2>
117
-
118
- <ul class="summary">
119
-
120
- <li class="public ">
121
- <span class="summary_signature">
122
-
123
- <a href="#events-instance_method" title="#events (instance method)">- (Array, Trackerific::Event) <strong>events</strong> </a>
124
-
125
-
126
-
127
- </span>
128
-
129
-
130
-
131
-
132
-
133
-
134
-
135
-
136
- <span class="summary_desc"><div class='inline'><p>
137
- Read-only string for the events for this package.
138
- </p>
139
- </div></span>
140
-
141
- </li>
142
-
143
-
144
- <li class="public ">
145
- <span class="summary_signature">
146
-
147
- <a href="#initialize-instance_method" title="#initialize (instance method)">- (Details) <strong>initialize</strong>(package_id, summary, events) </a>
148
-
149
-
150
-
151
- </span>
152
-
153
- <span class="note title constructor">constructor</span>
154
-
155
-
156
-
157
-
158
-
159
- <span class="private note title">Private</span>
160
-
161
-
162
- <span class="summary_desc"><div class='inline'><p>
163
- Provides a new instance of Details.
164
- </p>
165
- </div></span>
166
-
167
- </li>
168
-
169
-
170
- <li class="public ">
171
- <span class="summary_signature">
172
-
173
- <a href="#package_id-instance_method" title="#package_id (instance method)">- (String) <strong>package_id</strong> </a>
174
-
175
-
176
-
177
- </span>
178
-
179
-
180
-
181
-
182
-
183
-
184
-
185
-
186
- <span class="summary_desc"><div class='inline'><p>
187
- Read-only string for the package identifier.
188
- </p>
189
- </div></span>
190
-
191
- </li>
192
-
193
-
194
- <li class="public ">
195
- <span class="summary_signature">
196
-
197
- <a href="#summary-instance_method" title="#summary (instance method)">- (String) <strong>summary</strong> </a>
198
-
199
-
200
-
201
- </span>
202
-
203
-
204
-
205
-
206
-
207
-
208
-
209
-
210
- <span class="summary_desc"><div class='inline'><p>
211
- Read-only string for the summary of the package&#8217;s tracking events.
212
- </p>
213
- </div></span>
214
-
215
- </li>
216
-
217
-
218
- </ul>
219
-
220
-
221
- <div id="constructor_details" class="method_details_list">
222
- <h2>Constructor Details</h2>
223
-
224
- <div class="method_details first">
225
- <p class="signature first" id="initialize-instance_method">
226
-
227
- - (<tt><span class='object_link'><a href="" title="Trackerific::Details (class)">Details</a></span></tt>) <strong>initialize</strong>(package_id, summary, events)
228
-
229
-
230
-
231
- </p><div class="docstring">
232
- <div class="discussion">
233
- <p class="note private">
234
- <strong>This method is part of a private API.</strong>
235
- You should avoid using this method if possible, as it may be removed or be changed in the future.
236
- </p>
237
- <p>
238
- Provides a new instance of Details
239
- </p>
240
-
241
-
242
- </div>
243
- </div>
244
- <div class="tags">
245
- <h3>Parameters:</h3>
246
- <ul class="param">
247
-
248
- <li>
249
-
250
- <span class='name'>package_id</span>
251
-
252
-
253
- <span class='type'>(<tt>String</tt>)</span>
254
-
255
-
256
-
257
- &mdash;
258
- <div class='inline'><p>
259
- the package identifier
260
- </p>
261
- </div>
262
-
263
- </li>
264
-
265
- <li>
266
-
267
- <span class='name'>summary</span>
268
-
269
-
270
- <span class='type'>(<tt>String</tt>)</span>
271
-
272
-
273
-
274
- &mdash;
275
- <div class='inline'><p>
276
- a summary of the tracking status
277
- </p>
278
- </div>
279
-
280
- </li>
281
-
282
- <li>
283
-
284
- <span class='name'>events</span>
285
-
286
-
287
- <span class='type'>(<tt>Array</tt>, <tt><span class='object_link'><a href="Event.html" title="Trackerific::Event (class)">Trackerific::Event</a></span></tt>)</span>
288
-
289
-
290
-
291
- &mdash;
292
- <div class='inline'><p>
293
- the tracking events
294
- </p>
295
- </div>
296
-
297
- </li>
298
-
299
- </ul>
300
-
301
- </div><table class="source_code">
302
- <tr>
303
- <td>
304
- <pre class="lines">
305
-
306
-
307
- 10
308
- 11
309
- 12
310
- 13
311
- 14</pre>
312
- </td>
313
- <td>
314
- <pre class="code"><span class="info file"># File 'lib/trackerific/details.rb', line 10</span>
315
-
316
- <span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id package_id'>package_id</span><span class='comma'>,</span> <span class='id summary'>summary</span><span class='comma'>,</span> <span class='id events'>events</span><span class='rparen'>)</span>
317
- <span class='ivar'>@package_id</span> <span class='op'>=</span> <span class='id package_id'>package_id</span>
318
- <span class='ivar'>@summary</span> <span class='op'>=</span> <span class='id summary'>summary</span>
319
- <span class='ivar'>@events</span> <span class='op'>=</span> <span class='id events'>events</span>
320
- <span class='kw'>end</span></pre>
321
- </td>
322
- </tr>
323
- </table>
324
- </div>
325
-
326
- </div>
327
-
328
-
329
- <div id="instance_method_details" class="method_details_list">
330
- <h2>Instance Method Details</h2>
331
-
332
-
333
- <div class="method_details first">
334
- <p class="signature first" id="events-instance_method">
335
-
336
- - (<tt>Array</tt>, <tt><span class='object_link'><a href="Event.html" title="Trackerific::Event (class)">Trackerific::Event</a></span></tt>) <strong>events</strong>
337
-
338
-
339
-
340
- </p><div class="docstring">
341
- <div class="discussion">
342
- <p>
343
- Read-only string for the events for this package
344
- </p>
345
-
346
-
347
- </div>
348
- </div>
349
- <div class="tags">
350
-
351
- <div class="examples">
352
- <h3>Examples:</h3>
353
-
354
- <h4><div class='inline'><p>
355
- Print all the events for a tracked package
356
- </p>
357
- </div></h4>
358
- <pre class="example code"><span class='id puts'>puts</span> <span class='id details'>details</span><span class='period'>.</span><span class='id events'>events</span></pre>
359
-
360
- <h4><div class='inline'><p>
361
- Get the date the package was shipped
362
- </p>
363
- </div></h4>
364
- <pre class="example code"><span class='id details'>details</span><span class='period'>.</span><span class='id events'>events</span><span class='period'>.</span><span class='id last'>last</span><span class='period'>.</span><span class='id date'>date</span> <span class='comment'># =&gt; a DateTime value</span></pre>
365
-
366
- <h4><div class='inline'><p>
367
- A bulleted HTML list of the events (most current on top) in haml
368
- </p>
369
- </div></h4>
370
- <pre class="example code">%ul
371
- - details.events.each do |event|
372
- %li= event</pre>
373
-
374
- </div>
375
- <h3>Returns:</h3>
376
- <ul class="return">
377
-
378
- <li>
379
-
380
-
381
- <span class='type'>(<tt>Array</tt>, <tt><span class='object_link'><a href="Event.html" title="Trackerific::Event (class)">Trackerific::Event</a></span></tt>)</span>
382
-
383
-
384
-
385
- &mdash;
386
- <div class='inline'><p>
387
- the tracking events
388
- </p>
389
- </div>
390
-
391
- </li>
392
-
393
- </ul>
394
-
395
- </div><table class="source_code">
396
- <tr>
397
- <td>
398
- <pre class="lines">
399
-
400
-
401
- 45
402
- 46
403
- 47</pre>
404
- </td>
405
- <td>
406
- <pre class="code"><span class="info file"># File 'lib/trackerific/details.rb', line 45</span>
407
-
408
- <span class='kw'>def</span> <span class='id events'>events</span>
409
- <span class='ivar'>@events</span>
410
- <span class='kw'>end</span></pre>
411
- </td>
412
- </tr>
413
- </table>
414
- </div>
415
-
416
- <div class="method_details ">
417
- <p class="signature " id="package_id-instance_method">
418
-
419
- - (<tt>String</tt>) <strong>package_id</strong>
420
-
421
-
422
-
423
- </p><div class="docstring">
424
- <div class="discussion">
425
- <p>
426
- Read-only string for the package identifier
427
- </p>
428
-
429
-
430
- </div>
431
- </div>
432
- <div class="tags">
433
-
434
- <div class="examples">
435
- <h3>Examples:</h3>
436
-
437
- <h4><div class='inline'><p>
438
- Get the id of a tracked package
439
- </p>
440
- </div></h4>
441
- <pre class="example code"><span class='id details'>details</span><span class='period'>.</span><span class='id package_id'>package_id</span> <span class='comment'># =&gt; the package identifier</span></pre>
442
-
443
- </div>
444
- <h3>Returns:</h3>
445
- <ul class="return">
446
-
447
- <li>
448
-
449
-
450
- <span class='type'>(<tt>String</tt>)</span>
451
-
452
-
453
-
454
- &mdash;
455
- <div class='inline'><p>
456
- the package identifier
457
- </p>
458
- </div>
459
-
460
- </li>
461
-
462
- </ul>
463
-
464
- </div><table class="source_code">
465
- <tr>
466
- <td>
467
- <pre class="lines">
468
-
469
-
470
- 21
471
- 22
472
- 23</pre>
473
- </td>
474
- <td>
475
- <pre class="code"><span class="info file"># File 'lib/trackerific/details.rb', line 21</span>
476
-
477
- <span class='kw'>def</span> <span class='id package_id'>package_id</span>
478
- <span class='ivar'>@package_id</span>
479
- <span class='kw'>end</span></pre>
480
- </td>
481
- </tr>
482
- </table>
483
- </div>
484
-
485
- <div class="method_details ">
486
- <p class="signature " id="summary-instance_method">
487
-
488
- - (<tt>String</tt>) <strong>summary</strong>
489
-
490
-
491
-
492
- </p><div class="docstring">
493
- <div class="discussion">
494
- <p>
495
- Read-only string for the summary of the package&#8217;s tracking events
496
- </p>
497
-
498
-
499
- </div>
500
- </div>
501
- <div class="tags">
502
-
503
- <div class="examples">
504
- <h3>Examples:</h3>
505
-
506
- <h4><div class='inline'><p>
507
- Get the summary of a tracked package
508
- </p>
509
- </div></h4>
510
- <pre class="example code"><span class='id details'>details</span><span class='period'>.</span><span class='id summary'>summary</span> <span class='comment'># =&gt; Summary of the tracking events (i.e. Delivered)</span></pre>
511
-
512
- </div>
513
- <h3>Returns:</h3>
514
- <ul class="return">
515
-
516
- <li>
517
-
518
-
519
- <span class='type'>(<tt>String</tt>)</span>
520
-
521
-
522
-
523
- &mdash;
524
- <div class='inline'><p>
525
- a summary of the tracking status
526
- </p>
527
- </div>
528
-
529
- </li>
530
-
531
- </ul>
532
-
533
- </div><table class="source_code">
534
- <tr>
535
- <td>
536
- <pre class="lines">
537
-
538
-
539
- 30
540
- 31
541
- 32</pre>
542
- </td>
543
- <td>
544
- <pre class="code"><span class="info file"># File 'lib/trackerific/details.rb', line 30</span>
545
-
546
- <span class='kw'>def</span> <span class='id summary'>summary</span>
547
- <span class='ivar'>@summary</span>
548
- <span class='kw'>end</span></pre>
549
- </td>
550
- </tr>
551
- </table>
552
- </div>
553
-
554
- </div>
555
-
556
- </div>
557
-
558
- <div id="footer">
559
- Generated on Wed Jun 15 15:30:27 2011 by
560
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
561
- 0.7.1 (ruby-1.9.2).
562
- </div>
563
-
564
- </body>
565
- </html>
@@ -1,127 +0,0 @@
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/error.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 Wed Jun 15 15:30:26 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>