trackerific 0.3.2 → 0.3.3

data/doc/Trackerific/Details.html

@@ -87,7 +87,7 @@
   
   
     <dt class="r2 last">Defined in:</dt>
-    <dd class="r2 last">lib/trackerific_details.rb</dd>
+    <dd class="r2 last">lib/trackerific/details.rb</dd>
   
 </dl>
 <div class="clear"></div>
@@ -311,7 +311,7 @@ the tracking events
 14</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/trackerific_details.rb', line 10</span>
+      <pre class="code"><span class="info file"># File 'lib/trackerific/details.rb', line 10</span>
 
 <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>
   <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
 47</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/trackerific_details.rb', line 45</span>
+      <pre class="code"><span class="info file"># File 'lib/trackerific/details.rb', line 45</span>
 
 <span class='kw'>def</span> <span class='id events'>events</span>
   <span class='ivar'>@events</span>
@@ -472,7 +472,7 @@ the package identifier
 23</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/trackerific_details.rb', line 21</span>
+      <pre class="code"><span class="info file"># File 'lib/trackerific/details.rb', line 21</span>
 
 <span class='kw'>def</span> <span class='id package_id'>package_id</span>
   <span class='ivar'>@package_id</span>
@@ -541,7 +541,7 @@ a summary of the tracking status
 32</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/trackerific_details.rb', line 30</span>
+      <pre class="code"><span class="info file"># File 'lib/trackerific/details.rb', line 30</span>
 
 <span class='kw'>def</span> <span class='id summary'>summary</span>
   <span class='ivar'>@summary</span>
@@ -556,7 +556,7 @@ a summary of the tracking status
 </div>
     
     <div id="footer">
-  Generated on Mon Jun 13 16:20:06 2011 by 
+  Generated on Mon Jun 13 21:28:36 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/Error.html

@@ -89,7 +89,7 @@
   
   
     <dt class="r2 last">Defined in:</dt>
-    <dd class="r2 last">lib/trackerific.rb</dd>
+    <dd class="r2 last">lib/trackerific/error.rb</dd>
   
 </dl>
 <div class="clear"></div>
@@ -118,7 +118,7 @@ Raised if something other than tracking information is returned.
 </div>
     
     <div id="footer">
-  Generated on Mon Jun 13 16:20:06 2011 by 
+  Generated on Mon Jun 13 21:28:36 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

@@ -87,7 +87,7 @@
   
   
     <dt class="r2 last">Defined in:</dt>
-    <dd class="r2 last">lib/trackerific_event.rb</dd>
+    <dd class="r2 last">lib/trackerific/event.rb</dd>
   
 </dl>
 <div class="clear"></div>
@@ -334,7 +334,7 @@ where the event took place
 13</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/trackerific_event.rb', line 9</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>
@@ -406,7 +406,7 @@ Get the date of an event
 22</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 20</span>
 
 <span class='kw'>def</span> <span class='id date'>date</span>
   <span class='ivar'>@date</span>
@@ -469,7 +469,7 @@ Get the description of an event
 31</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/trackerific_event.rb', line 29</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>
@@ -532,7 +532,7 @@ Get the location of an event
 40</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/trackerific_event.rb', line 38</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>
@@ -612,7 +612,7 @@ converts the event into a string
 56</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/trackerific_event.rb', line 51</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>
@@ -630,7 +630,7 @@ converts the event into a string
 </div>
     
     <div id="footer">
-  Generated on Mon Jun 13 16:20:06 2011 by 
+  Generated on Mon Jun 13 21:28:36 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

@@ -93,7 +93,7 @@
   
   
     <dt class="r1 last">Defined in:</dt>
-    <dd class="r1 last">lib/fedex.rb</dd>
+    <dd class="r1 last">lib/trackerific/services/fedex.rb</dd>
   
 </dl>
 <div class="clear"></div>
@@ -124,6 +124,63 @@ Provides package tracking support for FedEx
   
 
   
+    <h2>
+      Class Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#package_id_matchers-class_method" title="package_id_matchers (class method)">+ (Regexp) <strong>package_id_matchers</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  <span class="private note title">Private</span>
+
+  
+    <span class="summary_desc"><div class='inline'><p>
+A regex that matches valid package identifiers for FedEx package ids.
+</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#required_options-class_method" title="required_options (class method)">+ (Array) <strong>required_options</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  <span class="private note title">Private</span>
+
+  
+    <span class="summary_desc"><div class='inline'><p>
+Returns an Array of required options used when creating a new instance.
+</p>
+</div></span>
+  
+</li>
+
+      
+    </ul>
+  
     <h2>
       Instance Method Summary
       <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
