trackerific 0.3.2 → 0.3.3

data/doc/Trackerific/USPS.html

@@ -93,7 +93,7 @@
   
   
     <dt class="r1 last">Defined in:</dt>
-    <dd class="r1 last">lib/usps.rb</dd>
+    <dd class="r1 last">lib/trackerific/services/usps.rb</dd>
   
 </dl>
 <div class="clear"></div>
@@ -124,6 +124,63 @@ Provides package tracking support for USPS.
   
 
   
+    <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 USPS 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 USPS 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 USPS 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">
+
+
+62
+63
+64</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/trackerific/services/usps.rb', line 62</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'>^E\D{1}\d{9}\D{2}$|^9\d{15,21}$</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">
+
+
+69
+70
+71</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/trackerific/services/usps.rb', line 69</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'>:user_id</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>
     
@@ -311,7 +498,7 @@ package, etc.)
 57</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/usps.rb', line 26</span>
+      <pre class="code"><span class="info file"># File 'lib/trackerific/services/usps.rb', line 26</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>
@@ -355,7 +542,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/_index.html

@@ -186,7 +186,7 @@
 </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>

data/doc/file.README.html

@@ -149,24 +149,14 @@ Here’s an example on how to handle Trackerific::Errors:
 <ul>
 <li><p>
 Check out the latest master to make sure the feature hasn&#8217;t been
-implemented
+implemented or the bug hasn&#8217;t been fixed yet
 </p>
 </li>
-</ul>
-<p>
-or the bug hasn&#8217;t been fixed yet
-</p>
-<ul>
 <li><p>
 Check out the issue tracker to make sure someone already hasn&#8217;t
-requested it
+requested it and/or contributed it
 </p>
 </li>
-</ul>
-<p>
-and/or contributed it
-</p>
-<ul>
 <li><p>
 Fork the project
 </p>
@@ -181,24 +171,16 @@ Commit and push until you are happy with your contribution
 </li>
 <li><p>
 Make sure to add tests for it. This is important so I don&#8217;t break it
-in a
+in a future version unintentionally.
 </p>
 </li>
-</ul>
-<p>
-future version unintentionally.
-</p>
-<ul>
 <li><p>
 Please try not to mess with the Rakefile, version, or history. If you want
-to
+to have your own version, or is otherwise necessary, that is fine, but
+please isolate to its own commit so I can cherry-pick around it.
 </p>
 </li>
 </ul>
-<p>
-have your own version, or is otherwise necessary, that is fine, but please
-isolate to its own commit so I can cherry-pick around it.
-</p>
 <h2>Copyright</h2>
 <p>
 Copyright &#169; 2011 Travis Haynes. See LICENSE.txt for further details.
@@ -206,7 +188,7 @@ Copyright &#169; 2011 Travis Haynes. See LICENSE.txt for further details.
 </div></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>

data/doc/index.html

@@ -149,24 +149,14 @@ Here’s an example on how to handle Trackerific::Errors:
 <ul>
 <li><p>
 Check out the latest master to make sure the feature hasn&#8217;t been
-implemented
+implemented or the bug hasn&#8217;t been fixed yet
 </p>
 </li>
-</ul>
-<p>
-or the bug hasn&#8217;t been fixed yet
-</p>
-<ul>
 <li><p>
 Check out the issue tracker to make sure someone already hasn&#8217;t
-requested it
+requested it and/or contributed it
 </p>
 </li>
-</ul>
-<p>
-and/or contributed it
-</p>
-<ul>
 <li><p>
 Fork the project
 </p>
@@ -181,24 +171,16 @@ Commit and push until you are happy with your contribution
 </li>
 <li><p>
 Make sure to add tests for it. This is important so I don&#8217;t break it
-in a
+in a future version unintentionally.
 </p>
 </li>
-</ul>
-<p>
-future version unintentionally.
-</p>
-<ul>
 <li><p>
 Please try not to mess with the Rakefile, version, or history. If you want
-to
+to have your own version, or is otherwise necessary, that is fine, but
+please isolate to its own commit so I can cherry-pick around it.
 </p>
 </li>
 </ul>
