trackerific 0.3.1 → 0.3.2
Sign up to get free protection for your applications and to get access to all the features.
- data/Gemfile +2 -1
- data/Gemfile.lock +5 -1
- data/Rakefile +16 -0
- data/VERSION +1 -1
- data/doc/Trackerific.html +30 -20
- data/doc/Trackerific/Base.html +56 -89
- data/doc/Trackerific/Details.html +84 -33
- data/doc/Trackerific/Error.html +1 -1
- data/doc/Trackerific/Event.html +97 -59
- data/doc/Trackerific/FedEx.html +48 -89
- data/doc/Trackerific/UPS.html +46 -78
- data/doc/Trackerific/USPS.html +56 -145
- data/doc/_index.html +1 -1
- data/doc/file.README.html +1 -1
- data/doc/index.html +1 -1
- data/doc/method_list.html +13 -53
- data/doc/top-level-namespace.html +1 -1
- data/lib/fedex.rb +32 -17
- data/lib/trackerific.rb +41 -10
- data/lib/trackerific_details.rb +22 -3
- data/lib/trackerific_event.rb +27 -7
- data/lib/ups.rb +21 -12
- data/lib/usps.rb +32 -19
- data/spec/lib/trackerific_spec.rb +1 -7
- data/trackerific.gemspec +7 -7
- metadata +21 -7
- data/.yardoc/checksums +0 -6
- data/.yardoc/objects/root.dat +0 -0
- data/.yardoc/proxy_types +0 -0
data/Gemfile
CHANGED
data/Gemfile.lock
CHANGED
@@ -100,6 +100,9 @@ GEM
|
|
100
100
|
treetop (1.4.9)
|
101
101
|
polyglot (>= 0.3.1)
|
102
102
|
tzinfo (0.3.26)
|
103
|
+
yard (0.7.1)
|
104
|
+
yardstick (0.4.0)
|
105
|
+
yard (~> 0.7.0)
|
103
106
|
|
104
107
|
PLATFORMS
|
105
108
|
ruby
|
@@ -112,4 +115,5 @@ DEPENDENCIES
|
|
112
115
|
jeweler (>= 1.5.2)
|
113
116
|
rails (>= 3.0.0)
|
114
117
|
rspec-rails (>= 2.6.1)
|
115
|
-
ruby-debug19
|
118
|
+
ruby-debug19 (>= 0.11.6)
|
119
|
+
yardstick (>= 0.4.0)
|
data/Rakefile
CHANGED
@@ -21,3 +21,19 @@ Jeweler::Tasks.new do |gem|
|
|
21
21
|
gem.authors = ["Travis Haynes"]
|
22
22
|
end
|
23
23
|
Jeweler::RubygemsDotOrgTasks.new
|
24
|
+
|
25
|
+
# measure coverage
|
26
|
+
|
27
|
+
require 'yardstick/rake/measurement'
|
28
|
+
|
29
|
+
Yardstick::Rake::Measurement.new(:yardstick_measure) do |measurement|
|
30
|
+
measurement.output = 'measurement/report.txt'
|
31
|
+
end
|
32
|
+
|
33
|
+
# verify coverage
|
34
|
+
|
35
|
+
require 'yardstick/rake/verify'
|
36
|
+
|
37
|
+
Yardstick::Rake::Verify.new do |verify|
|
38
|
+
verify.threshold = 100
|
39
|
+
end
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
0.3.
|
1
|
+
0.3.2
|
data/doc/Trackerific.html
CHANGED
@@ -130,8 +130,7 @@ Trackerific is a UPS, FedEx and USPS tracking provider.
|
|
130
130
|
|
131
131
|
|
132
132
|
<span class="summary_desc"><div class='inline'><p>
|
133
|
-
Checks a string for a valid package
|
134
|
-
class that should be able to track the package.
|
133
|
+
Checks a string for a valid package tracking service.
|
135
134
|
</p>
|
136
135
|
</div></span>
|
137
136
|
|
@@ -157,20 +156,31 @@ class that should be able to track the package.
|
|
157
156
|
</p><div class="docstring">
|
158
157
|
<div class="discussion">
|
159
158
|
<p>
|
160
|
-
Checks a string for a valid package
|
161
|
-
class that should be able to track the package.
|
159
|
+
Checks a string for a valid package tracking service
|
162
160
|
</p>
|
163
161
|
|
164
162
|
|
165
163
|
</div>
|
166
164
|
</div>
|
167
165
|
<div class="tags">
|
168
|
-
|
166
|
+
|
167
|
+
<div class="examples">
|
168
|
+
<h3>Examples:</h3>
|
169
|
+
|
170
|
+
<h4><div class='inline'><p>
|
171
|
+
Find out which service provider will track a valid FedEx number
|
172
|
+
</p>
|
173
|
+
</div></h4>
|
174
|
+
<pre class="example code"><span class='id include'>include</span> <span class='const'>Trackerific</span>
|
175
|
+
<span class='id tracking_service'>tracking_service</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>183689015000001</span><span class='tstring_end'>"</span></span> <span class='comment'># => Trackerific::FedEx</span></pre>
|
176
|
+
|
177
|
+
</div>
|
178
|
+
<h3>Parameters:</h3>
|
169
179
|
<ul class="param">
|
170
180
|
|
171
181
|
<li>
|
172
182
|
|
173
|
-
<span class='name'>
|
183
|
+
<span class='name'>package_id</span>
|
174
184
|
|
175
185
|
|
176
186
|
<span class='type'>(<tt>String</tt>)</span>
|
@@ -179,7 +189,7 @@ class that should be able to track the package.
|
|
179
189
|
|
180
190
|
—
|
181
191
|
<div class='inline'><p>
|
182
|
-
package identifier
|
192
|
+
the package identifier
|
183
193
|
</p>
|
184
194
|
</div>
|
185
195
|
|
@@ -213,20 +223,20 @@ found.
|
|
213
223
|
<pre class="lines">
|
214
224
|
|
215
225
|
|
216
|
-
|
217
|
-
|
218
|
-
|
219
|
-
|
220
|
-
|
221
|
-
|
222
|
-
|
223
|
-
|
224
|
-
|
225
|
-
|
226
|
-
|
226
|
+
77
|
227
|
+
78
|
228
|
+
79
|
229
|
+
80
|
230
|
+
81
|
231
|
+
82
|
232
|
+
83
|
233
|
+
84
|
234
|
+
85
|
235
|
+
86
|
236
|
+
87</pre>
|
227
237
|
</td>
|
228
238
|
<td>
|
229
|
-
<pre class="code"><span class="info file"># File 'lib/trackerific.rb', line
|
239
|
+
<pre class="code"><span class="info file"># File 'lib/trackerific.rb', line 77</span>
|
230
240
|
|
231
241
|
<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>
|
232
242
|
<span class='kw'>case</span> <span class='id package_id'>package_id</span>
|
@@ -249,7 +259,7 @@ found.
|
|
249
259
|
</div>
|
250
260
|
|
251
261
|
<div id="footer">
|
252
|
-
Generated on Mon Jun 13
|
262
|
+
Generated on Mon Jun 13 16:20:05 2011 by
|
253
263
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
254
264
|
0.7.1 (ruby-1.9.2).
|
255
265
|
</div>
|
data/doc/Trackerific/Base.html
CHANGED
@@ -135,35 +135,11 @@ Base class for Trackerific package tracking services.
|
|
135
135
|
|
136
136
|
|
137
137
|
|
138
|
-
|
139
|
-
|
140
|
-
|
141
|
-
<span class="summary_desc"><div class='inline'><p>
|
142
|
-
A new instance of Base.
|
143
|
-
</p>
|
144
|
-
</div></span>
|
145
|
-
|
146
|
-
</li>
|
147
|
-
|
148
|
-
|
149
|
-
<li class="public ">
|
150
|
-
<span class="summary_signature">
|
151
|
-
|
152
|
-
<a href="#required_options-instance_method" title="#required_options (instance method)">- (Array) <strong>required_options</strong> </a>
|
153
|
-
|
154
|
-
|
155
|
-
|
156
|
-
</span>
|
157
|
-
|
158
|
-
|
159
|
-
|
160
|
-
|
161
|
-
|
162
|
-
|
138
|
+
<span class="private note title">Private</span>
|
163
139
|
|
164
140
|
|
165
141
|
<span class="summary_desc"><div class='inline'><p>
|
166
|
-
|
142
|
+
Creates a new instance of Trackerific::Base with required options.
|
167
143
|
</p>
|
168
144
|
</div></span>
|
169
145
|
|
@@ -173,7 +149,7 @@ Override this method if your subclass has required options.
|
|
173
149
|
<li class="public ">
|
174
150
|
<span class="summary_signature">
|
175
151
|
|
176
|
-
<a href="#track_package-instance_method" title="#track_package (instance method)">- (
|
152
|
+
<a href="#track_package-instance_method" title="#track_package (instance method)">- (Trackerific::Details) <strong>track_package</strong>(package_id) </a>
|
177
153
|
|
178
154
|
|
179
155
|
|
@@ -187,7 +163,7 @@ Override this method if your subclass has required options.
|
|
187
163
|
|
188
164
|
|
189
165
|
<span class="summary_desc"><div class='inline'><p>
|
190
|
-
|
166
|
+
Gets the tracking information for the package from the server.
|
191
167
|
</p>
|
192
168
|
</div></span>
|
193
169
|
|
@@ -209,8 +185,12 @@ Override this method in your subclass to implement tracking a package.
|
|
209
185
|
|
210
186
|
</p><div class="docstring">
|
211
187
|
<div class="discussion">
|
212
|
-
<p>
|
213
|
-
|
188
|
+
<p class="note private">
|
189
|
+
<strong>This method is part of a private API.</strong>
|
190
|
+
You should avoid using this method if possible, as it may be removed or be changed in the future.
|
191
|
+
</p>
|
192
|
+
<p>
|
193
|
+
Creates a new instance of Trackerific::Base with required options
|
214
194
|
</p>
|
215
195
|
|
216
196
|
|
@@ -224,8 +204,6 @@ A new instance of Base
|
|
224
204
|
<pre class="lines">
|
225
205
|
|
226
206
|
|
227
|
-
12
|
228
|
-
13
|
229
207
|
14
|
230
208
|
15
|
231
209
|
16
|
@@ -233,17 +211,23 @@ A new instance of Base
|
|
233
211
|
18
|
234
212
|
19
|
235
213
|
20
|
236
|
-
21
|
214
|
+
21
|
215
|
+
22
|
216
|
+
23
|
217
|
+
24
|
218
|
+
25</pre>
|
237
219
|
</td>
|
238
220
|
<td>
|
239
|
-
<pre class="code"><span class="info file"># File 'lib/trackerific.rb', line
|
221
|
+
<pre class="code"><span class="info file"># File 'lib/trackerific.rb', line 14</span>
|
240
222
|
|
241
223
|
<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>
|
242
224
|
<span class='id required'>required</span> <span class='op'>=</span> <span class='id required_options'>required_options</span>
|
243
|
-
<span class='
|
225
|
+
<span class='comment'># make sure all the required options exist
|
226
|
+
</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>
|
244
227
|
<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'>"</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'>"</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>
|
245
228
|
<span class='kw'>end</span>
|
246
|
-
<span class='
|
229
|
+
<span class='comment'># make sure no invalid options exist
|
230
|
+
</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>
|
247
231
|
<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'>"</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'>"</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>
|
248
232
|
<span class='kw'>end</span>
|
249
233
|
<span class='ivar'>@options</span> <span class='op'>=</span> <span class='id options'>options</span>
|
@@ -261,87 +245,70 @@ A new instance of Base
|
|
261
245
|
|
262
246
|
|
263
247
|
<div class="method_details first">
|
264
|
-
<p class="signature first" id="
|
248
|
+
<p class="signature first" id="track_package-instance_method">
|
265
249
|
|
266
|
-
- (<tt>
|
250
|
+
- (<tt><span class='object_link'><a href="Details.html" title="Trackerific::Details (class)">Trackerific::Details</a></span></tt>) <strong>track_package</strong>(package_id)
|
267
251
|
|
268
252
|
|
269
253
|
|
270
254
|
</p><div class="docstring">
|
271
255
|
<div class="discussion">
|
272
256
|
<p>
|
273
|
-
|
257
|
+
Gets the tracking information for the package from the server
|
274
258
|
</p>
|
275
259
|
|
276
260
|
|
277
261
|
</div>
|
278
262
|
</div>
|
279
263
|
<div class="tags">
|
280
|
-
|
281
|
-
<
|
264
|
+
|
265
|
+
<div class="examples">
|
266
|
+
<h3>Examples:</h3>
|
267
|
+
|
268
|
+
<h4><div class='inline'><p>
|
269
|
+
Override this method in your custom tracking provider to implement tracking
|
270
|
+
</p>
|
271
|
+
</div></h4>
|
272
|
+
<pre class="example code"><span class='kw'>module</span> <span class='const'>Trackerific</span>
|
273
|
+
<span class='kw'>class</span> <span class='const'>MyTrackingProvider</span> <span class='op'><</span> <span class='const'>Base</span>
|
274
|
+
<span class='kw'>def</span> <span class='id track_package'>track_package</span>
|
275
|
+
<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>
|
276
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>summary of tracking events</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
277
|
+
<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'>"</span><span class='tstring_content'>summary</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>location</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='rbracket'>]</span>
|
278
|
+
<span class='rparen'>)</span>
|
279
|
+
<span class='kw'>end</span>
|
280
|
+
<span class='kw'>end</span>
|
281
|
+
<span class='kw'>end</span></pre>
|
282
|
+
|
283
|
+
</div>
|
284
|
+
<h3>Parameters:</h3>
|
285
|
+
<ul class="param">
|
282
286
|
|
283
287
|
<li>
|
284
288
|
|
289
|
+
<span class='name'>package_id</span>
|
290
|
+
|
285
291
|
|
286
|
-
<span class='type'>(<tt>
|
292
|
+
<span class='type'>(<tt>String</tt>)</span>
|
287
293
|
|
288
294
|
|
289
295
|
|
290
296
|
—
|
291
297
|
<div class='inline'><p>
|
292
|
-
the
|
298
|
+
the package identifier
|
293
299
|
</p>
|
294
300
|
</div>
|
295
301
|
|
296
302
|
</li>
|
297
303
|
|
298
304
|
</ul>
|
299
|
-
|
300
|
-
</div><table class="source_code">
|
301
|
-
<tr>
|
302
|
-
<td>
|
303
|
-
<pre class="lines">
|
304
|
-
|
305
|
-
|
306
|
-
25
|
307
|
-
26
|
308
|
-
27</pre>
|
309
|
-
</td>
|
310
|
-
<td>
|
311
|
-
<pre class="code"><span class="info file"># File 'lib/trackerific.rb', line 25</span>
|
312
|
-
|
313
|
-
<span class='kw'>def</span> <span class='id required_options'>required_options</span>
|
314
|
-
<span class='lbracket'>[</span><span class='rbracket'>]</span>
|
315
|
-
<span class='kw'>end</span></pre>
|
316
|
-
</td>
|
317
|
-
</tr>
|
318
|
-
</table>
|
319
|
-
</div>
|
320
|
-
|
321
|
-
<div class="method_details ">
|
322
|
-
<p class="signature " id="track_package-instance_method">
|
323
|
-
|
324
|
-
- (<tt>Hash</tt>) <strong>track_package</strong>(package_id)
|
325
|
-
|
326
|
-
|
327
|
-
|
328
|
-
</p><div class="docstring">
|
329
|
-
<div class="discussion">
|
330
|
-
<p>
|
331
|
-
Override this method in your subclass to implement tracking a package.
|
332
|
-
</p>
|
333
|
-
|
334
|
-
|
335
|
-
</div>
|
336
|
-
</div>
|
337
|
-
<div class="tags">
|
338
|
-
<h3>Returns:</h3>
|
305
|
+
<h3>Returns:</h3>
|
339
306
|
<ul class="return">
|
340
307
|
|
341
308
|
<li>
|
342
309
|
|
343
310
|
|
344
|
-
<span class='type'>(<tt>
|
311
|
+
<span class='type'>(<tt><span class='object_link'><a href="Details.html" title="Trackerific::Details (class)">Trackerific::Details</a></span></tt>)</span>
|
345
312
|
|
346
313
|
|
347
314
|
|
@@ -361,12 +328,12 @@ the tracking details
|
|
361
328
|
<pre class="lines">
|
362
329
|
|
363
330
|
|
364
|
-
|
365
|
-
|
366
|
-
|
331
|
+
42
|
332
|
+
43
|
333
|
+
44</pre>
|
367
334
|
</td>
|
368
335
|
<td>
|
369
|
-
<pre class="code"><span class="info file"># File 'lib/trackerific.rb', line
|
336
|
+
<pre class="code"><span class="info file"># File 'lib/trackerific.rb', line 42</span>
|
370
337
|
|
371
338
|
<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>
|
372
339
|
<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
|
|
381
348
|
</div>
|
382
349
|
|
383
350
|
<div id="footer">
|
384
|
-
Generated on Mon Jun 13
|
351
|
+
Generated on Mon Jun 13 16:20:06 2011 by
|
385
352
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
386
353
|
0.7.1 (ruby-1.9.2).
|
387
354
|
</div>
|
@@ -134,7 +134,7 @@ summary, and the events.
|
|
134
134
|
|
135
135
|
|
136
136
|
<span class="summary_desc"><div class='inline'><p>
|
137
|
-
|
137
|
+
Read-only string for the events for this package.
|
138
138
|
</p>
|
139
139
|
</div></span>
|
140
140
|
|
@@ -156,7 +156,7 @@ The tracking events.
|
|
156
156
|
|
157
157
|
|
158
158
|
|
159
|
-
|
159
|
+
<span class="private note title">Private</span>
|
160
160
|
|
161
161
|
|
162
162
|
<span class="summary_desc"><div class='inline'><p>
|
@@ -184,7 +184,7 @@ Provides a new instance of Details.
|
|
184
184
|
|
185
185
|
|
186
186
|
<span class="summary_desc"><div class='inline'><p>
|
187
|
-
|
187
|
+
Read-only string for the package identifier.
|
188
188
|
</p>
|
189
189
|
</div></span>
|
190
190
|
|
@@ -208,7 +208,7 @@ The package identifier.
|
|
208
208
|
|
209
209
|
|
210
210
|
<span class="summary_desc"><div class='inline'><p>
|
211
|
-
|
211
|
+
Read-only string for the summary of the package’s tracking events.
|
212
212
|
</p>
|
213
213
|
</div></span>
|
214
214
|
|
@@ -230,7 +230,11 @@ A summary of the tracking status.
|
|
230
230
|
|
231
231
|
</p><div class="docstring">
|
232
232
|
<div class="discussion">
|
233
|
-
<p>
|
233
|
+
<p class="note private">
|
234
|
+
<strong>This method is part of a private API.</strong>
|
235
|
+
You should avoid using this method if possible, as it may be removed or be changed in the future.
|
236
|
+
</p>
|
237
|
+
<p>
|
234
238
|
Provides a new instance of Details
|
235
239
|
</p>
|
236
240
|
|
@@ -243,7 +247,7 @@ Provides a new instance of Details
|
|
243
247
|
|
244
248
|
<li>
|
245
249
|
|
246
|
-
<span class='name'>
|
250
|
+
<span class='name'>package_id</span>
|
247
251
|
|
248
252
|
|
249
253
|
<span class='type'>(<tt>String</tt>)</span>
|
@@ -252,7 +256,7 @@ Provides a new instance of Details
|
|
252
256
|
|
253
257
|
—
|
254
258
|
<div class='inline'><p>
|
255
|
-
package identifier
|
259
|
+
the package identifier
|
256
260
|
</p>
|
257
261
|
</div>
|
258
262
|
|
@@ -260,7 +264,7 @@ package identifier
|
|
260
264
|
|
261
265
|
<li>
|
262
266
|
|
263
|
-
<span class='name'>
|
267
|
+
<span class='name'>summary</span>
|
264
268
|
|
265
269
|
|
266
270
|
<span class='type'>(<tt>String</tt>)</span>
|
@@ -269,7 +273,7 @@ package identifier
|
|
269
273
|
|
270
274
|
—
|
271
275
|
<div class='inline'><p>
|
272
|
-
summary of the tracking status
|
276
|
+
a summary of the tracking status
|
273
277
|
</p>
|
274
278
|
</div>
|
275
279
|
|
@@ -277,7 +281,7 @@ summary of the tracking status
|
|
277
281
|
|
278
282
|
<li>
|
279
283
|
|
280
|
-
<span class='name'>
|
284
|
+
<span class='name'>events</span>
|
281
285
|
|
282
286
|
|
283
287
|
<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
|
|
286
290
|
|
287
291
|
—
|
288
292
|
<div class='inline'><p>
|
289
|
-
tracking events
|
293
|
+
the tracking events
|
290
294
|
</p>
|
291
295
|
</div>
|
292
296
|
|
@@ -300,14 +304,14 @@ tracking events
|
|
300
304
|
<pre class="lines">
|
301
305
|
|
302
306
|
|
303
|
-
9
|
304
307
|
10
|
305
308
|
11
|
306
309
|
12
|
307
|
-
13
|
310
|
+
13
|
311
|
+
14</pre>
|
308
312
|
</td>
|
309
313
|
<td>
|
310
|
-
<pre class="code"><span class="info file"># File 'lib/trackerific_details.rb', line
|
314
|
+
<pre class="code"><span class="info file"># File 'lib/trackerific_details.rb', line 10</span>
|
311
315
|
|
312
316
|
<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>
|
313
317
|
<span class='ivar'>@package_id</span> <span class='op'>=</span> <span class='id package_id'>package_id</span>
|
@@ -336,14 +340,39 @@ tracking events
|
|
336
340
|
</p><div class="docstring">
|
337
341
|
<div class="discussion">
|
338
342
|
<p>
|
339
|
-
|
343
|
+
Read-only string for the events for this package
|
340
344
|
</p>
|
341
345
|
|
342
346
|
|
343
347
|
</div>
|
344
348
|
</div>
|
345
349
|
<div class="tags">
|
346
|
-
|
350
|
+
|
351
|
+
<div class="examples">
|
352
|
+
<h3>Examples:</h3>
|
353
|
+
|
354
|
+
<h4><div class='inline'><p>
|
355
|
+
Print all the events for a tracked package
|
356
|
+
</p>
|
357
|
+
</div></h4>
|
358
|
+
<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>
|
359
|
+
|
360
|
+
<h4><div class='inline'><p>
|
361
|
+
Get the date the package was shipped
|
362
|
+
</p>
|
363
|
+
</div></h4>
|
364
|
+
<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'># => a DateTime value</span></pre>
|
365
|
+
|
366
|
+
<h4><div class='inline'><p>
|
367
|
+
A bulleted HTML list of the events (most current on top) in haml
|
368
|
+
</p>
|
369
|
+
</div></h4>
|
370
|
+
<pre class="example code">%ul
|
371
|
+
- details.events.each do |event|
|
372
|
+
%li= event</pre>
|
373
|
+
|
374
|
+
</div>
|
375
|
+
<h3>Returns:</h3>
|
347
376
|
<ul class="return">
|
348
377
|
|
349
378
|
<li>
|
@@ -369,12 +398,12 @@ the tracking events
|
|
369
398
|
<pre class="lines">
|
370
399
|
|
371
400
|
|
372
|
-
|
373
|
-
|
374
|
-
|
401
|
+
45
|
402
|
+
46
|
403
|
+
47</pre>
|
375
404
|
</td>
|
376
405
|
<td>
|
377
|
-
<pre class="code"><span class="info file"># File 'lib/trackerific_details.rb', line
|
406
|
+
<pre class="code"><span class="info file"># File 'lib/trackerific_details.rb', line 45</span>
|
378
407
|
|
379
408
|
<span class='kw'>def</span> <span class='id events'>events</span>
|
380
409
|
<span class='ivar'>@events</span>
|
@@ -394,14 +423,25 @@ the tracking events
|
|
394
423
|
</p><div class="docstring">
|
395
424
|
<div class="discussion">
|
396
425
|
<p>
|
397
|
-
|
426
|
+
Read-only string for the package identifier
|
398
427
|
</p>
|
399
428
|
|
400
429
|
|
401
430
|
</div>
|
402
431
|
</div>
|
403
432
|
<div class="tags">
|
404
|
-
|
433
|
+
|
434
|
+
<div class="examples">
|
435
|
+
<h3>Examples:</h3>
|
436
|
+
|
437
|
+
<h4><div class='inline'><p>
|
438
|
+
Get the id of a tracked package
|
439
|
+
</p>
|
440
|
+
</div></h4>
|
441
|
+
<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'># => the package identifier</span></pre>
|
442
|
+
|
443
|
+
</div>
|
444
|
+
<h3>Returns:</h3>
|
405
445
|
<ul class="return">
|
406
446
|
|
407
447
|
<li>
|
@@ -427,12 +467,12 @@ the package identifier
|
|
427
467
|
<pre class="lines">
|
428
468
|
|
429
469
|
|
430
|
-
|
431
|
-
|
432
|
-
|
470
|
+
21
|
471
|
+
22
|
472
|
+
23</pre>
|
433
473
|
</td>
|
434
474
|
<td>
|
435
|
-
<pre class="code"><span class="info file"># File 'lib/trackerific_details.rb', line
|
475
|
+
<pre class="code"><span class="info file"># File 'lib/trackerific_details.rb', line 21</span>
|
436
476
|
|
437
477
|
<span class='kw'>def</span> <span class='id package_id'>package_id</span>
|
438
478
|
<span class='ivar'>@package_id</span>
|
@@ -452,14 +492,25 @@ the package identifier
|
|
452
492
|
</p><div class="docstring">
|
453
493
|
<div class="discussion">
|
454
494
|
<p>
|
455
|
-
|
495
|
+
Read-only string for the summary of the package’s tracking events
|
456
496
|
</p>
|
457
497
|
|
458
498
|
|
459
499
|
</div>
|
460
500
|
</div>
|
461
501
|
<div class="tags">
|
462
|
-
|
502
|
+
|
503
|
+
<div class="examples">
|
504
|
+
<h3>Examples:</h3>
|
505
|
+
|
506
|
+
<h4><div class='inline'><p>
|
507
|
+
Get the summary of a tracked package
|
508
|
+
</p>
|
509
|
+
</div></h4>
|
510
|
+
<pre class="example code"><span class='id details'>details</span><span class='period'>.</span><span class='id summary'>summary</span> <span class='comment'># => Summary of the tracking events (i.e. Delivered)</span></pre>
|
511
|
+
|
512
|
+
</div>
|
513
|
+
<h3>Returns:</h3>
|
463
514
|
<ul class="return">
|
464
515
|
|
465
516
|
<li>
|
@@ -485,12 +536,12 @@ a summary of the tracking status
|
|
485
536
|
<pre class="lines">
|
486
537
|
|
487
538
|
|
488
|
-
|
489
|
-
|
490
|
-
|
539
|
+
30
|
540
|
+
31
|
541
|
+
32</pre>
|
491
542
|
</td>
|
492
543
|
<td>
|
493
|
-
<pre class="code"><span class="info file"># File 'lib/trackerific_details.rb', line
|
544
|
+
<pre class="code"><span class="info file"># File 'lib/trackerific_details.rb', line 30</span>
|
494
545
|
|
495
546
|
<span class='kw'>def</span> <span class='id summary'>summary</span>
|
496
547
|
<span class='ivar'>@summary</span>
|
@@ -505,7 +556,7 @@ a summary of the tracking status
|
|
505
556
|
</div>
|
506
557
|
|
507
558
|
<div id="footer">
|
508
|
-
Generated on Mon Jun 13
|
559
|
+
Generated on Mon Jun 13 16:20:06 2011 by
|
509
560
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
510
561
|
0.7.1 (ruby-1.9.2).
|
511
562
|
</div>
|