trackerific 0.3.2 → 0.3.3

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 (36) hide show
  1. data/Gemfile +1 -0
  2. data/Gemfile.lock +40 -38
  3. data/README.rdoc +4 -9
  4. data/VERSION +1 -1
  5. data/doc/Trackerific.html +34 -22
  6. data/doc/Trackerific/Base.html +237 -20
  7. data/doc/Trackerific/Details.html +6 -6
  8. data/doc/Trackerific/Error.html +2 -2
  9. data/doc/Trackerific/Event.html +7 -7
  10. data/doc/Trackerific/FedEx.html +190 -3
  11. data/doc/Trackerific/UPS.html +190 -3
  12. data/doc/Trackerific/USPS.html +190 -3
  13. data/doc/_index.html +1 -1
  14. data/doc/file.README.html +6 -24
  15. data/doc/index.html +6 -24
  16. data/doc/method_list.html +68 -4
  17. data/doc/top-level-namespace.html +1 -1
  18. data/lib/trackerific.rb +37 -74
  19. data/lib/trackerific/base.rb +70 -0
  20. data/lib/{trackerific_details.rb → trackerific/details.rb} +0 -0
  21. data/lib/trackerific/error.rb +4 -0
  22. data/lib/{trackerific_event.rb → trackerific/event.rb} +0 -0
  23. data/lib/{fedex.rb → trackerific/services/fedex.rb} +9 -2
  24. data/lib/{ups.rb → trackerific/services/ups.rb} +10 -4
  25. data/lib/{usps.rb → trackerific/services/usps.rb} +10 -3
  26. data/spec/lib/trackerific/base_spec.rb +34 -0
  27. data/spec/lib/{trackerific_details_spec.rb → trackerific/details_spec.rb} +0 -0
  28. data/spec/lib/trackerific/error_spec.rb +5 -0
  29. data/spec/lib/{trackerific_event_spec.rb → trackerific/event_spec.rb} +0 -0
  30. data/spec/lib/{fedex_spec.rb → trackerific/services/fedex_spec.rb} +19 -14
  31. data/spec/lib/{ups_spec.rb → trackerific/services/ups_spec.rb} +20 -14
  32. data/spec/lib/{usps_spec.rb → trackerific/services/usps_spec.rb} +18 -14
  33. data/spec/lib/trackerific_spec.rb +7 -30
  34. data/spec/spec_helper.rb +1 -0
  35. data/trackerific.gemspec +18 -22
  36. metadata +38 -27
@@ -87,7 +87,7 @@
87
87
 
88
88
 
89
89
  <dt class="r2 last">Defined in:</dt>
90
- <dd class="r2 last">lib/trackerific_details.rb</dd>
90
+ <dd class="r2 last">lib/trackerific/details.rb</dd>
91
91
 
92
92
  </dl>
93
93
  <div class="clear"></div>
@@ -311,7 +311,7 @@ the tracking events
311
311
  14</pre>
312
312
  </td>
313
313
  <td>
314
- <pre class="code"><span class="info file"># File 'lib/trackerific_details.rb', line 10</span>
314
+ <pre class="code"><span class="info file"># File 'lib/trackerific/details.rb', line 10</span>
315
315
 
316
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
317
  <span class='ivar'>@package_id</span> <span class='op'>=</span> <span class='id package_id'>package_id</span>
@@ -403,7 +403,7 @@ the tracking events
403
403
  47</pre>
404
404
  </td>
405
405
  <td>
406
- <pre class="code"><span class="info file"># File 'lib/trackerific_details.rb', line 45</span>
406
+ <pre class="code"><span class="info file"># File 'lib/trackerific/details.rb', line 45</span>
407
407
 
408
408
  <span class='kw'>def</span> <span class='id events'>events</span>
409
409
  <span class='ivar'>@events</span>
@@ -472,7 +472,7 @@ the package identifier
472
472
  23</pre>
473
473
  </td>
474
474
  <td>
475
- <pre class="code"><span class="info file"># File 'lib/trackerific_details.rb', line 21</span>
475
+ <pre class="code"><span class="info file"># File 'lib/trackerific/details.rb', line 21</span>
476
476
 
477
477
  <span class='kw'>def</span> <span class='id package_id'>package_id</span>
478
478
  <span class='ivar'>@package_id</span>
@@ -541,7 +541,7 @@ a summary of the tracking status
541
541
  32</pre>
542
542
  </td>
543
543
  <td>
544
- <pre class="code"><span class="info file"># File 'lib/trackerific_details.rb', line 30</span>
544
+ <pre class="code"><span class="info file"># File 'lib/trackerific/details.rb', line 30</span>
545
545
 
