RubyGems - trackerific - Versions diffs - 0.5.5 → 0.6.0 - Mend

trackerific 0.5.5 → 0.6.0

Files changed (49) hide show

data/README.rdoc +62 -44
data/Rakefile +1 -1
data/VERSION +1 -1
data/changelog +9 -0
data/lib/trackerific/configuration.rb +2 -2
data/lib/trackerific/details.rb +36 -10
data/lib/trackerific/event.rb +9 -7
data/lib/trackerific/service.rb +22 -6
data/lib/trackerific/services/fedex.rb +11 -7
data/lib/trackerific/services/mock_service.rb +23 -14
data/lib/trackerific/services/ups.rb +12 -8
data/lib/trackerific/services/usps.rb +114 -21
data/spec/fixtures/usps_city_state_lookup_response.xml +8 -0
data/spec/lib/helpers/options_helper_spec.rb +3 -3
data/spec/lib/trackerific/configuration_spec.rb +35 -0
data/spec/lib/trackerific/details_spec.rb +71 -11
data/spec/lib/trackerific/event_spec.rb +34 -19
data/spec/lib/trackerific/service_spec.rb +3 -3
data/spec/lib/trackerific/services/fedex_spec.rb +16 -3
data/spec/lib/trackerific/services/mock_service_spec.rb +19 -4
data/spec/lib/trackerific/services/ups_spec.rb +17 -2
data/spec/lib/trackerific/services/usps_spec.rb +60 -11
data/spec/lib/trackerific_spec.rb +7 -5
data/trackerific.gemspec +5 -27
metadata +8 -30
data/doc/OptionsHelper.html +0 -287
data/doc/Trackerific/Configuration.html +0 -354
data/doc/Trackerific/Details.html +0 -565
data/doc/Trackerific/Error.html +0 -127
data/doc/Trackerific/Event.html +0 -639
data/doc/Trackerific/FedEx.html +0 -558
data/doc/Trackerific/Service.html +0 -579
data/doc/Trackerific/UPS.html +0 -532
data/doc/Trackerific/USPS.html +0 -568
data/doc/Trackerific.html +0 -833
data/doc/_index.html +0 -226
data/doc/class_list.html +0 -47
data/doc/css/common.css +0 -1
data/doc/css/full_list.css +0 -53
data/doc/css/style.css +0 -320
data/doc/file.README.html +0 -288
data/doc/file_list.html +0 -49
data/doc/frames.html +0 -13
data/doc/index.html +0 -288
data/doc/js/app.js +0 -205
data/doc/js/full_list.js +0 -150
data/doc/js/jquery.js +0 -16
data/doc/method_list.html +0 -294
data/doc/top-level-namespace.html +0 -103

data/doc/Trackerific/Details.html DELETED Viewed

