trackerific 0.3.0 → 0.3.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (18) hide show
  1. data/.yardoc/checksums +1 -1
  2. data/.yardoc/objects/root.dat +0 -0
  3. data/README.rdoc +24 -22
  4. data/VERSION +1 -1
  5. data/doc/Trackerific/Base.html +2 -2
  6. data/doc/Trackerific/Details.html +1 -1
  7. data/doc/Trackerific/Error.html +1 -1
  8. data/doc/Trackerific/Event.html +1 -1
  9. data/doc/Trackerific/FedEx.html +1 -1
  10. data/doc/Trackerific/UPS.html +1 -1
  11. data/doc/Trackerific/USPS.html +1 -1
  12. data/doc/Trackerific.html +1 -1
  13. data/doc/_index.html +1 -1
  14. data/doc/file.README.html +29 -27
  15. data/doc/index.html +29 -27
  16. data/doc/top-level-namespace.html +1 -1
  17. data/trackerific.gemspec +1 -1
  18. metadata +3 -3
data/.yardoc/checksums CHANGED
@@ -1,6 +1,6 @@
1
1
  lib/ups.rb 2b98972c48bd4032d5a6cd2017549ce394e8ea0d
2
2
  lib/usps.rb b6e83100cd5225341ce5a61f0ff843440309e063
3
3
  lib/fedex.rb ba42d502349530fe2518303c23d2b8babecd5f2d
4
- lib/trackerific.rb e559eb82a7572089ee2cfd48cbe2ec662d3c4c18
4
+ lib/trackerific.rb 78b145e898c315d3e80aaef686877cb674621fed
5
5
  lib/trackerific_event.rb 21e48404ba7b8b90114ce0d74d38248a637a0452
6
6
  lib/trackerific_details.rb d3c5cc1844259f2889b4d82920b12ad57fe4d412
data/.yardoc/objects/root.dat CHANGED
Binary file
data/README.rdoc CHANGED
@@ -9,40 +9,42 @@ and then run
9
9
 
10
10
  # Track a FedEx package:
11
11
  fedex = Trackerific::FedEx.new :account => '123456789', :meter => '123456789'
12
- tracking_info = fedex.track_package('183689015000001')
12
+ details = fedex.track_package('183689015000001')
13
13
 
14
14
  # Track a USPS package:
15
15
  usps = Trackerific::USPS.new :user_id => '123USERID4567'
16
- tracking_info = usps.track_package('EJ958083578US')
16
+ details = usps.track_package('EJ958083578US')
17
17
 
18
18
  # Track a UPS package:
19
19
  ups = Trackerific::UPS.new :user_id => 'userid', :key => 'kQdEJwuHBjtQ7g2', :password => 'secret'
20
- tracking_info = ups.track_package('1Z12345E0291980793')
20
+ details = ups.track_package('1Z12345E0291980793')
21
21
 
22
- === Tracking Results
22
+ === Tracking Details
23
23
 
24
- The tracking results for all three providers are returned in a Hash in this
25
- format:
24
+ The tracking information is returned in a Trackerific::Details instance.
26
25
 
27
- {
28
- :package_id => 'the package id being tracked',
29
- :summary => 'summary of the tracking results',
30
- :details => ['array containing each tracking status by date']
31
- }
26
+ details.summary # => a summary of the tracking events
27
+ details.events # => an Array of Trackerific::Events
32
28
 
33
- Here's an example of how to print the tracking results out in a readable format:
29
+ You can easily print out the tracking events just by doing:
34
30
 
35
- puts "Tracking information for package ID: %s" % tracking_info[:package_id]
36
- puts tracking_info[:summary]
37
- puts " * %s" % tracking_info[:details].join("\n * ")
38
-
39
- The above code would yield something that looks like this:
31
+ puts details.events # for all the events
32
+ puts details.events.first # for just one event
33
+
34
+ Or, if you need specific information about an event:
35
+
36
+ details.events.last.date # => the date the package was shipped
37
+ details.events.first.date # => the last date the package was updated
38
+ details.events.first.description # => a description of an event
39
+ details.events.first.location # => the location of the package during that event
40
+
41
+ location will not work for USPS packages, because USPS does not provide that
42
+ information seperately from the description. So for USPS packages, the location
43
+ will always be at the end of the description.
40
44
 