@@ -177,6 +234,136 @@ Tracks a FedEx package.
 </div>
 
 
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
+    
+    
+      <div class="method_details first">
+  <p class="signature first" id="package_id_matchers-class_method">
+  
+    + (<tt>Regexp</tt>) <strong>package_id_matchers</strong> 
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    <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>
+A regex that matches valid package identifiers for FedEx package ids
+</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <h3>Returns:</h3>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Regexp</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>
+the regular expression
+</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+51
+52
+53</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/trackerific/services/fedex.rb', line 51</span>
+
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id package_id_matchers'>package_id_matchers</span>
+  <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>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <p class="signature " id="required_options-class_method">
+  
+    + (<tt>Array</tt>) <strong>required_options</strong> 
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    <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>
+Returns an Array of required options used when creating a new instance
+</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <h3>Returns:</h3>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Array</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>
+required options for tracking a FedEx package are :account and :meter
+</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+59
+60
+61</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/trackerific/services/fedex.rb', line 59</span>
+
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</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>
+
   <div id="instance_method_details" class="method_details_list">
     <h2>Instance Method Details</h2>
     
@@ -306,7 +493,7 @@ package, etc.)
 46</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/fedex.rb', line 20</span>
+      <pre class="code"><span class="info file"># File 'lib/trackerific/services/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>
@@ -345,7 +532,7 @@ package, etc.)
 </div>
     
     <div id="footer">
-  Generated on Mon Jun 13 16:20:06 2011 by 
+  Generated on Mon Jun 13 21:28:36 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/UPS.html

@@ -93,7 +93,7 @@
   
   
     <dt class="r1 last">Defined in:</dt>
-    <dd class="r1 last">lib/ups.rb</dd>
+    <dd class="r1 last">lib/trackerific/services/ups.rb</dd>
   
 </dl>
 <div class="clear"></div>
@@ -124,6 +124,63 @@ Provides package tracking support for UPS.
   
 
   
+    <h2>
+      Class Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#package_id_matchers-class_method" title="package_id_matchers (class method)">+ (Regexp) <strong>package_id_matchers</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  <span class="private note title">Private</span>
+
+  
+    <span class="summary_desc"><div class='inline'><p>
+A regex that matches valid package identifiers for UPS package ids.
+</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#required_options-class_method" title="required_options (class method)">+ (Array) <strong>required_options</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  <span class="private note title">Private</span>
+
+  
+    <span class="summary_desc"><div class='inline'><p>
+The required options for tracking a UPS package.
+</p>
+</div></span>
+  
+</li>
+
+      
+    </ul>
+  
     <h2>
       Instance Method Summary
       <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
@@ -177,6 +234,136 @@ Tracks a UPS package.
 </div>
 
 
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
+    
+    
+      <div class="method_details first">
+  <p class="signature first" id="package_id_matchers-class_method">
+  
+    + (<tt>Regexp</tt>) <strong>package_id_matchers</strong> 
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    <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>
+A regex that matches valid package identifiers for UPS package ids
+</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <h3>Returns:</h3>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Regexp</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>
+the regular expression
+</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+43
+44
+45</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/trackerific/services/ups.rb', line 43</span>
+
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id package_id_matchers'>package_id_matchers</span>
+  <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>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <p class="signature " id="required_options-class_method">
+  
+    + (<tt>Array</tt>) <strong>required_options</strong> 
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    <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>
+The required options for tracking a UPS package
+</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <h3>Returns:</h3>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Array</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>
+the required options for tracking a UPS package
+</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+49
+50
+51</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/trackerific/services/ups.rb', line 49</span>
+
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id required_options'>required_options</span>
+  <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>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
   <div id="instance_method_details" class="method_details_list">
     <h2>Instance Method Details</h2>
     
@@ -293,7 +480,7 @@ package, etc.)
 38</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/ups.rb', line 25</span>
+      <pre class="code"><span class="info file"># File 'lib/trackerific/services/ups.rb', line 25</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>
@@ -319,7 +506,7 @@ package, etc.)
 </div>
     
     <div id="footer">
-  Generated on Mon Jun 13 16:20:05 2011 by 
+  Generated on Mon Jun 13 21:28:36 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>