546
546
  <span class='kw'>def</span> <span class='id summary'>summary</span>
547
547
  <span class='ivar'>@summary</span>
@@ -556,7 +556,7 @@ a summary of the tracking status
556
556
  </div>
557
557
 
558
558
  <div id="footer">
559
- Generated on Mon Jun 13 16:20:06 2011 by
559
+ Generated on Mon Jun 13 21:28:36 2011 by
560
560
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
561
561
  0.7.1 (ruby-1.9.2).
562
562
  </div>
@@ -89,7 +89,7 @@
89
89
 
90
90
 
91
91
  <dt class="r2 last">Defined in:</dt>
92
- <dd class="r2 last">lib/trackerific.rb</dd>
92
+ <dd class="r2 last">lib/trackerific/error.rb</dd>
93
93
 
94
94
  </dl>
95
95
  <div class="clear"></div>
@@ -118,7 +118,7 @@ Raised if something other than tracking information is returned.
118
118
  </div>
119
119
 
120
120
  <div id="footer">
121
- Generated on Mon Jun 13 16:20:06 2011 by
121
+ Generated on Mon Jun 13 21:28:36 2011 by
122
122
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
123
123
  0.7.1 (ruby-1.9.2).
124
124
  </div>
@@ -87,7 +87,7 @@
87
87
 
88
88
 
89
89
  <dt class="r2 last">Defined in:</dt>
90
- <dd class="r2 last">lib/trackerific_event.rb</dd>
90
+ <dd class="r2 last">lib/trackerific/event.rb</dd>
91
91
 
92
92
  </dl>
93
93
  <div class="clear"></div>
@@ -334,7 +334,7 @@ where the event took place
334
334
  13</pre>
335
335
  </td>
336
336
  <td>
337
- <pre class="code"><span class="info file"># File 'lib/trackerific_event.rb', line 9</span>
337
+ <pre class="code"><span class="info file"># File 'lib/trackerific/event.rb', line 9</span>
338
338
 
339
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
340
  <span class='ivar'>@date</span> <span class='op'>=</span> <span class='id date'>date</span>
@@ -406,7 +406,7 @@ Get the date of an event
406
406
  22</pre>
407
407
  </td>
408
408
  <td>
409
- <pre class="code"><span class="info file"># File 'lib/trackerific_event.rb', line 20</span>
409
+ <pre class="code"><span class="info file"># File 'lib/trackerific/event.rb', line 20</span>
410
410
 
411
411
  <span class='kw'>def</span> <span class='id date'>date</span>
412
412
  <span class='ivar'>@date</span>
@@ -469,7 +469,7 @@ Get the description of an event
469
469
  31</pre>
470
470
  </td>
471
471
  <td>
472
- <pre class="code"><span class="info file"># File 'lib/trackerific_event.rb', line 29</span>
472
+ <pre class="code"><span class="info file"># File 'lib/trackerific/event.rb', line 29</span>
473
473
 
474
474
  <span class='kw'>def</span> <span class='id description'>description</span>
475
475
  <span class='ivar'>@description</span>
@@ -532,7 +532,7 @@ Get the location of an event
532
532
  40</pre>
533
533
  </td>
534
534
  <td>
535
- <pre class="code"><span class="info file"># File 'lib/trackerific_event.rb', line 38</span>
535
+ <pre class="code"><span class="info file"># File 'lib/trackerific/event.rb', line 38</span>
536
536
 
537
537
  <span class='kw'>def</span> <span class='id location'>location</span>
538
538
  <span class='ivar'>@location</span>
@@ -612,7 +612,7 @@ converts the event into a string
612
612
  56</pre>
613
613
  </td>
614
614
  <td>
615
- <pre class="code"><span class="info file"># File 'lib/trackerific_event.rb', line 51</span>
615
+ <pre class="code"><span class="info file"># File 'lib/trackerific/event.rb', line 51</span>
616
616
 
617
617
  <span class='kw'>def</span> <span class='id to_s'>to_s</span>
618
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>
@@ -630,7 +630,7 @@ converts the event into a string
630
630
  </div>
631
631
 
632
632
  <div id="footer">
633
- Generated on Mon Jun 13 16:20:06 2011 by
633
+ Generated on Mon Jun 13 21:28:36 2011 by
634
634
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
635
635
  0.7.1 (ruby-1.9.2).
636
636
  </div>
@@ -93,7 +93,7 @@
93
93
 
94
94
 
95
95
  <dt class="r1 last">Defined in:</dt>
