glebm-activemerchant 1.7.2.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (139) hide show
  1. data/CHANGELOG +535 -0
  2. data/CONTRIBUTORS +142 -0
  3. data/MIT-LICENSE +20 -0
  4. data/README.rdoc +136 -0
  5. data/gem-public_cert.pem +20 -0
  6. data/lib/active_merchant.rb +46 -0
  7. data/lib/active_merchant/billing.rb +9 -0
  8. data/lib/active_merchant/billing/avs_result.rb +98 -0
  9. data/lib/active_merchant/billing/base.rb +57 -0
  10. data/lib/active_merchant/billing/check.rb +68 -0
  11. data/lib/active_merchant/billing/credit_card.rb +159 -0
  12. data/lib/active_merchant/billing/credit_card_formatting.rb +21 -0
  13. data/lib/active_merchant/billing/credit_card_methods.rb +125 -0
  14. data/lib/active_merchant/billing/cvv_result.rb +38 -0
  15. data/lib/active_merchant/billing/expiry_date.rb +34 -0
  16. data/lib/active_merchant/billing/gateway.rb +163 -0
  17. data/lib/active_merchant/billing/gateways.rb +18 -0
  18. data/lib/active_merchant/billing/gateways/authorize_net.rb +654 -0
  19. data/lib/active_merchant/billing/gateways/authorize_net_cim.rb +736 -0
  20. data/lib/active_merchant/billing/gateways/beanstream.rb +102 -0
  21. data/lib/active_merchant/billing/gateways/beanstream/beanstream_core.rb +244 -0
  22. data/lib/active_merchant/billing/gateways/beanstream_interac.rb +54 -0
  23. data/lib/active_merchant/billing/gateways/bogus.rb +102 -0
  24. data/lib/active_merchant/billing/gateways/braintree.rb +17 -0
  25. data/lib/active_merchant/billing/gateways/braintree/braintree_common.rb +9 -0
  26. data/lib/active_merchant/billing/gateways/braintree_blue.rb +210 -0
  27. data/lib/active_merchant/billing/gateways/braintree_orange.rb +17 -0
  28. data/lib/active_merchant/billing/gateways/card_stream.rb +230 -0
  29. data/lib/active_merchant/billing/gateways/cyber_source.rb +406 -0
  30. data/lib/active_merchant/billing/gateways/data_cash.rb +593 -0
  31. data/lib/active_merchant/billing/gateways/efsnet.rb +229 -0
  32. data/lib/active_merchant/billing/gateways/elavon.rb +134 -0
  33. data/lib/active_merchant/billing/gateways/eway.rb +277 -0
  34. data/lib/active_merchant/billing/gateways/exact.rb +222 -0
  35. data/lib/active_merchant/billing/gateways/first_pay.rb +172 -0
  36. data/lib/active_merchant/billing/gateways/garanti.rb +222 -0
  37. data/lib/active_merchant/billing/gateways/instapay.rb +164 -0
  38. data/lib/active_merchant/billing/gateways/jetpay.rb +270 -0
  39. data/lib/active_merchant/billing/gateways/linkpoint.rb +449 -0
  40. data/lib/active_merchant/billing/gateways/merchant_e_solutions.rb +154 -0
  41. data/lib/active_merchant/billing/gateways/merchant_ware.rb +283 -0
  42. data/lib/active_merchant/billing/gateways/modern_payments.rb +36 -0
  43. data/lib/active_merchant/billing/gateways/modern_payments_cim.rb +220 -0
  44. data/lib/active_merchant/billing/gateways/moneris.rb +205 -0
  45. data/lib/active_merchant/billing/gateways/net_registry.rb +189 -0
  46. data/lib/active_merchant/billing/gateways/netbilling.rb +168 -0
  47. data/lib/active_merchant/billing/gateways/ogone.rb +279 -0
  48. data/lib/active_merchant/billing/gateways/pay_junction.rb +392 -0
  49. data/lib/active_merchant/billing/gateways/pay_secure.rb +120 -0
  50. data/lib/active_merchant/billing/gateways/payflow.rb +236 -0
  51. data/lib/active_merchant/billing/gateways/payflow/payflow_common_api.rb +207 -0
  52. data/lib/active_merchant/billing/gateways/payflow/payflow_express_response.rb +39 -0
  53. data/lib/active_merchant/billing/gateways/payflow/payflow_response.rb +13 -0
  54. data/lib/active_merchant/billing/gateways/payflow_express.rb +138 -0
  55. data/lib/active_merchant/billing/gateways/payflow_express_uk.rb +15 -0
  56. data/lib/active_merchant/billing/gateways/payflow_uk.rb +21 -0
  57. data/lib/active_merchant/billing/gateways/payment_express.rb +230 -0
  58. data/lib/active_merchant/billing/gateways/paypal.rb +121 -0
  59. data/lib/active_merchant/billing/gateways/paypal/paypal_common_api.rb +326 -0
  60. data/lib/active_merchant/billing/gateways/paypal/paypal_express_response.rb +38 -0
  61. data/lib/active_merchant/billing/gateways/paypal_ca.rb +13 -0
  62. data/lib/active_merchant/billing/gateways/paypal_express.rb +135 -0
  63. data/lib/active_merchant/billing/gateways/paypal_express_common.rb +20 -0
  64. data/lib/active_merchant/billing/gateways/plugnpay.rb +292 -0
  65. data/lib/active_merchant/billing/gateways/psigate.rb +214 -0
  66. data/lib/active_merchant/billing/gateways/psl_card.rb +304 -0
  67. data/lib/active_merchant/billing/gateways/quickpay.rb +213 -0
  68. data/lib/active_merchant/billing/gateways/realex.rb +200 -0
  69. data/lib/active_merchant/billing/gateways/sage.rb +146 -0
  70. data/lib/active_merchant/billing/gateways/sage/sage_bankcard.rb +88 -0
  71. data/lib/active_merchant/billing/gateways/sage/sage_core.rb +116 -0
  72. data/lib/active_merchant/billing/gateways/sage/sage_virtual_check.rb +97 -0
  73. data/lib/active_merchant/billing/gateways/sage_pay.rb +317 -0
  74. data/lib/active_merchant/billing/gateways/sallie_mae.rb +144 -0
  75. data/lib/active_merchant/billing/gateways/secure_pay.rb +31 -0
  76. data/lib/active_merchant/billing/gateways/secure_pay_au.rb +157 -0
  77. data/lib/active_merchant/billing/gateways/secure_pay_tech.rb +113 -0
  78. data/lib/active_merchant/billing/gateways/skip_jack.rb +453 -0
  79. data/lib/active_merchant/billing/gateways/smart_ps.rb +265 -0
  80. data/lib/active_merchant/billing/gateways/trans_first.rb +127 -0
  81. data/lib/active_merchant/billing/gateways/transax.rb +25 -0
  82. data/lib/active_merchant/billing/gateways/trust_commerce.rb +418 -0
  83. data/lib/active_merchant/billing/gateways/usa_epay.rb +194 -0
  84. data/lib/active_merchant/billing/gateways/verifi.rb +228 -0
  85. data/lib/active_merchant/billing/gateways/viaklix.rb +189 -0
  86. data/lib/active_merchant/billing/gateways/wirecard.rb +318 -0
  87. data/lib/active_merchant/billing/integrations.rb +17 -0
  88. data/lib/active_merchant/billing/integrations/action_view_helper.rb +76 -0
  89. data/lib/active_merchant/billing/integrations/bogus.rb +23 -0
  90. data/lib/active_merchant/billing/integrations/bogus/helper.rb +17 -0
  91. data/lib/active_merchant/billing/integrations/bogus/notification.rb +11 -0
  92. data/lib/active_merchant/billing/integrations/bogus/return.rb +10 -0
  93. data/lib/active_merchant/billing/integrations/chronopay.rb +23 -0
  94. data/lib/active_merchant/billing/integrations/chronopay/helper.rb +120 -0
  95. data/lib/active_merchant/billing/integrations/chronopay/notification.rb +158 -0
  96. data/lib/active_merchant/billing/integrations/chronopay/return.rb +10 -0
  97. data/lib/active_merchant/billing/integrations/gestpay.rb +25 -0
  98. data/lib/active_merchant/billing/integrations/gestpay/common.rb +42 -0
  99. data/lib/active_merchant/billing/integrations/gestpay/helper.rb +70 -0
  100. data/lib/active_merchant/billing/integrations/gestpay/notification.rb +85 -0
  101. data/lib/active_merchant/billing/integrations/gestpay/return.rb +10 -0
  102. data/lib/active_merchant/billing/integrations/helper.rb +93 -0
  103. data/lib/active_merchant/billing/integrations/hi_trust.rb +27 -0
  104. data/lib/active_merchant/billing/integrations/hi_trust/helper.rb +58 -0
  105. data/lib/active_merchant/billing/integrations/hi_trust/notification.rb +59 -0
  106. data/lib/active_merchant/billing/integrations/hi_trust/return.rb +67 -0
  107. data/lib/active_merchant/billing/integrations/nochex.rb +88 -0
  108. data/lib/active_merchant/billing/integrations/nochex/helper.rb +68 -0
  109. data/lib/active_merchant/billing/integrations/nochex/notification.rb +94 -0
  110. data/lib/active_merchant/billing/integrations/nochex/return.rb +10 -0
  111. data/lib/active_merchant/billing/integrations/notification.rb +62 -0
  112. data/lib/active_merchant/billing/integrations/paypal.rb +39 -0
  113. data/lib/active_merchant/billing/integrations/paypal/helper.rb +119 -0
  114. data/lib/active_merchant/billing/integrations/paypal/notification.rb +154 -0
  115. data/lib/active_merchant/billing/integrations/paypal/return.rb +10 -0
  116. data/lib/active_merchant/billing/integrations/quickpay.rb +17 -0
  117. data/lib/active_merchant/billing/integrations/quickpay/helper.rb +72 -0
  118. data/lib/active_merchant/billing/integrations/quickpay/notification.rb +74 -0
  119. data/lib/active_merchant/billing/integrations/return.rb +35 -0
  120. data/lib/active_merchant/billing/integrations/two_checkout.rb +23 -0
  121. data/lib/active_merchant/billing/integrations/two_checkout/helper.rb +59 -0
  122. data/lib/active_merchant/billing/integrations/two_checkout/notification.rb +114 -0
  123. data/lib/active_merchant/billing/integrations/two_checkout/return.rb +17 -0
  124. data/lib/active_merchant/billing/response.rb +32 -0
  125. data/lib/active_merchant/common.rb +14 -0
  126. data/lib/active_merchant/common/connection.rb +172 -0
  127. data/lib/active_merchant/common/country.rb +319 -0
  128. data/lib/active_merchant/common/error.rb +26 -0
  129. data/lib/active_merchant/common/post_data.rb +24 -0
  130. data/lib/active_merchant/common/posts_data.rb +47 -0
  131. data/lib/active_merchant/common/requires_parameters.rb +16 -0
  132. data/lib/active_merchant/common/utils.rb +18 -0
  133. data/lib/active_merchant/common/validateable.rb +76 -0
  134. data/lib/active_merchant/version.rb +3 -0
  135. data/lib/activemerchant.rb +1 -0
  136. data/lib/certs/cacert.pem +7815 -0
  137. data/lib/support/gateway_support.rb +58 -0
  138. data/lib/support/outbound_hosts.rb +25 -0
  139. metadata +252 -0
