trackerific 0.3.1 → 0.3.2

data/Gemfile

@@ -12,7 +12,8 @@ end
 
 group :development, :test do
   gem "rspec-rails", ">= 2.6.1"
-  gem "ruby-debug19", :require => "ruby-debug"
+  gem "ruby-debug19", ">= 0.11.6", :require => "ruby-debug"
+  gem 'yardstick', ">= 0.4.0"
 end
 
 group :test do

data/Gemfile.lock

@@ -100,6 +100,9 @@ GEM
     treetop (1.4.9)
       polyglot (>= 0.3.1)
     tzinfo (0.3.26)
+    yard (0.7.1)
+    yardstick (0.4.0)
+      yard (~> 0.7.0)
 
 PLATFORMS
   ruby
@@ -112,4 +115,5 @@ DEPENDENCIES
   jeweler (>= 1.5.2)
   rails (>= 3.0.0)
   rspec-rails (>= 2.6.1)
-  ruby-debug19
+  ruby-debug19 (>= 0.11.6)
+  yardstick (>= 0.4.0)

data/Rakefile

@@ -21,3 +21,19 @@ Jeweler::Tasks.new do |gem|
   gem.authors = ["Travis Haynes"]
 end
 Jeweler::RubygemsDotOrgTasks.new
+
+# measure coverage
+
+require 'yardstick/rake/measurement'
+
+Yardstick::Rake::Measurement.new(:yardstick_measure) do |measurement|
+  measurement.output = 'measurement/report.txt'
+end
+
+# verify coverage
+
+require 'yardstick/rake/verify'
+
+Yardstick::Rake::Verify.new do |verify|
+  verify.threshold = 100
+end

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.3.2

data/doc/Trackerific.html

@@ -130,8 +130,7 @@ Trackerific is a UPS, FedEx and USPS tracking provider.
 
   
     <span class="summary_desc"><div class='inline'><p>
-Checks a string for a valid package identifier, and returns a Trackerific
-class that should be able to track the package.
+Checks a string for a valid package tracking service.
 </p>
 </div></span>
   
@@ -157,20 +156,31 @@ class that should be able to track the package.
 </p><div class="docstring">
   <div class="discussion">
     <p>
-Checks a string for a valid package identifier, and returns a Trackerific
-class that should be able to track the package.
+Checks a string for a valid package tracking service
 </p>
 
 
   </div>
 </div>
 <div class="tags">
-  <h3>Parameters:</h3>
+  
+  <div class="examples">
+    <h3>Examples:</h3>
+    
+      <h4><div class='inline'><p>
+Find out which service provider will track a valid FedEx number
+</p>
+</div></h4>
+      <pre class="example code"><span class='id include'>include</span> <span class='const'>Trackerific</span>
+<span class='id tracking_service'>tracking_service</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='comment'># =&gt; Trackerific::FedEx</span></pre>
+    
+  </div>
+<h3>Parameters:</h3>
 <ul class="param">
   
     <li>
       
-        <span class='name'>the</span>
+        <span class='name'>package_id</span>
       
       
         <span class='type'>(<tt>String</tt>)</span>
@@ -179,7 +189,7 @@ class that should be able to track the package.
       
         &mdash;
         <div class='inline'><p>
-package identifier.
+the package identifier
 </p>
 </div>
       
@@ -213,20 +223,20 @@ found.
       <pre class="lines">
 
 
-46
-47
-48
-49
-50
-51
-52
-53
-54
-55
-56</pre>
+77
+78
+79
+80
+81
+82
+83
+84
+85
+86
+87</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/trackerific.rb', line 46</span>
+      <pre class="code"><span class="info file"># File 'lib/trackerific.rb', line 77</span>
 
 <span class='kw'>def</span> <span class='id tracking_service'>tracking_service</span><span class='lparen'>(</span><span class='id package_id'>package_id</span><span class='rparen'>)</span>
   <span class='kw'>case</span> <span class='id package_id'>package_id</span>