41
- Tracking information for package ID: EJ958083578US
42
- Your item was delivered at 8:10 am on June 1 in Wilmington DE 19801.
43
- * May 30 11:07 am NOTICE LEFT WILMINGTON DE 19801.
44
- * May 30 10:08 am ARRIVAL AT UNIT WILMINGTON DE 19850.
45
- * May 29 9:55 am ACCEPT OR PICKUP EDGEWATER NJ 07020.
45
+ Note that events.last will return the first event the tracking provider
46
+ supplied. This is because the events are listed in LIFO order, so the most
47
+ recent events will always be at the top of the list.
46
48
 
47
49
  === Finding a Tracking Service Provider
48
50
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 0.3.0
1
+ 0.3.1
data/doc/Trackerific/Base.html CHANGED
@@ -95,7 +95,7 @@
95
95
  <h2>Overview</h2><div class="docstring">
96
96
  <div class="discussion">
97
97
  <p>
98
- Base class for Trackerific tracking services.
98
+ Base class for Trackerific package tracking services.
99
99
  </p>
100
100
 
101
101
 
@@ -381,7 +381,7 @@ the tracking details
381
381
  </div>
382
382
 
383
383
  <div id="footer">
384
- Generated on Mon Jun 13 13:53:34 2011 by
384
+ Generated on Mon Jun 13 14:22:51 2011 by
385
385
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
386
386
  0.7.1 (ruby-1.9.2).
387
387
  </div>
data/doc/Trackerific/Details.html CHANGED
@@ -505,7 +505,7 @@ a summary of the tracking status
505
505
  </div>
506
506
 
507
507
  <div id="footer">
508
- Generated on Mon Jun 13 13:53:34 2011 by
508
+ Generated on Mon Jun 13 14:22:52 2011 by
509
509
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
510
510
  0.7.1 (ruby-1.9.2).
511
511
  </div>
data/doc/Trackerific/Error.html CHANGED
@@ -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 13:53:34 2011 by
121
+ Generated on Mon Jun 13 14:22:51 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>
data/doc/Trackerific/Event.html CHANGED
@@ -592,7 +592,7 @@ converts the event into a string
592
592
  </div>
593
593
 
594
594
  <div id="footer">
595
- Generated on Mon Jun 13 13:53:34 2011 by
595
+ Generated on Mon Jun 13 14:22:52 2011 by
596
596
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
597
597
  0.7.1 (ruby-1.9.2).
598
598
  </div>
data/doc/Trackerific/FedEx.html CHANGED
@@ -386,7 +386,7 @@ the tracking details
386
386
  </div>
387
387
 
388
388
  <div id="footer">
389
- Generated on Mon Jun 13 13:53:34 2011 by
389
+ Generated on Mon Jun 13 14:22:51 2011 by
390
390
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
391
391
  0.7.1 (ruby-1.9.2).
392
392
  </div>
data/doc/Trackerific/UPS.html CHANGED
@@ -351,7 +351,7 @@ the tracking details
351
351
  </div>
352
352
 
353
353
  <div id="footer">
354
- Generated on Mon Jun 13 13:53:33 2011 by
354
+ Generated on Mon Jun 13 14:22:51 2011 by
355
355
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
356
356
  0.7.1 (ruby-1.9.2).
357
357
  </div>
data/doc/Trackerific/USPS.html CHANGED
@@ -444,7 +444,7 @@ the tracking details
444
444
  </div>
445
445
 
446
446
  <div id="footer">
447
- Generated on Mon Jun 13 13:53:33 2011 by
447
+ Generated on Mon Jun 13 14:22:51 2011 by
448
448
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
449
449
  0.7.1 (ruby-1.9.2).
