trackerific 0.3.1 → 0.3.2

data/doc/Trackerific/Error.html

@@ -118,7 +118,7 @@ Raised if something other than tracking information is returned.
 </div>
     
     <div id="footer">
-  Generated on Mon Jun 13 14:22:51 2011 by 
+  Generated on Mon Jun 13 16:20:06 2011 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.7.1 (ruby-1.9.2).
 </div>

data/doc/Trackerific/Event.html

@@ -119,7 +119,7 @@ Provides details for a tracking event
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#date-instance_method" title="#date (instance method)">- (Time) <strong>date</strong> </a>
+      <a href="#date-instance_method" title="#date (instance method)">- (DateTime) <strong>date</strong> </a>
     
 
     
@@ -133,7 +133,7 @@ Provides details for a tracking event
 
   
     <span class="summary_desc"><div class='inline'><p>
-The date / time of the event.
+The date and time of the event.
 </p>
 </div></span>
   
@@ -179,7 +179,7 @@ The event&#8217;s description.
   
   
   
-  
+  <span class="private note title">Private</span>
 
   
     <span class="summary_desc"><div class='inline'><p>
@@ -253,7 +253,11 @@ Converts the event into a string.
   
 </p><div class="docstring">
   <div class="discussion">
-    <p>
+    <p class="note private">
+  <strong>This method is part of a private API.</strong> 
+  You should avoid using this method if possible, as it may be removed or be changed in the future.
+</p>
+<p>
 Provides a new instance of Event
 </p>
 
@@ -266,7 +270,7 @@ Provides a new instance of Event
   
     <li>
       
-        <span class='name'>the</span>
+        <span class='name'>date</span>
       
       
         <span class='type'>(<tt>Time</tt>)</span>
@@ -275,7 +279,7 @@ Provides a new instance of Event
       
         &mdash;
         <div class='inline'><p>
-date / time of the event
+the date / time of the event
 </p>
 </div>
       
@@ -283,7 +287,7 @@ date / time of the event
   
     <li>
       
-        <span class='name'>the</span>
+        <span class='name'>description</span>
       
       
         <span class='type'>(<tt>String</tt>)</span>
@@ -292,7 +296,7 @@ date / time of the event
       
         &mdash;
         <div class='inline'><p>
-event&#8217;s description
+the event&#8217;s description
 </p>
 </div>
       
@@ -300,7 +304,7 @@ event&#8217;s description
   
     <li>
       
-        <span class='name'>where</span>
+        <span class='name'>location</span>
       
       
         <span class='type'>(<tt>String</tt>)</span>
@@ -309,7 +313,7 @@ event&#8217;s description
       
         &mdash;
         <div class='inline'><p>
-the event took place
+where the event took place
 </p>
 </div>
       
@@ -323,14 +327,14 @@ the event took place
       <pre class="lines">
 
 
-8
 9
 10
 11
-12</pre>
+12
+13</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/trackerific_event.rb', line 8</span>
+      <pre class="code"><span class="info file"># File 'lib/trackerific_event.rb', line 9</span>
 
 <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>
   <span class='ivar'>@date</span> <span class='op'>=</span> <span class='id date'>date</span>
@@ -352,35 +356,40 @@ the event took place
       <div class="method_details first">
   <p class="signature first" id="date-instance_method">
   
-    - (<tt>Time</tt>) <strong>date</strong> 
+    - (<tt>DateTime</tt>) <strong>date</strong> 
   
 
   
 </p><div class="docstring">
   <div class="discussion">
     <p>
-The date / time of the event
+The date and time of the event
 </p>
 
 
   </div>
 </div>
 <div class="tags">
-  <h3>Returns:</h3>
+  
+  <div class="examples">
+    <h3>Examples:</h3>
+    
+      <h4><div class='inline'><p>
+Get the date of an event
+</p>
+</div></h4>
+      <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>
+    
+  </div>
+<h3>Returns:</h3>
 <ul class="return">
   
     <li>
       
       
-        <span class='type'>(<tt>Time</tt>)</span>
-      
+        <span class='type'>(<tt>DateTime</tt>)</span>
       
       
-        &mdash;
-        <div class='inline'><p>
-the date / time of the event
-</p>
-</div>
       
     </li>
   
@@ -392,12 +401,12 @@ the date / time of the event
       <pre class="lines">
 
 