96
- <dd class="r1 last">lib/fedex.rb</dd>
96
+ <dd class="r1 last">lib/trackerific/services/fedex.rb</dd>
97
97
 
98
98
  </dl>
99
99
  <div class="clear"></div>
@@ -124,6 +124,63 @@ Provides package tracking support for FedEx
124
124
 
125
125
 
126
126
 
127
+ <h2>
128
+ Class Method Summary
129
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
130
+ </h2>
131
+
132
+ <ul class="summary">
133
+
134
+ <li class="public ">
135
+ <span class="summary_signature">
136
+
137
+ <a href="#package_id_matchers-class_method" title="package_id_matchers (class method)">+ (Regexp) <strong>package_id_matchers</strong> </a>
138
+
139
+
140
+
141
+ </span>
142
+
143
+
144
+
145
+
146
+
147
+ <span class="private note title">Private</span>
148
+
149
+
150
+ <span class="summary_desc"><div class='inline'><p>
151
+ A regex that matches valid package identifiers for FedEx package ids.
152
+ </p>
153
+ </div></span>
154
+
155
+ </li>
156
+
157
+
158
+ <li class="public ">
159
+ <span class="summary_signature">
160
+
161
+ <a href="#required_options-class_method" title="required_options (class method)">+ (Array) <strong>required_options</strong> </a>
162
+
163
+
164
+
165
+ </span>
166
+
167
+
168
+
169
+
170
+
171
+ <span class="private note title">Private</span>
172
+
173
+
174
+ <span class="summary_desc"><div class='inline'><p>
175
+ Returns an Array of required options used when creating a new instance.
176
+ </p>
177
+ </div></span>
178
+
179
+ </li>
180
+
181
+
182
+ </ul>
183
+
127
184
  <h2>
128
185
  Instance Method Summary
129
186
  <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
@@ -177,6 +234,136 @@ Tracks a FedEx package.
177
234
  </div>
178
235
 
179
236
 
237
+ <div id="class_method_details" class="method_details_list">
238
+ <h2>Class Method Details</h2>
239
+
240
+
241
+ <div class="method_details first">
242
+ <p class="signature first" id="package_id_matchers-class_method">
243
+
244
+ + (<tt>Regexp</tt>) <strong>package_id_matchers</strong>
245
+
246
+
247
+
248
+ </p><div class="docstring">
249
+ <div class="discussion">
250
+ <p class="note private">
251
+ <strong>This method is part of a private API.</strong>
252
+ You should avoid using this method if possible, as it may be removed or be changed in the future.
253
+ </p>
254
+ <p>
255
+ A regex that matches valid package identifiers for FedEx package ids
256
+ </p>
257
+
258
+
259
+ </div>
260
+ </div>
261
+ <div class="tags">
262
+ <h3>Returns:</h3>
263
+ <ul class="return">
264
+
265
+ <li>
266
+
267
+
268
+ <span class='type'>(<tt>Regexp</tt>)</span>
269
+
270
+
271
+
272
+ &mdash;
273
+ <div class='inline'><p>
274
+ the regular expression
275
+ </p>
276
+ </div>
277
+
278
+ </li>
279
+
280
+ </ul>
281
+
282
+ </div><table class="source_code">
283
+ <tr>
284
+ <td>
285
+ <pre class="lines">
286
+
287
+
288
+ 51
289
+ 52
290
+ 53</pre>
291
+ </td>
292
+ <td>
293
+ <pre class="code"><span class="info file"># File 'lib/trackerific/services/fedex.rb', line 51</span>
294
+
295
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id package_id_matchers'>package_id_matchers</span>
296
+ <span class='lbracket'>[</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^[0-9]{15}$</span><span class='regexp_end'>/</span></span> <span class='rbracket'>]</span>
297
+ <span class='kw'>end</span></pre>
298
+ </td>
299
+ </tr>
300
+ </table>
301
+ </div>
302
+
303
+ <div class="method_details ">
304
+ <p class="signature " id="required_options-class_method">
305
+
306
+ + (<tt>Array</tt>) <strong>required_options</strong>
307
+
308
+
309
+
310
+ </p><div class="docstring">
311
+ <div class="discussion">
312
+ <p class="note private">
313
+ <strong>This method is part of a private API.</strong>
314
+ You should avoid using this method if possible, as it may be removed or be changed in the future.
315
+ </p>
316
+ <p>
317
+ Returns an Array of required options used when creating a new instance
318
+ </p>
319
+
320
+
321
+ </div>
322
+ </div>
323
+ <div class="tags">
324
+ <h3>Returns:</h3>
325
+ <ul class="return">
326
+
327
+ <li>
328
+
329
+
330
+ <span class='type'>(<tt>Array</tt>)</span>
331
+
332
+
333
+
334
+ &mdash;
335
+ <div class='inline'><p>
336
+ required options for tracking a FedEx package are :account and :meter
337
+ </p>
338
+ </div>
339
+
340
+ </li>
341
+
342
+ </ul>
343
+
344
+ </div><table class="source_code">
345
+ <tr>
346
+ <td>
347
+ <pre class="lines">
348
+
349
+
350
+ 59
351
+ 60
352
+ 61</pre>
353
+ </td>
354
+ <td>
355
+ <pre class="code"><span class="info file"># File 'lib/trackerific/services/fedex.rb', line 59</span>
356
+
357
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id required_options'>required_options</span>
358
+ <span class='lbracket'>[</span><span class='symbol'>:account</span><span class='comma'>,</span> <span class='symbol'>:meter</span><span class='rbracket'>]</span>
359
+ <span class='kw'>end</span></pre>
360
+ </td>
361
+ </tr>
362
+ </table>
363
+ </div>
364
+
365
+ </div>
366
+
180
367
  <div id="instance_method_details" class="method_details_list">