450
450
  </div>
data/doc/Trackerific.html CHANGED
@@ -249,7 +249,7 @@ found.
249
249
  </div>
250
250
 
251
251
  <div id="footer">
252
- Generated on Mon Jun 13 13:53:33 2011 by
252
+ Generated on Mon Jun 13 14:22:51 2011 by
253
253
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
254
254
  0.7.1 (ruby-1.9.2).
255
255
  </div>
data/doc/_index.html CHANGED
@@ -186,7 +186,7 @@
186
186
  </div>
187
187
 
188
188
  <div id="footer">
189
- Generated on Mon Jun 13 13:53:33 2011 by
189
+ Generated on Mon Jun 13 14:22:51 2011 by
190
190
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
191
191
  0.7.1 (ruby-1.9.2).
192
192
  </div>
data/doc/file.README.html CHANGED
@@ -71,48 +71,50 @@ and then run
71
71
  <pre class="code">
72
72
  <span class='comment'># Track a FedEx package:
73
73
  </span> <span class='id fedex'>fedex</span> <span class='op'>=</span> <span class='const'>Trackerific</span><span class='op'>::</span><span class='const'>FedEx</span><span class='period'>.</span><span class='id new'>new</span> <span class='symbol'>:account</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>123456789</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:meter</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>123456789</span><span class='tstring_end'>'</span></span>
74
- <span class='id tracking_info'>tracking_info</span> <span class='op'>=</span> <span class='id fedex'>fedex</span><span class='period'>.</span><span class='id track_package'>track_package</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>183689015000001</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
74
+ <span class='id details'>details</span> <span class='op'>=</span> <span class='id fedex'>fedex</span><span class='period'>.</span><span class='id track_package'>track_package</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>183689015000001</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
75
75
 
76
76
  <span class='comment'># Track a USPS package:
77
77
  </span> <span class='id usps'>usps</span> <span class='op'>=</span> <span class='const'>Trackerific</span><span class='op'>::</span><span class='const'>USPS</span><span class='period'>.</span><span class='id new'>new</span> <span class='symbol'>:user_id</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>123USERID4567</span><span class='tstring_end'>'</span></span>
78
- <span class='id tracking_info'>tracking_info</span> <span class='op'>=</span> <span class='id usps'>usps</span><span class='period'>.</span><span class='id track_package'>track_package</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>EJ958083578US</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
78
+ <span class='id details'>details</span> <span class='op'>=</span> <span class='id usps'>usps</span><span class='period'>.</span><span class='id track_package'>track_package</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>EJ958083578US</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
79
79
 
80
80
  <span class='comment'># Track a UPS package:
81
81
  </span> <span class='id ups'>ups</span> <span class='op'>=</span> <span class='const'>Trackerific</span><span class='op'>::</span><span class='const'>UPS</span><span class='period'>.</span><span class='id new'>new</span> <span class='symbol'>:user_id</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>userid</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:key</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>kQdEJwuHBjtQ7g2</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:password</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>secret</span><span class='tstring_end'>'</span></span>
82
- <span class='id tracking_info'>tracking_info</span> <span class='op'>=</span> <span class='id ups'>ups</span><span class='period'>.</span><span class='id track_package'>track_package</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>1Z12345E0291980793</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
82
+ <span class='id details'>details</span> <span class='op'>=</span> <span class='id ups'>ups</span><span class='period'>.</span><span class='id track_package'>track_package</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>1Z12345E0291980793</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
83
83
  </pre>
84
- <h3>Tracking Results</h3>
84
+ <h3>Tracking Details</h3>
85
85
  <p>
86
- The tracking results for all three providers are returned in a Hash in this
87
- format:
86
+ The tracking information is returned in a Trackerific::Details instance.
88
87
  </p>
89
88
  <pre class="code">