@@ -249,7 +259,7 @@ found.
 </div>
     
     <div id="footer">
-  Generated on Mon Jun 13 14:22:51 2011 by 
+  Generated on Mon Jun 13 16:20:05 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/Base.html

@@ -135,35 +135,11 @@ Base class for Trackerific package tracking services.
   
   
   
-  
-
-  
-    <span class="summary_desc"><div class='inline'><p>
-A new instance of Base.
-</p>
-</div></span>
-  
-</li>
-
-      
-        <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="private note title">Private</span>
 
   
     <span class="summary_desc"><div class='inline'><p>
-Override this method if your subclass has required options.
+Creates a new instance of Trackerific::Base with required options.
 </p>
 </div></span>
   
@@ -173,7 +149,7 @@ Override this method if your subclass has required options.
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#track_package-instance_method" title="#track_package (instance method)">- (Hash) <strong>track_package</strong>(package_id) </a>
+      <a href="#track_package-instance_method" title="#track_package (instance method)">- (Trackerific::Details) <strong>track_package</strong>(package_id) </a>
     
 
     
@@ -187,7 +163,7 @@ Override this method if your subclass has required options.
 
   
     <span class="summary_desc"><div class='inline'><p>
-Override this method in your subclass to implement tracking a package.
+Gets the tracking information for the package from the server.
 </p>
 </div></span>
   
@@ -209,8 +185,12 @@ Override this method in your subclass to implement tracking a package.
   
 </p><div class="docstring">
   <div class="discussion">
-    <p>
-A new instance of Base
+    <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>
+Creates a new instance of Trackerific::Base with required options
 </p>
 
 
@@ -224,8 +204,6 @@ A new instance of Base
       <pre class="lines">
 
 
-12
-13
 14
 15
 16
@@ -233,17 +211,23 @@ A new instance of Base
 18
 19
 20
-21</pre>
+21
+22
+23
+24
+25</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/trackerific.rb', line 12</span>
+      <pre class="code"><span class="info file"># File 'lib/trackerific.rb', line 14</span>
 
 <span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
   <span class='id required'>required</span> <span class='op'>=</span> <span class='id required_options'>required_options</span>
-  <span class='id required'>required</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id k'>k</span><span class='op'>|</span>
+  <span class='comment'># make sure all the required options exist
+</span>  <span class='id required'>required</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id k'>k</span><span class='op'>|</span>
     <span class='id raise'>raise</span> <span class='const'>ArgumentError</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Missing required parameter: </span><span class='embexpr_beg'>#{</span><span class='id k'>k</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id options'>options</span><span class='period'>.</span><span class='id has_key?'>has_key?</span><span class='lparen'>(</span><span class='id k'>k</span><span class='rparen'>)</span>
   <span class='kw'>end</span>
-  <span class='id options'>options</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id k'>k</span><span class='comma'>,</span> <span class='id v'>v</span><span class='op'>|</span>
+  <span class='comment'># make sure no invalid options exist
+</span>  <span class='id options'>options</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id k'>k</span><span class='comma'>,</span> <span class='id v'>v</span><span class='op'>|</span>
     <span class='id raise'>raise</span> <span class='const'>ArgumentError</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Invalid parameter: </span><span class='embexpr_beg'>#{</span><span class='id k'>k</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id required'>required</span><span class='period'>.</span><span class='id include?'>include?</span><span class='lparen'>(</span><span class='id k'>k</span><span class='rparen'>)</span>
   <span class='kw'>end</span>
   <span class='ivar'>@options</span> <span class='op'>=</span> <span class='id options'>options</span>
@@ -261,87 +245,70 @@ A new instance of Base
     
     
       <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>
-Override this method if your subclass has required options.
+Gets the tracking information for the package from the server
 </p>
 
 
   </div>
 </div>
 <div class="tags">