-15
-16
-17</pre>
+20
+21
+22</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/trackerific_event.rb', line 15</span>
+      <pre class="code"><span class="info file"># File 'lib/trackerific_event.rb', line 20</span>
 
 <span class='kw'>def</span> <span class='id date'>date</span>
   <span class='ivar'>@date</span>
@@ -417,14 +426,25 @@ the date / time of the event
 </p><div class="docstring">
   <div class="discussion">
     <p>
-The event&#8217;s description.
+The event&#8217;s description
 </p>
 
 
   </div>
 </div>
 <div class="tags">
-  <h3>Returns:</h3>
+  
+  <div class="examples">
+    <h3>Examples:</h3>
+    
+      <h4><div class='inline'><p>
+Get the description of an event
+</p>
+</div></h4>
+      <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>
+    
+  </div>
+<h3>Returns:</h3>
 <ul class="return">
   
     <li>
@@ -434,12 +454,6 @@ The event&#8217;s description.
       
       
       
-        &mdash;
-        <div class='inline'><p>
-the event&#8217;s description.
-</p>
-</div>
-      
     </li>
   
 </ul>
@@ -450,12 +464,12 @@ the event&#8217;s description.
       <pre class="lines">
 
 
-20
-21
-22</pre>
+29
+30
+31</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/trackerific_event.rb', line 20</span>
+      <pre class="code"><span class="info file"># File 'lib/trackerific_event.rb', line 29</span>
 
 <span class='kw'>def</span> <span class='id description'>description</span>
   <span class='ivar'>@description</span>
@@ -482,7 +496,18 @@ Where the event took place (usually in City State Zip format)
   </div>
 </div>
 <div class="tags">
-  <h3>Returns:</h3>
+  
+  <div class="examples">
+    <h3>Examples:</h3>
+    
+      <h4><div class='inline'><p>
+Get the location of an event
+</p>
+</div></h4>
+      <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>
+    
+  </div>
+<h3>Returns:</h3>
 <ul class="return">
   
     <li>
@@ -492,12 +517,6 @@ Where the event took place (usually in City State Zip format)
       
       
       
-        &mdash;
-        <div class='inline'><p>
-where the event took place (usually in City State Zip format)
-</p>
-</div>
-      
     </li>
   
 </ul>
@@ -508,12 +527,12 @@ where the event took place (usually in City State Zip format)
       <pre class="lines">
 
 
-26
-27
-28</pre>
+38
+39
+40</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/trackerific_event.rb', line 26</span>
+      <pre class="code"><span class="info file"># File 'lib/trackerific_event.rb', line 38</span>
 
 <span class='kw'>def</span> <span class='id location'>location</span>
   <span class='ivar'>@location</span>
@@ -540,7 +559,26 @@ Converts the event into a string
   </div>
 </div>
 <div class="tags">
-  <h3>Returns:</h3>
+  
+  <div class="examples">
+    <h3>Examples:</h3>
+    
+      <h4><div class='inline'><p>
+Get a human-readable string from an event
+</p>
+</div></h4>
+      <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>
+    
+      <h4><div class='inline'><p>
+A bulleted list of events in haml
+</p>
+</div></h4>
+      <pre class="example code">%ul
+  - details.events.each do |event|
+  %li= event</pre>
+    
+  </div>
+<h3>Returns:</h3>
 <ul class="return">
   
     <li>
@@ -566,15 +604,15 @@ converts the event into a string
       <pre class="lines">
 
 
-31
-32
-33
-34
-35
-36</pre>
+51
+52
+53
+54
+55
+56</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/trackerific_event.rb', line 31</span>
+      <pre class="code"><span class="info file"># File 'lib/trackerific_event.rb', line 51</span>
 
 <span class='kw'>def</span> <span class='id to_s'>to_s</span>
   <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>
@@ -592,7 +630,7 @@ converts the event into a string
 </div>
     
     <div id="footer">
-  Generated on Mon Jun 13 14:22:52 2011 by 
+  Generated on Mon Jun 13 16:20:06 2011 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.7.1 (ruby-1.9.2).
 </div>

data/doc/Trackerific/FedEx.html