-<p>
-have your own version, or is otherwise necessary, that is fine, but please
-isolate to its own commit so I can cherry-pick around it.
-</p>
 <h2>Copyright</h2>
 <p>
 Copyright &#169; 2011 Travis Haynes. See LICENSE.txt for further details.
@@ -206,7 +188,7 @@ Copyright &#169; 2011 Travis Haynes. See LICENSE.txt for further details.
 </div></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>

data/doc/method_list.html

@@ -73,17 +73,17 @@
   
 
   <li class="r1 ">
-    <span class='object_link'><a href="Trackerific/Details.html#initialize-instance_method" title="Trackerific::Details#initialize (method)">#initialize</a></span> 
+    <span class='object_link'><a href="Trackerific/Event.html#initialize-instance_method" title="Trackerific::Event#initialize (method)">#initialize</a></span> 
     
-      <small>Trackerific::Details</small>
+      <small>Trackerific::Event</small>
     
   </li>
   
 
   <li class="r2 ">
-    <span class='object_link'><a href="Trackerific/Event.html#initialize-instance_method" title="Trackerific::Event#initialize (method)">#initialize</a></span> 
+    <span class='object_link'><a href="Trackerific/Details.html#initialize-instance_method" title="Trackerific::Details#initialize (method)">#initialize</a></span> 
     
-      <small>Trackerific::Event</small>
+      <small>Trackerific::Details</small>
     
   </li>
   
@@ -104,6 +104,70 @@
   </li>
   
 
+  <li class="r1 ">
+    <span class='object_link'><a href="Trackerific/UPS.html#package_id_matchers-class_method" title="Trackerific::UPS.package_id_matchers (method)">package_id_matchers</a></span> 
+    
+      <small>Trackerific::UPS</small>
+    
+  </li>
+  
+
+  <li class="r2 ">
+    <span class='object_link'><a href="Trackerific/FedEx.html#package_id_matchers-class_method" title="Trackerific::FedEx.package_id_matchers (method)">package_id_matchers</a></span> 
+    
+      <small>Trackerific::FedEx</small>
+    
+  </li>
+  
+
+  <li class="r1 ">
+    <span class='object_link'><a href="Trackerific/Base.html#package_id_matchers-class_method" title="Trackerific::Base.package_id_matchers (method)">package_id_matchers</a></span> 
+    
+      <small>Trackerific::Base</small>
+    
+  </li>
+  
+
+  <li class="r2 ">
+    <span class='object_link'><a href="Trackerific/USPS.html#package_id_matchers-class_method" title="Trackerific::USPS.package_id_matchers (method)">package_id_matchers</a></span> 
+    
+      <small>Trackerific::USPS</small>
+    
+  </li>
+  
+
+  <li class="r1 ">
+    <span class='object_link'><a href="Trackerific/Base.html#required_options-class_method" title="Trackerific::Base.required_options (method)">required_options</a></span> 
+    
+      <small>Trackerific::Base</small>
+    
+  </li>
+  
+
+  <li class="r2 ">
+    <span class='object_link'><a href="Trackerific/USPS.html#required_options-class_method" title="Trackerific::USPS.required_options (method)">required_options</a></span> 
+    
+      <small>Trackerific::USPS</small>
+    
+  </li>
+  
+
+  <li class="r1 ">
+    <span class='object_link'><a href="Trackerific/UPS.html#required_options-class_method" title="Trackerific::UPS.required_options (method)">required_options</a></span> 
+    
+      <small>Trackerific::UPS</small>
+    
+  </li>
+  
+
+  <li class="r2 ">
+    <span class='object_link'><a href="Trackerific/FedEx.html#required_options-class_method" title="Trackerific::FedEx.required_options (method)">required_options</a></span> 
+    
+      <small>Trackerific::FedEx</small>
+    
+  </li>
+  
+
   <li class="r1 ">
     <span class='object_link'><a href="Trackerific/Details.html#summary-instance_method" title="Trackerific::Details#summary (method)">#summary</a></span>