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,639 +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::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)">- (DateTime) <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 and 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
- <span class="private note title">Private</span>
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 class="note private">
257
- <strong>This method is part of a private API.</strong>
258
- You should avoid using this method if possible, as it may be removed or be changed in the future.
259
- </p>
260
- <p>
261
- Provides a new instance of Event
262
- </p>
263
-
264
-
265
- </div>
266
- </div>
267
- <div class="tags">
268
- <h3>Parameters:</h3>
269
- <ul class="param">
270
-
271
- <li>
272
-
273
- <span class='name'>date</span>
274
-
275
-
276
- <span class='type'>(<tt>DateTime</tt>)</span>
277
-
278
-
279
-
280
- &mdash;
281
- <div class='inline'><p>
282
- the date / time of the event
283
- </p>
284
- </div>
285
-
286
- </li>
287
-
288
- <li>
289
-
290
- <span class='name'>description</span>
291
-
292
-
293
- <span class='type'>(<tt>String</tt>)</span>
294
-
295
-
296
-
297
- &mdash;
298
- <div class='inline'><p>
299
- the event&#8217;s description
300
- </p>
301
- </div>
302
-
303
- </li>
304
-
305
- <li>
306
-
307
- <span class='name'>location</span>
308
-
309
-
310
- <span class='type'>(<tt>String</tt>)</span>
311
-
312
-
313
-
314
- &mdash;
315
- <div class='inline'><p>
316
- where the event took place
317
- </p>
318
- </div>
319
-
320
- </li>
321
-
322
- </ul>
323
-
324
- </div><table class="source_code">
325
- <tr>
326
- <td>
327
- <pre class="lines">
328
-
329
-
330
- 9
331
- 10
332
- 11
333
- 12
334
- 13</pre>
335
- </td>
336
- <td>
337
- <pre class="code"><span class="info file"># File 'lib/trackerific/event.rb', line 9</span>
338
-
339
- <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>
340
- <span class='ivar'>@date</span> <span class='op'>=</span> <span class='id date'>date</span>
341
- <span class='ivar'>@description</span> <span class='op'>=</span> <span class='id description'>description</span>
342
- <span class='ivar'>@location</span> <span class='op'>=</span> <span class='id location'>location</span>
343
- <span class='kw'>end</span></pre>
344
- </td>
345
- </tr>
346
- </table>
347
- </div>
348
-
349
- </div>
350
-
351
-
352
- <div id="instance_method_details" class="method_details_list">
353
- <h2>Instance Method Details</h2>
354
-
355
-
356
- <div class="method_details first">
357
- <p class="signature first" id="date-instance_method">
358
-
359
- - (<tt>DateTime</tt>) <strong>date</strong>
360
-
361
-
362
-
363
- </p><div class="docstring">
364
- <div class="discussion">
365
- <p>
366
- The date and time of the event
367
- </p>
368
-
369
-
370
- </div>
371
- </div>
372
- <div class="tags">
373
-
374
- <div class="examples">
375
- <h3>Examples:</h3>
376
-
377
- <h4><div class='inline'><p>
378
- Get the date of an event
379
- </p>
380
- </div></h4>
381
- <pre class="example code"><span class='id date'>date</span> <span class='op'>=</span> <span class='id details'>details</span><span class='period'>.</span><span class='id events'>events</span><span class='period'>.</span><span class='id first'>first</span><span class='period'>.</span><span class='id date'>date</span></pre>
382
-
383
- </div>
384
- <h3>Returns:</h3>
385
- <ul class="return">
386
-
387
- <li>
388
-
389
-
390
- <span class='type'>(<tt>DateTime</tt>)</span>
391
-
392
-
393
-
394
- </li>
395
-
396
- </ul>
397
-
398
- </div><table class="source_code">
399
- <tr>
400
- <td>
401
- <pre class="lines">
402
-
403
-
404
- 20
405
- 21
406
- 22</pre>
407
- </td>
408
- <td>
409
- <pre class="code"><span class="info file"># File 'lib/trackerific/event.rb', line 20</span>
410
-
411
- <span class='kw'>def</span> <span class='id date'>date</span>
412
- <span class='ivar'>@date</span>
413
- <span class='kw'>end</span></pre>
414
- </td>
415
- </tr>
416
- </table>
417
- </div>
418
-
419
- <div class="method_details ">
420
- <p class="signature " id="description-instance_method">
421
-
422
- - (<tt>String</tt>) <strong>description</strong>
423
-
424
-
425
-
426
- </p><div class="docstring">
427
- <div class="discussion">
428
- <p>
429
- The event&#8217;s description
430
- </p>
431
-
432
-
433
- </div>
434
- </div>
435
- <div class="tags">
436
-
437
- <div class="examples">
438
- <h3>Examples:</h3>
439
-
440
- <h4><div class='inline'><p>
441
- Get the description of an event
442
- </p>
443
- </div></h4>
444
- <pre class="example code"><span class='id description'>description</span> <span class='op'>=</span> <span class='id details'>details</span><span class='period'>.</span><span class='id events'>events</span><span class='period'>.</span><span class='id first'>first</span><span class='period'>.</span><span class='id description'>description</span></pre>
445
-
446
- </div>
447
- <h3>Returns:</h3>
448
- <ul class="return">
449
-
450
- <li>
451
-
452
-
453
- <span class='type'>(<tt>String</tt>)</span>
454
-
455
-
456
-
457
- </li>
458
-
459
- </ul>
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/trackerific/event.rb', line 29</span>
473
-
474
- <span class='kw'>def</span> <span class='id description'>description</span>
475
- <span class='ivar'>@description</span>
476
- <span class='kw'>end</span></pre>
477
- </td>
478
- </tr>
479
- </table>
480
- </div>
481
-
482
- <div class="method_details ">
483
- <p class="signature " id="location-instance_method">
484
-
485
- - (<tt>String</tt>) <strong>location</strong>
486
-
487
-
488
-
489
- </p><div class="docstring">
490
- <div class="discussion">
491
- <p>
492
- Where the event took place (usually in City State Zip format)
493
- </p>
494
-
495
-
496
- </div>
497
- </div>
498
- <div class="tags">
499
-
500
- <div class="examples">
501
- <h3>Examples:</h3>
502
-
503
- <h4><div class='inline'><p>
504
- Get the location of an event
505
- </p>
506
- </div></h4>
507
- <pre class="example code"><span class='id location'>location</span> <span class='op'>=</span> <span class='id details'>details</span><span class='period'>.</span><span class='id events'>events</span><span class='period'>.</span><span class='id first'>first</span><span class='period'>.</span><span class='id location'>location</span></pre>
508
-
509
- </div>
510
- <h3>Returns:</h3>
511
- <ul class="return">
512
-
513
- <li>
514
-
515
-
516
- <span class='type'>(<tt>String</tt>)</span>
517
-
518
-
519
-
520
- </li>
521
-
522
- </ul>
523
-
524
- </div><table class="source_code">
525
- <tr>
526
- <td>
527
- <pre class="lines">
528
-
529
-
530
- 38
531
- 39
532
- 40</pre>
533
- </td>
534
- <td>
535
- <pre class="code"><span class="info file"># File 'lib/trackerific/event.rb', line 38</span>
536
-
537
- <span class='kw'>def</span> <span class='id location'>location</span>
538
- <span class='ivar'>@location</span>
539
- <span class='kw'>end</span></pre>
540
- </td>
541
- </tr>
542
- </table>
543
- </div>
544
-
545
- <div class="method_details ">
546
- <p class="signature " id="to_s-instance_method">
547
-
548
- - (<tt>String</tt>) <strong>to_s</strong>
549
-
550
-
551
-
552
- </p><div class="docstring">
553
- <div class="discussion">
554
- <p>
555
- Converts the event into a string
556
- </p>
557
-
558
-
559
- </div>
560
- </div>
561
- <div class="tags">
562
-
563
- <div class="examples">
564
- <h3>Examples:</h3>
565
-
566
- <h4><div class='inline'><p>
567
- Get a human-readable string from an event
568
- </p>
569
- </div></h4>
570
- <pre class="example code"><span class='id event'>event</span> <span class='op'>=</span> <span class='id details'>details</span><span class='period'>.</span><span class='id event'>event</span><span class='period'>.</span><span class='id to_s'>to_s</span></pre>
571
-
572
- <h4><div class='inline'><p>
573
- A bulleted list of events in haml
574
- </p>
575
- </div></h4>
576
- <pre class="example code">%ul
577
- - details.events.each do |event|
578
- %li= event</pre>
579
-
580
- </div>
581
- <h3>Returns:</h3>
582
- <ul class="return">
583
-
584
- <li>
585
-
586
-
587
- <span class='type'>(<tt>String</tt>)</span>
588
-
589
-
590
-
591
- &mdash;
592
- <div class='inline'><p>
593
- converts the event into a string
594
- </p>
595
- </div>
596
-
597
- </li>
598
-
599
- </ul>
600
-
601
- </div><table class="source_code">
602
- <tr>
603
- <td>
604
- <pre class="lines">
605
-
606
-
607
- 51
608
- 52
609
- 53
610
- 54
611
- 55
612
- 56</pre>
613
- </td>
614
- <td>
615
- <pre class="code"><span class="info file"># File 'lib/trackerific/event.rb', line 51</span>
616
-
617
- <span class='kw'>def</span> <span class='id to_s'>to_s</span>
618
- <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>
619
- <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>
620
- <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>
621
- <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>
622
- <span class='kw'>end</span></pre>
623
- </td>
624
- </tr>
625
- </table>
626
- </div>
627
-
628
- </div>
629
-
630
- </div>
631
-
632
- <div id="footer">
633
- Generated on Wed Jun 15 15:30:26 2011 by
634
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
635
- 0.7.1 (ruby-1.9.2).
636
- </div>
637
-
638
- </body>
639
- </html>