@@ -134,30 +134,6 @@ Provides package tracking support for FedEx
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#required_options-instance_method" title="#required_options (instance method)">- (Array) <strong>required_options</strong> </a>
-    
-
-    
-  </span>
-  
-  
-  
-  
-  
-  
-
-  
-    <span class="summary_desc"><div class='inline'><p>
-Required options for tracking a FedEx package are :account and :meter.
-</p>
-</div></span>
-  
-</li>
-
-      
-        <li class="public ">
-  <span class="summary_signature">
-    
       <a href="#track_package-instance_method" title="#track_package (instance method)">- (Trackerific::Details) <strong>track_package</strong>(package_id) </a>
     
 
@@ -206,84 +182,56 @@ Tracks a FedEx package.
     
     
       <div class="method_details first">
-  <p class="signature first" id="required_options-instance_method">
+  <p class="signature first" id="track_package-instance_method">
   
-    - (<tt>Array</tt>) <strong>required_options</strong> 
+    - (<tt><span class='object_link'><a href="Details.html" title="Trackerific::Details (class)">Trackerific::Details</a></span></tt>) <strong>track_package</strong>(package_id) 
   
 
   
 </p><div class="docstring">
   <div class="discussion">
     <p>
-Required options for tracking a FedEx package are :account and :meter.
+Tracks a FedEx package
 </p>
 
 
   </div>
 </div>
 <div class="tags">
-  <h3>Returns:</h3>
-<ul class="return">
+  
+  <div class="examples">
+    <h3>Examples:</h3>
+    
+      <h4><div class='inline'><p>
+Track a package
+</p>
+</div></h4>
+      <pre class="example code"><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'>account</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'>meter</span><span class='tstring_end'>'</span></span>
+<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'>&quot;</span><span class='tstring_content'>183689015000001</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span></pre>
+    
+  </div>
+<h3>Parameters:</h3>
+<ul class="param">
   
     <li>
       
+        <span class='name'>package_id</span>
       
-        <span class='type'>(<tt>Array</tt>)</span>
+      
+        <span class='type'>(<tt>String</tt>)</span>
       
       
       
         &mdash;
         <div class='inline'><p>
-required options for tracking a FedEx package are :account and :meter.
+the package identifier
 </p>
 </div>
       
     </li>
   
 </ul>
-
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-
-
-13
-14
-15</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/fedex.rb', line 13</span>
-
-<span class='kw'>def</span> <span class='id required_options'>required_options</span>
-  <span class='lbracket'>[</span><span class='symbol'>:account</span><span class='comma'>,</span> <span class='symbol'>:meter</span><span class='rbracket'>]</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-    
-      <div class="method_details ">
-  <p class="signature " id="track_package-instance_method">
-  
-    - (<tt><span class='object_link'><a href="Details.html" title="Trackerific::Details (class)">Trackerific::Details</a></span></tt>) <strong>track_package</strong>(package_id) 
-  
-
-  
-</p><div class="docstring">
-  <div class="discussion">
-    <p>
-Tracks a FedEx package.
-</p>
-<p>
-A Trackerific::Error is raised when a package cannot be tracked.
-</p>
-
-
-  </div>
-</div>
-<div class="tags">
-  <h3>Returns:</h3>
+<h3>Returns:</h3>
 <ul class="return">
   
     <li>
@@ -312,6 +260,13 @@ the tracking details
       
       
       
+        &mdash;
+        <div class='inline'><p>
+raised when the server returns an error (invalid credentials, tracking
+package, etc.)
+</p>
+</div>
+      
     </li>
   
 </ul>
@@ -322,6 +277,8 @@ the tracking details
       <pre class="lines">
 
 
+20
+21
 22
 23
 24
@@ -349,28 +306,30 @@ the tracking details
 46</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/fedex.rb', line 22</span>
+      <pre class="code"><span class="info file"># File 'lib/fedex.rb', line 20</span>
 
 <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>
   <span class='kw'>super</span>