@@ -1,565 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-  <head>
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<title>
-  Class: Trackerific::Details
-    &mdash; Documentation by YARD 0.7.1
-</title>
-  <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
-  <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
-<script type="text/javascript" charset="utf-8">
-  relpath = '..';
-  if (relpath != '') relpath += '/';
-</script>
-  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
-  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
-  </head>
-  <body>
-    <script type="text/javascript" charset="utf-8">
-      if (window.top.frames.main) document.body.className = 'frames';
-    </script>
-    <div id="header">
-      <div id="menu">
-    <a href="../_index.html">Index (D)</a> &raquo;
-    <span class='title'><span class='object_link'><a href="../Trackerific.html" title="Trackerific (module)">Trackerific</a></span></span>
-     &raquo;
-    <span class="title">Details</span>
-  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
-</div>
-      <div id="search">
-    <a id="class_list_link" href="#">Class List</a>
-    <a id="method_list_link" href="#">Method List</a>
-    <a id="file_list_link" href="#">File List</a>
-</div>
-      <div class="clear"></div>
-    </div>
-    <iframe id="search_frame"></iframe>
-    <div id="content"><h1>Class: Trackerific::Details
-</h1>
-<dl class="box">
-    <dt class="r1">Inherits:</dt>
-    <dd class="r1">
-      <span class="inheritName">Object</span>
-        <ul class="fullTree">
-          <li>Object</li>
-            <li class="next">Trackerific::Details</li>
-        </ul>
-        <a href="#" class="inheritanceTree">show all</a>
-      </dd>
-    <dt class="r2 last">Defined in:</dt>
-    <dd class="r2 last">lib/trackerific/details.rb</dd>
-</dl>
-<div class="clear"></div>
-<h2>Overview</h2><div class="docstring">
-  <div class="discussion">
-    <p>
-Details returned when tracking a package. Stores the package identifier, a
-summary, and the events.
-</p>
-  </div>
-</div>
-<div class="tags">
-</div>
-    <h2>
-      Instance Method Summary
-      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
-    </h2>
-    <ul class="summary">
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#events-instance_method" title="#events (instance method)">- (Array, Trackerific::Event) <strong>events</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'><p>
-Read-only string for the events for this package.
-</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#initialize-instance_method" title="#initialize (instance method)">- (Details) <strong>initialize</strong>(package_id, summary, events) </a>
-  </span>
-    <span class="note title constructor">constructor</span>
-  <span class="private note title">Private</span>
-    <span class="summary_desc"><div class='inline'><p>
-Provides a new instance of Details.
-</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#package_id-instance_method" title="#package_id (instance method)">- (String) <strong>package_id</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'><p>
-Read-only string for the package identifier.
-</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#summary-instance_method" title="#summary (instance method)">- (String) <strong>summary</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'><p>
-Read-only string for the summary of the package&#8217;s tracking events.
-</p>
-</div></span>
-</li>
-    </ul>
-<div id="constructor_details" class="method_details_list">
-  <h2>Constructor Details</h2>
-    <div class="method_details first">
-  <p class="signature first" id="initialize-instance_method">
-    - (<tt><span class='object_link'><a href="" title="Trackerific::Details (class)">Details</a></span></tt>) <strong>initialize</strong>(package_id, summary, events)
-</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>
-Provides a new instance of Details
-</p>
-  </div>
-</div>
-<div class="tags">
-  <h3>Parameters:</h3>
-<ul class="param">
-    <li>
-        <span class='name'>package_id</span>
-        <span class='type'>(<tt>String</tt>)</span>
-        &mdash;
-        <div class='inline'><p>
-the package identifier
-</p>
-</div>
-    </li>
-    <li>
-        <span class='name'>summary</span>
-        <span class='type'>(<tt>String</tt>)</span>
-        &mdash;
-        <div class='inline'><p>
-a summary of the tracking status
-</p>
-</div>
-    </li>
-    <li>
-        <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>
-        &mdash;
-        <div class='inline'><p>
-the tracking events
-</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-10
-11
-12
-13
-14</pre>
-    </td>
-    <td>
-      <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>
-  <span class='ivar'>@summary</span> <span class='op'>=</span> <span class='id summary'>summary</span>
-  <span class='ivar'>@events</span> <span class='op'>=</span> <span class='id events'>events</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>
-      <div class="method_details first">
-  <p class="signature first" id="events-instance_method">
-    - (<tt>Array</tt>, <tt><span class='object_link'><a href="Event.html" title="Trackerific::Event (class)">Trackerific::Event</a></span></tt>) <strong>events</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    <p>
-Read-only string for the events for this package
-</p>
-  </div>
-</div>
-<div class="tags">
-  <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>
-        <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>
-        &mdash;
-        <div class='inline'><p>
-the tracking events
-</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-45
-46
-47</pre>
-    </td>
-    <td>
-      <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>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="package_id-instance_method">
-    - (<tt>String</tt>) <strong>package_id</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    <p>
-Read-only string for the package identifier
-</p>
-  </div>
-</div>
-<div class="tags">
-  <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>
-        <span class='type'>(<tt>String</tt>)</span>
-        &mdash;
-        <div class='inline'><p>
-the package identifier
-</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-21
-22
-23</pre>
-    </td>
-    <td>
-      <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>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <p class="signature " id="summary-instance_method">
-    - (<tt>String</tt>) <strong>summary</strong>
-</p><div class="docstring">
-  <div class="discussion">
-    <p>
-Read-only string for the summary of the package&#8217;s tracking events
-</p>
-  </div>
-</div>
-<div class="tags">
-  <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>
-        <span class='type'>(<tt>String</tt>)</span>
-        &mdash;
-        <div class='inline'><p>
-a summary of the tracking status
-</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-30
-31
-32</pre>
-    </td>
-    <td>
-      <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>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-</div>
-    <div id="footer">
-  Generated on Wed Jun 15 15:30:27 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>
-  </body>
-</html>

data/doc/Trackerific/Error.html DELETED Viewed

@@ -1,127 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-  <head>
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<title>
-  Exception: Trackerific::Error
-    &mdash; Documentation by YARD 0.7.1
-</title>
-  <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
-  <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
-<script type="text/javascript" charset="utf-8">
-  relpath = '..';
-  if (relpath != '') relpath += '/';
-</script>
-  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
-  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
-  </head>
-  <body>
-    <script type="text/javascript" charset="utf-8">
-      if (window.top.frames.main) document.body.className = 'frames';
-    </script>
-    <div id="header">
-      <div id="menu">
-    <a href="../_index.html">Index (E)</a> &raquo;
-    <span class='title'><span class='object_link'><a href="../Trackerific.html" title="Trackerific (module)">Trackerific</a></span></span>
-     &raquo;
-    <span class="title">Error</span>
-  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
-</div>
-      <div id="search">
-    <a id="class_list_link" href="#">Class List</a>
-    <a id="method_list_link" href="#">Method List</a>
-    <a id="file_list_link" href="#">File List</a>
-</div>
-      <div class="clear"></div>
-    </div>
-    <iframe id="search_frame"></iframe>
-    <div id="content"><h1>Exception: Trackerific::Error
-</h1>
-<dl class="box">
-    <dt class="r1">Inherits:</dt>
-    <dd class="r1">
-      <span class="inheritName">StandardError</span>
-        <ul class="fullTree">
-          <li>Object</li>
-            <li class="next">StandardError</li>
-            <li class="next">Trackerific::Error</li>
-        </ul>
-        <a href="#" class="inheritanceTree">show all</a>
-      </dd>
-    <dt class="r2 last">Defined in:</dt>
-    <dd class="r2 last">lib/trackerific/error.rb</dd>
-</dl>
-<div class="clear"></div>
-<h2>Overview</h2><div class="docstring">
-  <div class="discussion">
-    <p>
-Raised if something other than tracking information is returned.
-</p>
-  </div>
-</div>
-<div class="tags">
-</div>
-</div>
-    <div id="footer">
-  Generated on Wed Jun 15 15:30:26 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>
-  </body>
-</html>