trackerific 0.2.1 → 0.3.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.
- data/.yardoc/checksums +6 -0
- data/.yardoc/objects/root.dat +0 -0
- data/.yardoc/proxy_types +0 -0
- data/VERSION +1 -1
- data/doc/Trackerific.html +258 -0
- data/doc/Trackerific/Base.html +390 -0
- data/doc/Trackerific/Details.html +514 -0
- data/doc/Trackerific/Error.html +127 -0
- data/doc/Trackerific/Event.html +601 -0
- data/doc/Trackerific/FedEx.html +395 -0
- data/doc/Trackerific/UPS.html +360 -0
- data/doc/Trackerific/USPS.html +453 -0
- data/doc/_index.html +195 -0
- data/doc/class_list.html +47 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +53 -0
- data/doc/css/style.css +320 -0
- data/doc/file.README.html +213 -0
- data/doc/file_list.html +49 -0
- data/doc/frames.html +13 -0
- data/doc/index.html +213 -0
- data/doc/js/app.js +205 -0
- data/doc/js/full_list.js +150 -0
- data/doc/js/jquery.js +16 -0
- data/doc/method_list.html +206 -0
- data/doc/top-level-namespace.html +103 -0
- data/lib/fedex.rb +17 -7
- data/lib/trackerific.rb +16 -2
- data/lib/trackerific_details.rb +30 -0
- data/lib/trackerific_event.rb +38 -0
- data/lib/ups.rb +40 -14
- data/lib/usps.rb +28 -5
- data/spec/lib/fedex_spec.rb +8 -10
- data/spec/lib/trackerific_details_spec.rb +19 -0
- data/spec/lib/trackerific_event_spec.rb +20 -0
- data/spec/lib/ups_spec.rb +8 -6
- data/spec/lib/usps_spec.rb +8 -10
- data/trackerific.gemspec +32 -1
- metadata +35 -4
|
@@ -0,0 +1,514 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
3
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
4
|
+
<head>
|
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
6
|
+
<title>
|
|
7
|
+
Class: Trackerific::Details
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.7.1
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
relpath = '..';
|
|
19
|
+
if (relpath != '') relpath += '/';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
|
23
|
+
|
|
24
|
+
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
</head>
|
|
28
|
+
<body>
|
|
29
|
+
<script type="text/javascript" charset="utf-8">
|
|
30
|
+
if (window.top.frames.main) document.body.className = 'frames';
|
|
31
|
+
</script>
|
|
32
|
+
|
|
33
|
+
<div id="header">
|
|
34
|
+
<div id="menu">
|
|
35
|
+
|
|
36
|
+
<a href="../_index.html">Index (D)</a> »
|
|
37
|
+
<span class='title'><span class='object_link'><a href="../Trackerific.html" title="Trackerific (module)">Trackerific</a></span></span>
|
|
38
|
+
»
|
|
39
|
+
<span class="title">Details</span>
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
|
43
|
+
</div>
|
|
44
|
+
|
|
45
|
+
<div id="search">
|
|
46
|
+
|
|
47
|
+
<a id="class_list_link" href="#">Class List</a>
|
|
48
|
+
|
|
49
|
+
<a id="method_list_link" href="#">Method List</a>
|
|
50
|
+
|
|
51
|
+
<a id="file_list_link" href="#">File List</a>
|
|
52
|
+
|
|
53
|
+
</div>
|
|
54
|
+
<div class="clear"></div>
|
|
55
|
+
</div>
|
|
56
|
+
|
|
57
|
+
<iframe id="search_frame"></iframe>
|
|
58
|
+
|
|
59
|
+
<div id="content"><h1>Class: Trackerific::Details
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
</h1>
|
|
64
|
+
|
|
65
|
+
<dl class="box">
|
|
66
|
+
|
|
67
|
+
<dt class="r1">Inherits:</dt>
|
|
68
|
+
<dd class="r1">
|
|
69
|
+
<span class="inheritName">Object</span>
|
|
70
|
+
|
|
71
|
+
<ul class="fullTree">
|
|
72
|
+
<li>Object</li>
|
|
73
|
+
|
|
74
|
+
<li class="next">Trackerific::Details</li>
|
|
75
|
+
|
|
76
|
+
</ul>
|
|
77
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
78
|
+
|
|
79
|
+
</dd>
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
<dt class="r2 last">Defined in:</dt>
|
|
90
|
+
<dd class="r2 last">lib/trackerific_details.rb</dd>
|
|
91
|
+
|
|
92
|
+
</dl>
|
|
93
|
+
<div class="clear"></div>
|
|
94
|
+
|
|
95
|
+
<h2>Overview</h2><div class="docstring">
|
|
96
|
+
<div class="discussion">
|
|
97
|
+
<p>
|
|
98
|
+
Details returned when tracking a package. Stores the package identifier, a
|
|
99
|
+
summary, and the events.
|
|
100
|
+
</p>
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
</div>
|
|
104
|
+
</div>
|
|
105
|
+
<div class="tags">
|
|
106
|
+
|
|
107
|
+
</div>
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
<h2>
|
|
114
|
+
Instance Method Summary
|
|
115
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
|
116
|
+
</h2>
|
|
117
|
+
|
|
118
|
+
<ul class="summary">
|
|
119
|
+
|
|
120
|
+
<li class="public ">
|
|
121
|
+
<span class="summary_signature">
|
|
122
|
+
|
|
123
|
+
<a href="#events-instance_method" title="#events (instance method)">- (Array, Trackerific::Event) <strong>events</strong> </a>
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
</span>
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
137
|
+
The tracking events.
|
|
138
|
+
</p>
|
|
139
|
+
</div></span>
|
|
140
|
+
|
|
141
|
+
</li>
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
<li class="public ">
|
|
145
|
+
<span class="summary_signature">
|
|
146
|
+
|
|
147
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Details) <strong>initialize</strong>(package_id, summary, events) </a>
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
</span>
|
|
152
|
+
|
|
153
|
+
<span class="note title constructor">constructor</span>
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
163
|
+
Provides a new instance of Details.
|
|
164
|
+
</p>
|
|
165
|
+
</div></span>
|
|
166
|
+
|
|
167
|
+
</li>
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
<li class="public ">
|
|
171
|
+
<span class="summary_signature">
|
|
172
|
+
|
|
173
|
+
<a href="#package_id-instance_method" title="#package_id (instance method)">- (String) <strong>package_id</strong> </a>
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
</span>
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
187
|
+
The package identifier.
|
|
188
|
+
</p>
|
|
189
|
+
</div></span>
|
|
190
|
+
|
|
191
|
+
</li>
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
<li class="public ">
|
|
195
|
+
<span class="summary_signature">
|
|
196
|
+
|
|
197
|
+
<a href="#summary-instance_method" title="#summary (instance method)">- (String) <strong>summary</strong> </a>
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
</span>
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
<span class="summary_desc"><div class='inline'><p>
|
|
211
|
+
A summary of the tracking status.
|
|
212
|
+
</p>
|
|
213
|
+
</div></span>
|
|
214
|
+
|
|
215
|
+
</li>
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
</ul>
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
<div id="constructor_details" class="method_details_list">
|
|
222
|
+
<h2>Constructor Details</h2>
|
|
223
|
+
|
|
224
|
+
<div class="method_details first">
|
|
225
|
+
<p class="signature first" id="initialize-instance_method">
|
|
226
|
+
|
|
227
|
+
- (<tt><span class='object_link'><a href="" title="Trackerific::Details (class)">Details</a></span></tt>) <strong>initialize</strong>(package_id, summary, events)
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
</p><div class="docstring">
|
|
232
|
+
<div class="discussion">
|
|
233
|
+
<p>
|
|
234
|
+
Provides a new instance of Details
|
|
235
|
+
</p>
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
</div>
|
|
239
|
+
</div>
|
|
240
|
+
<div class="tags">
|
|
241
|
+
<h3>Parameters:</h3>
|
|
242
|
+
<ul class="param">
|
|
243
|
+
|
|
244
|
+
<li>
|
|
245
|
+
|
|
246
|
+
<span class='name'>the</span>
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
—
|
|
254
|
+
<div class='inline'><p>
|
|
255
|
+
package identifier
|
|
256
|
+
</p>
|
|
257
|
+
</div>
|
|
258
|
+
|
|
259
|
+
</li>
|
|
260
|
+
|
|
261
|
+
<li>
|
|
262
|
+
|
|
263
|
+
<span class='name'>a</span>
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
—
|
|
271
|
+
<div class='inline'><p>
|
|
272
|
+
summary of the tracking status
|
|
273
|
+
</p>
|
|
274
|
+
</div>
|
|
275
|
+
|
|
276
|
+
</li>
|
|
277
|
+
|
|
278
|
+
<li>
|
|
279
|
+
|
|
280
|
+
<span class='name'>the</span>
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
<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>
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
—
|
|
288
|
+
<div class='inline'><p>
|
|
289
|
+
tracking events
|
|
290
|
+
</p>
|
|
291
|
+
</div>
|
|
292
|
+
|
|
293
|
+
</li>
|
|
294
|
+
|
|
295
|
+
</ul>
|
|
296
|
+
|
|
297
|
+
</div><table class="source_code">
|
|
298
|
+
<tr>
|
|
299
|
+
<td>
|
|
300
|
+
<pre class="lines">
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
9
|
|
304
|
+
10
|
|
305
|
+
11
|
|
306
|
+
12
|
|
307
|
+
13</pre>
|
|
308
|
+
</td>
|
|
309
|
+
<td>
|
|
310
|
+
<pre class="code"><span class="info file"># File 'lib/trackerific_details.rb', line 9</span>
|
|
311
|
+
|
|
312
|
+
<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
|
+
<span class='ivar'>@package_id</span> <span class='op'>=</span> <span class='id package_id'>package_id</span>
|
|
314
|
+
<span class='ivar'>@summary</span> <span class='op'>=</span> <span class='id summary'>summary</span>
|
|
315
|
+
<span class='ivar'>@events</span> <span class='op'>=</span> <span class='id events'>events</span>
|
|
316
|
+
<span class='kw'>end</span></pre>
|
|
317
|
+
</td>
|
|
318
|
+
</tr>
|
|
319
|
+
</table>
|
|
320
|
+
</div>
|
|
321
|
+
|
|
322
|
+
</div>
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
<div id="instance_method_details" class="method_details_list">
|
|
326
|
+
<h2>Instance Method Details</h2>
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
<div class="method_details first">
|
|
330
|
+
<p class="signature first" id="events-instance_method">
|
|
331
|
+
|
|
332
|
+
- (<tt>Array</tt>, <tt><span class='object_link'><a href="Event.html" title="Trackerific::Event (class)">Trackerific::Event</a></span></tt>) <strong>events</strong>
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
</p><div class="docstring">
|
|
337
|
+
<div class="discussion">
|
|
338
|
+
<p>
|
|
339
|
+
The tracking events
|
|
340
|
+
</p>
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
</div>
|
|
344
|
+
</div>
|
|
345
|
+
<div class="tags">
|
|
346
|
+
<h3>Returns:</h3>
|
|
347
|
+
<ul class="return">
|
|
348
|
+
|
|
349
|
+
<li>
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
<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>
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
—
|
|
357
|
+
<div class='inline'><p>
|
|
358
|
+
the tracking events
|
|
359
|
+
</p>
|
|
360
|
+
</div>
|
|
361
|
+
|
|
362
|
+
</li>
|
|
363
|
+
|
|
364
|
+
</ul>
|
|
365
|
+
|
|
366
|
+
</div><table class="source_code">
|
|
367
|
+
<tr>
|
|
368
|
+
<td>
|
|
369
|
+
<pre class="lines">
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
26
|
|
373
|
+
27
|
|
374
|
+
28</pre>
|
|
375
|
+
</td>
|
|
376
|
+
<td>
|
|
377
|
+
<pre class="code"><span class="info file"># File 'lib/trackerific_details.rb', line 26</span>
|
|
378
|
+
|
|
379
|
+
<span class='kw'>def</span> <span class='id events'>events</span>
|
|
380
|
+
<span class='ivar'>@events</span>
|
|
381
|
+
<span class='kw'>end</span></pre>
|
|
382
|
+
</td>
|
|
383
|
+
</tr>
|
|
384
|
+
</table>
|
|
385
|
+
</div>
|
|
386
|
+
|
|
387
|
+
<div class="method_details ">
|
|
388
|
+
<p class="signature " id="package_id-instance_method">
|
|
389
|
+
|
|
390
|
+
- (<tt>String</tt>) <strong>package_id</strong>
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
</p><div class="docstring">
|
|
395
|
+
<div class="discussion">
|
|
396
|
+
<p>
|
|
397
|
+
The package identifier
|
|
398
|
+
</p>
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
</div>
|
|
402
|
+
</div>
|
|
403
|
+
<div class="tags">
|
|
404
|
+
<h3>Returns:</h3>
|
|
405
|
+
<ul class="return">
|
|
406
|
+
|
|
407
|
+
<li>
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
—
|
|
415
|
+
<div class='inline'><p>
|
|
416
|
+
the package identifier
|
|
417
|
+
</p>
|
|
418
|
+
</div>
|
|
419
|
+
|
|
420
|
+
</li>
|
|
421
|
+
|
|
422
|
+
</ul>
|
|
423
|
+
|
|
424
|
+
</div><table class="source_code">
|
|
425
|
+
<tr>
|
|
426
|
+
<td>
|
|
427
|
+
<pre class="lines">
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
16
|
|
431
|
+
17
|
|
432
|
+
18</pre>
|
|
433
|
+
</td>
|
|
434
|
+
<td>
|
|
435
|
+
<pre class="code"><span class="info file"># File 'lib/trackerific_details.rb', line 16</span>
|
|
436
|
+
|
|
437
|
+
<span class='kw'>def</span> <span class='id package_id'>package_id</span>
|
|
438
|
+
<span class='ivar'>@package_id</span>
|
|
439
|
+
<span class='kw'>end</span></pre>
|
|
440
|
+
</td>
|
|
441
|
+
</tr>
|
|
442
|
+
</table>
|
|
443
|
+
</div>
|
|
444
|
+
|
|
445
|
+
<div class="method_details ">
|
|
446
|
+
<p class="signature " id="summary-instance_method">
|
|
447
|
+
|
|
448
|
+
- (<tt>String</tt>) <strong>summary</strong>
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
</p><div class="docstring">
|
|
453
|
+
<div class="discussion">
|
|
454
|
+
<p>
|
|
455
|
+
A summary of the tracking status
|
|
456
|
+
</p>
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
</div>
|
|
460
|
+
</div>
|
|
461
|
+
<div class="tags">
|
|
462
|
+
<h3>Returns:</h3>
|
|
463
|
+
<ul class="return">
|
|
464
|
+
|
|
465
|
+
<li>
|
|
466
|
+
|
|
467
|
+
|
|
468
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
469
|
+
|
|
470
|
+
|
|
471
|
+
|
|
472
|
+
—
|
|
473
|
+
<div class='inline'><p>
|
|
474
|
+
a summary of the tracking status
|
|
475
|
+
</p>
|
|
476
|
+
</div>
|
|
477
|
+
|
|
478
|
+
</li>
|
|
479
|
+
|
|
480
|
+
</ul>
|
|
481
|
+
|
|
482
|
+
</div><table class="source_code">
|
|
483
|
+
<tr>
|
|
484
|
+
<td>
|
|
485
|
+
<pre class="lines">
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
21
|
|
489
|
+
22
|
|
490
|
+
23</pre>
|
|
491
|
+
</td>
|
|
492
|
+
<td>
|
|
493
|
+
<pre class="code"><span class="info file"># File 'lib/trackerific_details.rb', line 21</span>
|
|
494
|
+
|
|
495
|
+
<span class='kw'>def</span> <span class='id summary'>summary</span>
|
|
496
|
+
<span class='ivar'>@summary</span>
|
|
497
|
+
<span class='kw'>end</span></pre>
|
|
498
|
+
</td>
|
|
499
|
+
</tr>
|
|
500
|
+
</table>
|
|
501
|
+
</div>
|
|
502
|
+
|
|
503
|
+
</div>
|
|
504
|
+
|
|
505
|
+
</div>
|
|
506
|
+
|
|
507
|
+
<div id="footer">
|
|
508
|
+
Generated on Mon Jun 13 13:53:34 2011 by
|
|
509
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
510
|
+
0.7.1 (ruby-1.9.2).
|
|
511
|
+
</div>
|
|
512
|
+
|
|
513
|
+
</body>
|
|
514
|
+
</html>
|