90
- <span class='lbrace'>{</span>
91
- <span class='symbol'>:package_id</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>the package id being tracked</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
92
- <span class='symbol'>:summary</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>summary of the tracking results</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
93
- <span class='symbol'>:details</span> <span class='op'>=&gt;</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>array containing each tracking status by date</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
94
- <span class='rbrace'>}</span>
95
- </pre>
89
+ <span class='id details'>details</span><span class='period'>.</span><span class='id summary'>summary</span> <span class='comment'># =&gt; a summary of the tracking events
90
+ </span> <span class='id details'>details</span><span class='period'>.</span><span class='id events'>events</span> <span class='comment'># =&gt; an Array of Trackerific::Events
91
+ </span></pre>
96
92
  <p>
97
- Here&#8217;s an example of how to print the tracking results out in a
98
- readable format:
93
+ You can easily print out the tracking events just by doing:
99
94
  </p>
100
95
  <pre class="code">
101
- <span class='id puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Tracking information for package ID: %s</span><span class='tstring_end'>&quot;</span></span> <span class='op'>%</span> <span class='id tracking_info'>tracking_info</span><span class='lbracket'>[</span><span class='symbol'>:package_id</span><span class='rbracket'>]</span>
102
- <span class='id puts'>puts</span> <span class='id tracking_info'>tracking_info</span><span class='lbracket'>[</span><span class='symbol'>:summary</span><span class='rbracket'>]</span>
103
- <span class='id puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'> * %s</span><span class='tstring_end'>&quot;</span></span> <span class='op'>%</span> <span class='id tracking_info'>tracking_info</span><span class='lbracket'>[</span><span class='symbol'>:details</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n * </span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
104
-
105
- </pre>
96
+ <span class='id puts'>puts</span> <span class='id details'>details</span><span class='period'>.</span><span class='id events'>events</span> <span class='comment'># for all the events
97
+ </span> <span class='id puts'>puts</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='comment'># for just one event
98
+ </span></pre>
106
99
  <p>
107
- The above code would yield something that looks like this:
100
+ Or, if you need specific information about an event:
108
101
  </p>
109
102
  <pre class="code">
110
- Tracking information for package ID: EJ958083578US
111
- Your item was delivered at 8:10 am on June 1 in Wilmington DE 19801.
112
- * May 30 11:07 am NOTICE LEFT WILMINGTON DE 19801.
113
- * May 30 10:08 am ARRIVAL AT UNIT WILMINGTON DE 19850.
114
- * May 29 9:55 am ACCEPT OR PICKUP EDGEWATER NJ 07020.
115
- </pre>
103
+ <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; the date the package was shipped
104
+ </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> <span class='comment'># =&gt; the last date the package was updated
105
+ </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> <span class='comment'># =&gt; a description of an event
106
+ </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> <span class='comment'># =&gt; the location of the package during that event
107
+ </span></pre>
108
+ <p>
109
+ location will not work for USPS packages, because USPS does not provide
110
+ that information seperately from the description. So for USPS packages, the
111
+ location will always be at the end of the description.
112
+ </p>
113
+ <p>
114
+ Note that events.last will return the first event the tracking provider
115
+ supplied. This is because the events are listed in LIFO order, so the most
116
+ recent events will always be at the top of the list.
117
+ </p>
116
118
  <h3>Finding a Tracking Service Provider</h3>
117
119
  <p>
118
120
  If you do not know the tracking service provider of a package id, you can
@@ -204,7 +206,7 @@ Copyright &#169; 2011 Travis Haynes. See LICENSE.txt for further details.
204
206
  </div></div>
205
207
 
206
208
  <div id="footer">
207
- Generated on Mon Jun 13 13:53:33 2011 by
209
+ Generated on Mon Jun 13 14:22:51 2011 by
208
210
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
209
211
  0.7.1 (ruby-1.9.2).
210
212
  </div>
data/doc/index.html CHANGED
@@ -71,48 +71,50 @@ and then run
71
71
  <pre class="code">
72
72
  <span class='comment'># Track a FedEx package:
73
73
  </span> <span class='id fedex'>fedex</span> <span class='op'>=</span> <span class='const'>Trackerific</span><span class='op'>::</span><span class='const'>FedEx</span><span class='period'>.</span><span class='id new'>new</span> <span class='symbol'>:account</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>123456789</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:meter</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>123456789</span><span class='tstring_end'>'</span></span>
74
- <span class='id tracking_info'>tracking_info</span> <span class='op'>=</span> <span class='id fedex'>fedex</span><span class='period'>.</span><span class='id track_package'>track_package</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>183689015000001</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
74
+ <span class='id details'>details</span> <span class='op'>=</span> <span class='id fedex'>fedex</span><span class='period'>.</span><span class='id track_package'>track_package</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>183689015000001</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
75
75
 
76
76
  <span class='comment'># Track a USPS package:
77
77
  </span> <span class='id usps'>usps</span> <span class='op'>=</span> <span class='const'>Trackerific</span><span class='op'>::</span><span class='const'>USPS</span><span class='period'>.</span><span class='id new'>new</span> <span class='symbol'>:user_id</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>123USERID4567</span><span class='tstring_end'>'</span></span>
78
- <span class='id tracking_info'>tracking_info</span> <span class='op'>=</span> <span class='id usps'>usps</span><span class='period'>.</span><span class='id track_package'>track_package</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>EJ958083578US</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
78
+ <span class='id details'>details</span> <span class='op'>=</span> <span class='id usps'>usps</span><span class='period'>.</span><span class='id track_package'>track_package</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>EJ958083578US</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
79
79
 
80
80
  <span class='comment'># Track a UPS package:
81
81
  </span> <span class='id ups'>ups</span> <span class='op'>=</span> <span class='const'>Trackerific</span><span class='op'>::</span><span class='const'>UPS</span><span class='period'>.</span><span class='id new'>new</span> <span class='symbol'>:user_id</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>userid</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:key</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>kQdEJwuHBjtQ7g2</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:password</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>secret</span><span class='tstring_end'>'</span></span>
82
- <span class='id tracking_info'>tracking_info</span> <span class='op'>=</span> <span class='id ups'>ups</span><span class='period'>.</span><span class='id track_package'>track_package</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>1Z12345E0291980793</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
82
+ <span class='id details'>details</span> <span class='op'>=</span> <span class='id ups'>ups</span><span class='period'>.</span><span class='id track_package'>track_package</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>1Z12345E0291980793</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
83
83
  </pre>
84
- <h3>Tracking Results</h3>
84
+ <h3>Tracking Details</h3>
85
85
  <p>
86
- The tracking results for all three providers are returned in a Hash in this
87
- format:
86
+ The tracking information is returned in a Trackerific::Details instance.
88
87
  </p>
89
88
  <pre class="code">
90
- <span class='lbrace'>{</span>
91
- <span class='symbol'>:package_id</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>the package id being tracked</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
92
- <span class='symbol'>:summary</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>summary of the tracking results</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
93
- <span class='symbol'>:details</span> <span class='op'>=&gt;</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>array containing each tracking status by date</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
94
- <span class='rbrace'>}</span>
95
- </pre>
89
+ <span class='id details'>details</span><span class='period'>.</span><span class='id summary'>summary</span> <span class='comment'># =&gt; a summary of the tracking events
90
+ </span> <span class='id details'>details</span><span class='period'>.</span><span class='id events'>events</span> <span class='comment'># =&gt; an Array of Trackerific::Events
91
+ </span></pre>
96
92
  <p>
97
- Here&#8217;s an example of how to print the tracking results out in a
98
- readable format:
93
+ You can easily print out the tracking events just by doing:
99
94
  </p>
100
95
  <pre class="code">
101
- <span class='id puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Tracking information for package ID: %s</span><span class='tstring_end'>&quot;</span></span> <span class='op'>%</span> <span class='id tracking_info'>tracking_info</span><span class='lbracket'>[</span><span class='symbol'>:package_id</span><span class='rbracket'>]</span>
102
- <span class='id puts'>puts</span> <span class='id tracking_info'>tracking_info</span><span class='lbracket'>[</span><span class='symbol'>:summary</span><span class='rbracket'>]</span>
103
- <span class='id puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'> * %s</span><span class='tstring_end'>&quot;</span></span> <span class='op'>%</span> <span class='id tracking_info'>tracking_info</span><span class='lbracket'>[</span><span class='symbol'>:details</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n * </span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
104
-
105
- </pre>
96
+ <span class='id puts'>puts</span> <span class='id details'>details</span><span class='period'>.</span><span class='id events'>events</span> <span class='comment'># for all the events
97
+ </span> <span class='id puts'>puts</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='comment'># for just one event
98
+ </span></pre>
106
99
  <p>
107
- The above code would yield something that looks like this:
100
+ Or, if you need specific information about an event:
108
101
  </p>
109
102
  <pre class="code">
110
- Tracking information for package ID: EJ958083578US
111
- Your item was delivered at 8:10 am on June 1 in Wilmington DE 19801.
112
- * May 30 11:07 am NOTICE LEFT WILMINGTON DE 19801.
113
- * May 30 10:08 am ARRIVAL AT UNIT WILMINGTON DE 19850.
114
- * May 29 9:55 am ACCEPT OR PICKUP EDGEWATER NJ 07020.
115
- </pre>
103
+ <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; the date the package was shipped
104
+ </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> <span class='comment'># =&gt; the last date the package was updated
105
+ </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> <span class='comment'># =&gt; a description of an event
106
+ </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> <span class='comment'># =&gt; the location of the package during that event
107
+ </span></pre>
108
+ <p>
109
+ location will not work for USPS packages, because USPS does not provide
110
+ that information seperately from the description. So for USPS packages, the
111
+ location will always be at the end of the description.
112
+ </p>
113
+ <p>
114
+ Note that events.last will return the first event the tracking provider
115
+ supplied. This is because the events are listed in LIFO order, so the most
116
+ recent events will always be at the top of the list.
117
+ </p>
116
118
  <h3>Finding a Tracking Service Provider</h3>
117
119
  <p>
118
120
  If you do not know the tracking service provider of a package id, you can
@@ -204,7 +206,7 @@ Copyright &#169; 2011 Travis Haynes. See LICENSE.txt for further details.
204
206
  </div></div>
205
207
 
206
208
  <div id="footer">
207
- Generated on Mon Jun 13 13:53:33 2011 by
209
+ Generated on Mon Jun 13 14:22:51 2011 by
208
210
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
209
211
  0.7.1 (ruby-1.9.2).
210
212
  </div>
data/doc/top-level-namespace.html CHANGED
@@ -94,7 +94,7 @@
94
94
  </div>
95
95
 
96
96
  <div id="footer">
97
- Generated on Mon Jun 13 13:53:34 2011 by
97
+ Generated on Mon Jun 13 14:22:52 2011 by
98
98
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
99
99
  0.7.1 (ruby-1.9.2).
100
100
  </div>
data/trackerific.gemspec CHANGED
@@ -5,7 +5,7 @@
5
5
 
6
6
  Gem::Specification.new do |s|
7
7
  s.name = %q{trackerific}
8
- s.version = "0.3.0"
8
+ s.version = "0.3.1"
9
9
 
10
10
  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
11
11
  s.authors = ["Travis Haynes"]
metadata CHANGED
@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
5
5
  segments:
6
6
  - 0
7
7
  - 3
8
- - 0
9
- version: 0.3.0
8
+ - 1
9
+ version: 0.3.1
10
10
  platform: ruby
11
11
  authors:
12
12
  - Travis Haynes
@@ -198,7 +198,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
198
198
  requirements:
199
199
  - - ">="
200
200
  - !ruby/object:Gem::Version
201
- hash: -883111149
201
+ hash: -53613295
202
202
  segments:
203
203
  - 0
204
204
  version: "0"