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

trackerific 0.5.5 → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

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/FedEx.html DELETED Viewed

@@ -1,558 +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::FedEx
-    &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 (F)</a> &raquo;
-    <span class='title'><span class='object_link'><a href="../Trackerific.html" title="Trackerific (module)">Trackerific</a></span></span>
-     &raquo;
-    <span class="title">FedEx</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::FedEx
-</h1>
-<dl class="box">
-    <dt class="r1">Inherits:</dt>
-    <dd class="r1">
-      <span class="inheritName"><span class='object_link'><a href="Service.html" title="Trackerific::Service (class)">Service</a></span></span>
-        <ul class="fullTree">
-          <li>Object</li>
-            <li class="next"><span class='object_link'><a href="Service.html" title="Trackerific::Service (class)">Service</a></span></li>
-            <li class="next">Trackerific::FedEx</li>
-        </ul>
-        <a href="#" class="inheritanceTree">show all</a>
-      </dd>
-      <dt class="r2">Includes:</dt>
-      <dd class="r2">HTTParty</dd>
-    <dt class="r1 last">Defined in:</dt>
-    <dd class="r1 last">lib/trackerific/services/fedex.rb</dd>
-</dl>
-<div class="clear"></div>
-<h2>Overview</h2><div class="docstring">
-  <div class="discussion">
-    <p>
-Provides package tracking support for FedEx
-</p>
-  </div>
-</div>
-<div class="tags">
-</div>
-    <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)">+ (Array, Regexp) <strong>package_id_matchers</strong> </a>
-  </span>
-  <span class="private note title">Private</span>
-    <span class="summary_desc"><div class='inline'><p>
-An Array of Regexp that matches valid 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>
-    </h2>
-    <ul class="summary">
-        <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>
-  </span>
-    <span class="summary_desc"><div class='inline'><p>
-Tracks a FedEx package.
-</p>
-</div></span>
-</li>
-    </ul>
-  <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Service.html" title="Trackerific::Service (class)">Service</a></span></h3>
-  <p class="inherited"><span class='object_link'><a href="Service.html#initialize-instance_method" title="Trackerific::Service#initialize (method)">#initialize</a></span></p>
-  <h3 class="inherited">Methods included from <span class='object_link'><a href="../OptionsHelper.html" title="OptionsHelper (module)">OptionsHelper</a></span></h3>
-  <p class="inherited"><span class='object_link'><a href="../OptionsHelper.html#validate_options-instance_method" title="OptionsHelper#validate_options (method)">#validate_options</a></span></p>
-<div id="constructor_details" class="method_details_list">
-  <h2>Constructor Details</h2>
-    <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Service.html#initialize-instance_method" title="Trackerific::Service#initialize (method)">Trackerific::Service</a></span></p>
-</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>Array</tt>, <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>
-An Array of Regexp that matches valid FedEx package IDs
-</p>
-  </div>
-</div>
-<div class="tags">
-  <h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Array</tt>, <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">
-16
-17
-18</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/trackerific/services/fedex.rb', line 16</span>
-<span class='kw'>def</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">
-24
-25
-26</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/trackerific/services/fedex.rb', line 24</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>
-  <div id="instance_method_details" class="method_details_list">
-    <h2>Instance Method Details</h2>
-      <div class="method_details first">
-  <p class="signature first" 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>
-  </div>
-</div>
-<div class="tags">
-  <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>String</tt>)</span>
-        &mdash;
-        <div class='inline'><p>
-the package identifier
-</p>
-</div>
-    </li>
-</ul>
-<h3>Returns:</h3>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt><span class='object_link'><a href="Details.html" title="Trackerific::Details (class)">Trackerific::Details</a></span></tt>)</span>
-        &mdash;
-        <div class='inline'><p>
-the tracking details
-</p>
-</div>
-    </li>
-</ul>
-<h3>Raises:</h3>
-<ul class="raise">
-    <li>
-        <span class='type'>(<tt><span class='object_link'><a href="Error.html" title="Trackerific::Error (class)">Trackerific::Error</a></span></tt>)</span>
-        &mdash;
-        <div class='inline'><p>
-raised when the server returns an error (invalid credentials, tracking
-package, etc.)
-</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-37
-38
-39
-40
-41
-42
-43
-44
-45
-46
-47
-48
-49
-50
-51
-52
-53
-54
-55
-56
-57
-58
-59
-60
-61
-62
-63</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/trackerific/services/fedex.rb', line 37</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='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='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='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>
-  <span class='rparen'>)</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>