-  <span class='id http_response'>http_response</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id class'>class</span><span class='period'>.</span><span class='id post'>post</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/GatewayDC</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='symbol'>:body</span> <span class='op'>=&gt;</span> <span class='id build_xml_request'>build_xml_request</span>
-  <span class='id http_response'>http_response</span><span class='period'>.</span><span class='id error!'>error!</span> <span class='kw'>unless</span> <span class='id http_response'>http_response</span><span class='period'>.</span><span class='id code'>code</span> <span class='op'>==</span> <span class='int'>200</span>
-  
-  <span class='id track_reply'>track_reply</span> <span class='op'>=</span> <span class='id http_response'>http_response</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>FDXTrack2Reply</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
-  <span class='id raise'>raise</span> <span class='const'>Trackerific</span><span class='op'>::</span><span class='const'>Error</span><span class='comma'>,</span> <span class='id track_reply'>track_reply</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Error</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Message</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='kw'>unless</span> <span class='id track_reply'>track_reply</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Error</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id nil?'>nil?</span>
-  
-  <span class='id details'>details</span> <span class='op'>=</span> <span class='id track_reply'>track_reply</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Package</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
-  <span class='id events'>events</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
+  <span class='comment'># request tracking information from FedEx via HTTParty
+</span>  <span class='id http_response'>http_response</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id class'>class</span><span class='period'>.</span><span class='id post'>post</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/GatewayDC</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='symbol'>:body</span> <span class='op'>=&gt;</span> <span class='id build_xml_request'>build_xml_request</span>
+  <span class='comment'># raise any HTTP errors
+</span>  <span class='id http_response'>http_response</span><span class='period'>.</span><span class='id error!'>error!</span> <span class='kw'>unless</span> <span class='id http_response'>http_response</span><span class='period'>.</span><span class='id code'>code</span> <span class='op'>==</span> <span class='int'>200</span>
+  <span class='comment'># get the tracking information from the reply
+</span>  <span class='id track_reply'>track_reply</span> <span class='op'>=</span> <span class='id http_response'>http_response</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>FDXTrack2Reply</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
+  <span class='comment'># raise a Trackerific::Error if there is an error in the reply
+</span>  <span class='id raise'>raise</span> <span class='const'>Trackerific</span><span class='op'>::</span><span class='const'>Error</span><span class='comma'>,</span> <span class='id track_reply'>track_reply</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Error</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Message</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='kw'>unless</span> <span class='id track_reply'>track_reply</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Error</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id nil?'>nil?</span>
+  <span class='comment'># get the details from the reply
+</span>  <span class='id details'>details</span> <span class='op'>=</span> <span class='id track_reply'>track_reply</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Package</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
+  <span class='comment'># convert them into Trackerific::Events
+</span>  <span class='id events'>events</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
   <span class='id details'>details</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Event</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id e'>e</span><span class='op'>|</span>
     <span class='id date'>date</span> <span class='op'>=</span> <span class='const'>Time</span><span class='period'>.</span><span class='id parse'>parse</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id e'>e</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Date</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='id e'>e</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Time</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
     <span class='id desc'>desc</span> <span class='op'>=</span> <span class='id e'>e</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Description</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
     <span class='id addr'>addr</span> <span class='op'>=</span> <span class='id e'>e</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Address</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
-    <span class='comment'># Adds event in this format:
-</span>    <span class='comment'># MM DD HH:MM am/pm Description City State Zip
-</span>    <span class='id events'>events</span> <span class='op'>&lt;&lt;</span> <span class='const'>Trackerific</span><span class='op'>::</span><span class='const'>Event</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='id date'>date</span><span class='comma'>,</span> <span class='id desc'>desc</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id addr'>addr</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>StateOrProvinceCode</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='id addr'>addr</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>PostalCode</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
+    <span class='id events'>events</span> <span class='op'>&lt;&lt;</span> <span class='const'>Trackerific</span><span class='op'>::</span><span class='const'>Event</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='id date'>date</span><span class='comma'>,</span> <span class='id desc'>desc</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id addr'>addr</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>StateOrProvinceCode</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='id addr'>addr</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>PostalCode</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
   <span class='kw'>end</span>
-  
-  <span class='const'>Details</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span>
+  <span class='comment'># Return a Trackerific::Details containing all the events
+</span>  <span class='const'>Trackerific</span><span class='op'>::</span><span class='const'>Details</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span>
     <span class='id details'>details</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>TrackingNumber</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
     <span class='id details'>details</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>StatusDescription</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
     <span class='id events'>events</span>
@@ -386,7 +345,7 @@ the tracking details
 </div>
     
     <div id="footer">
-  Generated on Mon Jun 13 14:22:51 2011 by 
+  Generated on Mon Jun 13 16:20:06 2011 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.7.1 (ruby-1.9.2).
 </div>