patmaddox-activemerchant 1.4.2
Sign up to get free protection for your applications and to get access to all the features.
- data/CHANGELOG +480 -0
- data/CONTRIBUTORS +126 -0
- data/MIT-LICENSE +20 -0
- data/README +136 -0
- data/Rakefile +153 -0
- data/gem-public_cert.pem +20 -0
- data/init.rb +3 -0
- data/lib/active_merchant.rb +66 -0
- data/lib/active_merchant/billing/avs_result.rb +98 -0
- data/lib/active_merchant/billing/base.rb +57 -0
- data/lib/active_merchant/billing/check.rb +68 -0
- data/lib/active_merchant/billing/credit_card.rb +159 -0
- data/lib/active_merchant/billing/credit_card_formatting.rb +21 -0
- data/lib/active_merchant/billing/credit_card_methods.rb +125 -0
- data/lib/active_merchant/billing/cvv_result.rb +38 -0
- data/lib/active_merchant/billing/expiry_date.rb +34 -0
- data/lib/active_merchant/billing/gateway.rb +158 -0
- data/lib/active_merchant/billing/gateways.rb +18 -0
- data/lib/active_merchant/billing/gateways/authorize_net.rb +657 -0
- data/lib/active_merchant/billing/gateways/authorize_net_cim.rb +743 -0
- data/lib/active_merchant/billing/gateways/beanstream.rb +102 -0
- data/lib/active_merchant/billing/gateways/beanstream/beanstream_core.rb +233 -0
- data/lib/active_merchant/billing/gateways/beanstream_interac.rb +54 -0
- data/lib/active_merchant/billing/gateways/bogus.rb +101 -0
- data/lib/active_merchant/billing/gateways/braintree.rb +17 -0
- data/lib/active_merchant/billing/gateways/card_stream.rb +230 -0
- data/lib/active_merchant/billing/gateways/cyber_source.rb +406 -0
- data/lib/active_merchant/billing/gateways/data_cash.rb +595 -0
- data/lib/active_merchant/billing/gateways/efsnet.rb +229 -0
- data/lib/active_merchant/billing/gateways/elavon.rb +134 -0
- data/lib/active_merchant/billing/gateways/eway.rb +277 -0
- data/lib/active_merchant/billing/gateways/exact.rb +222 -0
- data/lib/active_merchant/billing/gateways/first_pay.rb +172 -0
- data/lib/active_merchant/billing/gateways/instapay.rb +164 -0
- data/lib/active_merchant/billing/gateways/jetpay.rb +270 -0
- data/lib/active_merchant/billing/gateways/linkpoint.rb +449 -0
- data/lib/active_merchant/billing/gateways/merchant_e_solutions.rb +154 -0
- data/lib/active_merchant/billing/gateways/merchant_ware.rb +283 -0
- data/lib/active_merchant/billing/gateways/modern_payments.rb +36 -0
- data/lib/active_merchant/billing/gateways/modern_payments_cim.rb +220 -0
- data/lib/active_merchant/billing/gateways/moneris.rb +205 -0
- data/lib/active_merchant/billing/gateways/net_registry.rb +189 -0
- data/lib/active_merchant/billing/gateways/netbilling.rb +168 -0
- data/lib/active_merchant/billing/gateways/ogone.rb +279 -0
- data/lib/active_merchant/billing/gateways/pay_junction.rb +392 -0
- data/lib/active_merchant/billing/gateways/pay_secure.rb +120 -0
- data/lib/active_merchant/billing/gateways/payflow.rb +236 -0
- data/lib/active_merchant/billing/gateways/payflow/payflow_common_api.rb +207 -0
- data/lib/active_merchant/billing/gateways/payflow/payflow_express_response.rb +39 -0
- data/lib/active_merchant/billing/gateways/payflow/payflow_response.rb +13 -0
- data/lib/active_merchant/billing/gateways/payflow_express.rb +138 -0
- data/lib/active_merchant/billing/gateways/payflow_express_uk.rb +15 -0
- data/lib/active_merchant/billing/gateways/payflow_uk.rb +21 -0
- data/lib/active_merchant/billing/gateways/payment_express.rb +230 -0
- data/lib/active_merchant/billing/gateways/paypal.rb +121 -0
- data/lib/active_merchant/billing/gateways/paypal/paypal_common_api.rb +326 -0
- data/lib/active_merchant/billing/gateways/paypal/paypal_express_response.rb +38 -0
- data/lib/active_merchant/billing/gateways/paypal_ca.rb +13 -0
- data/lib/active_merchant/billing/gateways/paypal_express.rb +130 -0
- data/lib/active_merchant/billing/gateways/paypal_express_common.rb +20 -0
- data/lib/active_merchant/billing/gateways/plugnpay.rb +292 -0
- data/lib/active_merchant/billing/gateways/psigate.rb +214 -0
- data/lib/active_merchant/billing/gateways/psl_card.rb +306 -0
- data/lib/active_merchant/billing/gateways/quickpay.rb +213 -0
- data/lib/active_merchant/billing/gateways/realex.rb +200 -0
- data/lib/active_merchant/billing/gateways/sage.rb +146 -0
- data/lib/active_merchant/billing/gateways/sage/sage_bankcard.rb +88 -0
- data/lib/active_merchant/billing/gateways/sage/sage_core.rb +116 -0
- data/lib/active_merchant/billing/gateways/sage/sage_virtual_check.rb +97 -0
- data/lib/active_merchant/billing/gateways/sage_pay.rb +308 -0
- data/lib/active_merchant/billing/gateways/sallie_mae.rb +144 -0
- data/lib/active_merchant/billing/gateways/secure_pay.rb +31 -0
- data/lib/active_merchant/billing/gateways/secure_pay_au.rb +157 -0
- data/lib/active_merchant/billing/gateways/secure_pay_tech.rb +113 -0
- data/lib/active_merchant/billing/gateways/skip_jack.rb +452 -0
- data/lib/active_merchant/billing/gateways/smart_ps.rb +265 -0
- data/lib/active_merchant/billing/gateways/trans_first.rb +127 -0
- data/lib/active_merchant/billing/gateways/transax.rb +26 -0
- data/lib/active_merchant/billing/gateways/trust_commerce.rb +418 -0
- data/lib/active_merchant/billing/gateways/usa_epay.rb +194 -0
- data/lib/active_merchant/billing/gateways/verifi.rb +228 -0
- data/lib/active_merchant/billing/gateways/viaklix.rb +189 -0
- data/lib/active_merchant/billing/gateways/wirecard.rb +318 -0
- data/lib/active_merchant/billing/integrations.rb +29 -0
- data/lib/active_merchant/billing/integrations/action_view_helper.rb +79 -0
- data/lib/active_merchant/billing/integrations/bogus.rb +23 -0
- data/lib/active_merchant/billing/integrations/bogus/helper.rb +17 -0
- data/lib/active_merchant/billing/integrations/bogus/notification.rb +11 -0
- data/lib/active_merchant/billing/integrations/bogus/return.rb +10 -0
- data/lib/active_merchant/billing/integrations/chronopay.rb +23 -0
- data/lib/active_merchant/billing/integrations/chronopay/helper.rb +81 -0
- data/lib/active_merchant/billing/integrations/chronopay/notification.rb +156 -0
- data/lib/active_merchant/billing/integrations/chronopay/return.rb +10 -0
- data/lib/active_merchant/billing/integrations/gestpay.rb +25 -0
- data/lib/active_merchant/billing/integrations/gestpay/common.rb +42 -0
- data/lib/active_merchant/billing/integrations/gestpay/helper.rb +70 -0
- data/lib/active_merchant/billing/integrations/gestpay/notification.rb +83 -0
- data/lib/active_merchant/billing/integrations/gestpay/return.rb +10 -0
- data/lib/active_merchant/billing/integrations/helper.rb +93 -0
- data/lib/active_merchant/billing/integrations/hi_trust.rb +27 -0
- data/lib/active_merchant/billing/integrations/hi_trust/helper.rb +58 -0
- data/lib/active_merchant/billing/integrations/hi_trust/notification.rb +59 -0
- data/lib/active_merchant/billing/integrations/hi_trust/return.rb +67 -0
- data/lib/active_merchant/billing/integrations/nochex.rb +88 -0
- data/lib/active_merchant/billing/integrations/nochex/helper.rb +68 -0
- data/lib/active_merchant/billing/integrations/nochex/notification.rb +94 -0
- data/lib/active_merchant/billing/integrations/nochex/return.rb +10 -0
- data/lib/active_merchant/billing/integrations/notification.rb +62 -0
- data/lib/active_merchant/billing/integrations/paypal.rb +39 -0
- data/lib/active_merchant/billing/integrations/paypal/helper.rb +119 -0
- data/lib/active_merchant/billing/integrations/paypal/notification.rb +154 -0
- data/lib/active_merchant/billing/integrations/paypal/return.rb +10 -0
- data/lib/active_merchant/billing/integrations/quickpay.rb +17 -0
- data/lib/active_merchant/billing/integrations/quickpay/helper.rb +72 -0
- data/lib/active_merchant/billing/integrations/quickpay/notification.rb +74 -0
- data/lib/active_merchant/billing/integrations/return.rb +35 -0
- data/lib/active_merchant/billing/integrations/two_checkout.rb +23 -0
- data/lib/active_merchant/billing/integrations/two_checkout/helper.rb +59 -0
- data/lib/active_merchant/billing/integrations/two_checkout/notification.rb +114 -0
- data/lib/active_merchant/billing/integrations/two_checkout/return.rb +17 -0
- data/lib/active_merchant/billing/response.rb +32 -0
- data/lib/active_merchant/lib/connection.rb +170 -0
- data/lib/active_merchant/lib/country.rb +319 -0
- data/lib/active_merchant/lib/error.rb +4 -0
- data/lib/active_merchant/lib/post_data.rb +22 -0
- data/lib/active_merchant/lib/posts_data.rb +47 -0
- data/lib/active_merchant/lib/requires_parameters.rb +16 -0
- data/lib/active_merchant/lib/utils.rb +18 -0
- data/lib/active_merchant/lib/validateable.rb +76 -0
- data/lib/certs/cacert.pem +7815 -0
- data/lib/support/gateway_support.rb +58 -0
- data/script/destroy +14 -0
- data/script/generate +14 -0
- data/test/fixtures.yml +355 -0
- data/test/remote/gateways/remote_authorize_net_cim_test.rb +460 -0
- data/test/remote/gateways/remote_authorize_net_test.rb +145 -0
- data/test/remote/gateways/remote_beanstream_interac_test.rb +53 -0
- data/test/remote/gateways/remote_beanstream_test.rb +150 -0
- data/test/remote/gateways/remote_braintree_test.rb +154 -0
- data/test/remote/gateways/remote_card_stream_test.rb +148 -0
- data/test/remote/gateways/remote_cyber_source_test.rb +144 -0
- data/test/remote/gateways/remote_data_cash_test.rb +357 -0
- data/test/remote/gateways/remote_efsnet_test.rb +81 -0
- data/test/remote/gateways/remote_elavon_test.rb +66 -0
- data/test/remote/gateways/remote_eway_test.rb +74 -0
- data/test/remote/gateways/remote_exact_test.rb +60 -0
- data/test/remote/gateways/remote_first_pay_test.rb +87 -0
- data/test/remote/gateways/remote_instapay_test.rb +61 -0
- data/test/remote/gateways/remote_jetpay_test.rb +103 -0
- data/test/remote/gateways/remote_linkpoint_test.rb +121 -0
- data/test/remote/gateways/remote_merchant_e_solutions_test.rb +173 -0
- data/test/remote/gateways/remote_merchant_ware_test.rb +113 -0
- data/test/remote/gateways/remote_modern_payments_cim_test.rb +58 -0
- data/test/remote/gateways/remote_modern_payments_test.rb +57 -0
- data/test/remote/gateways/remote_moneris_test.rb +82 -0
- data/test/remote/gateways/remote_net_registry_test.rb +85 -0
- data/test/remote/gateways/remote_netbilling_test.rb +70 -0
- data/test/remote/gateways/remote_ogone_test.rb +115 -0
- data/test/remote/gateways/remote_pay_junction_test.rb +143 -0
- data/test/remote/gateways/remote_pay_secure_test.rb +39 -0
- data/test/remote/gateways/remote_payflow_express_test.rb +50 -0
- data/test/remote/gateways/remote_payflow_test.rb +237 -0
- data/test/remote/gateways/remote_payflow_uk_test.rb +173 -0
- data/test/remote/gateways/remote_payment_express_test.rb +136 -0
- data/test/remote/gateways/remote_paypal_express_test.rb +49 -0
- data/test/remote/gateways/remote_paypal_test.rb +191 -0
- data/test/remote/gateways/remote_plugnpay_test.rb +72 -0
- data/test/remote/gateways/remote_psigate_test.rb +50 -0
- data/test/remote/gateways/remote_psl_card_test.rb +125 -0
- data/test/remote/gateways/remote_quickpay_test.rb +190 -0
- data/test/remote/gateways/remote_realex_test.rb +224 -0
- data/test/remote/gateways/remote_sage_bankcard_test.rb +109 -0
- data/test/remote/gateways/remote_sage_pay_test.rb +219 -0
- data/test/remote/gateways/remote_sage_test.rb +87 -0
- data/test/remote/gateways/remote_sage_virtual_check_test.rb +62 -0
- data/test/remote/gateways/remote_sallie_mae_test.rb +51 -0
- data/test/remote/gateways/remote_secure_pay_au_test.rb +40 -0
- data/test/remote/gateways/remote_secure_pay_tech_test.rb +37 -0
- data/test/remote/gateways/remote_secure_pay_test.rb +28 -0
- data/test/remote/gateways/remote_skipjack_test.rb +105 -0
- data/test/remote/gateways/remote_trans_first_test.rb +34 -0
- data/test/remote/gateways/remote_transax_test.rb +112 -0
- data/test/remote/gateways/remote_trust_commerce_test.rb +152 -0
- data/test/remote/gateways/remote_usa_epay_test.rb +46 -0
- data/test/remote/gateways/remote_verifi_test.rb +107 -0
- data/test/remote/gateways/remote_viaklix_test.rb +43 -0
- data/test/remote/gateways/remote_wirecard_test.rb +111 -0
- data/test/remote/integrations/remote_gestpay_integration_test.rb +37 -0
- data/test/remote/integrations/remote_paypal_integration_test.rb +26 -0
- data/test/test_helper.rb +182 -0
- data/test/unit/avs_result_test.rb +59 -0
- data/test/unit/base_test.rb +55 -0
- data/test/unit/check_test.rb +88 -0
- data/test/unit/connection_test.rb +129 -0
- data/test/unit/country_code_test.rb +33 -0
- data/test/unit/country_test.rb +64 -0
- data/test/unit/credit_card_formatting_test.rb +19 -0
- data/test/unit/credit_card_methods_test.rb +179 -0
- data/test/unit/credit_card_test.rb +318 -0
- data/test/unit/cvv_result_test.rb +33 -0
- data/test/unit/expiry_date_test.rb +32 -0
- data/test/unit/gateways/authorize_net_cim_test.rb +676 -0
- data/test/unit/gateways/authorize_net_test.rb +290 -0
- data/test/unit/gateways/beanstream_interac_test.rb +51 -0
- data/test/unit/gateways/beanstream_test.rb +108 -0
- data/test/unit/gateways/bogus_test.rb +46 -0
- data/test/unit/gateways/braintree_test.rb +126 -0
- data/test/unit/gateways/card_stream_test.rb +90 -0
- data/test/unit/gateways/cyber_source_test.rb +188 -0
- data/test/unit/gateways/data_cash_test.rb +133 -0
- data/test/unit/gateways/efsnet_test.rb +123 -0
- data/test/unit/gateways/elavon_test.rb +139 -0
- data/test/unit/gateways/eway_test.rb +118 -0
- data/test/unit/gateways/exact_test.rb +156 -0
- data/test/unit/gateways/first_pay_test.rb +125 -0
- data/test/unit/gateways/gateway_test.rb +48 -0
- data/test/unit/gateways/instapay_test.rb +102 -0
- data/test/unit/gateways/jetpay_test.rb +185 -0
- data/test/unit/gateways/linkpoint_test.rb +197 -0
- data/test/unit/gateways/merchant_e_solutions_test.rb +169 -0
- data/test/unit/gateways/merchant_ware_test.rb +188 -0
- data/test/unit/gateways/modern_payments_cim_test.rb +162 -0
- data/test/unit/gateways/moneris_test.rb +158 -0
- data/test/unit/gateways/net_registry_test.rb +416 -0
- data/test/unit/gateways/netbilling_test.rb +54 -0
- data/test/unit/gateways/ogone_test.rb +319 -0
- data/test/unit/gateways/pay_junction_test.rb +123 -0
- data/test/unit/gateways/pay_secure_test.rb +71 -0
- data/test/unit/gateways/payflow_express_test.rb +173 -0
- data/test/unit/gateways/payflow_express_uk_test.rb +86 -0
- data/test/unit/gateways/payflow_test.rb +305 -0
- data/test/unit/gateways/payflow_uk_test.rb +30 -0
- data/test/unit/gateways/payment_express_test.rb +195 -0
- data/test/unit/gateways/paypal_express_test.rb +382 -0
- data/test/unit/gateways/paypal_test.rb +569 -0
- data/test/unit/gateways/plugnpay_test.rb +86 -0
- data/test/unit/gateways/psigate_test.rb +169 -0
- data/test/unit/gateways/psl_card_test.rb +64 -0
- data/test/unit/gateways/quickpay_test.rb +112 -0
- data/test/unit/gateways/realex_test.rb +151 -0
- data/test/unit/gateways/sage_bankcard_test.rb +196 -0
- data/test/unit/gateways/sage_pay_test.rb +139 -0
- data/test/unit/gateways/sage_virtual_check_test.rb +71 -0
- data/test/unit/gateways/sallie_mae_test.rb +53 -0
- data/test/unit/gateways/secure_pay_au_test.rb +207 -0
- data/test/unit/gateways/secure_pay_tech_test.rb +44 -0
- data/test/unit/gateways/secure_pay_test.rb +87 -0
- data/test/unit/gateways/skip_jack_test.rb +213 -0
- data/test/unit/gateways/trans_first_test.rb +112 -0
- data/test/unit/gateways/trust_commerce_test.rb +90 -0
- data/test/unit/gateways/usa_epay_test.rb +128 -0
- data/test/unit/gateways/verifi_test.rb +96 -0
- data/test/unit/gateways/viaklix_test.rb +78 -0
- data/test/unit/gateways/wirecard_test.rb +250 -0
- data/test/unit/generators/test_gateway_generator.rb +46 -0
- data/test/unit/generators/test_generator_helper.rb +20 -0
- data/test/unit/generators/test_integration_generator.rb +53 -0
- data/test/unit/integrations/action_view_helper_test.rb +50 -0
- data/test/unit/integrations/bogus_module_test.rb +20 -0
- data/test/unit/integrations/chronopay_module_test.rb +13 -0
- data/test/unit/integrations/gestpay_module_test.rb +14 -0
- data/test/unit/integrations/helpers/bogus_helper_test.rb +28 -0
- data/test/unit/integrations/helpers/chronopay_helper_test.rb +67 -0
- data/test/unit/integrations/helpers/gestpay_helper_test.rb +100 -0
- data/test/unit/integrations/helpers/hi_trust_helper_test.rb +16 -0
- data/test/unit/integrations/helpers/nochex_helper_test.rb +53 -0
- data/test/unit/integrations/helpers/paypal_helper_test.rb +171 -0
- data/test/unit/integrations/helpers/quickpay_helper_test.rb +40 -0
- data/test/unit/integrations/helpers/two_checkout_helper_test.rb +92 -0
- data/test/unit/integrations/hi_trust_module_test.rb +13 -0
- data/test/unit/integrations/nochex_module_test.rb +13 -0
- data/test/unit/integrations/notifications/chronopay_notification_test.rb +66 -0
- data/test/unit/integrations/notifications/gestpay_notification_test.rb +60 -0
- data/test/unit/integrations/notifications/hi_trust_notification_test.rb +59 -0
- data/test/unit/integrations/notifications/nochex_notification_test.rb +51 -0
- data/test/unit/integrations/notifications/notification_test.rb +54 -0
- data/test/unit/integrations/notifications/paypal_notification_test.rb +85 -0
- data/test/unit/integrations/notifications/quickpay_notification_test.rb +69 -0
- data/test/unit/integrations/notifications/two_checkout_notification_test.rb +55 -0
- data/test/unit/integrations/paypal_module_test.rb +28 -0
- data/test/unit/integrations/quickpay_module_test.rb +9 -0
- data/test/unit/integrations/returns/chronopay_return_test.rb +11 -0
- data/test/unit/integrations/returns/gestpay_return_test.rb +10 -0
- data/test/unit/integrations/returns/hi_trust_return_test.rb +24 -0
- data/test/unit/integrations/returns/nochex_return_test.rb +10 -0
- data/test/unit/integrations/returns/paypal_return_test.rb +10 -0
- data/test/unit/integrations/returns/return_test.rb +11 -0
- data/test/unit/integrations/returns/two_checkout_return_test.rb +24 -0
- data/test/unit/integrations/two_checkout_module_test.rb +13 -0
- data/test/unit/post_data_test.rb +55 -0
- data/test/unit/posts_data_test.rb +48 -0
- data/test/unit/response_test.rb +28 -0
- data/test/unit/utils_test.rb +7 -0
- data/test/unit/validateable_test.rb +60 -0
- metadata +367 -0
@@ -0,0 +1,743 @@
|
|
1
|
+
module ActiveMerchant #:nodoc:
|
2
|
+
module Billing #:nodoc:
|
3
|
+
# ==== Customer Information Manager (CIM)
|
4
|
+
#
|
5
|
+
# The Authorize.Net Customer Information Manager (CIM) is an optional additional service that allows you to store sensitive payment information on
|
6
|
+
# Authorize.Net's servers, simplifying payments for returning customers and recurring transactions. It can also help with Payment Card Industry (PCI)
|
7
|
+
# Data Security Standard compliance, since customer data is no longer stored locally.
|
8
|
+
#
|
9
|
+
# To use the AuthorizeNetCimGateway CIM must be enabled for your account.
|
10
|
+
#
|
11
|
+
# Information about CIM is available on the {Authorize.Net website}[http://www.authorize.net/solutions/merchantsolutions/merchantservices/cim/].
|
12
|
+
# Information about the CIM API is available at the {Authorize.Net Integration Center}[http://developer.authorize.net/]
|
13
|
+
#
|
14
|
+
# ==== Login and Password
|
15
|
+
#
|
16
|
+
# The login and password are not the username and password you use to
|
17
|
+
# login to the Authorize.Net Merchant Interface. Instead, you will
|
18
|
+
# use the API Login ID as the login and Transaction Key as the
|
19
|
+
# password.
|
20
|
+
#
|
21
|
+
# ==== How to Get Your API Login ID and Transaction Key
|
22
|
+
#
|
23
|
+
# 1. Log into the Merchant Interface
|
24
|
+
# 2. Select Settings from the Main Menu
|
25
|
+
# 3. Click on API Login ID and Transaction Key in the Security section
|
26
|
+
# 4. Type in the answer to the secret question configured on setup
|
27
|
+
# 5. Click Submit
|
28
|
+
class AuthorizeNetCimGateway < Gateway
|
29
|
+
|
30
|
+
class_inheritable_accessor :test_url, :live_url
|
31
|
+
|
32
|
+
self.test_url = 'https://apitest.authorize.net/xml/v1/request.api'
|
33
|
+
self.live_url = 'https://api.authorize.net/xml/v1/request.api'
|
34
|
+
|
35
|
+
AUTHORIZE_NET_CIM_NAMESPACE = 'AnetApi/xml/v1/schema/AnetApiSchema.xsd'
|
36
|
+
|
37
|
+
CIM_ACTIONS = {
|
38
|
+
:create_customer_profile => 'createCustomerProfile',
|
39
|
+
:create_customer_payment_profile => 'createCustomerPaymentProfile',
|
40
|
+
:create_customer_shipping_address => 'createCustomerShippingAddress',
|
41
|
+
:get_customer_profile => 'getCustomerProfile',
|
42
|
+
:get_customer_payment_profile => 'getCustomerPaymentProfile',
|
43
|
+
:get_customer_shipping_address => 'getCustomerShippingAddress',
|
44
|
+
:delete_customer_profile => 'deleteCustomerProfile',
|
45
|
+
:delete_customer_payment_profile => 'deleteCustomerPaymentProfile',
|
46
|
+
:delete_customer_shipping_address => 'deleteCustomerShippingAddress',
|
47
|
+
:update_customer_profile => 'updateCustomerProfile',
|
48
|
+
:update_customer_payment_profile => 'updateCustomerPaymentProfile',
|
49
|
+
:update_customer_shipping_address => 'updateCustomerShippingAddress',
|
50
|
+
:create_customer_profile_transaction => 'createCustomerProfileTransaction',
|
51
|
+
:validate_customer_payment_profile => 'validateCustomerPaymentProfile'
|
52
|
+
}
|
53
|
+
|
54
|
+
CIM_TRANSACTION_TYPES = {
|
55
|
+
:auth_capture => 'profileTransAuthCapture',
|
56
|
+
:auth_only => 'profileTransAuthOnly',
|
57
|
+
:capture_only => 'profileTransCaptureOnly'
|
58
|
+
}
|
59
|
+
|
60
|
+
CIM_VALIDATION_MODES = {
|
61
|
+
:none => 'none',
|
62
|
+
:test => 'testMode',
|
63
|
+
:live => 'liveMode'
|
64
|
+
}
|
65
|
+
|
66
|
+
BANK_ACCOUNT_TYPES = {
|
67
|
+
:checking => 'checking',
|
68
|
+
:savings => 'savings',
|
69
|
+
:business_checking => 'businessChecking'
|
70
|
+
}
|
71
|
+
|
72
|
+
ECHECK_TYPES = {
|
73
|
+
:ccd => 'CCD',
|
74
|
+
:ppd => 'PPD'
|
75
|
+
}
|
76
|
+
|
77
|
+
self.homepage_url = 'http://www.authorize.net/'
|
78
|
+
self.display_name = 'Authorize.Net CIM'
|
79
|
+
self.supported_countries = ['US']
|
80
|
+
self.supported_cardtypes = [:visa, :master, :american_express, :discover]
|
81
|
+
|
82
|
+
# Creates a new AuthorizeNetCimGateway
|
83
|
+
#
|
84
|
+
# The gateway requires that a valid API Login ID and Transaction Key be passed
|
85
|
+
# in the +options+ hash.
|
86
|
+
#
|
87
|
+
# ==== Options
|
88
|
+
#
|
89
|
+
# * <tt>:login</tt> -- The Authorize.Net API Login ID (REQUIRED)
|
90
|
+
# * <tt>:password</tt> -- The Authorize.Net Transaction Key. (REQUIRED)
|
91
|
+
# * <tt>:test</tt> -- +true+ or +false+. If true, perform transactions against the test server.
|
92
|
+
# Otherwise, perform transactions against the production server.
|
93
|
+
def initialize(options = {})
|
94
|
+
requires!(options, :login, :password)
|
95
|
+
@options = options
|
96
|
+
super
|
97
|
+
end
|
98
|
+
|
99
|
+
# Creates a new customer profile along with any customer payment profiles and customer shipping addresses
|
100
|
+
# for the customer profile.
|
101
|
+
#
|
102
|
+
# Returns a Response with the Customer Profile ID of the new customer profile in the authorization field.
|
103
|
+
# It is *CRITICAL* that you save this ID. There is no way to retrieve this through the API. You will not
|
104
|
+
# be able to create another Customer Profile with the same information.
|
105
|
+
#
|
106
|
+
# ==== Options
|
107
|
+
#
|
108
|
+
# TODO
|
109
|
+
def create_customer_profile(options)
|
110
|
+
# TODO Add requires
|
111
|
+
request = build_request(:create_customer_profile, options)
|
112
|
+
commit(:create_customer_profile, request)
|
113
|
+
end
|
114
|
+
|
115
|
+
# Creates a new customer payment profile for an existing customer profile.
|
116
|
+
#
|
117
|
+
# ==== Options
|
118
|
+
#
|
119
|
+
# * <tt>:customer_profile_id</tt> -- The Customer Profile ID of the customer the payment profile will be added to. (REQUIRED)
|
120
|
+
# * <tt>:payment_profile</tt> -- A hash containing the elements of the new payment profile (REQUIRED)
|
121
|
+
#
|
122
|
+
# ==== Payment Profile
|
123
|
+
#
|
124
|
+
# * <tt>:payment</tt> -- A hash containing information on payment. Either :credit_card or :bank_account (REQUIRED)
|
125
|
+
def create_customer_payment_profile(options)
|
126
|
+
requires!(options, :customer_profile_id)
|
127
|
+
requires!(options, :payment_profile)
|
128
|
+
requires!(options[:payment_profile], :payment)
|
129
|
+
|
130
|
+
request = build_request(:create_customer_payment_profile, options)
|
131
|
+
commit(:create_customer_payment_profile, request)
|
132
|
+
end
|
133
|
+
|
134
|
+
# Creates a new customer shipping address for an existing customer profile.
|
135
|
+
#
|
136
|
+
# ==== Options
|
137
|
+
#
|
138
|
+
# * <tt>:customer_profile_id</tt> -- The Customer Profile ID of the customer the payment profile will be added to. (REQUIRED)
|
139
|
+
# * <tt>:address</tt> -- A hash containing the elements of the shipping address (REQUIRED)
|
140
|
+
def create_customer_shipping_address(options)
|
141
|
+
requires!(options, :customer_profile_id)
|
142
|
+
requires!(options, :address)
|
143
|
+
|
144
|
+
request = build_request(:create_customer_shipping_address, options)
|
145
|
+
commit(:create_customer_shipping_address, request)
|
146
|
+
end
|
147
|
+
|
148
|
+
# Deletes an existing customer profile along with all associated customer payment profiles and customer shipping addresses.
|
149
|
+
#
|
150
|
+
# ==== Options
|
151
|
+
#
|
152
|
+
# * <tt>:customer_profile_id</tt> -- The Customer Profile ID of the customer to be deleted. (REQUIRED)
|
153
|
+
def delete_customer_profile(options)
|
154
|
+
requires!(options, :customer_profile_id)
|
155
|
+
|
156
|
+
request = build_request(:delete_customer_profile, options)
|
157
|
+
commit(:delete_customer_profile, request)
|
158
|
+
end
|
159
|
+
|
160
|
+
# Deletes a customer payment profile from an existing customer profile.
|
161
|
+
#
|
162
|
+
# ==== Options
|
163
|
+
#
|
164
|
+
# * <tt>:customer_profile_id</tt> -- The Customer Profile ID of the customer with the payment profile to be deleted. (REQUIRED)
|
165
|
+
# * <tt>:customer_payment_profile_id</tt> -- The Payment Profile ID of the payment profile to be deleted. (REQUIRED)
|
166
|
+
def delete_customer_payment_profile(options)
|
167
|
+
requires!(options, :customer_profile_id)
|
168
|
+
requires!(options, :customer_payment_profile_id)
|
169
|
+
|
170
|
+
request = build_request(:delete_customer_payment_profile, options)
|
171
|
+
commit(:delete_customer_payment_profile, request)
|
172
|
+
end
|
173
|
+
|
174
|
+
# Deletes a customer shipping address from an existing customer profile.
|
175
|
+
#
|
176
|
+
# ==== Options
|
177
|
+
#
|
178
|
+
# * <tt>:customer_profile_id</tt> -- The Customer Profile ID of the customer with the payment profile to be deleted. (REQUIRED)
|
179
|
+
# * <tt>:customer_address_id</tt> -- The Shipping Address ID of the shipping address to be deleted. (REQUIRED)
|
180
|
+
def delete_customer_shipping_address(options)
|
181
|
+
requires!(options, :customer_profile_id)
|
182
|
+
requires!(options, :customer_address_id)
|
183
|
+
|
184
|
+
request = build_request(:delete_customer_shipping_address, options)
|
185
|
+
commit(:delete_customer_shipping_address, request)
|
186
|
+
end
|
187
|
+
|
188
|
+
# Retrieves an existing customer profile along with all the associated customer payment profiles and customer shipping addresses.
|
189
|
+
#
|
190
|
+
# Returns a Response whose params hash contains all the profile information.
|
191
|
+
#
|
192
|
+
# ==== Options
|
193
|
+
#
|
194
|
+
# * <tt>:customer_profile_id</tt> -- The Customer Profile ID of the customer to retrieve. (REQUIRED)
|
195
|
+
def get_customer_profile(options)
|
196
|
+
requires!(options, :customer_profile_id)
|
197
|
+
|
198
|
+
request = build_request(:get_customer_profile, options)
|
199
|
+
commit(:get_customer_profile, request)
|
200
|
+
end
|
201
|
+
|
202
|
+
# Retrieve a customer payment profile for an existing customer profile.
|
203
|
+
#
|
204
|
+
# Returns a Response whose params hash contains all the payment profile information. Sensitive information such as credit card
|
205
|
+
# numbers will be masked.
|
206
|
+
#
|
207
|
+
# ==== Options
|
208
|
+
#
|
209
|
+
# * <tt>:customer_profile_id</tt> -- The Customer Profile ID of the customer with the payment profile to be retrieved. (REQUIRED)
|
210
|
+
# * <tt>:customer_payment_profile_id</tt> -- The Payment Profile ID of the payment profile to be retrieved. (REQUIRED)
|
211
|
+
def get_customer_payment_profile(options)
|
212
|
+
requires!(options, :customer_profile_id)
|
213
|
+
requires!(options, :customer_payment_profile_id)
|
214
|
+
|
215
|
+
request = build_request(:get_customer_payment_profile, options)
|
216
|
+
commit(:get_customer_payment_profile, request)
|
217
|
+
end
|
218
|
+
|
219
|
+
# Retrieve a customer shipping address for an existing customer profile.
|
220
|
+
#
|
221
|
+
# Returns a Response whose params hash contains all the shipping address information.
|
222
|
+
#
|
223
|
+
# ==== Options
|
224
|
+
#
|
225
|
+
# * <tt>:customer_profile_id</tt> -- The Customer Profile ID of the customer with the payment profile to be retrieved. (REQUIRED)
|
226
|
+
# * <tt>:customer_address_id</tt> -- The Shipping Address ID of the shipping address to be retrieved. (REQUIRED)
|
227
|
+
def get_customer_shipping_address(options)
|
228
|
+
requires!(options, :customer_profile_id)
|
229
|
+
requires!(options, :customer_address_id)
|
230
|
+
|
231
|
+
request = build_request(:get_customer_shipping_address, options)
|
232
|
+
commit(:get_customer_shipping_address, request)
|
233
|
+
end
|
234
|
+
|
235
|
+
# Updates an existing customer profile.
|
236
|
+
#
|
237
|
+
# Warning: if you do not provide a parameter in the <tt>:payment_profile</tt> hash, it is automatically set to nil at
|
238
|
+
# Authorize.Net. You will most likely want to first get the profile hash using get_customer_profile and then only change the
|
239
|
+
# elements you wish to change.
|
240
|
+
#
|
241
|
+
# ==== Options
|
242
|
+
#
|
243
|
+
# * <tt>:profile</tt> -- A hash containing the values the Customer Profile should be updated to. (REQUIRED)
|
244
|
+
#
|
245
|
+
# ==== Profile
|
246
|
+
#
|
247
|
+
# * <tt>:customer_profile_id</tt> -- The Customer Profile ID of the customer profile to update. (REQUIRED)
|
248
|
+
def update_customer_profile(options)
|
249
|
+
requires!(options, :profile)
|
250
|
+
requires!(options[:profile], :customer_profile_id)
|
251
|
+
|
252
|
+
request = build_request(:update_customer_profile, options)
|
253
|
+
commit(:update_customer_profile, request)
|
254
|
+
end
|
255
|
+
|
256
|
+
# Updates a customer payment profile for an existing customer profile.
|
257
|
+
#
|
258
|
+
# Warning: if you do not provide a parameter in the <tt>:payment_profile</tt> hash, it is automatically set to nil at
|
259
|
+
# Authorize.Net. You will most likely want to first get the profile hash using get_customer_payment_profile and then only
|
260
|
+
# change the elements you wish to change.
|
261
|
+
#
|
262
|
+
# ==== Options
|
263
|
+
#
|
264
|
+
# * <tt>:customer_profile_id</tt> -- The Customer Profile ID of the customer with the payment profile to be updated. (REQUIRED)
|
265
|
+
# * <tt>:payment_profile</tt> -- A hash containing the values the Customer Payment Profile should be updated to. (REQUIRED)
|
266
|
+
#
|
267
|
+
# ==== Payment Profile
|
268
|
+
#
|
269
|
+
# * <tt>:customer_payment_profile_id</tt> -- The Customer Payment Profile ID of the Customer Payment Profile to update. (REQUIRED)
|
270
|
+
def update_customer_payment_profile(options)
|
271
|
+
requires!(options, :customer_profile_id, :payment_profile)
|
272
|
+
requires!(options[:payment_profile], :customer_payment_profile_id)
|
273
|
+
|
274
|
+
request = build_request(:update_customer_payment_profile, options)
|
275
|
+
commit(:update_customer_payment_profile, request)
|
276
|
+
end
|
277
|
+
|
278
|
+
# Updates a customer shipping address for an existing customer profile.
|
279
|
+
#
|
280
|
+
# Warning: if you do not provide a parameter in the <tt>:address</tt> hash, it is automatically set to nil at
|
281
|
+
# Authorize.Net. You will most likely want to first get the profile hash using get_customer_shipping_address and then only
|
282
|
+
# change the elements you wish to change.
|
283
|
+
#
|
284
|
+
# ==== Options
|
285
|
+
#
|
286
|
+
# * <tt>:customer_profile_id</tt> -- The Customer Profile ID of the customer with the payment profile to be updated. (REQUIRED)
|
287
|
+
# * <tt>:address</tt> -- A hash containing the values the Customer Shipping Address should be updated to. (REQUIRED)
|
288
|
+
#
|
289
|
+
# ==== Address
|
290
|
+
#
|
291
|
+
# * <tt>:customer_address_id</tt> -- The Customer Address ID of the Customer Payment Profile to update. (REQUIRED)
|
292
|
+
def update_customer_shipping_address(options)
|
293
|
+
requires!(options, :customer_profile_id, :address)
|
294
|
+
requires!(options[:address], :customer_address_id)
|
295
|
+
|
296
|
+
request = build_request(:update_customer_shipping_address, options)
|
297
|
+
commit(:update_customer_shipping_address, request)
|
298
|
+
end
|
299
|
+
|
300
|
+
# Creates a new payment transaction from an existing customer profile
|
301
|
+
#
|
302
|
+
# This is what is used to charge a customer whose information you have stored in a Customer Profile.
|
303
|
+
#
|
304
|
+
# Returns a Response object that contains the result of the transaction in <tt>params['direct_response']</tt>
|
305
|
+
#
|
306
|
+
# ==== Options
|
307
|
+
#
|
308
|
+
# * <tt>:transaction</tt> -- A hash containing information on the transaction that is being requested. (REQUIRED)
|
309
|
+
#
|
310
|
+
# ==== Transaction
|
311
|
+
#
|
312
|
+
# * <tt>:type</tt> -- The type of transaction. Can be either <tt>:auth_only</tt>, <tt>:capture_only</tt>, or <tt>:auth_capture</tt>. (REQUIRED)
|
313
|
+
# * <tt>:amount</tt> -- The amount for the tranaction. Formatted with a decimal. For example "4.95" (REQUIRED)
|
314
|
+
# * <tt>:customer_profile_id</tt> -- The Customer Profile ID of the customer to use in this transaction. (REQUIRED)
|
315
|
+
# * <tt>:customer_payment_profile_id</tt> -- The Customer Payment Profile ID of the Customer Payment Profile to use in this transaction. (REQUIRED)
|
316
|
+
def create_customer_profile_transaction(options)
|
317
|
+
requires!(options, :transaction)
|
318
|
+
requires!(options[:transaction], :type, :amount, :customer_profile_id, :customer_payment_profile_id)
|
319
|
+
|
320
|
+
request = build_request(:create_customer_profile_transaction, options)
|
321
|
+
commit(:create_customer_profile_transaction, request)
|
322
|
+
end
|
323
|
+
|
324
|
+
# Verifies an existing customer payment profile by generating a test transaction
|
325
|
+
#
|
326
|
+
# Returns a Response object that contains the result of the transaction in <tt>params['direct_response']</tt>
|
327
|
+
#
|
328
|
+
# ==== Options
|
329
|
+
#
|
330
|
+
# * <tt>:customer_profile_id</tt> -- The Customer Profile ID of the customer to use in this transaction. (REQUIRED)
|
331
|
+
# * <tt>:customer_payment_profile_id</tt> -- The Customer Payment Profile ID of the Customer Payment Profile to be verified. (REQUIRED)
|
332
|
+
# * <tt>:customer_address_id</tt> -- The Customer Address ID of the Customer Shipping Address to be verified.
|
333
|
+
# * <tt>:validation_mode</tt> -- <tt>:live</tt> or <tt>:test</tt> In Test Mode, only field validation is performed.
|
334
|
+
# In Live Mode, a transaction is generated and submitted to the processor with the amount of $0.01. If successful, the transaction is immediately voided. (REQUIRED)
|
335
|
+
def validate_customer_payment_profile(options)
|
336
|
+
requires!(options, :customer_profile_id, :customer_payment_profile_id, :validation_mode)
|
337
|
+
|
338
|
+
request = build_request(:validate_customer_payment_profile, options)
|
339
|
+
commit(:validate_customer_payment_profile, request)
|
340
|
+
end
|
341
|
+
|
342
|
+
private
|
343
|
+
|
344
|
+
def expdate(credit_card)
|
345
|
+
sprintf('%04d-%02d', credit_card.year, credit_card.month)
|
346
|
+
end
|
347
|
+
|
348
|
+
def build_request(action, options = {})
|
349
|
+
unless CIM_ACTIONS.include?(action)
|
350
|
+
raise StandardError, "Invalid Customer Information Manager Action: #{action}"
|
351
|
+
end
|
352
|
+
|
353
|
+
xml = Builder::XmlMarkup.new(:indent => 2)
|
354
|
+
xml.instruct!(:xml, :version => '1.0', :encoding => 'utf-8')
|
355
|
+
xml.tag!("#{CIM_ACTIONS[action]}Request", :xmlns => AUTHORIZE_NET_CIM_NAMESPACE) do
|
356
|
+
add_merchant_authentication(xml)
|
357
|
+
# Merchant-assigned reference ID for the request
|
358
|
+
xml.tag!('refId', options[:ref_id]) if options[:ref_id]
|
359
|
+
send("build_#{action}_request", xml, options)
|
360
|
+
end
|
361
|
+
end
|
362
|
+
|
363
|
+
# Contains the merchant’s payment gateway account authentication information
|
364
|
+
def add_merchant_authentication(xml)
|
365
|
+
xml.tag!('merchantAuthentication') do
|
366
|
+
xml.tag!('name', @options[:login])
|
367
|
+
xml.tag!('transactionKey', @options[:password])
|
368
|
+
end
|
369
|
+
end
|
370
|
+
|
371
|
+
def build_create_customer_profile_request(xml, options)
|
372
|
+
add_profile(xml, options[:profile])
|
373
|
+
|
374
|
+
xml.target!
|
375
|
+
end
|
376
|
+
|
377
|
+
def build_create_customer_payment_profile_request(xml, options)
|
378
|
+
xml.tag!('customerProfileId', options[:customer_profile_id])
|
379
|
+
|
380
|
+
xml.tag!('paymentProfile') do
|
381
|
+
add_payment_profile(xml, options[:payment_profile])
|
382
|
+
end
|
383
|
+
|
384
|
+
xml.tag!('validationMode', CIM_VALIDATION_MODES[options[:validation_mode]]) if options[:validation_mode]
|
385
|
+
|
386
|
+
xml.target!
|
387
|
+
end
|
388
|
+
|
389
|
+
def build_create_customer_shipping_address_request(xml, options)
|
390
|
+
xml.tag!('customerProfileId', options[:customer_profile_id])
|
391
|
+
|
392
|
+
xml.tag!('address') do
|
393
|
+
add_address(xml, options[:address])
|
394
|
+
end
|
395
|
+
|
396
|
+
xml.target!
|
397
|
+
end
|
398
|
+
|
399
|
+
def build_delete_customer_profile_request(xml, options)
|
400
|
+
xml.tag!('customerProfileId', options[:customer_profile_id])
|
401
|
+
xml.target!
|
402
|
+
end
|
403
|
+
|
404
|
+
def build_delete_customer_payment_profile_request(xml, options)
|
405
|
+
xml.tag!('customerProfileId', options[:customer_profile_id])
|
406
|
+
xml.tag!('customerPaymentProfileId', options[:customer_payment_profile_id])
|
407
|
+
xml.target!
|
408
|
+
end
|
409
|
+
|
410
|
+
def build_delete_customer_shipping_address_request(xml, options)
|
411
|
+
xml.tag!('customerProfileId', options[:customer_profile_id])
|
412
|
+
xml.tag!('customerAddressId', options[:customer_address_id])
|
413
|
+
xml.target!
|
414
|
+
end
|
415
|
+
|
416
|
+
def build_get_customer_profile_request(xml, options)
|
417
|
+
xml.tag!('customerProfileId', options[:customer_profile_id])
|
418
|
+
xml.target!
|
419
|
+
end
|
420
|
+
|
421
|
+
def build_get_customer_payment_profile_request(xml, options)
|
422
|
+
xml.tag!('customerProfileId', options[:customer_profile_id])
|
423
|
+
xml.tag!('customerPaymentProfileId', options[:customer_payment_profile_id])
|
424
|
+
xml.target!
|
425
|
+
end
|
426
|
+
|
427
|
+
def build_get_customer_shipping_address_request(xml, options)
|
428
|
+
xml.tag!('customerProfileId', options[:customer_profile_id])
|
429
|
+
xml.tag!('customerAddressId', options[:customer_address_id])
|
430
|
+
xml.target!
|
431
|
+
end
|
432
|
+
|
433
|
+
def build_update_customer_profile_request(xml, options)
|
434
|
+
add_profile(xml, options[:profile], true)
|
435
|
+
|
436
|
+
xml.target!
|
437
|
+
end
|
438
|
+
|
439
|
+
def build_update_customer_payment_profile_request(xml, options)
|
440
|
+
xml.tag!('customerProfileId', options[:customer_profile_id])
|
441
|
+
|
442
|
+
xml.tag!('paymentProfile') do
|
443
|
+
add_payment_profile(xml, options[:payment_profile])
|
444
|
+
end
|
445
|
+
|
446
|
+
xml.target!
|
447
|
+
end
|
448
|
+
|
449
|
+
def build_update_customer_shipping_address_request(xml, options)
|
450
|
+
xml.tag!('customerProfileId', options[:customer_profile_id])
|
451
|
+
|
452
|
+
xml.tag!('address') do
|
453
|
+
add_address(xml, options[:address])
|
454
|
+
end
|
455
|
+
|
456
|
+
xml.target!
|
457
|
+
end
|
458
|
+
|
459
|
+
def build_create_customer_profile_transaction_request(xml, options)
|
460
|
+
add_transaction(xml, options[:transaction])
|
461
|
+
xml.tag!('extraOptions', "x_test_request=TRUE") if @options[:test]
|
462
|
+
|
463
|
+
xml.target!
|
464
|
+
end
|
465
|
+
|
466
|
+
def build_validate_customer_payment_profile_request(xml, options)
|
467
|
+
xml.tag!('customerProfileId', options[:customer_profile_id])
|
468
|
+
xml.tag!('customerPaymentProfileId', options[:customer_payment_profile_id])
|
469
|
+
xml.tag!('customerShippingAddressId', options[:customer_address_id]) if options[:customer_address_id]
|
470
|
+
xml.tag!('validationMode', CIM_VALIDATION_MODES[options[:validation_mode]]) if options[:validation_mode]
|
471
|
+
|
472
|
+
xml.target!
|
473
|
+
end
|
474
|
+
|
475
|
+
# :merchant_customer_id (Optional)
|
476
|
+
# :description (Optional)
|
477
|
+
# :email (Optional)
|
478
|
+
# :payment_profiles (Optional)
|
479
|
+
def add_profile(xml, profile, update = false)
|
480
|
+
xml.tag!('profile') do
|
481
|
+
# Merchant assigned ID for the customer. Up to 20 characters. (optional)
|
482
|
+
xml.tag!('merchantCustomerId', profile[:merchant_customer_id]) if profile[:merchant_customer_id]
|
483
|
+
# Description of the customer. Up to 255 Characters (optional)
|
484
|
+
xml.tag!('description', profile[:description]) if profile[:description]
|
485
|
+
# Email Address for the customer. Up to 255 Characters (optional)
|
486
|
+
xml.tag!('email', profile[:email]) if profile[:email]
|
487
|
+
|
488
|
+
if update
|
489
|
+
xml.tag!('customerProfileId', profile[:customer_profile_id])
|
490
|
+
else
|
491
|
+
add_payment_profiles(xml, profile[:payment_profiles]) if profile[:payment_profiles]
|
492
|
+
add_ship_to_list(xml, profile[:ship_to_list]) if profile[:ship_to_list]
|
493
|
+
end
|
494
|
+
end
|
495
|
+
end
|
496
|
+
|
497
|
+
def add_transaction(xml, transaction)
|
498
|
+
unless CIM_TRANSACTION_TYPES.include?(transaction[:type])
|
499
|
+
raise StandardError, "Invalid Customer Information Manager Transaction Type: #{transaction[:type]}"
|
500
|
+
end
|
501
|
+
|
502
|
+
xml.tag!('transaction') do
|
503
|
+
xml.tag!(CIM_TRANSACTION_TYPES[transaction[:type]]) do
|
504
|
+
# The amount to be billed to the customer
|
505
|
+
xml.tag!('amount', transaction[:amount])
|
506
|
+
xml.tag!('customerProfileId', transaction[:customer_profile_id])
|
507
|
+
xml.tag!('customerPaymentProfileId', transaction[:customer_payment_profile_id])
|
508
|
+
xml.tag!('approvalCode', transaction[:approval_code]) if transaction[:type] == :capture_only
|
509
|
+
add_order(xml, transaction[:order]) if transaction[:order]
|
510
|
+
end
|
511
|
+
end
|
512
|
+
end
|
513
|
+
|
514
|
+
def add_order(xml, order)
|
515
|
+
xml.tag!('order') do
|
516
|
+
xml.tag!('invoiceNumber', order[:invoice_number]) if order[:invoice_number]
|
517
|
+
xml.tag!('description', order[:description]) if order[:description]
|
518
|
+
xml.tag!('purchaseOrderNumber', order[:purchase_order_number]) if order[:purchase_order_number]
|
519
|
+
end
|
520
|
+
end
|
521
|
+
|
522
|
+
def add_payment_profiles(xml, payment_profiles)
|
523
|
+
xml.tag!('paymentProfiles') do
|
524
|
+
add_payment_profile(xml, payment_profiles)
|
525
|
+
end
|
526
|
+
end
|
527
|
+
|
528
|
+
# :customer_type => 'individual or business', # Optional
|
529
|
+
# :bill_to => @address,
|
530
|
+
# :payment => @payment
|
531
|
+
def add_payment_profile(xml, payment_profile)
|
532
|
+
# 'individual' or 'business' (optional)
|
533
|
+
xml.tag!('customerType', payment_profile[:customer_type]) if payment_profile[:customer_type]
|
534
|
+
|
535
|
+
if payment_profile[:bill_to]
|
536
|
+
xml.tag!('billTo') do
|
537
|
+
add_address(xml, payment_profile[:bill_to])
|
538
|
+
end
|
539
|
+
end
|
540
|
+
|
541
|
+
if payment_profile[:payment]
|
542
|
+
xml.tag!('payment') do
|
543
|
+
add_credit_card(xml, payment_profile[:payment][:credit_card]) if payment_profile[:payment].has_key?(:credit_card)
|
544
|
+
add_bank_account(xml, payment_profile[:payment][:bank_account]) if payment_profile[:payment].has_key?(:bank_account)
|
545
|
+
add_drivers_license(xml, payment_profile[:payment][:drivers_license]) if payment_profile[:payment].has_key?(:drivers_license)
|
546
|
+
# This element is only required for Wells Fargo SecureSource eCheck.Net merchants
|
547
|
+
# The customer's Social Security Number or Tax ID
|
548
|
+
xml.tag!('taxId', payment_profile[:payment]) if payment_profile[:payment].has_key?(:tax_id)
|
549
|
+
end
|
550
|
+
end
|
551
|
+
|
552
|
+
xml.tag!('customerPaymentProfileId', payment_profile[:customer_payment_profile_id]) if payment_profile[:customer_payment_profile_id]
|
553
|
+
end
|
554
|
+
|
555
|
+
def add_ship_to_list(xml, ship_to_list)
|
556
|
+
xml.tag!('shipToList') do
|
557
|
+
add_address(xml, ship_to_list)
|
558
|
+
end
|
559
|
+
end
|
560
|
+
|
561
|
+
def add_address(xml, address)
|
562
|
+
xml.tag!('firstName', address[:first_name])
|
563
|
+
xml.tag!('lastName', address[:last_name])
|
564
|
+
xml.tag!('company', address[:company])
|
565
|
+
xml.tag!('address', address[:address1]) if address[:address1]
|
566
|
+
xml.tag!('address', address[:address]) if address[:address]
|
567
|
+
xml.tag!('city', address[:city])
|
568
|
+
xml.tag!('state', address[:state])
|
569
|
+
xml.tag!('zip', address[:zip])
|
570
|
+
xml.tag!('country', address[:country])
|
571
|
+
xml.tag!('phoneNumber', address[:phone_number]) if address[:phone_number]
|
572
|
+
xml.tag!('faxNumber', address[:fax_number]) if address[:fax_number]
|
573
|
+
|
574
|
+
xml.tag!('customerAddressId', address[:customer_address_id]) if address[:customer_address_id]
|
575
|
+
end
|
576
|
+
|
577
|
+
# Adds customer’s credit card information
|
578
|
+
# Note: This element should only be included
|
579
|
+
# when the payment method is credit card.
|
580
|
+
def add_credit_card(xml, credit_card)
|
581
|
+
return unless credit_card
|
582
|
+
xml.tag!('creditCard') do
|
583
|
+
# The credit card number used for payment of the subscription
|
584
|
+
xml.tag!('cardNumber', credit_card.number)
|
585
|
+
# The expiration date of the credit card used for the subscription
|
586
|
+
xml.tag!('expirationDate', expdate(credit_card))
|
587
|
+
xml.tag!('cardCode', credit_card.verification_value) if credit_card.verification_value?
|
588
|
+
end
|
589
|
+
end
|
590
|
+
|
591
|
+
# Adds customer’s bank account information
|
592
|
+
# Note: This element should only be included
|
593
|
+
# when the payment method is bank account.
|
594
|
+
def add_bank_account(xml, bank_account)
|
595
|
+
raise StandardError, "Invalid Bank Account Type: #{bank_account[:account_type]}" unless BANK_ACCOUNT_TYPES.include?(bank_account[:account_type])
|
596
|
+
raise StandardError, "Invalid eCheck Type: #{bank_account[:echeck_type]}" unless ECHECK_TYPES.include?(bank_account[:echeck_type])
|
597
|
+
|
598
|
+
xml.tag!('bankAccount') do
|
599
|
+
# The type of bank account
|
600
|
+
xml.tag!('accountType', BANK_ACCOUNT_TYPES[bank_account[:account_type]])
|
601
|
+
# The routing number of the customer’s bank
|
602
|
+
xml.tag!('routingNumber', bank_account[:routing_number])
|
603
|
+
# The bank account number
|
604
|
+
xml.tag!('accountNumber', bank_account[:account_number])
|
605
|
+
# The full name of the individual associated
|
606
|
+
# with the bank account number
|
607
|
+
xml.tag!('nameOnAccount', bank_account[:name_on_account])
|
608
|
+
# The type of electronic check transaction
|
609
|
+
xml.tag!('echeckType', ECHECK_TYPES[bank_account[:echeck_type]])
|
610
|
+
# The full name of the individual associated
|
611
|
+
# with the bank account number (optional)
|
612
|
+
xml.tag!('bankName', bank_account[:bank_name]) if bank_account[:bank_name]
|
613
|
+
end
|
614
|
+
end
|
615
|
+
|
616
|
+
# Adds customer’s driver's license information
|
617
|
+
# Note: This element is only required for
|
618
|
+
# Wells Fargo SecureSource eCheck.Net merchants
|
619
|
+
def add_drivers_license(xml, drivers_license)
|
620
|
+
xml.tag!('driversLicense') do
|
621
|
+
# The state of the customer's driver's license
|
622
|
+
# A valid two character state code
|
623
|
+
xml.tag!('state', drivers_license[:state])
|
624
|
+
# The customer’s driver's license number
|
625
|
+
xml.tag!('number', drivers_license[:number])
|
626
|
+
# The date of birth listed on the customer's driver's license
|
627
|
+
# YYYY-MM-DD
|
628
|
+
xml.tag!('dateOfBirth', drivers_license[:date_of_birth])
|
629
|
+
end
|
630
|
+
end
|
631
|
+
|
632
|
+
def commit(action, request)
|
633
|
+
url = test? ? test_url : live_url
|
634
|
+
xml = ssl_post(url, request, "Content-Type" => "text/xml")
|
635
|
+
|
636
|
+
response_params = parse(action, xml)
|
637
|
+
|
638
|
+
message = response_params['messages']['message']['text']
|
639
|
+
test_mode = test? || message =~ /Test Mode/
|
640
|
+
success = response_params['messages']['result_code'] == 'Ok'
|
641
|
+
|
642
|
+
authorization = response_params['customer_profile_id']
|
643
|
+
authorization ||= response_params['profile']['customer_profile_id'] if response_params['profile']
|
644
|
+
if authorization.nil? && response_params['direct_response']
|
645
|
+
direct_response = parse_direct_response(response_params['direct_response'])
|
646
|
+
authorization = direct_response['approval_code']
|
647
|
+
end
|
648
|
+
|
649
|
+
response = Response.new(success, message, response_params,
|
650
|
+
:test => test_mode,
|
651
|
+
:authorization => authorization
|
652
|
+
)
|
653
|
+
|
654
|
+
response.params['direct_response'] = direct_response if direct_response
|
655
|
+
response
|
656
|
+
end
|
657
|
+
|
658
|
+
def parse_direct_response(direct_response_params)
|
659
|
+
direct_response = {'raw' => direct_response_params}
|
660
|
+
direct_response_fields = direct_response_params.split(',')
|
661
|
+
|
662
|
+
direct_response.merge(
|
663
|
+
{
|
664
|
+
'response_code' => direct_response_fields[0],
|
665
|
+
'response_subcode' => direct_response_fields[1],
|
666
|
+
'response_reason_code' => direct_response_fields[2],
|
667
|
+
'message' => direct_response_fields[3],
|
668
|
+
'approval_code' => direct_response_fields[4],
|
669
|
+
'avs_response' => direct_response_fields[5],
|
670
|
+
'transaction_id' => direct_response_fields[6],
|
671
|
+
'invoice_number' => direct_response_fields[7],
|
672
|
+
'order_description' => direct_response_fields[8],
|
673
|
+
'amount' => direct_response_fields[9],
|
674
|
+
'method' => direct_response_fields[10],
|
675
|
+
'transaction_type' => direct_response_fields[11],
|
676
|
+
'customer_id' => direct_response_fields[12],
|
677
|
+
'first_name' => direct_response_fields[13],
|
678
|
+
'last_name' => direct_response_fields[14],
|
679
|
+
'company' => direct_response_fields[15],
|
680
|
+
'address' => direct_response_fields[16],
|
681
|
+
'city' => direct_response_fields[17],
|
682
|
+
'state' => direct_response_fields[18],
|
683
|
+
'zip_code' => direct_response_fields[19],
|
684
|
+
'country' => direct_response_fields[20],
|
685
|
+
'phone' => direct_response_fields[21],
|
686
|
+
'fax' => direct_response_fields[22],
|
687
|
+
'email_address' => direct_response_fields[23],
|
688
|
+
'ship_to_first_name' => direct_response_fields[24],
|
689
|
+
'ship_to_last_name' => direct_response_fields[25],
|
690
|
+
'ship_to_company' => direct_response_fields[26],
|
691
|
+
'ship_to_address' => direct_response_fields[27],
|
692
|
+
'ship_to_city' => direct_response_fields[28],
|
693
|
+
'ship_to_state' => direct_response_fields[29],
|
694
|
+
'ship_to_zip_code' => direct_response_fields[30],
|
695
|
+
'ship_to_country' => direct_response_fields[31],
|
696
|
+
'tax' => direct_response_fields[32],
|
697
|
+
'duty' => direct_response_fields[33],
|
698
|
+
'freight' => direct_response_fields[34],
|
699
|
+
'tax_exempt' => direct_response_fields[35],
|
700
|
+
'purchase_order_number' => direct_response_fields[36],
|
701
|
+
'md5_hash' => direct_response_fields[37],
|
702
|
+
'card_code' => direct_response_fields[38],
|
703
|
+
'cardholder_authentication_verification_response' => direct_response_fields[39]
|
704
|
+
}
|
705
|
+
)
|
706
|
+
end
|
707
|
+
|
708
|
+
def parse(action, xml)
|
709
|
+
xml = REXML::Document.new(xml)
|
710
|
+
root = REXML::XPath.first(xml, "//#{CIM_ACTIONS[action]}Response") ||
|
711
|
+
REXML::XPath.first(xml, "//ErrorResponse")
|
712
|
+
if root
|
713
|
+
response = parse_element(root)
|
714
|
+
end
|
715
|
+
|
716
|
+
response
|
717
|
+
end
|
718
|
+
|
719
|
+
def parse_element(node)
|
720
|
+
if node.has_elements?
|
721
|
+
response = {}
|
722
|
+
node.elements.each{ |e|
|
723
|
+
key = e.name.underscore
|
724
|
+
value = parse_element(e)
|
725
|
+
if response.has_key?(key)
|
726
|
+
if response[key].is_a?(Array)
|
727
|
+
response[key].push(value)
|
728
|
+
else
|
729
|
+
response[key] = [response[key], value]
|
730
|
+
end
|
731
|
+
else
|
732
|
+
response[key] = parse_element(e)
|
733
|
+
end
|
734
|
+
}
|
735
|
+
else
|
736
|
+
response = node.text
|
737
|
+
end
|
738
|
+
|
739
|
+
response
|
740
|
+
end
|
741
|
+
end
|
742
|
+
end
|
743
|
+
end
|