Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 46 lines (28 sloc) 0.87 kB
2fa2455 @mojombo Initial commit.
authored
1 OmniShip
2 ========
3
73de691 @mojombo Make README more accurate.
authored
4 WARNING: This library is Super Duper Alpha. You've been warned.
5
2fa2455 @mojombo Initial commit.
authored
6 Everyone likes to ship stuff around the world. And as coders, we like to
73de691 @mojombo Make README more accurate.
authored
7 interact with our favorite shipper via their API.
8
9 OmniShip uses Semantic Versioning and TomDoc. Look 'em up.
2fa2455 @mojombo Initial commit.
authored
10
11
12 Currently Supported Calls
13 -------------------------
14
15 * UPS
16 * Track
17
18
19 Usage
20 -----
21
22 Require the library:
23
24 require 'rubygems'
25 require 'omniship'
26
27 Set authentication details:
28
29 OmniShip::UPS.username = 'johndoe'
30 OmniShip::UPS.password = 'xk793Ab4G'
31 OmniShip::UPS.token = 'DFFBF2984239A2C6'
32
33 Track a package by tracking number:
34
35 trk = OmniShip::UPS.track('1z3050790327433970')
36
37 The result:
38
73de691 @mojombo Make README more accurate.
authored
39 trk.class
40 # => OmniShip::UPS::TrackResponse
41
42 trk.shipment.class
43 # => OmniShip::UPS::Track::Shipment
44
45 trk.shipment.scheduled_delivery
46 # => Mon Nov 29 12:00:00 UTC 2010
Something went wrong with that request. Please try again.