ez_paypal 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,278 @@
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: EZPaypal::Cart::RecurringProfile
8
+
9
+ &mdash; Documentation by YARD 0.7.5
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 (R)</a> &raquo;
37
+ <span class='title'><span class='object_link'><a href="../../EZPaypal.html" title="EZPaypal (module)">EZPaypal</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Cart.html" title="EZPaypal::Cart (module)">Cart</a></span></span>
38
+ &raquo;
39
+ <span class="title">RecurringProfile</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: EZPaypal::Cart::RecurringProfile
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">HashWithIndifferentAccess</span>
70
+
71
+ <ul class="fullTree">
72
+ <li>Object</li>
73
+
74
+ <li class="next">HashWithIndifferentAccess</li>
75
+
76
+ <li class="next">EZPaypal::Cart::RecurringProfile</li>
77
+
78
+ </ul>
79
+ <a href="#" class="inheritanceTree">show all</a>
80
+
81
+ </dd>
82
+
83
+
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+ <dt class="r2 last">Defined in:</dt>
92
+ <dd class="r2 last">lib/core/data.rb</dd>
93
+
94
+ </dl>
95
+ <div class="clear"></div>
96
+
97
+
98
+
99
+
100
+
101
+
102
+
103
+
104
+
105
+ <h2>
106
+ Instance Method Summary
107
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
108
+ </h2>
109
+
110
+ <ul class="summary">
111
+
112
+ <li class="public ">
113
+ <span class="summary_signature">
114
+
115
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (RecurringProfile) <strong>initialize</strong>(profile) </a>
116
+
117
+
118
+
119
+ </span>
120
+
121
+ <span class="note title constructor">constructor</span>
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+ <span class="summary_desc"><div class='inline'>
131
+ <p>Setup profile.</p>
132
+ </div></span>
133
+
134
+ </li>
135
+
136
+
137
+ </ul>
138
+
139
+
140
+
141
+ <div id="constructor_details" class="method_details_list">
142
+ <h2>Constructor Details</h2>
143
+
144
+ <div class="method_details first">
145
+ <p class="signature first" id="initialize-instance_method">
146
+
147
+ - (<tt><span class='object_link'><a href="" title="EZPaypal::Cart::RecurringProfile (class)">RecurringProfile</a></span></tt>) <strong>initialize</strong>(profile)
148
+
149
+
150
+
151
+ </p><div class="docstring">
152
+ <div class="discussion">
153
+
154
+ <p>Setup profile</p>
155
+
156
+
157
+ </div>
158
+ </div>
159
+ <div class="tags">
160
+ <h3>Parameters:</h3>
161
+ <ul class="param">
162
+
163
+ <li>
164
+
165
+ <span class='name'>profile</span>
166
+
167
+
168
+ <span class='type'>(<tt>Hash</tt>)</span>
169
+
170
+
171
+
172
+ &mdash;
173
+ <div class='inline'>
174
+ <h1>"email", "currency" =&gt; "USD" (default "USD"),</h1>
175
+
176
+ <p>"item_code", "unit_price", "quantity", "amount", "initial_amount" =&gt; "0"
177
+ (recurring profile will do auto-charge since begining! do not use this if
178
+ you are not sure), "start_date" =&gt; "2012/02/02" (Default Time.now),
179
+ "period" =&gt; "Day/Week/Month/Year" (default "Month"), "frequency" =&gt;
180
+ "1" (how many periods a purchase, default 1), "cycles" =&gt; "0" (total
181
+ cycles of recurring billing, default 0 means infinite)</p>
182
+
183
+ <pre></pre>
184
+ </div>
185
+
186
+ </li>
187
+
188
+ </ul>
189
+
190
+
191
+ </div><table class="source_code">
192
+ <tr>
193
+ <td>
194
+ <pre class="lines">
195
+
196
+
197
+ 190
198
+ 191
199
+ 192
200
+ 193
201
+ 194
202
+ 195
203
+ 196
204
+ 197
205
+ 198
206
+ 199
207
+ 200
208
+ 201
209
+ 202
210
+ 203
211
+ 204
212
+ 205
213
+ 206
214
+ 207
215
+ 208
216
+ 209
217
+ 210
218
+ 211
219
+ 212
220
+ 213
221
+ 214
222
+ 215
223
+ 216
224
+ 217
225
+ 218
226
+ 219</pre>
227
+ </td>
228
+ <td>
229
+ <pre class="code"><span class="info file"># File 'lib/core/data.rb', line 190</span>
230
+
231
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_profile'>profile</span><span class='rparen'>)</span>
232
+ <span class='id identifier rubyid_item'>item</span> <span class='op'>=</span> <span class='id identifier rubyid_profile'>profile</span>
233
+ <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span>
234
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>TOKEN</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_item'>item</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>token</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
235
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>EMAIL</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_item'>item</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>email</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
236
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>CURRENCYCODE</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_item'>item</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>currency</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>USD</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
237
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>FAILEDINITAMTACTION</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>CancelOnFailure</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='comment'>#ContinueOnFailure / CancelOnFailure
238
+ </span>
239
+ <span class='comment'># Display details
240
+ </span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>L_PAYMENTREQUEST_0_ITEMCATEGORY0</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_item'>item</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>category</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Physical</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
241
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>L_PAYMENTREQUEST_0_NAME0</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_item'>item</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>item_code</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
242
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>L_PAYMENTREQUEST_0_AMT0</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_item'>item</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>unit_price</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
243
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>L_PAYMENTREQUEST_0_QTY0</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_item'>item</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>quantity</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
244
+
245
+ <span class='comment'># Profile details
246
+ </span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>DESC</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_item'>item</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>item_code</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
247
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>AMT</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_item'>item</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>amount</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
248
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>QTY</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_item'>item</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>quantity</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
249
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>INITAMT</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_item'>item</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>initial_amount</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
250
+
251
+ <span class='comment'># Recurring details
252
+ </span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>PROFILESTARTDATE</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_item'>item</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>start_date</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_now'>now</span><span class='comma'>,</span>
253
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>BILLINGFREQUENCY</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_item'>item</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>frequency</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
254
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>BILLINGPERIOD</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_item'>item</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>period</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Month</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
255
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>TOTALBILLINGCYCLES</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_item'>item</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>cycles</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0</span><span class='tstring_end'>&quot;</span></span>
256
+
257
+ <span class='rbrace'>}</span>
258
+
259
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
260
+ <span class='kw'>end</span></pre>
261
+ </td>
262
+ </tr>
263
+ </table>
264
+ </div>
265
+
266
+ </div>
267
+
268
+
269
+ </div>
270
+
271
+ <div id="footer">
272
+ Generated on Sat Apr 21 02:53:51 2012 by
273
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
274
+ 0.7.5 (ruby-1.9.3).
275
+ </div>
276
+
277
+ </body>
278
+ </html>
@@ -0,0 +1,434 @@
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: EZPaypal::Cart::RecurringPurchaseCart
8
+
9
+ &mdash; Documentation by YARD 0.7.5
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 (R)</a> &raquo;
37
+ <span class='title'><span class='object_link'><a href="../../EZPaypal.html" title="EZPaypal (module)">EZPaypal</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Cart.html" title="EZPaypal::Cart (module)">Cart</a></span></span>
38
+ &raquo;
39
+ <span class="title">RecurringPurchaseCart</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: EZPaypal::Cart::RecurringPurchaseCart
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">HashWithIndifferentAccess</span>
70
+
71
+ <ul class="fullTree">
72
+ <li>Object</li>
73
+
74
+ <li class="next">HashWithIndifferentAccess</li>
75
+
76
+ <li class="next">EZPaypal::Cart::RecurringPurchaseCart</li>
77
+
78
+ </ul>
79
+ <a href="#" class="inheritanceTree">show all</a>
80
+
81
+ </dd>
82
+
83
+
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+ <dt class="r2 last">Defined in:</dt>
92
+ <dd class="r2 last">lib/core/data.rb</dd>
93
+
94
+ </dl>
95
+ <div class="clear"></div>
96
+
97
+ <h2>Overview</h2><div class="docstring">
98
+ <div class="discussion">
99
+
100
+ <p>A cart object that holds all recurring purchase items Note that this cart
101
+ only support one subscription item at a time</p>
102
+
103
+ <pre class="code ruby"><code>How to use:
104
+ -&gt; initialize Cart
105
+ -&gt; setup agreement (required)
106
+ -&gt; setup summary(required)
107
+ -&gt; done (please create profile after this, this cart only shows agreement for recurring items)
108
+ Note:
109
+ you are responsible for all the cost calculations</code></pre>
110
+
111
+
112
+ </div>
113
+ </div>
114
+ <div class="tags">
115
+
116
+
117
+ </div>
118
+
119
+
120
+
121
+
122
+
123
+
124
+
125
+ <h2>
126
+ Instance Method Summary
127
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
128
+ </h2>
129
+
130
+ <ul class="summary">
131
+
132
+ <li class="public ">
133
+ <span class="summary_signature">
134
+
135
+ <a href="#cartSize-instance_method" title="#cartSize (instance method)">- (Object) <strong>cartSize</strong> </a>
136
+
137
+
138
+
139
+ </span>
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+
148
+ <span class="summary_desc"><div class='inline'>
149
+ <p>Max cart size of this cart type.</p>
150
+ </div></span>
151
+
152
+ </li>
153
+
154
+
155
+ <li class="public ">
156
+ <span class="summary_signature">
157
+
158
+ <a href="#reset-instance_method" title="#reset (instance method)">- (Object) <strong>reset</strong> </a>
159
+
160
+
161
+
162
+ </span>
163
+
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+ <span class="summary_desc"><div class='inline'>
172
+ <p>Clean the cart.</p>
173
+ </div></span>
174
+
175
+ </li>
176
+
177
+
178
+ <li class="public ">
179
+ <span class="summary_signature">
180
+
181
+ <a href="#setupAgreement-instance_method" title="#setupAgreement (instance method)">- (Object) <strong>setupAgreement</strong>(agreement) </a>
182
+
183
+
184
+
185
+ </span>
186
+
187
+
188
+
189
+
190
+
191
+
192
+
193
+
194
+ <span class="summary_desc"><div class='inline'>
195
+ <p>Setup recurring payment agreement.</p>
196
+ </div></span>
197
+
198
+ </li>
199
+
200
+
201
+ </ul>
202
+
203
+
204
+
205
+
206
+
207
+ <div id="instance_method_details" class="method_details_list">
208
+ <h2>Instance Method Details</h2>
209
+
210
+
211
+ <div class="method_details first">
212
+ <p class="signature first" id="cartSize-instance_method">
213
+
214
+ - (<tt>Object</tt>) <strong>cartSize</strong>
215
+
216
+
217
+
218
+ </p><div class="docstring">
219
+ <div class="discussion">
220
+
221
+ <p>Max cart size of this cart type</p>
222
+
223
+
224
+ </div>
225
+ </div>
226
+ <div class="tags">
227
+
228
+
229
+ </div><table class="source_code">
230
+ <tr>
231
+ <td>
232
+ <pre class="lines">
233
+
234
+
235
+ 122
236
+ 123
237
+ 124</pre>
238
+ </td>
239
+ <td>
240
+ <pre class="code"><span class="info file"># File 'lib/core/data.rb', line 122</span>
241
+
242
+ <span class='kw'>def</span> <span class='id identifier rubyid_cartSize'>cartSize</span>
243
+ <span class='int'>1</span>
244
+ <span class='kw'>end</span></pre>
245
+ </td>
246
+ </tr>
247
+ </table>
248
+ </div>
249
+
250
+ <div class="method_details ">
251
+ <p class="signature " id="reset-instance_method">
252
+
253
+ - (<tt>Object</tt>) <strong>reset</strong>
254
+
255
+
256
+
257
+ </p><div class="docstring">
258
+ <div class="discussion">
259
+
260
+ <p>Clean the cart</p>
261
+
262
+
263
+ </div>
264
+ </div>
265
+ <div class="tags">
266
+
267
+
268
+ </div><table class="source_code">
269
+ <tr>
270
+ <td>
271
+ <pre class="lines">
272
+
273
+
274
+ 173
275
+ 174
276
+ 175</pre>
277
+ </td>
278
+ <td>
279
+ <pre class="code"><span class="info file"># File 'lib/core/data.rb', line 173</span>
280
+
281
+ <span class='kw'>def</span> <span class='id identifier rubyid_reset'>reset</span>
282
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_clear'>clear</span>
283
+ <span class='kw'>end</span></pre>
284
+ </td>
285
+ </tr>
286
+ </table>
287
+ </div>
288
+
289
+ <div class="method_details ">
290
+ <p class="signature " id="setupAgreement-instance_method">
291
+
292
+ - (<tt>Object</tt>) <strong>setupAgreement</strong>(agreement)
293
+
294
+
295
+
296
+ </p><div class="docstring">
297
+ <div class="discussion">
298
+
299
+ <p>Setup recurring payment agreement</p>
300
+
301
+
302
+ </div>
303
+ </div>
304
+ <div class="tags">
305
+ <h3>Parameters:</h3>
306
+ <ul class="param">
307
+
308
+ <li>
309
+
310
+ <span class='name'>agreement</span>
311
+
312
+
313
+ <span class='type'>(<tt>Hash</tt>)</span>
314
+
315
+
316
+
317
+ &mdash;
318
+ <div class='inline'>
319
+ <h1>=&gt; "digital / physical" (default physical),</h1>
320
+
321
+ <p>"currency" =&gt; "USD"(default "USD") "item_code" =&gt; ""(code should be
322
+ unique and meaningful), "unit_price", "quantity" ,"amount"</p>
323
+ </div>
324
+
325
+ </li>
326
+
327
+ </ul>
328
+
329
+
330
+ </div><table class="source_code">
331
+ <tr>
332
+ <td>
333
+ <pre class="lines">
334
+
335
+
336
+ 132
337
+ 133
338
+ 134
339
+ 135
340
+ 136
341
+ 137
342
+ 138
343
+ 139
344
+ 140
345
+ 141
346
+ 142
347
+ 143
348
+ 144
349
+ 145
350
+ 146
351
+ 147
352
+ 148
353
+ 149
354
+ 150
355
+ 151
356
+ 152
357
+ 153
358
+ 154
359
+ 155
360
+ 156
361
+ 157
362
+ 158
363
+ 159
364
+ 160
365
+ 161
366
+ 162
367
+ 163
368
+ 164
369
+ 165
370
+ 166
371
+ 167
372
+ 168
373
+ 169
374
+ 170</pre>
375
+ </td>
376
+ <td>
377
+ <pre class="code"><span class="info file"># File 'lib/core/data.rb', line 132</span>
378
+
379
+ <span class='kw'>def</span> <span class='id identifier rubyid_setupAgreement'>setupAgreement</span><span class='lparen'>(</span><span class='id identifier rubyid_agreement'>agreement</span><span class='rparen'>)</span>
380
+
381
+ <span class='comment'># Check max cart size, make sure do not exceed the limit
382
+ </span> <span class='id identifier rubyid_max'>max</span> <span class='op'>=</span> <span class='int'>0</span>
383
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='op'>|</span>
384
+ <span class='id identifier rubyid_max'>max</span> <span class='op'>=</span> <span class='id identifier rubyid_max'>max</span> <span class='op'>+</span> <span class='int'>1</span> <span class='kw'>if</span> <span class='id identifier rubyid_key'>key</span><span class='period'>.</span><span class='id identifier rubyid_match'>match</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^L_PAYMENTREQUEST_0_NAME</span><span class='regexp_end'>/</span></span><span class='rparen'>)</span>
385
+ <span class='kw'>end</span>
386
+ <span class='id identifier rubyid_throw'>throw</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Exceed max cart size: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_cartSize'>cartSize</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='lparen'>(</span><span class='id identifier rubyid_max'>max</span><span class='op'>+</span><span class='int'>1</span> <span class='op'>&gt;</span> <span class='id identifier rubyid_cartSize'>cartSize</span><span class='rparen'>)</span>
387
+
388
+ <span class='id identifier rubyid_item'>item</span> <span class='op'>=</span> <span class='id identifier rubyid_agreement'>agreement</span>
389
+ <span class='id identifier rubyid_current_index'>current_index</span> <span class='op'>=</span> <span class='id identifier rubyid_max'>max</span>
390
+ <span class='id identifier rubyid_current_item'>current_item</span> <span class='op'>=</span> <span class='lbrace'>{</span>
391
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>L_PAYMENTREQUEST_0_NAME</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_current_index'>current_index</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_item'>item</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>item_code</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
392
+ <span class='comment'>#&quot;L_PAYMENTREQUEST_0_NUMBER#{current_index}&quot; =&gt; item[&quot;item_code&quot;] || &quot;&quot;,
393
+ </span> <span class='comment'>#&quot;L_PAYMENTREQUEST_0_DESC#{current_index}&quot; =&gt; item[&quot;description&quot;] || &quot;&quot;,
394
+ </span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>L_PAYMENTREQUEST_0_AMT</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_current_index'>current_index</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_item'>item</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>unit_price</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
395
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>L_PAYMENTREQUEST_0_QTY</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_current_index'>current_index</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_item'>item</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>quantity</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
396
+
397
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>L_PAYMENTREQUEST_0_ITEMCATEGORY</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_current_index'>current_index</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_item'>item</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>category</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Physical</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
398
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>L_BILLINGTYPE</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_current_index'>current_index</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>RecurringPayments</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
399
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>L_BILLINGAGREEMENTDESCRIPTION</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_current_index'>current_index</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_item'>item</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>item_code</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span>
400
+ <span class='rbrace'>}</span>
401
+
402
+ <span class='id identifier rubyid_summary'>summary</span> <span class='op'>=</span> <span class='lbrace'>{</span>
403
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>PAYMENTREQUEST_0_PAYMENTACTION</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_item'>item</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>payment_action</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Sale</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
404
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>PAYMENTREQUEST_0_CURRENCYCODE</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_item'>item</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>currency</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>USD</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
405
+ <span class='comment'>#&quot;PAYMENTREQUEST_0_ITEMAMT&quot; =&gt; item[&quot;total&quot;] || &quot;0&quot;,
406
+ </span> <span class='comment'>#&quot;PAYMENTREQUEST_0_TAXAMT&quot; =&gt; item[&quot;tax&quot;] || &quot;0&quot;,
407
+ </span> <span class='comment'>#&quot;PAYMENTREQUEST_0_SHIPPINGAMT&quot; =&gt; item[&quot;shipping&quot;] || &quot;0&quot;,
408
+ </span> <span class='comment'>#&quot;PAYMENTREQUEST_0_HANDLINGAMT&quot; =&gt; item[&quot;handling&quot;] || &quot;0&quot;,
409
+ </span> <span class='comment'>#&quot;PAYMENTREQUEST_0_SHIPDISCAMT&quot; =&gt; item[&quot;shipping_discount&quot;] || &quot;0&quot;,
410
+ </span> <span class='comment'>#&quot;PAYMENTREQUEST_0_INSURANCEAMT&quot; =&gt; item[&quot;insurance&quot;] || &quot;0&quot;,
411
+ </span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>PAYMENTREQUEST_0_AMT</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_item'>item</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>amount</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
412
+
413
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>ALLOWNOTE</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_item'>item</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>allow_note</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
414
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>NOSHIPPING</span><span class='tstring_end'>&quot;</span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_item'>item</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>disable_change_shipping_info</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1</span><span class='tstring_end'>&quot;</span></span>
415
+ <span class='rbrace'>}</span>
416
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='id identifier rubyid_current_item'>current_item</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='id identifier rubyid_summary'>summary</span><span class='rparen'>)</span>
417
+ <span class='kw'>end</span></pre>
418
+ </td>
419
+ </tr>
420
+ </table>
421
+ </div>
422
+
423
+ </div>
424
+
425
+ </div>
426
+
427
+ <div id="footer">
428
+ Generated on Sat Apr 21 02:53:51 2012 by
429
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
430
+ 0.7.5 (ruby-1.9.3).
431
+ </div>
432
+
433
+ </body>
434
+ </html>