hps 2.2.5 → 2.3.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/LICENSE.md +264 -0
- data/README.md +44 -47
- data/hps.gemspec +2 -3
- data/lib/hps.rb +2 -0
- data/lib/hps/entities/hps_gift_card.rb +133 -0
- data/lib/hps/infrastructure/exceptions.json +81 -2
- data/lib/hps/infrastructure/hps_exception_mapper.rb +26 -15
- data/lib/hps/infrastructure/hps_input_validation.rb +1 -1
- data/lib/hps/services/hps_gift_card_service.rb +301 -0
- data/lib/hps/version.rb +1 -1
- data/tests/certification/gift_card_certification_test.rb +107 -0
- data/tests/certification/gift_card_certification_tests.rb +107 -0
- data/tests/exception_mapper_tests.rb +105 -38
- data/tests/giftcard_tests.rb +212 -0
- data/tests/test_data.rb +32 -22
- data/tests/test_helper.rb +63 -0
- metadata +14 -9
- data/LICENSE.txt +0 -32
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
|
-
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: fde3630d75851b0e8d0e3d57b8499a910f70fc1a6d9f4db50ec61f170dea6257
|
|
4
|
+
data.tar.gz: 7b2a572ae0cd537c9b9bdd5772afd584cec130a15afbe93514a23fb8e514f69a
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: d00ea93bbe04f5436f423c39f90e04931eff8115ee19658c2052684c6b4c6cf38723c185cf2801e0525c852dcc0e533fc93d9d2363825eddf1a06d6d4dcad32d
|
|
7
|
+
data.tar.gz: 0de30cb6cfff974b79c2ae40596d6b4b6ca1dd9e02c058e2a46c3ed1a6bef4ad2532e4cf4d6cade10843a5481ac89cb0a6a481e96fa22c31c0741743a56a57da
|
data/LICENSE.md
ADDED
|
@@ -0,0 +1,264 @@
|
|
|
1
|
+
The GNU General Public License, Version 2, June 1991 (GPLv2)
|
|
2
|
+
============================================================
|
|
3
|
+
|
|
4
|
+
> Copyright (C) 1989, 1991 Free Software Foundation, Inc.
|
|
5
|
+
> 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
|
6
|
+
|
|
7
|
+
Everyone is permitted to copy and distribute verbatim copies of this license
|
|
8
|
+
document, but changing it is not allowed.
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
Preamble
|
|
12
|
+
--------
|
|
13
|
+
|
|
14
|
+
The licenses for most software are designed to take away your freedom to share
|
|
15
|
+
and change it. By contrast, the GNU General Public License is intended to
|
|
16
|
+
guarantee your freedom to share and change free software--to make sure the
|
|
17
|
+
software is free for all its users. This General Public License applies to most
|
|
18
|
+
of the Free Software Foundation's software and to any other program whose
|
|
19
|
+
authors commit to using it. (Some other Free Software Foundation software is
|
|
20
|
+
covered by the GNU Library General Public License instead.) You can apply it to
|
|
21
|
+
your programs, too.
|
|
22
|
+
|
|
23
|
+
When we speak of free software, we are referring to freedom, not price. Our
|
|
24
|
+
General Public Licenses are designed to make sure that you have the freedom to
|
|
25
|
+
distribute copies of free software (and charge for this service if you wish),
|
|
26
|
+
that you receive source code or can get it if you want it, that you can change
|
|
27
|
+
the software or use pieces of it in new free programs; and that you know you can
|
|
28
|
+
do these things.
|
|
29
|
+
|
|
30
|
+
To protect your rights, we need to make restrictions that forbid anyone to deny
|
|
31
|
+
you these rights or to ask you to surrender the rights. These restrictions
|
|
32
|
+
translate to certain responsibilities for you if you distribute copies of the
|
|
33
|
+
software, or if you modify it.
|
|
34
|
+
|
|
35
|
+
For example, if you distribute copies of such a program, whether gratis or for a
|
|
36
|
+
fee, you must give the recipients all the rights that you have. You must make
|
|
37
|
+
sure that they, too, receive or can get the source code. And you must show them
|
|
38
|
+
these terms so they know their rights.
|
|
39
|
+
|
|
40
|
+
We protect your rights with two steps: (1) copyright the software, and (2) offer
|
|
41
|
+
you this license which gives you legal permission to copy, distribute and/or
|
|
42
|
+
modify the software.
|
|
43
|
+
|
|
44
|
+
Also, for each author's protection and ours, we want to make certain that
|
|
45
|
+
everyone understands that there is no warranty for this free software. If the
|
|
46
|
+
software is modified by someone else and passed on, we want its recipients to
|
|
47
|
+
know that what they have is not the original, so that any problems introduced by
|
|
48
|
+
others will not reflect on the original authors' reputations.
|
|
49
|
+
|
|
50
|
+
Finally, any free program is threatened constantly by software patents. We wish
|
|
51
|
+
to avoid the danger that redistributors of a free program will individually
|
|
52
|
+
obtain patent licenses, in effect making the program proprietary. To prevent
|
|
53
|
+
this, we have made it clear that any patent must be licensed for everyone's free
|
|
54
|
+
use or not licensed at all.
|
|
55
|
+
|
|
56
|
+
The precise terms and conditions for copying, distribution and modification
|
|
57
|
+
follow.
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
Terms And Conditions For Copying, Distribution And Modification
|
|
61
|
+
---------------------------------------------------------------
|
|
62
|
+
|
|
63
|
+
**0.** This License applies to any program or other work which contains a notice
|
|
64
|
+
placed by the copyright holder saying it may be distributed under the terms of
|
|
65
|
+
this General Public License. The "Program", below, refers to any such program or
|
|
66
|
+
work, and a "work based on the Program" means either the Program or any
|
|
67
|
+
derivative work under copyright law: that is to say, a work containing the
|
|
68
|
+
Program or a portion of it, either verbatim or with modifications and/or
|
|
69
|
+
translated into another language. (Hereinafter, translation is included without
|
|
70
|
+
limitation in the term "modification".) Each licensee is addressed as "you".
|
|
71
|
+
|
|
72
|
+
Activities other than copying, distribution and modification are not covered by
|
|
73
|
+
this License; they are outside its scope. The act of running the Program is not
|
|
74
|
+
restricted, and the output from the Program is covered only if its contents
|
|
75
|
+
constitute a work based on the Program (independent of having been made by
|
|
76
|
+
running the Program). Whether that is true depends on what the Program does.
|
|
77
|
+
|
|
78
|
+
**1.** You may copy and distribute verbatim copies of the Program's source code
|
|
79
|
+
as you receive it, in any medium, provided that you conspicuously and
|
|
80
|
+
appropriately publish on each copy an appropriate copyright notice and
|
|
81
|
+
disclaimer of warranty; keep intact all the notices that refer to this License
|
|
82
|
+
and to the absence of any warranty; and give any other recipients of the Program
|
|
83
|
+
a copy of this License along with the Program.
|
|
84
|
+
|
|
85
|
+
You may charge a fee for the physical act of transferring a copy, and you may at
|
|
86
|
+
your option offer warranty protection in exchange for a fee.
|
|
87
|
+
|
|
88
|
+
**2.** You may modify your copy or copies of the Program or any portion of it,
|
|
89
|
+
thus forming a work based on the Program, and copy and distribute such
|
|
90
|
+
modifications or work under the terms of Section 1 above, provided that you also
|
|
91
|
+
meet all of these conditions:
|
|
92
|
+
|
|
93
|
+
* **a)** You must cause the modified files to carry prominent notices stating
|
|
94
|
+
that you changed the files and the date of any change.
|
|
95
|
+
|
|
96
|
+
* **b)** You must cause any work that you distribute or publish, that in whole
|
|
97
|
+
or in part contains or is derived from the Program or any part thereof, to
|
|
98
|
+
be licensed as a whole at no charge to all third parties under the terms of
|
|
99
|
+
this License.
|
|
100
|
+
|
|
101
|
+
* **c)** If the modified program normally reads commands interactively when
|
|
102
|
+
run, you must cause it, when started running for such interactive use in the
|
|
103
|
+
most ordinary way, to print or display an announcement including an
|
|
104
|
+
appropriate copyright notice and a notice that there is no warranty (or
|
|
105
|
+
else, saying that you provide a warranty) and that users may redistribute
|
|
106
|
+
the program under these conditions, and telling the user how to view a copy
|
|
107
|
+
of this License. (Exception: if the Program itself is interactive but does
|
|
108
|
+
not normally print such an announcement, your work based on the Program is
|
|
109
|
+
not required to print an announcement.)
|
|
110
|
+
|
|
111
|
+
These requirements apply to the modified work as a whole. If identifiable
|
|
112
|
+
sections of that work are not derived from the Program, and can be reasonably
|
|
113
|
+
considered independent and separate works in themselves, then this License, and
|
|
114
|
+
its terms, do not apply to those sections when you distribute them as separate
|
|
115
|
+
works. But when you distribute the same sections as part of a whole which is a
|
|
116
|
+
work based on the Program, the distribution of the whole must be on the terms of
|
|
117
|
+
this License, whose permissions for other licensees extend to the entire whole,
|
|
118
|
+
and thus to each and every part regardless of who wrote it.
|
|
119
|
+
|
|
120
|
+
Thus, it is not the intent of this section to claim rights or contest your
|
|
121
|
+
rights to work written entirely by you; rather, the intent is to exercise the
|
|
122
|
+
right to control the distribution of derivative or collective works based on the
|
|
123
|
+
Program.
|
|
124
|
+
|
|
125
|
+
In addition, mere aggregation of another work not based on the Program with the
|
|
126
|
+
Program (or with a work based on the Program) on a volume of a storage or
|
|
127
|
+
distribution medium does not bring the other work under the scope of this
|
|
128
|
+
License.
|
|
129
|
+
|
|
130
|
+
**3.** You may copy and distribute the Program (or a work based on it, under
|
|
131
|
+
Section 2) in object code or executable form under the terms of Sections 1 and 2
|
|
132
|
+
above provided that you also do one of the following:
|
|
133
|
+
|
|
134
|
+
* **a)** Accompany it with the complete corresponding machine-readable source
|
|
135
|
+
code, which must be distributed under the terms of Sections 1 and 2 above on
|
|
136
|
+
a medium customarily used for software interchange; or,
|
|
137
|
+
|
|
138
|
+
* **b)** Accompany it with a written offer, valid for at least three years, to
|
|
139
|
+
give any third party, for a charge no more than your cost of physically
|
|
140
|
+
performing source distribution, a complete machine-readable copy of the
|
|
141
|
+
corresponding source code, to be distributed under the terms of Sections 1
|
|
142
|
+
and 2 above on a medium customarily used for software interchange; or,
|
|
143
|
+
|
|
144
|
+
* **c)** Accompany it with the information you received as to the offer to
|
|
145
|
+
distribute corresponding source code. (This alternative is allowed only for
|
|
146
|
+
noncommercial distribution and only if you received the program in object
|
|
147
|
+
code or executable form with such an offer, in accord with Subsection b
|
|
148
|
+
above.)
|
|
149
|
+
|
|
150
|
+
The source code for a work means the preferred form of the work for making
|
|
151
|
+
modifications to it. For an executable work, complete source code means all the
|
|
152
|
+
source code for all modules it contains, plus any associated interface
|
|
153
|
+
definition files, plus the scripts used to control compilation and installation
|
|
154
|
+
of the executable. However, as a special exception, the source code distributed
|
|
155
|
+
need not include anything that is normally distributed (in either source or
|
|
156
|
+
binary form) with the major components (compiler, kernel, and so on) of the
|
|
157
|
+
operating system on which the executable runs, unless that component itself
|
|
158
|
+
accompanies the executable.
|
|
159
|
+
|
|
160
|
+
If distribution of executable or object code is made by offering access to copy
|
|
161
|
+
from a designated place, then offering equivalent access to copy the source code
|
|
162
|
+
from the same place counts as distribution of the source code, even though third
|
|
163
|
+
parties are not compelled to copy the source along with the object code.
|
|
164
|
+
|
|
165
|
+
**4.** You may not copy, modify, sublicense, or distribute the Program except as
|
|
166
|
+
expressly provided under this License. Any attempt otherwise to copy, modify,
|
|
167
|
+
sublicense or distribute the Program is void, and will automatically terminate
|
|
168
|
+
your rights under this License. However, parties who have received copies, or
|
|
169
|
+
rights, from you under this License will not have their licenses terminated so
|
|
170
|
+
long as such parties remain in full compliance.
|
|
171
|
+
|
|
172
|
+
**5.** You are not required to accept this License, since you have not signed
|
|
173
|
+
it. However, nothing else grants you permission to modify or distribute the
|
|
174
|
+
Program or its derivative works. These actions are prohibited by law if you do
|
|
175
|
+
not accept this License. Therefore, by modifying or distributing the Program (or
|
|
176
|
+
any work based on the Program), you indicate your acceptance of this License to
|
|
177
|
+
do so, and all its terms and conditions for copying, distributing or modifying
|
|
178
|
+
the Program or works based on it.
|
|
179
|
+
|
|
180
|
+
**6.** Each time you redistribute the Program (or any work based on the
|
|
181
|
+
Program), the recipient automatically receives a license from the original
|
|
182
|
+
licensor to copy, distribute or modify the Program subject to these terms and
|
|
183
|
+
conditions. You may not impose any further restrictions on the recipients'
|
|
184
|
+
exercise of the rights granted herein. You are not responsible for enforcing
|
|
185
|
+
compliance by third parties to this License.
|
|
186
|
+
|
|
187
|
+
**7.** If, as a consequence of a court judgment or allegation of patent
|
|
188
|
+
infringement or for any other reason (not limited to patent issues), conditions
|
|
189
|
+
are imposed on you (whether by court order, agreement or otherwise) that
|
|
190
|
+
contradict the conditions of this License, they do not excuse you from the
|
|
191
|
+
conditions of this License. If you cannot distribute so as to satisfy
|
|
192
|
+
simultaneously your obligations under this License and any other pertinent
|
|
193
|
+
obligations, then as a consequence you may not distribute the Program at all.
|
|
194
|
+
For example, if a patent license would not permit royalty-free redistribution of
|
|
195
|
+
the Program by all those who receive copies directly or indirectly through you,
|
|
196
|
+
then the only way you could satisfy both it and this License would be to refrain
|
|
197
|
+
entirely from distribution of the Program.
|
|
198
|
+
|
|
199
|
+
If any portion of this section is held invalid or unenforceable under any
|
|
200
|
+
particular circumstance, the balance of the section is intended to apply and the
|
|
201
|
+
section as a whole is intended to apply in other circumstances.
|
|
202
|
+
|
|
203
|
+
It is not the purpose of this section to induce you to infringe any patents or
|
|
204
|
+
other property right claims or to contest validity of any such claims; this
|
|
205
|
+
section has the sole purpose of protecting the integrity of the free software
|
|
206
|
+
distribution system, which is implemented by public license practices. Many
|
|
207
|
+
people have made generous contributions to the wide range of software
|
|
208
|
+
distributed through that system in reliance on consistent application of that
|
|
209
|
+
system; it is up to the author/donor to decide if he or she is willing to
|
|
210
|
+
distribute software through any other system and a licensee cannot impose that
|
|
211
|
+
choice.
|
|
212
|
+
|
|
213
|
+
This section is intended to make thoroughly clear what is believed to be a
|
|
214
|
+
consequence of the rest of this License.
|
|
215
|
+
|
|
216
|
+
**8.** If the distribution and/or use of the Program is restricted in certain
|
|
217
|
+
countries either by patents or by copyrighted interfaces, the original copyright
|
|
218
|
+
holder who places the Program under this License may add an explicit
|
|
219
|
+
geographical distribution limitation excluding those countries, so that
|
|
220
|
+
distribution is permitted only in or among countries not thus excluded. In such
|
|
221
|
+
case, this License incorporates the limitation as if written in the body of this
|
|
222
|
+
License.
|
|
223
|
+
|
|
224
|
+
**9.** The Free Software Foundation may publish revised and/or new versions of
|
|
225
|
+
the General Public License from time to time. Such new versions will be similar
|
|
226
|
+
in spirit to the present version, but may differ in detail to address new
|
|
227
|
+
problems or concerns.
|
|
228
|
+
|
|
229
|
+
Each version is given a distinguishing version number. If the Program specifies
|
|
230
|
+
a version number of this License which applies to it and "any later version",
|
|
231
|
+
you have the option of following the terms and conditions either of that version
|
|
232
|
+
or of any later version published by the Free Software Foundation. If the
|
|
233
|
+
Program does not specify a version number of this License, you may choose any
|
|
234
|
+
version ever published by the Free Software Foundation.
|
|
235
|
+
|
|
236
|
+
**10.** If you wish to incorporate parts of the Program into other free programs
|
|
237
|
+
whose distribution conditions are different, write to the author to ask for
|
|
238
|
+
permission. For software which is copyrighted by the Free Software Foundation,
|
|
239
|
+
write to the Free Software Foundation; we sometimes make exceptions for this.
|
|
240
|
+
Our decision will be guided by the two goals of preserving the free status of
|
|
241
|
+
all derivatives of our free software and of promoting the sharing and reuse of
|
|
242
|
+
software generally.
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
No Warranty
|
|
246
|
+
-----------
|
|
247
|
+
|
|
248
|
+
**11.** BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR
|
|
249
|
+
THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE
|
|
250
|
+
STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM
|
|
251
|
+
"AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
|
|
252
|
+
BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
|
|
253
|
+
PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
|
|
254
|
+
PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
|
255
|
+
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
|
256
|
+
|
|
257
|
+
**12.** IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
|
258
|
+
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE
|
|
259
|
+
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
|
260
|
+
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR
|
|
261
|
+
INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA
|
|
262
|
+
BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
|
|
263
|
+
FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER
|
|
264
|
+
OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
|
data/README.md
CHANGED
|
@@ -15,32 +15,39 @@ This SDK makes it easy to integrate your Ruby application with Heartland's [**Po
|
|
|
15
15
|
|
|
16
16
|
Supported Gateway Calls
|
|
17
17
|
|
|
18
|
+
* BatchClose
|
|
18
19
|
* CheckSale
|
|
19
20
|
* CheckVoid
|
|
20
|
-
* CreditAccountVerify
|
|
21
|
-
* CreditAddToBatch
|
|
22
|
-
* CreditAuth
|
|
23
|
-
* CreditReturn
|
|
24
|
-
* CreditReversal
|
|
25
|
-
* CreditSale
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
|
|
21
|
+
* CreditAccountVerify
|
|
22
|
+
* CreditAddToBatch
|
|
23
|
+
* CreditAuth
|
|
24
|
+
* CreditReturn
|
|
25
|
+
* CreditReversal
|
|
26
|
+
* CreditSale
|
|
27
|
+
* GiftCardActivate
|
|
28
|
+
* GiftCardAddValue
|
|
29
|
+
* GiftCardAlias
|
|
30
|
+
* GiftCardBalance
|
|
31
|
+
* GiftCardDeactivate
|
|
32
|
+
* GiftCardReplace
|
|
33
|
+
* GiftCardReward
|
|
34
|
+
* GiftCardSale
|
|
35
|
+
* GiftCardVoid
|
|
36
|
+
* GiftCardReversal
|
|
37
|
+
* ReportActivity
|
|
38
|
+
* ReportTxnDetail
|
|
30
39
|
|
|
31
40
|
| <a href="#data-security"><b>Data Security</b></a> | <a href="#api-reference"><b>API Reference</b></a> | <a href="#testing--certification"><b>Testing & Certification</b></a> | <a href="#api-keys">API Keys</a> | Links |
|
|
32
41
|
|:--:|:--:|:--:|:--:|:--|
|
|
33
42
|
| [](#data-security) | [](#documentation-and-examples) | [](#certification--testing) | [](#api-keys) | <a href="http://developer.heartlandpaymentsystems.com/Account/Register" target="_blank">Register an Account</a> <br> <a href="http://www.heartlandpaymentsystems.com/partners/" target="_blank">Partner with Heartland</a> <br> <a href="http://developer.heartlandpaymentsystems.com/SecureSubmit/Support" target="_blank">Developer Support</a> |
|
|
34
43
|
|
|
35
|
-
|
|
36
44
|
#### Developer Support
|
|
37
45
|
|
|
38
46
|
You are not alone! If you have any questions while you are working through your development process, please feel free to <a href="mailto:entapp_devportal@e-hps.com?Subject=Developer Support Request">reach out to our team for assistance</a>.
|
|
39
47
|
|
|
40
|
-
|
|
41
48
|
## Requirements
|
|
42
|
-
Ruby 2.3+
|
|
43
49
|
|
|
50
|
+
Ruby 2.3+
|
|
44
51
|
|
|
45
52
|
## Installation
|
|
46
53
|
|
|
@@ -56,7 +63,6 @@ And then run Bundler :
|
|
|
56
63
|
|
|
57
64
|
> Bundler
|
|
58
65
|
|
|
59
|
-
|
|
60
66
|
## API Keys
|
|
61
67
|
|
|
62
68
|
<img src="http://developer.heartlandpaymentsystems.com/Resource/Download/sdk-readme-icon-keys" align="right"/>
|
|
@@ -72,41 +78,33 @@ Note: Multi-Use tokenization is not enabled by default when creating an account.
|
|
|
72
78
|
|
|
73
79
|
## Data Security
|
|
74
80
|
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
* **Secure Submit** for eCommerce web or mobile applications ("card-not-present"), which leverages single-use tokenization to prevent card data from passing through the merchant or integrator's webserver. It only requires a simple JavaScript inclusion and provides two options for payment field hosting:
|
|
79
|
-
|
|
80
|
-
* **Self-Hosted Fields** - this approach relies upon the standard, appropriately named, HTML form controls on the integrator's served web page.
|
|
81
|
+
<img src="http://developer.heartlandpaymentsystems.com/Resource/Download/sdk-readme-icon-secure" align="right"/>
|
|
82
|
+
If your app stores, processes, or transmits cardholder data in cleartext then it is in-scope for PA-DSS. If your app is hosted, or the data in question otherwise comes into your organization, then the app and your entire company are in-scope for PCI DSS (either as a merchant or a service provider). Heartland offers a suite of solutions to help keep integrators' applications and/or environments shielded from cardholder data, whether at motion or at rest.
|
|
81
83
|
|
|
82
|
-
|
|
84
|
+
- **Secure Submit** for eCommerce web or mobile applications ("card-not-present"), which leverages single-use tokenization to prevent card data from passing through the merchant or integrator's webserver. It only requires a simple JavaScript inclusion and provides two options for payment field hosting:
|
|
85
|
+
- **Self-Hosted Fields** - this approach relies upon the standard, appropriately named, HTML form controls on the integrator's served web page.
|
|
86
|
+
- **Heartland Hosted Fields** - this approach combines the Secure Submit service with iframes to handle presentation of the form fields and collection of sensitive data on Heartland servers. Since PCI version 3.1 the PCI Council and many QSAs advocate the iframe-based approach as enabling a merchant to more readily achieve PCI compliance via the simplified SAQ-A form. Check out the CoalFire's [whitepaper](http://developer.heartlandpaymentsystems.com/Resource/Download/coalfire-white-paper) for more information.
|
|
87
|
+
- **Heartland Secure** for card-present retailers, hospitality, and other "POS" applications, comprises three distinct security technologies working in concert:
|
|
88
|
+
- **End-to-End Encryption** (E3) - combines symmetric and asymmetric cryptography to form an "Identity-Based Encryption" methodology which keeps cardholder data encrypted from the moment of the swipe.
|
|
89
|
+
- **Tokenization** - replaces sensitive data values with non-sensitive representations which may be stored for recurring billing, future orders, etc.
|
|
90
|
+
- **EMV** - though less about data security and more about fraud prevention, EMV or chip card technology guarantees the authenticity of the payment card and is thus an important concern for retailers.
|
|
83
91
|
|
|
84
|
-
|
|
85
|
-
- **End-to-End Encryption** (E3) - combines symmetric and asymmetric cryptography to form an "Identity-Based Encryption" methodology which keeps cardholder data encrypted from the moment of the swipe.
|
|
92
|
+
Depending on your (or your customers') payment acceptance environment, you may need to support one or more of these technologies in addition to this SDK. This SDK also supports the ability to submit cleartext card numbers as input, but any developer who does so will be expected to demonstrate compliance with PA-DSS. Likewise any third party integrator who is planning on handling cleartext card data on behalf of other merchants will be expected to demonstrate their PCI DSS compliance as a Service Provider prior to completing certification with Heartland.
|
|
86
93
|
|
|
87
|
-
|
|
94
|
+
If you implement Secure Submit tokenization for your web or mobile application you will never have to deal with handling a card number - Heartland will take care of it for you and return a token to initiate the charge from your servers.
|
|
88
95
|
|
|
89
|
-
|
|
96
|
+
Similarly, if you implement Heartland Secure with E3 (for both swiped and keyed entry methods) then your POS application will be out-of-scope for PA-DSS. Heartland Secure certified devices will only ever return E3 encrypted data which can safely be passed through your systems as input to this SDK. Heartland Secure devices include many popular models manufactured by PAX and Ingenico.
|
|
90
97
|
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
If you implement Secure Submit tokenization for your web or mobile application you will never have to deal with handling a card number - Heartland will take care of it for you and return a token to initiate the charge from your servers.
|
|
94
|
-
|
|
95
|
-
Similarly, if you implement Heartland Secure with E3 (for both swiped and keyed entry methods) then your POS application will be out-of-scope for PA-DSS. Heartland Secure certified devices will only ever return E3 encrypted data which can safely be passed through your systems as input to this SDK. Heartland Secure devices include many popular models manufactured by PAX and Ingenico.
|
|
96
|
-
|
|
97
|
-
To summarize, when you create a payment method using this SDK you have the following options for securely avoiding interaction with sensitive cardholder data:
|
|
98
|
-
|
|
99
|
-
- Card data (track or PAN) may be sent directly from a web browser to Heartland, returning a SecureSubmit single use token that is then sent to your server.
|
|
100
|
-
|
|
101
|
-
- Encrypted card data (track or PAN) may be obtained directly from a Heartland Secure device and passed to the SDK
|
|
98
|
+
To summarize, when you create a payment method using this SDK you have the following options for securely avoiding interaction with sensitive cardholder data:
|
|
102
99
|
|
|
100
|
+
- Card data (track or PAN) may be sent directly from a web browser to Heartland, returning a SecureSubmit single use token that is then sent to your server.
|
|
101
|
+
- Encrypted card data (track or PAN) may be obtained directly from a Heartland Secure device and passed to the SDK
|
|
103
102
|
|
|
104
103
|
## Documentation and Examples
|
|
105
104
|
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
105
|
+
<img src="http://developer.heartlandpaymentsystems.com/Resource/Download/sdk-readme-icon-resources" align="right"/>
|
|
106
|
+
You can find the latest SDK documentation along with code examples on our [Developer Portal](http://developer.heartlandpaymentsystems.com/documentation).
|
|
107
|
+
In addition the included [test suite](http://github.hps.com/DevPortal/Ruby-SDK/tree/master/tests) can be a great source of code samples for using the SDK!
|
|
110
108
|
|
|
111
109
|
## Testing & Certification
|
|
112
110
|
|
|
@@ -186,13 +184,14 @@ During your integration you will want to test for specific issuer responses such
|
|
|
186
184
|
|
|
187
185
|
```ruby
|
|
188
186
|
begin
|
|
189
|
-
|
|
187
|
+
credit_service.charge(-5, 'usd', credit_card, card_holder)
|
|
190
188
|
rescue HpsInvalidRequestException => e
|
|
191
|
-
|
|
189
|
+
# handle error for amount less than zero dollars
|
|
192
190
|
rescue HpsAuthenticationException => e
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
191
|
+
# handle errors related to your HpsServiceConfig
|
|
192
|
+
rescue HpsCreditException => e
|
|
193
|
+
# handle card-related exceptions: card declined, processing error, etc
|
|
194
|
+
end
|
|
196
195
|
````
|
|
197
196
|
|
|
198
197
|
More exceptions can be found [here](https://github.com/hps/heartland-ruby/tree/master/lib/hps/infrastructure).
|
|
@@ -212,5 +211,3 @@ All our code is open sourced and we encourage fellow developers to contribute an
|
|
|
212
211
|
#### Included Test Suite
|
|
213
212
|
|
|
214
213
|
The included test suite can help ensure your contribution doesn't cause unexpected errors and is a terrific resource of working examples that you can reference. As mentioned earlier, the [certification folder](http://github.hps.com/DevPortal/Ruby-SDK/blob/master/tests/cert_tests.rb) contains tests that mirror the types of requirements you will encounter when you certify your integration for production.
|
|
215
|
-
|
|
216
|
-
|
data/hps.gemspec
CHANGED
|
@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
|
|
|
11
11
|
spec.description = %q{Ruby SDK for processing payments via Portico Gateway}
|
|
12
12
|
spec.summary = %q{Heartland Payment Systems - Portico Gateway SDK}
|
|
13
13
|
spec.homepage = ""
|
|
14
|
-
spec.license = "
|
|
14
|
+
spec.license = "GPL-2.0"
|
|
15
15
|
|
|
16
16
|
spec.files = `git ls-files`.split($/)
|
|
17
17
|
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
|
@@ -23,6 +23,5 @@ Gem::Specification.new do |spec|
|
|
|
23
23
|
spec.add_development_dependency "rspec"
|
|
24
24
|
spec.add_development_dependency "pry"
|
|
25
25
|
spec.add_dependency('builder', '>= 2.1.2', '< 4.0.0')
|
|
26
|
-
spec.add_dependency('activesupport', '>= 2.3.14', '
|
|
27
|
-
|
|
26
|
+
spec.add_dependency('activesupport', '>= 2.3.14', '<= 5.0.1')
|
|
28
27
|
end
|
data/lib/hps.rb
CHANGED
|
@@ -30,6 +30,7 @@ require "hps/entities/hps_check_holder"
|
|
|
30
30
|
require "hps/entities/hps_check_response"
|
|
31
31
|
require "hps/entities/hps_check_response_details"
|
|
32
32
|
require "hps/entities/hps_manage_tokens"
|
|
33
|
+
require "hps/entities/hps_gift_card"
|
|
33
34
|
|
|
34
35
|
# Infrastructure
|
|
35
36
|
require "hps/infrastructure/hps_sdk_codes"
|
|
@@ -53,6 +54,7 @@ require "hps/services/hps_service"
|
|
|
53
54
|
require "hps/services/hps_charge_service"
|
|
54
55
|
require "hps/services/hps_check_service"
|
|
55
56
|
require "hps/services/hps_batch_service"
|
|
57
|
+
require "hps/services/hps_gift_card_service"
|
|
56
58
|
|
|
57
59
|
module Hps
|
|
58
60
|
|