TaxCloud 1.0.0 → 1.0.1
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +8 -0
- data/Gemfile +9 -0
- data/Gemfile.lock +79 -0
- data/README +93 -0
- data/config.ru +2 -0
- data/doc/Gemfile.html +143 -0
- data/doc/Helper.html +249 -0
- data/doc/Object.html +193 -0
- data/doc/README.html +245 -0
- data/doc/TaxCloud.html +244 -0
- data/doc/TaxCloud/Address.html +356 -0
- data/doc/TaxCloud/AuthorizedResponse.html +226 -0
- data/doc/TaxCloud/AuthorizedService.html +304 -0
- data/doc/TaxCloud/AuthorizedWithCaptureResponse.html +246 -0
- data/doc/TaxCloud/BaseService.html +243 -0
- data/doc/TaxCloud/CapturedResponse.html +226 -0
- data/doc/TaxCloud/CartItem.html +341 -0
- data/doc/TaxCloud/CartItemResponse.html +256 -0
- data/doc/TaxCloud/CartItemsResponse.html +286 -0
- data/doc/TaxCloud/GetTICsResponse.html +284 -0
- data/doc/TaxCloud/LookupResponse.html +259 -0
- data/doc/TaxCloud/LookupService.html +230 -0
- data/doc/TaxCloud/MessageType.html +205 -0
- data/doc/TaxCloud/ResponseBase.html +214 -0
- data/doc/TaxCloud/ResponseMessage.html +212 -0
- data/doc/TaxCloud/ResponseType.html +212 -0
- data/doc/TaxCloud/ReturnedResponse.html +226 -0
- data/doc/TaxCloud/ReturnedService.html +231 -0
- data/doc/TaxCloud/TIC.html +272 -0
- data/doc/TaxCloud/TICService.html +292 -0
- data/doc/TaxCloud/VerifyAddressResult.html +361 -0
- data/doc/TaxCloud/VerifyAddressService.html +236 -0
- data/doc/created.rid +33 -0
- data/doc/images/add.png +0 -0
- data/doc/images/brick.png +0 -0
- data/doc/images/brick_link.png +0 -0
- data/doc/images/bug.png +0 -0
- data/doc/images/bullet_black.png +0 -0
- data/doc/images/bullet_toggle_minus.png +0 -0
- data/doc/images/bullet_toggle_plus.png +0 -0
- data/doc/images/date.png +0 -0
- data/doc/images/delete.png +0 -0
- data/doc/images/find.png +0 -0
- data/doc/images/loadingAnimation.gif +0 -0
- data/doc/images/macFFBgHack.png +0 -0
- data/doc/images/package.png +0 -0
- data/doc/images/page_green.png +0 -0
- data/doc/images/page_white_text.png +0 -0
- data/doc/images/page_white_width.png +0 -0
- data/doc/images/plugin.png +0 -0
- data/doc/images/ruby.png +0 -0
- data/doc/images/tag_blue.png +0 -0
- data/doc/images/tag_green.png +0 -0
- data/doc/images/transparent.png +0 -0
- data/doc/images/wrench.png +0 -0
- data/doc/images/wrench_orange.png +0 -0
- data/doc/images/zoom.png +0 -0
- data/doc/index.html +130 -0
- data/doc/js/darkfish.js +153 -0
- data/doc/js/jquery.js +18 -0
- data/doc/js/navigation.js +142 -0
- data/doc/js/search.js +94 -0
- data/doc/js/search_index.js +1 -0
- data/doc/js/searcher.js +228 -0
- data/doc/rdoc.css +543 -0
- data/doc/table_of_contents.html +200 -0
- data/lib/address.rb +27 -0
- data/lib/cartitem.rb +28 -0
- data/lib/response/authorized_response.rb +15 -0
- data/lib/response/authorized_with_capture_response.rb +16 -0
- data/lib/response/captured_response.rb +15 -0
- data/lib/response/cart_item_response.rb +11 -0
- data/lib/response/cart_items_response.rb +22 -0
- data/lib/response/get_ti_cs_response.rb +18 -0
- data/lib/response/lookup_response.rb +24 -0
- data/lib/response/message_type.rb +12 -0
- data/lib/response/response_base.rb +10 -0
- data/lib/response/response_message.rb +9 -0
- data/lib/response/response_type.rb +9 -0
- data/lib/response/returned_response.rb +15 -0
- data/lib/response/verify_address_result.rb +21 -0
- data/lib/service/authorized_service.rb +40 -0
- data/lib/service/base_service.rb +13 -0
- data/lib/service/lookup_service.rb +20 -0
- data/lib/service/returned_service.rb +19 -0
- data/lib/service/tic_service.rb +26 -0
- data/lib/service/verify_address_service.rb +26 -0
- data/lib/tic.rb +14 -0
- data/spec/helper.rb +38 -0
- data/spec/service/authorized_service_spec.rb +66 -0
- data/spec/service/lookup_service_spec.rb +45 -0
- data/spec/service/returned_service_spec.rb +36 -0
- data/spec/service/tic_serivce_spec.rb +47 -0
- data/spec/service/verify_address_service_spec.rb +24 -0
- data/spec/spec_helper.rb +12 -0
- data/taxcloud.gemspec +18 -0
- metadata +117 -3
data/doc/Object.html
ADDED
@@ -0,0 +1,193 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
|
3
|
+
<html>
|
4
|
+
<head>
|
5
|
+
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
|
6
|
+
|
7
|
+
<title>class Object - RDoc Documentation</title>
|
8
|
+
|
9
|
+
<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">
|
10
|
+
|
11
|
+
<script type="text/javascript">
|
12
|
+
var rdoc_rel_prefix = "./";
|
13
|
+
</script>
|
14
|
+
|
15
|
+
<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
|
16
|
+
<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
|
17
|
+
<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
|
18
|
+
<script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
|
19
|
+
<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
|
20
|
+
<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>
|
21
|
+
|
22
|
+
|
23
|
+
<body id="top" class="class">
|
24
|
+
<nav id="metadata">
|
25
|
+
<nav id="home-section" class="section">
|
26
|
+
<h3 class="section-header">
|
27
|
+
<a href="./index.html">Home</a>
|
28
|
+
<a href="./table_of_contents.html#classes">Classes</a>
|
29
|
+
<a href="./table_of_contents.html#methods">Methods</a>
|
30
|
+
</h3>
|
31
|
+
</nav>
|
32
|
+
|
33
|
+
|
34
|
+
<nav id="search-section" class="section project-section" class="initially-hidden">
|
35
|
+
<form action="#" method="get" accept-charset="utf-8">
|
36
|
+
<h3 class="section-header">
|
37
|
+
<input type="text" name="search" placeholder="Search" id="search-field"
|
38
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
39
|
+
</h3>
|
40
|
+
</form>
|
41
|
+
|
42
|
+
<ul id="search-results" class="initially-hidden"></ul>
|
43
|
+
</nav>
|
44
|
+
|
45
|
+
|
46
|
+
<div id="file-metadata">
|
47
|
+
<nav id="file-list-section" class="section">
|
48
|
+
<h3 class="section-header">Defined In</h3>
|
49
|
+
<ul>
|
50
|
+
<li>spec/service/authorized_service_spec.rb
|
51
|
+
<li>spec/service/lookup_service_spec.rb
|
52
|
+
<li>spec/service/returned_service_spec.rb
|
53
|
+
<li>spec/service/tic_serivce_spec.rb
|
54
|
+
<li>spec/service/verify_address_service_spec.rb
|
55
|
+
</ul>
|
56
|
+
</nav>
|
57
|
+
|
58
|
+
|
59
|
+
</div>
|
60
|
+
|
61
|
+
<div id="class-metadata">
|
62
|
+
|
63
|
+
<nav id="parent-class-section" class="section">
|
64
|
+
<h3 class="section-header">Parent</h3>
|
65
|
+
|
66
|
+
<p class="link">BasicObject
|
67
|
+
|
68
|
+
</nav>
|
69
|
+
|
70
|
+
<!-- Included Modules -->
|
71
|
+
<nav id="includes-section" class="section">
|
72
|
+
<h3 class="section-header">Included Modules</h3>
|
73
|
+
|
74
|
+
<ul class="link-list">
|
75
|
+
|
76
|
+
|
77
|
+
<li><a class="include" href="Helper.html">Helper</a>
|
78
|
+
|
79
|
+
|
80
|
+
</ul>
|
81
|
+
</nav>
|
82
|
+
|
83
|
+
|
84
|
+
</div>
|
85
|
+
|
86
|
+
<div id="project-metadata">
|
87
|
+
<nav id="fileindex-section" class="section project-section">
|
88
|
+
<h3 class="section-header">Pages</h3>
|
89
|
+
|
90
|
+
<ul>
|
91
|
+
|
92
|
+
<li class="file"><a href="./Gemfile.html">Gemfile</a>
|
93
|
+
|
94
|
+
<li class="file"><a href="./README.html">README</a>
|
95
|
+
|
96
|
+
</ul>
|
97
|
+
</nav>
|
98
|
+
|
99
|
+
<nav id="classindex-section" class="section project-section">
|
100
|
+
<h3 class="section-header">Class and Module Index</h3>
|
101
|
+
|
102
|
+
<ul class="link-list">
|
103
|
+
|
104
|
+
<li><a href="./TaxCloud.html">TaxCloud</a>
|
105
|
+
|
106
|
+
<li><a href="./TaxCloud.html">TaxCloud</a>
|
107
|
+
|
108
|
+
<li><a href="./TaxCloud/Address.html">TaxCloud::Address</a>
|
109
|
+
|
110
|
+
<li><a href="./TaxCloud/AuthorizedResponse.html">TaxCloud::AuthorizedResponse</a>
|
111
|
+
|
112
|
+
<li><a href="./TaxCloud/AuthorizedService.html">TaxCloud::AuthorizedService</a>
|
113
|
+
|
114
|
+
<li><a href="./TaxCloud/AuthorizedWithCaptureResponse.html">TaxCloud::AuthorizedWithCaptureResponse</a>
|
115
|
+
|
116
|
+
<li><a href="./TaxCloud/BaseService.html">TaxCloud::BaseService</a>
|
117
|
+
|
118
|
+
<li><a href="./TaxCloud/CapturedResponse.html">TaxCloud::CapturedResponse</a>
|
119
|
+
|
120
|
+
<li><a href="./TaxCloud/CartItem.html">TaxCloud::CartItem</a>
|
121
|
+
|
122
|
+
<li><a href="./TaxCloud/CartItemResponse.html">TaxCloud::CartItemResponse</a>
|
123
|
+
|
124
|
+
<li><a href="./TaxCloud/CartItemsResponse.html">TaxCloud::CartItemsResponse</a>
|
125
|
+
|
126
|
+
<li><a href="./TaxCloud/GetTICsResponse.html">TaxCloud::GetTICsResponse</a>
|
127
|
+
|
128
|
+
<li><a href="./TaxCloud/LookupResponse.html">TaxCloud::LookupResponse</a>
|
129
|
+
|
130
|
+
<li><a href="./TaxCloud/LookupService.html">TaxCloud::LookupService</a>
|
131
|
+
|
132
|
+
<li><a href="./TaxCloud/MessageType.html">TaxCloud::MessageType</a>
|
133
|
+
|
134
|
+
<li><a href="./TaxCloud/ResponseBase.html">TaxCloud::ResponseBase</a>
|
135
|
+
|
136
|
+
<li><a href="./TaxCloud/ResponseMessage.html">TaxCloud::ResponseMessage</a>
|
137
|
+
|
138
|
+
<li><a href="./TaxCloud/ResponseType.html">TaxCloud::ResponseType</a>
|
139
|
+
|
140
|
+
<li><a href="./TaxCloud/ReturnedResponse.html">TaxCloud::ReturnedResponse</a>
|
141
|
+
|
142
|
+
<li><a href="./TaxCloud/ReturnedService.html">TaxCloud::ReturnedService</a>
|
143
|
+
|
144
|
+
<li><a href="./TaxCloud/TIC.html">TaxCloud::TIC</a>
|
145
|
+
|
146
|
+
<li><a href="./TaxCloud/TICService.html">TaxCloud::TICService</a>
|
147
|
+
|
148
|
+
<li><a href="./TaxCloud/VerifyAddressResult.html">TaxCloud::VerifyAddressResult</a>
|
149
|
+
|
150
|
+
<li><a href="./TaxCloud/VerifyAddressService.html">TaxCloud::VerifyAddressService</a>
|
151
|
+
|
152
|
+
<li><a href="./Helper.html">Helper</a>
|
153
|
+
|
154
|
+
<li><a href="./Object.html">Object</a>
|
155
|
+
|
156
|
+
</ul>
|
157
|
+
</nav>
|
158
|
+
|
159
|
+
</div>
|
160
|
+
</nav>
|
161
|
+
|
162
|
+
<div id="documentation">
|
163
|
+
<h1 class="class">class Object</h1>
|
164
|
+
|
165
|
+
<div id="description" class="description">
|
166
|
+
|
167
|
+
</div><!-- description -->
|
168
|
+
|
169
|
+
|
170
|
+
|
171
|
+
|
172
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
173
|
+
|
174
|
+
|
175
|
+
|
176
|
+
|
177
|
+
|
178
|
+
|
179
|
+
|
180
|
+
|
181
|
+
<!-- Methods -->
|
182
|
+
|
183
|
+
</section><!-- 5Buntitled-5D -->
|
184
|
+
|
185
|
+
</div><!-- documentation -->
|
186
|
+
|
187
|
+
|
188
|
+
<footer id="validator-badges">
|
189
|
+
<p><a href="http://validator.w3.org/check/referer">[Validate]</a>
|
190
|
+
<p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.
|
191
|
+
<p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
|
192
|
+
</footer>
|
193
|
+
|
data/doc/README.html
ADDED
@@ -0,0 +1,245 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
|
3
|
+
<html>
|
4
|
+
<head>
|
5
|
+
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
|
6
|
+
|
7
|
+
<title>README - RDoc Documentation</title>
|
8
|
+
|
9
|
+
<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">
|
10
|
+
|
11
|
+
<script type="text/javascript">
|
12
|
+
var rdoc_rel_prefix = "./";
|
13
|
+
</script>
|
14
|
+
|
15
|
+
<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
|
16
|
+
<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
|
17
|
+
<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
|
18
|
+
<script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
|
19
|
+
<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
|
20
|
+
<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>
|
21
|
+
|
22
|
+
|
23
|
+
<body class="file">
|
24
|
+
<nav id="metadata">
|
25
|
+
<nav id="home-section" class="section">
|
26
|
+
<h3 class="section-header">
|
27
|
+
<a href="./index.html">Home</a>
|
28
|
+
<a href="./table_of_contents.html#classes">Classes</a>
|
29
|
+
<a href="./table_of_contents.html#methods">Methods</a>
|
30
|
+
</h3>
|
31
|
+
</nav>
|
32
|
+
|
33
|
+
|
34
|
+
<nav id="search-section" class="section project-section" class="initially-hidden">
|
35
|
+
<form action="#" method="get" accept-charset="utf-8">
|
36
|
+
<h3 class="section-header">
|
37
|
+
<input type="text" name="search" placeholder="Search" id="search-field"
|
38
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
39
|
+
</h3>
|
40
|
+
</form>
|
41
|
+
|
42
|
+
<ul id="search-results" class="initially-hidden"></ul>
|
43
|
+
</nav>
|
44
|
+
|
45
|
+
|
46
|
+
<div id="project-metadata">
|
47
|
+
<nav id="fileindex-section" class="section project-section">
|
48
|
+
<h3 class="section-header">Pages</h3>
|
49
|
+
|
50
|
+
<ul>
|
51
|
+
|
52
|
+
<li class="file"><a href="./Gemfile.html">Gemfile</a>
|
53
|
+
|
54
|
+
<li class="file"><a href="./README.html">README</a>
|
55
|
+
|
56
|
+
</ul>
|
57
|
+
</nav>
|
58
|
+
|
59
|
+
<nav id="classindex-section" class="section project-section">
|
60
|
+
<h3 class="section-header">Class and Module Index</h3>
|
61
|
+
|
62
|
+
<ul class="link-list">
|
63
|
+
|
64
|
+
<li><a href="./TaxCloud.html">TaxCloud</a>
|
65
|
+
|
66
|
+
<li><a href="./TaxCloud.html">TaxCloud</a>
|
67
|
+
|
68
|
+
<li><a href="./TaxCloud/Address.html">TaxCloud::Address</a>
|
69
|
+
|
70
|
+
<li><a href="./TaxCloud/AuthorizedResponse.html">TaxCloud::AuthorizedResponse</a>
|
71
|
+
|
72
|
+
<li><a href="./TaxCloud/AuthorizedService.html">TaxCloud::AuthorizedService</a>
|
73
|
+
|
74
|
+
<li><a href="./TaxCloud/AuthorizedWithCaptureResponse.html">TaxCloud::AuthorizedWithCaptureResponse</a>
|
75
|
+
|
76
|
+
<li><a href="./TaxCloud/BaseService.html">TaxCloud::BaseService</a>
|
77
|
+
|
78
|
+
<li><a href="./TaxCloud/CapturedResponse.html">TaxCloud::CapturedResponse</a>
|
79
|
+
|
80
|
+
<li><a href="./TaxCloud/CartItem.html">TaxCloud::CartItem</a>
|
81
|
+
|
82
|
+
<li><a href="./TaxCloud/CartItemResponse.html">TaxCloud::CartItemResponse</a>
|
83
|
+
|
84
|
+
<li><a href="./TaxCloud/CartItemsResponse.html">TaxCloud::CartItemsResponse</a>
|
85
|
+
|
86
|
+
<li><a href="./TaxCloud/GetTICsResponse.html">TaxCloud::GetTICsResponse</a>
|
87
|
+
|
88
|
+
<li><a href="./TaxCloud/LookupResponse.html">TaxCloud::LookupResponse</a>
|
89
|
+
|
90
|
+
<li><a href="./TaxCloud/LookupService.html">TaxCloud::LookupService</a>
|
91
|
+
|
92
|
+
<li><a href="./TaxCloud/MessageType.html">TaxCloud::MessageType</a>
|
93
|
+
|
94
|
+
<li><a href="./TaxCloud/ResponseBase.html">TaxCloud::ResponseBase</a>
|
95
|
+
|
96
|
+
<li><a href="./TaxCloud/ResponseMessage.html">TaxCloud::ResponseMessage</a>
|
97
|
+
|
98
|
+
<li><a href="./TaxCloud/ResponseType.html">TaxCloud::ResponseType</a>
|
99
|
+
|
100
|
+
<li><a href="./TaxCloud/ReturnedResponse.html">TaxCloud::ReturnedResponse</a>
|
101
|
+
|
102
|
+
<li><a href="./TaxCloud/ReturnedService.html">TaxCloud::ReturnedService</a>
|
103
|
+
|
104
|
+
<li><a href="./TaxCloud/TIC.html">TaxCloud::TIC</a>
|
105
|
+
|
106
|
+
<li><a href="./TaxCloud/TICService.html">TaxCloud::TICService</a>
|
107
|
+
|
108
|
+
<li><a href="./TaxCloud/VerifyAddressResult.html">TaxCloud::VerifyAddressResult</a>
|
109
|
+
|
110
|
+
<li><a href="./TaxCloud/VerifyAddressService.html">TaxCloud::VerifyAddressService</a>
|
111
|
+
|
112
|
+
<li><a href="./Helper.html">Helper</a>
|
113
|
+
|
114
|
+
<li><a href="./Object.html">Object</a>
|
115
|
+
|
116
|
+
</ul>
|
117
|
+
</nav>
|
118
|
+
|
119
|
+
</div>
|
120
|
+
</nav>
|
121
|
+
|
122
|
+
<div id="documentation" class="description">
|
123
|
+
|
124
|
+
<h2 id="label-TaxCloud+Sales+Tax+Calculation+Service"><a href="TaxCloud.html">TaxCloud</a> Sales Tax Calculation Service</h2>
|
125
|
+
|
126
|
+
<p><a href="TaxCloud.html">TaxCloud</a> is a free hosted service that
|
127
|
+
calculates the sales tax due on your transactions. Using <a
|
128
|
+
href="TaxCloud.html">TaxCloud</a> is as easy as calculating real-time
|
129
|
+
shipping, a common feature in most shopping carts today. When you calculate
|
130
|
+
real-time shipping, your website sends a request to the shipper to
|
131
|
+
determine the cost of shipping at a certain speed to a particular location.
|
132
|
+
<a href="TaxCloud.html">TaxCloud</a> works the same way.</p>
|
133
|
+
|
134
|
+
<p>When a customer is ready to check out, <a href="TaxCloud.html">TaxCloud</a>
|
135
|
+
sends your website the sales tax amount based on the origin, destination,
|
136
|
+
and class of goods. Your website displays that sales tax amount and adds it
|
137
|
+
on to the customer’s total. The customer finishes checking out, and your
|
138
|
+
website notifies <a href="TaxCloud.html">TaxCloud</a> that the purchase was
|
139
|
+
completed, allowing us to keep record the transaction for you.</p>
|
140
|
+
|
141
|
+
<p><a href="TaxCloud.html">TaxCloud</a> operates on a real-time web services
|
142
|
+
API.</p>
|
143
|
+
|
144
|
+
<p>See <a href="http://www.TaxCloud.net">www.TaxCloud.net</a> for more
|
145
|
+
information and to sign up for a free account</p>
|
146
|
+
|
147
|
+
<h2 id="label-Getting+Started">Getting Started</h2>
|
148
|
+
<ol><li>
|
149
|
+
<p>Create a <a href="TaxCloud.html">TaxCloud</a> merchant account at <a
|
150
|
+
href="http://www.TaxCloud.net">www.TaxCloud.net</a></p>
|
151
|
+
</li><li>
|
152
|
+
<p>Add a website to your <a href="TaxCloud.html">TaxCloud</a> account. This
|
153
|
+
will generate an API ID and API Key that you will</p>
|
154
|
+
</li></ol>
|
155
|
+
|
156
|
+
<p>need to use the service.</p>
|
157
|
+
<ol><li>
|
158
|
+
<p>Optional - create a USPS ID to use the address verification service. It is
|
159
|
+
recommended to verify</p>
|
160
|
+
</li></ol>
|
161
|
+
|
162
|
+
<p>each address to get the nine digit zip code. This allows <a
|
163
|
+
href="TaxCloud.html">TaxCloud</a> to determine the most accurate rate.</p>
|
164
|
+
<ol><li>
|
165
|
+
<p>Add the <a href="TaxCloud.html">TaxCloud</a> gem to your application.</p>
|
166
|
+
</li><li>
|
167
|
+
<p>Call the <a href="TaxCloud.html">TaxCloud</a> web services to calculate
|
168
|
+
sales tax.</p>
|
169
|
+
</li></ol>
|
170
|
+
|
171
|
+
<h2 id="label-Using+the+web+services">Using the web services</h2>
|
172
|
+
|
173
|
+
<p>TaxCloud’s API is build as a standard SOAP web service. This gem is not
|
174
|
+
required to use <a href="TaxCloud.html">TaxCloud</a>. It is meant to give
|
175
|
+
examples of how to use the service.</p>
|
176
|
+
|
177
|
+
<p><a href="TaxCloud.html">TaxCloud</a> determines a sales tax rate based on
|
178
|
+
the merchant's origin address, the customer's shipping address and the type
|
179
|
+
of project. There are three main services that will need to be integrated:
|
180
|
+
verify_address(), lookup(), and authorized_and_capture().</p>
|
181
|
+
|
182
|
+
<p>This process is designed with a shopping cart checkout in mind, but it can
|
183
|
+
be used for other applications. In a shopping cart the process would be to
|
184
|
+
verify the customer’s shipping address, and then call lookup() with the
|
185
|
+
addresses and the items in the shopping cart. This will return the tax to
|
186
|
+
apply to each item in the cart. Shipping is also included in the
|
187
|
+
calculation as it can sometimes be taxable.</p>
|
188
|
+
|
189
|
+
<p>Once the tax has been added to the order and you are ready to complete the
|
190
|
+
transaction the authorized_and_captured() service is called and the
|
191
|
+
transaction details are recorded.</p>
|
192
|
+
|
193
|
+
<p>You can reverse a cancelled order by calling the returned() service.</p>
|
194
|
+
|
195
|
+
<p>There are also services available to look up the TIC codes available in the
|
196
|
+
<a href="TaxCloud.html">TaxCloud</a> system. The Taxability Identifier
|
197
|
+
Codes define the type of product being sold so that the correct tax can be
|
198
|
+
applied. More information is available at: <a
|
199
|
+
href="http://www.taxcloud.net/tic/">www.taxcloud.net/tic/</a></p>
|
200
|
+
|
201
|
+
<h2 id="label-Integration">Integration</h2>
|
202
|
+
|
203
|
+
<p>The lib directory contains a number of ‘services’ which makes it easy to
|
204
|
+
call the <a href="TaxCloud.html">TaxCloud</a> services. Each service
|
205
|
+
represents one of the web services described above. They can be called from
|
206
|
+
any point in your application by passing in a few parameters. All the
|
207
|
+
required classes are included.</p>
|
208
|
+
|
209
|
+
<h2 id="label-Tests">Tests</h2>
|
210
|
+
|
211
|
+
<p>The included RSpec tests demonstrate how to use the services. You will need
|
212
|
+
to configure your <a href="TaxCloud.html">TaxCloud</a> API ID, API Key and
|
213
|
+
USPS ID in helper.rb to run the tests.</p>
|
214
|
+
|
215
|
+
<h2 id="label-Support">Support</h2>
|
216
|
+
|
217
|
+
<p>You can contact service@taxcloud.net with any questions you may have.</p>
|
218
|
+
|
219
|
+
<h2 id="label-Description+of+Contents">Description of Contents</h2>
|
220
|
+
|
221
|
+
<pre>|-- lib
|
222
|
+
| |-- response
|
223
|
+
| |-- service
|
224
|
+
| |--
|
225
|
+
|-- spec
|
226
|
+
| |-- service</pre>
|
227
|
+
|
228
|
+
<p>lib</p>
|
229
|
+
|
230
|
+
<pre>Includes TaxCloud specific classes, service classes and example response classes.</pre>
|
231
|
+
|
232
|
+
<p>spec</p>
|
233
|
+
|
234
|
+
<pre>Unit tests which demonstrate how to integrate with the TaxCloud services.</pre>
|
235
|
+
|
236
|
+
</div>
|
237
|
+
|
238
|
+
|
239
|
+
|
240
|
+
<footer id="validator-badges">
|
241
|
+
<p><a href="http://validator.w3.org/check/referer">[Validate]</a>
|
242
|
+
<p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.
|
243
|
+
<p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
|
244
|
+
</footer>
|
245
|
+
|
data/doc/TaxCloud.html
ADDED
@@ -0,0 +1,244 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
|
3
|
+
<html>
|
4
|
+
<head>
|
5
|
+
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
|
6
|
+
|
7
|
+
<title>class TaxCloud - RDoc Documentation</title>
|
8
|
+
|
9
|
+
<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">
|
10
|
+
|
11
|
+
<script type="text/javascript">
|
12
|
+
var rdoc_rel_prefix = "./";
|
13
|
+
</script>
|
14
|
+
|
15
|
+
<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
|
16
|
+
<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
|
17
|
+
<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
|
18
|
+
<script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
|
19
|
+
<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
|
20
|
+
<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>
|
21
|
+
|
22
|
+
|
23
|
+
<body id="top" class="class">
|
24
|
+
<nav id="metadata">
|
25
|
+
<nav id="home-section" class="section">
|
26
|
+
<h3 class="section-header">
|
27
|
+
<a href="./index.html">Home</a>
|
28
|
+
<a href="./table_of_contents.html#classes">Classes</a>
|
29
|
+
<a href="./table_of_contents.html#methods">Methods</a>
|
30
|
+
</h3>
|
31
|
+
</nav>
|
32
|
+
|
33
|
+
|
34
|
+
<nav id="search-section" class="section project-section" class="initially-hidden">
|
35
|
+
<form action="#" method="get" accept-charset="utf-8">
|
36
|
+
<h3 class="section-header">
|
37
|
+
<input type="text" name="search" placeholder="Search" id="search-field"
|
38
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
39
|
+
</h3>
|
40
|
+
</form>
|
41
|
+
|
42
|
+
<ul id="search-results" class="initially-hidden"></ul>
|
43
|
+
</nav>
|
44
|
+
|
45
|
+
|
46
|
+
<div id="file-metadata">
|
47
|
+
<nav id="file-list-section" class="section">
|
48
|
+
<h3 class="section-header">Defined In</h3>
|
49
|
+
<ul>
|
50
|
+
<li>lib/address.rb
|
51
|
+
<li>lib/cartitem.rb
|
52
|
+
<li>lib/response/authorized_response.rb
|
53
|
+
<li>lib/response/authorized_with_capture_response.rb
|
54
|
+
<li>lib/response/captured_response.rb
|
55
|
+
<li>lib/response/cart_item_response.rb
|
56
|
+
<li>lib/response/cart_items_response.rb
|
57
|
+
<li>lib/response/get_ti_cs_response.rb
|
58
|
+
<li>lib/response/lookup_response.rb
|
59
|
+
<li>lib/response/message_type.rb
|
60
|
+
<li>lib/response/response_base.rb
|
61
|
+
<li>lib/response/response_message.rb
|
62
|
+
<li>lib/response/response_type.rb
|
63
|
+
<li>lib/response/returned_response.rb
|
64
|
+
<li>lib/response/verify_address_result.rb
|
65
|
+
<li>lib/service/authorized_service.rb
|
66
|
+
<li>lib/service/base_service.rb
|
67
|
+
<li>lib/service/lookup_service.rb
|
68
|
+
<li>lib/service/returned_service.rb
|
69
|
+
<li>lib/service/tic_service.rb
|
70
|
+
<li>lib/service/verify_address_service.rb
|
71
|
+
<li>lib/tax_cloud.rb
|
72
|
+
</ul>
|
73
|
+
</nav>
|
74
|
+
|
75
|
+
|
76
|
+
</div>
|
77
|
+
|
78
|
+
<div id="class-metadata">
|
79
|
+
|
80
|
+
<nav id="parent-class-section" class="section">
|
81
|
+
<h3 class="section-header">Parent</h3>
|
82
|
+
|
83
|
+
<p class="link"><a href="Object.html">Object</a>
|
84
|
+
|
85
|
+
</nav>
|
86
|
+
|
87
|
+
|
88
|
+
<!-- Method Quickref -->
|
89
|
+
<nav id="method-list-section" class="section">
|
90
|
+
<h3 class="section-header">Methods</h3>
|
91
|
+
|
92
|
+
<ul class="link-list">
|
93
|
+
|
94
|
+
<li><a href="#method-c-hi">::hi</a>
|
95
|
+
|
96
|
+
</ul>
|
97
|
+
</nav>
|
98
|
+
|
99
|
+
</div>
|
100
|
+
|
101
|
+
<div id="project-metadata">
|
102
|
+
<nav id="fileindex-section" class="section project-section">
|
103
|
+
<h3 class="section-header">Pages</h3>
|
104
|
+
|
105
|
+
<ul>
|
106
|
+
|
107
|
+
<li class="file"><a href="./Gemfile.html">Gemfile</a>
|
108
|
+
|
109
|
+
<li class="file"><a href="./README.html">README</a>
|
110
|
+
|
111
|
+
</ul>
|
112
|
+
</nav>
|
113
|
+
|
114
|
+
<nav id="classindex-section" class="section project-section">
|
115
|
+
<h3 class="section-header">Class and Module Index</h3>
|
116
|
+
|
117
|
+
<ul class="link-list">
|
118
|
+
|
119
|
+
<li><a href="./TaxCloud.html">TaxCloud</a>
|
120
|
+
|
121
|
+
<li><a href="./TaxCloud.html">TaxCloud</a>
|
122
|
+
|
123
|
+
<li><a href="./TaxCloud/Address.html">TaxCloud::Address</a>
|
124
|
+
|
125
|
+
<li><a href="./TaxCloud/AuthorizedResponse.html">TaxCloud::AuthorizedResponse</a>
|
126
|
+
|
127
|
+
<li><a href="./TaxCloud/AuthorizedService.html">TaxCloud::AuthorizedService</a>
|
128
|
+
|
129
|
+
<li><a href="./TaxCloud/AuthorizedWithCaptureResponse.html">TaxCloud::AuthorizedWithCaptureResponse</a>
|
130
|
+
|
131
|
+
<li><a href="./TaxCloud/BaseService.html">TaxCloud::BaseService</a>
|
132
|
+
|
133
|
+
<li><a href="./TaxCloud/CapturedResponse.html">TaxCloud::CapturedResponse</a>
|
134
|
+
|
135
|
+
<li><a href="./TaxCloud/CartItem.html">TaxCloud::CartItem</a>
|
136
|
+
|
137
|
+
<li><a href="./TaxCloud/CartItemResponse.html">TaxCloud::CartItemResponse</a>
|
138
|
+
|
139
|
+
<li><a href="./TaxCloud/CartItemsResponse.html">TaxCloud::CartItemsResponse</a>
|
140
|
+
|
141
|
+
<li><a href="./TaxCloud/GetTICsResponse.html">TaxCloud::GetTICsResponse</a>
|
142
|
+
|
143
|
+
<li><a href="./TaxCloud/LookupResponse.html">TaxCloud::LookupResponse</a>
|
144
|
+
|
145
|
+
<li><a href="./TaxCloud/LookupService.html">TaxCloud::LookupService</a>
|
146
|
+
|
147
|
+
<li><a href="./TaxCloud/MessageType.html">TaxCloud::MessageType</a>
|
148
|
+
|
149
|
+
<li><a href="./TaxCloud/ResponseBase.html">TaxCloud::ResponseBase</a>
|
150
|
+
|
151
|
+
<li><a href="./TaxCloud/ResponseMessage.html">TaxCloud::ResponseMessage</a>
|
152
|
+
|
153
|
+
<li><a href="./TaxCloud/ResponseType.html">TaxCloud::ResponseType</a>
|
154
|
+
|
155
|
+
<li><a href="./TaxCloud/ReturnedResponse.html">TaxCloud::ReturnedResponse</a>
|
156
|
+
|
157
|
+
<li><a href="./TaxCloud/ReturnedService.html">TaxCloud::ReturnedService</a>
|
158
|
+
|
159
|
+
<li><a href="./TaxCloud/TIC.html">TaxCloud::TIC</a>
|
160
|
+
|
161
|
+
<li><a href="./TaxCloud/TICService.html">TaxCloud::TICService</a>
|
162
|
+
|
163
|
+
<li><a href="./TaxCloud/VerifyAddressResult.html">TaxCloud::VerifyAddressResult</a>
|
164
|
+
|
165
|
+
<li><a href="./TaxCloud/VerifyAddressService.html">TaxCloud::VerifyAddressService</a>
|
166
|
+
|
167
|
+
<li><a href="./Helper.html">Helper</a>
|
168
|
+
|
169
|
+
<li><a href="./Object.html">Object</a>
|
170
|
+
|
171
|
+
</ul>
|
172
|
+
</nav>
|
173
|
+
|
174
|
+
</div>
|
175
|
+
</nav>
|
176
|
+
|
177
|
+
<div id="documentation">
|
178
|
+
<h1 class="class">class TaxCloud</h1>
|
179
|
+
|
180
|
+
<div id="description" class="description">
|
181
|
+
|
182
|
+
</div><!-- description -->
|
183
|
+
|
184
|
+
|
185
|
+
|
186
|
+
|
187
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
188
|
+
|
189
|
+
|
190
|
+
|
191
|
+
|
192
|
+
|
193
|
+
|
194
|
+
|
195
|
+
|
196
|
+
<!-- Methods -->
|
197
|
+
|
198
|
+
<section id="public-class-5Buntitled-5D-method-details" class="method-section section">
|
199
|
+
<h3 class="section-header">Public Class Methods</h3>
|
200
|
+
|
201
|
+
|
202
|
+
<div id="method-c-hi" class="method-detail ">
|
203
|
+
|
204
|
+
<div class="method-heading">
|
205
|
+
<span class="method-name">hi</span><span
|
206
|
+
class="method-args">()</span>
|
207
|
+
<span class="method-click-advice">click to toggle source</span>
|
208
|
+
</div>
|
209
|
+
|
210
|
+
|
211
|
+
<div class="method-description">
|
212
|
+
|
213
|
+
|
214
|
+
|
215
|
+
|
216
|
+
|
217
|
+
<div class="method-source-code" id="hi-source">
|
218
|
+
<pre><span class="ruby-comment"># File lib/tax_cloud.rb, line 2</span>
|
219
|
+
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">hi</span>
|
220
|
+
<span class="ruby-identifier">puts</span> <span class="ruby-string">'This is the TaxCloud gem.'</span>
|
221
|
+
<span class="ruby-keyword">end</span></pre>
|
222
|
+
</div><!-- hi-source -->
|
223
|
+
|
224
|
+
</div>
|
225
|
+
|
226
|
+
|
227
|
+
|
228
|
+
|
229
|
+
</div><!-- hi-method -->
|
230
|
+
|
231
|
+
|
232
|
+
</section><!-- public-class-method-details -->
|
233
|
+
|
234
|
+
</section><!-- 5Buntitled-5D -->
|
235
|
+
|
236
|
+
</div><!-- documentation -->
|
237
|
+
|
238
|
+
|
239
|
+
<footer id="validator-badges">
|
240
|
+
<p><a href="http://validator.w3.org/check/referer">[Validate]</a>
|
241
|
+
<p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.
|
242
|
+
<p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
|
243
|
+
</footer>
|
244
|
+
|