181
368
  <h2>Instance Method Details</h2>
182
369
 
@@ -306,7 +493,7 @@ package, etc.)
306
493
  46</pre>
307
494
  </td>
308
495
  <td>
309
- <pre class="code"><span class="info file"># File 'lib/fedex.rb', line 20</span>
496
+ <pre class="code"><span class="info file"># File 'lib/trackerific/services/fedex.rb', line 20</span>
310
497
 
311
498
  <span class='kw'>def</span> <span class='id track_package'>track_package</span><span class='lparen'>(</span><span class='id package_id'>package_id</span><span class='rparen'>)</span>
312
499
  <span class='kw'>super</span>
@@ -345,7 +532,7 @@ package, etc.)
345
532
  </div>
346
533
 
347
534
  <div id="footer">
348
- Generated on Mon Jun 13 16:20:06 2011 by
535
+ Generated on Mon Jun 13 21:28:36 2011 by
349
536
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
350
537
  0.7.1 (ruby-1.9.2).
351
538
  </div>
@@ -93,7 +93,7 @@
93
93
 
94
94
 
95
95
  <dt class="r1 last">Defined in:</dt>
96
- <dd class="r1 last">lib/ups.rb</dd>
96
+ <dd class="r1 last">lib/trackerific/services/ups.rb</dd>
97
97
 
98
98
  </dl>
99
99
  <div class="clear"></div>
@@ -124,6 +124,63 @@ Provides package tracking support for UPS.
124
124
 
125
125
 
126
126
 
127
+ <h2>
128
+ Class Method Summary
129
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
130
+ </h2>
131
+
132
+ <ul class="summary">
133
+
134
+ <li class="public ">
135
+ <span class="summary_signature">
136
+
137
+ <a href="#package_id_matchers-class_method" title="package_id_matchers (class method)">+ (Regexp) <strong>package_id_matchers</strong> </a>
138
+
139
+
140
+
141
+ </span>
142
+
143
+
144
+
145
+
146
+
147
+ <span class="private note title">Private</span>
148
+
149
+
150
+ <span class="summary_desc"><div class='inline'><p>
151
+ A regex that matches valid package identifiers for UPS package ids.
152
+ </p>
153
+ </div></span>
154
+
155
+ </li>
156
+
157
+
158
+ <li class="public ">
159
+ <span class="summary_signature">
160
+
161
+ <a href="#required_options-class_method" title="required_options (class method)">+ (Array) <strong>required_options</strong> </a>
162
+
163
+
164
+
165
+ </span>
166
+
167
+
168
+
169
+
170
+
171
+ <span class="private note title">Private</span>
172
+
173
+
174
+ <span class="summary_desc"><div class='inline'><p>
175
+ The required options for tracking a UPS package.
176
+ </p>
177
+ </div></span>
178
+
179
+ </li>
180
+
181
+
182
+ </ul>
183
+
127
184
  <h2>
128
185
  Instance Method Summary
129
186
  <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
@@ -177,6 +234,136 @@ Tracks a UPS package.
177
234
  </div>
178
235
 
179
236
 