-  <h3>Returns:</h3>
-<ul class="return">
+  
+  <div class="examples">
+    <h3>Examples:</h3>
+    
+      <h4><div class='inline'><p>
+Override this method in your custom tracking provider to implement tracking
+</p>
+</div></h4>
+      <pre class="example code"><span class='kw'>module</span> <span class='const'>Trackerific</span>
+  <span class='kw'>class</span> <span class='const'>MyTrackingProvider</span> <span class='op'>&lt;</span> <span class='const'>Base</span>
+    <span class='kw'>def</span> <span class='id track_package'>track_package</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='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>summary of tracking events</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
+        <span class='lbracket'>[</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='const'>Time</span><span class='period'>.</span><span class='id now'>now</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>summary</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>location</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rbracket'>]</span>
+      <span class='rparen'>)</span>
+    <span class='kw'>end</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</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>
-the required options
+the package identifier
 </p>
 </div>
       
     </li>
   
 </ul>
-
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-
-
-25
-26
-27</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/trackerific.rb', line 25</span>
-
-<span class='kw'>def</span> <span class='id required_options'>required_options</span>
-  <span class='lbracket'>[</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>Hash</tt>) <strong>track_package</strong>(package_id) 
-  
-
-  
-</p><div class="docstring">
-  <div class="discussion">
-    <p>
-Override this method in your subclass to implement tracking a package.
-</p>
-
-
-  </div>
-</div>
-<div class="tags">
-  <h3>Returns:</h3>
+<h3>Returns:</h3>
 <ul class="return">
   
     <li>
       
       
-        <span class='type'>(<tt>Hash</tt>)</span>
+        <span class='type'>(<tt><span class='object_link'><a href="Details.html" title="Trackerific::Details (class)">Trackerific::Details</a></span></tt>)</span>
       
       
       
@@ -361,12 +328,12 @@ the tracking details
       <pre class="lines">
 
 
-31
-32
-33</pre>
+42
+43
+44</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/trackerific.rb', line 31</span>
+      <pre class="code"><span class="info file"># File 'lib/trackerific.rb', line 42</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='ivar'>@package_id</span> <span class='op'>=</span> <span class='id package_id'>package_id</span>
@@ -381,7 +348,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>

data/doc/Trackerific/Details.html

@@ -134,7 +134,7 @@ summary, and the events.
 
   
     <span class="summary_desc"><div class='inline'><p>
-The tracking events.
+Read-only string for the events for this package.
 </p>
 </div></span>
   
@@ -156,7 +156,7 @@ The tracking events.
   
   
   
-  
+  <span class="private note title">Private</span>
 
   
     <span class="summary_desc"><div class='inline'><p>
@@ -184,7 +184,7 @@ Provides a new instance of Details.
 
   
     <span class="summary_desc"><div class='inline'><p>
-The package identifier.
+Read-only string for the package identifier.
 </p>
 </div></span>
   
@@ -208,7 +208,7 @@ The package identifier.
 
   
     <span class="summary_desc"><div class='inline'><p>
-A summary of the tracking status.
+Read-only string for the summary of the package&#8217;s tracking events.
 </p>
 </div></span>
   
@@ -230,7 +230,11 @@ A summary of the tracking status.
   
 </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 Details
 </p>
 
@@ -243,7 +247,7 @@ Provides a new instance of Details
   
     <li>
       
-        <span class='name'>the</span>
+        <span class='name'>package_id</span>
       
       
         <span class='type'>(<tt>String</tt>)</span>
@@ -252,7 +256,7 @@ Provides a new instance of Details
       
         &mdash;
         <div class='inline'><p>
-package identifier
+the package identifier
 </p>
 </div>
       
@@ -260,7 +264,7 @@ package identifier
   
     <li>
       
-        <span class='name'>a</span>
+        <span class='name'>summary</span>
       
       
         <span class='type'>(<tt>String</tt>)</span>
@@ -269,7 +273,7 @@ package identifier
       
         &mdash;
         <div class='inline'><p>
-summary of the tracking status
+a summary of the tracking status
 </p>
 </div>
       