@@ -0,0 +1,68 @@
1
+ module ActiveMerchant #:nodoc:
2
+ module Billing #:nodoc:
3
+ module Integrations #:nodoc:
4
+ module Nochex
5
+ class Helper < ActiveMerchant::Billing::Integrations::Helper
6
+ # Required Parameters
7
+ # email
8
+ # amount
9
+ mapping :account, 'email'
10
+ mapping :amount, 'amount'
11
+
12
+ # Set the field status = test for testing with accounts:
13
+ # Account Password
14
+ # test1@nochex.com 123456
15
+ # test2@nochex.com 123456
16
+ # def initialize(order, account, options = {})
17
+ # super
18
+ # add_field('status', 'test')
19
+ # end
20
+
21
+ # Need to format the amount to have 2 decimal places
22
+ def amount=(money)
23
+ cents = money.respond_to?(:cents) ? money.cents : money
24
+ if money.is_a?(String) or cents.to_i <= 0
25
+ raise ArgumentError, 'money amount must be either a Money object or a positive integer in cents.'
26
+ end
27
+ add_field mappings[:amount], sprintf("%.2f", cents.to_f/100)
28
+ end
29
+
30
+ # Optional Parameters
31
+ # ordernumber
32
+ mapping :order, 'ordernumber'
33
+
34
+ # firstname
35
+ # lastname
36
+ # email_address_sender
37
+ mapping :customer, :first_name => 'firstname',
38
+ :last_name => 'lastname',
39
+ :email => 'email_address_sender'
40
+
41
+ # town
42
+ # firstline
43
+ # county
44
+ # postcode
45
+ mapping :billing_address, :city => 'town',
46
+ :address1 => 'firstline',
47
+ :state => 'county',
48
+ :zip => 'postcode'
49
+
50
+ # responderurl
51
+ mapping :notify_url, 'responderurl'
52
+
53
+ # returnurl
54
+ mapping :return_url, 'returnurl'
55
+
56
+ # cancelurl
57
+ mapping :cancel_return_url, 'cancelurl'
58
+
59
+ # description
60
+ mapping :description, 'description'
61
+
62
+ # Currently unmapped
63
+ # logo
64
+ end
65
+ end
66
+ end
67
+ end
68
+ end
@@ -0,0 +1,94 @@
1
+ require 'net/http'
2
+ require 'date'
3
+
4
+ module ActiveMerchant #:nodoc:
5
+ module Billing #:nodoc:
6
+ module Integrations #:nodoc:
7
+ module Nochex
8
+ # Parser and handler for incoming Automatic Payment Confirmations from Nochex.
9
+ class Notification < ActiveMerchant::Billing::Integrations::Notification
10
+ include ActiveMerchant::PostsData
11
+
12
+ def complete?
13
+ status == 'Completed'
14
+ end
15
+
16
+ # Id of the order we passed to Nochex
17
+ def item_id
18
+ params['order_id']
19
+ end
20
+
21
+ def transaction_id
22
+ params['transaction_id']
23
+ end
24
+
25
+ def currency
26
+ 'GBP'
27
+ end
28
+
29
+ # When was this payment received by the client.
30
+ def received_at
31
+ # U.K. Format: 27/09/2006 22:30:54
32
+ return if params['transaction_date'].blank?
33
+ time = params['transaction_date'].scan(/\d+/)
34
+ Time.utc(time[2], time[1], time[0], time[3], time[4], time[5])
35
+ end
36
+
37
+ def payer_email
38
+ params['from_email']
39
+ end
40
+
41
+ def receiver_email
42
+ params['to_email']
43
+ end
44
+
45
+ def security_key
46
+ params['security_key']
47
+ end
48
+
49
+ # the money amount we received in X.2 decimal.
50
+ def gross
51
+ sprintf("%.2f", params['amount'].to_f)
52
+ end
53
+
54
+ # Was this a test transaction?
55
+ def test?
56
+ params['status'] == 'test'
57
+ end
58
+
59
+ def status
60
+ 'Completed'
61
+ end
62
+
63
+ # Acknowledge the transaction to Nochex. This method has to be called after a new
64
+ # apc arrives. Nochex will verify that all the information we received are correct and will return a
65
+ # ok or a fail. This is very similar to the PayPal IPN scheme.
66
+ #
67
+ # Example:
68
+ #
69
+ # def nochex_ipn
70
+ # notify = NochexNotification.new(request.raw_post)
71
+ #
72
+ # if notify.acknowledge
73
+ # ... process order ... if notify.complete?
74
+ # else
75
+ # ... log possible hacking attempt ...
76
+ # end
77
+ def acknowledge
78
+ payload = raw
79
+
80
+ response = ssl_post(Nochex.notification_confirmation_url, payload,
81
+ 'Content-Length' => "#{payload.size}",
82
+ 'User-Agent' => "Active Merchant -- http://activemerchant.org",
83
+ 'Content-Type' => "application/x-www-form-urlencoded"
84
+ )
85
+
86
+ raise StandardError.new("Faulty Nochex result: #{response}") unless ["AUTHORISED", "DECLINED"].include?(response)
87
+
88
+ response == "AUTHORISED"
89
+ end
90
+ end
91
+ end
92
+ end
93
+ end
94
+ end
@@ -0,0 +1,10 @@
1
+ module ActiveMerchant #:nodoc:
2
+ module Billing #:nodoc:
3
+ module Integrations #:nodoc:
4
+ module Nochex
5
+ class Return < ActiveMerchant::Billing::Integrations::Return
6
+ end
7
+ end
8
+ end
9
+ end
10
+ end
@@ -0,0 +1,62 @@
1
+ module ActiveMerchant #:nodoc:
2
+ module Billing #:nodoc:
3
+ module Integrations #:nodoc:
4
+ class Notification
5
+ attr_accessor :params
6
+ attr_accessor :raw
7
+
8
+ # set this to an array in the subclass, to specify which IPs are allowed to send requests
9
+ class_inheritable_accessor :production_ips
10
+
11
+ def initialize(post, options = {})
12
+ @options = options
13
+ empty!
14
+ parse(post)
15
+ end
16
+
17
+ def status
18
+ raise NotImplementedError, "Must implement this method in the subclass"
19
+ end
20
+
21
+ # the money amount we received in X.2 decimal.
22
+ def gross
23
+ raise NotImplementedError, "Must implement this method in the subclass"
24
+ end
25
+
26
+ def gross_cents
27
+ (gross.to_f * 100.0).round
28
+ end
29
+
30
+ # This combines the gross and currency and returns a proper Money object.
31
+ # this requires the money library located at http://dist.leetsoft.com/api/money
32
+ def amount
33
+ return Money.new(gross_cents, currency) rescue ArgumentError
34
+ return Money.new(gross_cents) # maybe you have an own money object which doesn't take a currency?
35
+ end
36
+
37
+ # reset the notification.
38
+ def empty!
39
+ @params = Hash.new
40
+ @raw = ""
41
+ end
42
+
43
+ # Check if the request comes from an official IP
44
+ def valid_sender?(ip)
45
+ return true if ActiveMerchant::Billing::Base.integration_mode == :test || production_ips.blank?
46
+ production_ips.include?(ip)
47
+ end
48
+
49
+ private
50
+
51
+ # Take the posted data and move the relevant data into a hash
52
+ def parse(post)
53
+ @raw = post.to_s
54
+ for line in @raw.split('&')
55
+ key, value = *line.scan( %r{^([A-Za-z0-9_.]+)\=(.*)$} ).flatten
56
+ params[key] = CGI.unescape(value)
57
+ end
58
+ end
59
+ end
60
+ end
61
+ end
62
+ end
@@ -0,0 +1,39 @@
1
+ module ActiveMerchant #:nodoc:
2
+ module Billing #:nodoc:
3
+ module Integrations #:nodoc:
4
+ module Paypal
5
+ autoload :Return, 'active_merchant/billing/integrations/paypal/return.rb'
6
+ autoload :Helper, 'active_merchant/billing/integrations/paypal/helper.rb'
7
+ autoload :Notification, 'active_merchant/billing/integrations/paypal/notification.rb'
8
+
9
+ # Overwrite this if you want to change the Paypal test url
10
+ mattr_accessor :test_url
11
+ self.test_url = 'https://www.sandbox.paypal.com/cgi-bin/webscr'
12
+
13
+ # Overwrite this if you want to change the Paypal production url
14
+ mattr_accessor :production_url
15
+ self.production_url = 'https://www.paypal.com/cgi-bin/webscr'
16
+
17
+ def self.service_url
18
+ mode = ActiveMerchant::Billing::Base.integration_mode
19
+ case mode
20
+ when :production
21
+ self.production_url
22
+ when :test
23
+ self.test_url
24
+ else
25
+ raise StandardError, "Integration mode set to an invalid value: #{mode}"
26
+ end
27
+ end
28
+
29
+ def self.notification(post)
30
+ Notification.new(post)
31
+ end
32
+
33
+ def self.return(query_string)
34
+ Return.new(query_string)
35
+ end
36
+ end
37
+ end
38
+ end
39
+ end
@@ -0,0 +1,119 @@
1
+ module ActiveMerchant #:nodoc:
2
+ module Billing #:nodoc:
3
+ module Integrations #:nodoc:
4
+ module Paypal
5
+ class Helper < ActiveMerchant::Billing::Integrations::Helper
6
+ CANADIAN_PROVINCES = { 'AB' => 'Alberta',
7
+ 'BC' => 'British Columbia',
8
+ 'MB' => 'Manitoba',
9
+ 'NB' => 'New Brunswick',
10
+ 'NL' => 'Newfoundland',
11
+ 'NS' => 'Nova Scotia',
12
+ 'NU' => 'Nunavut',
13
+ 'NT' => 'Northwest Territories',
14
+ 'ON' => 'Ontario',
15
+ 'PE' => 'Prince Edward Island',
16
+ 'QC' => 'Quebec',
17
+ 'SK' => 'Saskatchewan',
18
+ 'YT' => 'Yukon'
19
+ }
20
+ # See https://www.paypal.com/IntegrationCenter/ic_std-variable-reference.html for details on the following options.
21
+ mapping :order, [ 'item_number', 'custom' ]
22
+
23
+ def initialize(order, account, options = {})
24
+ super
25
+ add_field('cmd', '_ext-enter')
26
+ add_field('redirect_cmd', '_xclick')
27
+ add_field('quantity', 1)
28
+ add_field('item_name', 'Store purchase')
29
+ add_field('no_shipping', '1')
30
+ add_field('no_note', '1')
31
+ add_field('charset', 'utf-8')
32
+ add_field('address_override', '0')
33
+ add_field('bn', application_id.to_s.slice(0,32)) unless application_id.blank?
34
+ end
35
+
36
+ mapping :amount, 'amount'
37
+ mapping :account, 'business'
38
+ mapping :currency, 'currency_code'
39
+ mapping :notify_url, 'notify_url'
40
+ mapping :return_url, 'return'
41
+ mapping :cancel_return_url, 'cancel_return'
42
+ mapping :invoice, 'invoice'
43
+ mapping :item_name, 'item_name'
44
+ mapping :quantity, 'quantity'
45
+ mapping :no_shipping, 'no_shipping'
46
+ mapping :no_note, 'no_note'
47
+ mapping :address_override, 'address_override'
48
+
49
+ mapping :application_id, 'bn'
50
+
51
+ mapping :customer, :first_name => 'first_name',
52
+ :last_name => 'last_name',
53
+ :email => 'email'
54
+
55
+ mapping :shipping_address, :city => 'city',
56
+ :address1 => 'address1',
57
+ :address2 => 'address2',
58
+ :state => 'state',
59
+ :zip => 'zip',
60
+ :country => 'country'
61
+
62
+ def shipping_address(params = {})
63
+
64
+ # Get the country code in the correct format
65
+ # Use what we were given if we can't find anything
66
+ country_code = lookup_country_code(params.delete(:country))
67
+ add_field(mappings[:shipping_address][:country], country_code)
68
+
69
+ if params.has_key?(:phone)
70
+ phone = params.delete(:phone).to_s
71
+
72
+ # Whipe all non digits
73
+ phone.gsub!(/\D+/, '')
74
+
75
+ if ['US', 'CA'].include?(country_code) && phone =~ /(\d{3})(\d{3})(\d{4})$/
76
+ add_field('night_phone_a', $1)
77
+ add_field('night_phone_b', $2)
78
+ add_field('night_phone_c', $3)
79
+ else
80
+ add_field('night_phone_b', phone)
81
+ end
82
+ end
83
+
84
+ province_code = params.delete(:state)
85
+
86
+ case country_code
87
+ when 'CA'
88
+ add_field(mappings[:shipping_address][:state], CANADIAN_PROVINCES[province_code.upcase]) unless province_code.nil?
89
+ when 'US'
90
+ add_field(mappings[:shipping_address][:state], province_code)
91
+ else
92
+ add_field(mappings[:shipping_address][:state], province_code.blank? ? 'N/A' : province_code)
93
+ end
94
+
95
+ # Everything else
96
+ params.each do |k, v|
97
+ field = mappings[:shipping_address][k]
98
+ add_field(field, v) unless field.nil?
99
+ end
100
+ end
101
+
102
+ mapping :tax, 'tax'
103
+ mapping :shipping, 'shipping'
104
+ mapping :cmd, 'cmd'
105
+ mapping :custom, 'custom'
106
+ mapping :src, 'src'
107
+ mapping :sra, 'sra'
108
+ %w(a p t).each do |l|
109
+ (1..3).each do |i|
110
+ mapping "#{l}#{i}".to_sym, "#{l}#{i}"
111
+ end
112
+ end
113
+ end
114
+ end
115
+ end
116
+ end
117
+ end
118
+
119
+
@@ -0,0 +1,154 @@
1
+ require 'net/http'
2
+
3
+ module ActiveMerchant #:nodoc:
4
+ module Billing #:nodoc:
5
+ module Integrations #:nodoc:
6
+ module Paypal
7
+ # Parser and handler for incoming Instant payment notifications from paypal.
8
+ # The Example shows a typical handler in a rails application. Note that this
9
+ # is an example, please read the Paypal API documentation for all the details
10
+ # on creating a safe payment controller.
11
+ #
12
+ # Example
13
+ #
14
+ # class BackendController < ApplicationController
15
+ # include ActiveMerchant::Billing::Integrations
16
+ #
17
+ # def paypal_ipn
18
+ # notify = Paypal::Notification.new(request.raw_post)
19
+ #
20
+ # order = Order.find(notify.item_id)
21
+ #
22
+ # if notify.acknowledge
23
+ # begin
24
+ #
25
+ # if notify.complete? and order.total == notify.amount
26
+ # order.status = 'success'
27
+ #
28
+ # shop.ship(order)
29
+ # else
30
+ # logger.error("Failed to verify Paypal's notification, please investigate")
31
+ # end
32
+ #
33
+ # rescue => e
34
+ # order.status = 'failed'
35
+ # raise
36
+ # ensure
37
+ # order.save
38
+ # end
39
+ # end
40
+ #
41
+ # render :nothing
42
+ # end
43
+ # end
44
+ class Notification < ActiveMerchant::Billing::Integrations::Notification
45
+ include PostsData
46
+
47
+ # Was the transaction complete?
48
+ def complete?
49
+ status == "Completed"
50
+ end
51
+
52
+ # When was this payment received by the client.
53
+ # sometimes it can happen that we get the notification much later.
54
+ # One possible scenario is that our web application was down. In this case paypal tries several
55
+ # times an hour to inform us about the notification
56
+ def received_at
57
+ Time.parse params['payment_date']
58
+ end
59
+
60
+ # Status of transaction. List of possible values:
61
+ # <tt>Canceled-Reversal</tt>::
62
+ # <tt>Completed</tt>::
63
+ # <tt>Denied</tt>::
64
+ # <tt>Expired</tt>::
65
+ # <tt>Failed</tt>::
66
+ # <tt>In-Progress</tt>::
67
+ # <tt>Partially-Refunded</tt>::
68
+ # <tt>Pending</tt>::
69
+ # <tt>Processed</tt>::
70
+ # <tt>Refunded</tt>::
71
+ # <tt>Reversed</tt>::
72
+ # <tt>Voided</tt>::
73
+ def status
74
+ params['payment_status']
75
+ end
76
+
77
+ # Id of this transaction (paypal number)
78
+ def transaction_id
79
+ params['txn_id']
80
+ end
81
+
82
+ # What type of transaction are we dealing with?
83
+ # "cart" "send_money" "web_accept" are possible here.
84
+ def type
85
+ params['txn_type']
86
+ end
87
+
88
+ # the money amount we received in X.2 decimal.
89
+ def gross
90
+ params['mc_gross']
91
+ end
92
+
93
+ # the markup paypal charges for the transaction
94
+ def fee
95
+ params['mc_fee']
96
+ end
97
+
98
+ # What currency have we been dealing with
99
+ def currency
100
+ params['mc_currency']
101
+ end
102
+
103
+ # This is the item number which we submitted to paypal
104
+ # The custom field is also mapped to item_id because PayPal
105
+ # doesn't return item_number in dispute notifications
106
+ def item_id
107
+ params['item_number'] || params['custom']
108
+ end
109
+
110
+ # This is the invoice which you passed to paypal
111
+ def invoice
112
+ params['invoice']
113
+ end
114
+
115
+ # Was this a test transaction?
116
+ def test?
117
+ params['test_ipn'] == '1'
118
+ end
119
+
120
+ def account
121
+ params['business'] || params['receiver_email']
122
+ end
123
+
124
+ # Acknowledge the transaction to paypal. This method has to be called after a new
125
+ # ipn arrives. Paypal will verify that all the information we received are correct and will return a
126
+ # ok or a fail.
127
+ #
128
+ # Example:
129
+ #
130
+ # def paypal_ipn
131
+ # notify = PaypalNotification.new(request.raw_post)
132
+ #
133
+ # if notify.acknowledge
134
+ # ... process order ... if notify.complete?
135
+ # else
136
+ # ... log possible hacking attempt ...
137
+ # end
138
+ def acknowledge
139
+ payload = raw
140
+
141
+ response = ssl_post(Paypal.service_url + '?cmd=_notify-validate', payload,
142
+ 'Content-Length' => "#{payload.size}",
143
+ 'User-Agent' => "Active Merchant -- http://activemerchant.org"
144
+ )
145
+
146
+ raise StandardError.new("Faulty paypal result: #{response}") unless ["VERIFIED", "INVALID"].include?(response)
147
+
148
+ response == "VERIFIED"
149
+ end
150
+ end
151
+ end
152
+ end
153
+ end
154
+ end