237
+ <div id="class_method_details" class="method_details_list">
238
+ <h2>Class Method Details</h2>
239
+
240
+
241
+ <div class="method_details first">
242
+ <p class="signature first" id="package_id_matchers-class_method">
243
+
244
+ + (<tt>Regexp</tt>) <strong>package_id_matchers</strong>
245
+
246
+
247
+
248
+ </p><div class="docstring">
249
+ <div class="discussion">
250
+ <p class="note private">
251
+ <strong>This method is part of a private API.</strong>
252
+ You should avoid using this method if possible, as it may be removed or be changed in the future.
253
+ </p>
254
+ <p>
255
+ A regex that matches valid package identifiers for UPS package ids
256
+ </p>
257
+
258
+
259
+ </div>
260
+ </div>
261
+ <div class="tags">
262
+ <h3>Returns:</h3>
263
+ <ul class="return">
264
+
265
+ <li>
266
+
267
+
268
+ <span class='type'>(<tt>Regexp</tt>)</span>
269
+
270
+
271
+
272
+ &mdash;
273
+ <div class='inline'><p>
274
+ the regular expression
275
+ </p>
276
+ </div>
277
+
278
+ </li>
279
+
280
+ </ul>
281
+
282
+ </div><table class="source_code">
283
+ <tr>
284
+ <td>
285
+ <pre class="lines">
286
+
287
+
288
+ 43
289
+ 44
290
+ 45</pre>
291
+ </td>
292
+ <td>
293
+ <pre class="code"><span class="info file"># File 'lib/trackerific/services/ups.rb', line 43</span>
294
+
295
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id package_id_matchers'>package_id_matchers</span>
296
+ <span class='lbracket'>[</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^.Z</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^[HK].{10}$</span><span class='regexp_end'>/</span></span> <span class='rbracket'>]</span>
297
+ <span class='kw'>end</span></pre>
298
+ </td>
299
+ </tr>
300
+ </table>
301
+ </div>
302
+
303
+ <div class="method_details ">
304
+ <p class="signature " id="required_options-class_method">
305
+
306
+ + (<tt>Array</tt>) <strong>required_options</strong>
307
+
308
+
309
+
310
+ </p><div class="docstring">
311
+ <div class="discussion">
312
+ <p class="note private">
313
+ <strong>This method is part of a private API.</strong>
314
+ You should avoid using this method if possible, as it may be removed or be changed in the future.
315
+ </p>
316
+ <p>
317
+ The required options for tracking a UPS package
318
+ </p>
319
+
320
+
321
+ </div>
322
+ </div>
323
+ <div class="tags">
324
+ <h3>Returns:</h3>
325
+ <ul class="return">
326
+
327
+ <li>
328
+
329
+
330
+ <span class='type'>(<tt>Array</tt>)</span>
331
+
332
+
333
+
334
+ &mdash;
335
+ <div class='inline'><p>
336
+ the required options for tracking a UPS package
337
+ </p>
338
+ </div>
339
+
340
+ </li>
341
+
342
+ </ul>
343
+
344
+ </div><table class="source_code">
345
+ <tr>
346
+ <td>
347
+ <pre class="lines">
348
+
349
+
350
+ 49
351
+ 50
352
+ 51</pre>
353
+ </td>
354
+ <td>
355
+ <pre class="code"><span class="info file"># File 'lib/trackerific/services/ups.rb', line 49</span>
356
+
357
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id required_options'>required_options</span>
358
+ <span class='lbracket'>[</span><span class='symbol'>:key</span><span class='comma'>,</span> <span class='symbol'>:user_id</span><span class='comma'>,</span> <span class='symbol'>:password</span><span class='rbracket'>]</span>
359
+ <span class='kw'>end</span></pre>
360
+ </td>
361
+ </tr>
362
+ </table>
363
+ </div>
364
+
365
+ </div>
366
+
180
367
  <div id="instance_method_details" class="method_details_list">
181
368
  <h2>Instance Method Details</h2>
182
369
 
@@ -293,7 +480,7 @@ package, etc.)
293
480
  38</pre>
294
481
  </td>
295
482
  <td>
296
- <pre class="code"><span class="info file"># File 'lib/ups.rb', line 25</span>
483
+ <pre class="code"><span class="info file"># File 'lib/trackerific/services/ups.rb', line 25</span>
297
484
 
298
485
  <span class='kw'>def</span> <span class='id track_package'>track_package</span><span class='lparen'>(</span><span class='id package_id'>package_id</span><span class='rparen'>)</span>
299
486
  <span class='kw'>super</span>
@@ -319,7 +506,7 @@ package, etc.)
319
506
  </div>
320
507
 
321
508
  <div id="footer">
322
- Generated on Mon Jun 13 16:20:05 2011 by
509
+ Generated on Mon Jun 13 21:28:36 2011 by
323
510
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
324
511
  0.7.1 (ruby-1.9.2).
325
512
  </div>