@@ -277,7 +281,7 @@ summary of the tracking status
   
     <li>
       
-        <span class='name'>the</span>
+        <span class='name'>events</span>
       
       
         <span class='type'>(<tt>Array</tt>, <tt><span class='object_link'><a href="Event.html" title="Trackerific::Event (class)">Trackerific::Event</a></span></tt>)</span>
@@ -286,7 +290,7 @@ summary of the tracking status
       
         &mdash;
         <div class='inline'><p>
-tracking events
+the tracking events
 </p>
 </div>
       
@@ -300,14 +304,14 @@ tracking events
       <pre class="lines">
 
 
-9
 10
 11
 12
-13</pre>
+13
+14</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/trackerific_details.rb', line 9</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>
@@ -336,14 +340,39 @@ tracking events
 </p><div class="docstring">
   <div class="discussion">
     <p>
-The tracking events
+Read-only string for the events for this package
 </p>
 
 
   </div>
 </div>
 <div class="tags">
-  <h3>Returns:</h3>
+  
+  <div class="examples">
+    <h3>Examples:</h3>
+    
+      <h4><div class='inline'><p>
+Print all the events for a tracked package
+</p>
+</div></h4>
+      <pre class="example code"><span class='id puts'>puts</span> <span class='id details'>details</span><span class='period'>.</span><span class='id events'>events</span></pre>
+    
+      <h4><div class='inline'><p>
+Get the date the package was shipped
+</p>
+</div></h4>
+      <pre class="example code"><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; a DateTime value</span></pre>
+    
+      <h4><div class='inline'><p>
+A bulleted HTML list of the events (most current on top) 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>
@@ -369,12 +398,12 @@ the tracking events
       <pre class="lines">
 
 
-26
-27
-28</pre>
+45
+46
+47</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/trackerific_details.rb', line 26</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>
@@ -394,14 +423,25 @@ the tracking events
 </p><div class="docstring">
   <div class="discussion">
     <p>
-The package identifier
+Read-only string for the package identifier
 </p>
 
 
   </div>
 </div>
 <div class="tags">
-  <h3>Returns:</h3>
+  
+  <div class="examples">
+    <h3>Examples:</h3>
+    
+      <h4><div class='inline'><p>
+Get the id of a tracked package
+</p>
+</div></h4>
+      <pre class="example code"><span class='id details'>details</span><span class='period'>.</span><span class='id package_id'>package_id</span> <span class='comment'># =&gt; the package identifier</span></pre>
+    
+  </div>
+<h3>Returns:</h3>
 <ul class="return">
   
     <li>
@@ -427,12 +467,12 @@ the package identifier
       <pre class="lines">
 
 
-16
-17
-18</pre>
+21
+22
+23</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/trackerific_details.rb', line 16</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>
@@ -452,14 +492,25 @@ the package identifier
 </p><div class="docstring">
   <div class="discussion">
     <p>
-A summary of the tracking status
+Read-only string for the summary of the package&#8217;s tracking events
 </p>
 
 
   </div>
 </div>
 <div class="tags">
-  <h3>Returns:</h3>
+  
+  <div class="examples">
+    <h3>Examples:</h3>
+    
+      <h4><div class='inline'><p>
+Get the summary of a tracked package
+</p>
+</div></h4>
+      <pre class="example code"><span class='id details'>details</span><span class='period'>.</span><span class='id summary'>summary</span> <span class='comment'># =&gt; Summary of the tracking events (i.e. Delivered)</span></pre>
+    
+  </div>
+<h3>Returns:</h3>
 <ul class="return">
   
     <li>
@@ -485,12 +536,12 @@ a summary of the tracking status
       <pre class="lines">
 
 
-21
-22
-23</pre>
+30
+31
+32</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 30</span>
 
 <span class='kw'>def</span> <span class='id summary'>summary</span>
   <span class='ivar'>@summary</span>
@@ -505,7 +556,7 @@ a summary of the tracking status
 </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>