swiss-activemerchant 1.0.1

data/lib/active_merchant/billing/gateways/paypal_express.rb

@@ -0,0 +1,272 @@
+require 'active_merchant/billing/gateways/paypal/paypal_common_api'
+require 'active_merchant/billing/gateways/paypal/paypal_express_response'
+require 'active_merchant/billing/gateways/paypal/paypal_recurring_api'
+require 'active_merchant/billing/gateways/paypal_express_common'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class PaypalExpressGateway < Gateway
+      include PaypalCommonAPI
+      include PaypalExpressCommon
+      include PaypalRecurringApi
+
+      NON_STANDARD_LOCALE_CODES = {
+        'DK' => 'da_DK',
+        'IL' => 'he_IL',
+        'ID' => 'id_ID',
+        'JP' => 'jp_JP',
+        'NO' => 'no_NO',
+        'BR' => 'pt_BR',
+        'RU' => 'ru_RU',
+        'SE' => 'sv_SE',
+        'TH' => 'th_TH',
+        'TR' => 'tr_TR',
+        'CN' => 'zh_CN',
+        'HK' => 'zh_HK',
+        'TW' => 'zh_TW'
+      }
+
+      self.test_redirect_url = 'https://www.sandbox.paypal.com/cgi-bin/webscr'
+      self.supported_countries = ['US']
+      self.homepage_url = 'https://www.paypal.com/cgi-bin/webscr?cmd=xpt/merchant/ExpressCheckoutIntro-outside'
+      self.display_name = 'PayPal Express Checkout'
+      self.currencies_without_fractions = %w(HUF JPY TWD)
+
+      def setup_authorization(money, options = {})
+        requires!(options, :return_url, :cancel_return_url)
+
+        commit 'SetExpressCheckout', build_setup_request('Authorization', money, options)
+      end
+
+      def setup_purchase(money, options = {})
+        requires!(options, :return_url, :cancel_return_url)
+
+        commit 'SetExpressCheckout', build_setup_request('Sale', money, options)
+      end
+
+      def details_for(token)
+        commit 'GetExpressCheckoutDetails', build_get_details_request(token)
+      end
+
+      def authorize(money, options = {})
+        requires!(options, :token, :payer_id)
+
+        commit 'DoExpressCheckoutPayment', build_sale_or_authorization_request('Authorization', money, options)
+      end
+
+      def purchase(money, options = {})
+        requires!(options, :token, :payer_id)
+
+        commit 'DoExpressCheckoutPayment', build_sale_or_authorization_request('Sale', money, options)
+      end
+
+      def store(token, options = {})
+        commit 'CreateBillingAgreement', build_create_billing_agreement_request(token, options)
+      end
+
+      def unstore(token, options = {})
+        commit 'BAUpdate', build_cancel_billing_agreement_request(token)
+      end
+
+      def agreement_details(reference_id, options = {})
+        commit 'BAUpdate', build_details_billing_agreement_request(reference_id)
+      end
+
+      def authorize_reference_transaction(money, options = {})
+        requires!(options, :reference_id)
+
+        commit 'DoReferenceTransaction', build_reference_transaction_request('Authorization', money, options)
+      end
+
+      def reference_transaction(money, options = {})
+        requires!(options, :reference_id)
+
+        commit 'DoReferenceTransaction', build_reference_transaction_request('Sale', money, options)
+      end
+
+      private
+      def build_get_details_request(token)
+        xml = Builder::XmlMarkup.new :indent => 2
+        xml.tag! 'GetExpressCheckoutDetailsReq', 'xmlns' => PAYPAL_NAMESPACE do
+          xml.tag! 'GetExpressCheckoutDetailsRequest', 'xmlns:n2' => EBAY_NAMESPACE do
+            xml.tag! 'n2:Version', API_VERSION
+            xml.tag! 'Token', token
+          end
+        end
+
+        xml.target!
+      end
+
+      def build_sale_or_authorization_request(action, money, options)
+        currency_code = options[:currency] || currency(money)
+
+        xml = Builder::XmlMarkup.new :indent => 2
+        xml.tag! 'DoExpressCheckoutPaymentReq', 'xmlns' => PAYPAL_NAMESPACE do
+          xml.tag! 'DoExpressCheckoutPaymentRequest', 'xmlns:n2' => EBAY_NAMESPACE do
+            xml.tag! 'n2:Version', API_VERSION
+            xml.tag! 'n2:DoExpressCheckoutPaymentRequestDetails' do
+              xml.tag! 'n2:PaymentAction', action
+              xml.tag! 'n2:Token', options[:token]
+              xml.tag! 'n2:PayerID', options[:payer_id]
+              xml.tag! 'n2:MsgSubID', options[:idempotency_key] if options[:idempotency_key]
+              add_payment_details(xml, money, currency_code, options)
+            end
+          end
+        end
+
+        xml.target!
+      end
+
+      def build_setup_request(action, money, options)
+        currency_code = options[:currency] || currency(money)
+        options[:payment_action] = action
+        options[:express_request] = true
+        options[:shipping_address] ||= options[:address]
+
+        xml = Builder::XmlMarkup.new :indent => 2
+        xml.tag! 'SetExpressCheckoutReq', 'xmlns' => PAYPAL_NAMESPACE do
+          xml.tag! 'SetExpressCheckoutRequest', 'xmlns:n2' => EBAY_NAMESPACE do
+            xml.tag! 'n2:Version', API_VERSION
+            xml.tag! 'n2:SetExpressCheckoutRequestDetails' do
+              xml.tag! 'n2:ReturnURL', options[:return_url]
+              xml.tag! 'n2:CancelURL', options[:cancel_return_url]
+              if options[:max_amount]
+                xml.tag! 'n2:MaxAmount', localized_amount(options[:max_amount], currency_code), 'currencyID' => currency_code
+              end
+              xml.tag! 'n2:ReqBillingAddress', options[:req_billing_address] ? '1' : '0'
+              xml.tag! 'n2:NoShipping', options[:no_shipping] ? '1' : '0'
+              xml.tag! 'n2:AddressOverride', options[:address_override] ? '1' : '0'
+              xml.tag! 'n2:LocaleCode', locale_code(options[:locale]) unless options[:locale].blank?
+              xml.tag! 'n2:BrandName', options[:brand_name] unless options[:brand_name].blank?
+              # Customization of the payment page
+              xml.tag! 'n2:PageStyle', options[:page_style] unless options[:page_style].blank?
+              xml.tag! 'n2:cpp-logo-image', options[:logo_image] unless options[:logo_image].blank?
+              xml.tag! 'n2:cpp-header-image', options[:header_image] unless options[:header_image].blank?
+              xml.tag! 'n2:cpp-header-border-color', options[:header_border_color] unless options[:header_border_color].blank?
+              xml.tag! 'n2:cpp-header-back-color', options[:header_background_color] unless options[:header_background_color].blank?
+              xml.tag! 'n2:cpp-payflow-color', options[:background_color] unless options[:background_color].blank?
+              if options[:allow_guest_checkout]
+                xml.tag! 'n2:SolutionType', 'Sole'
+                unless options[:paypal_chooses_landing_page]
+                  xml.tag! 'n2:LandingPage', options[:landing_page] || 'Billing'
+                end
+              end
+              xml.tag! 'n2:BuyerEmail', options[:email] unless options[:email].blank?
+
+              if options[:billing_agreement]
+                xml.tag! 'n2:BillingAgreementDetails' do
+                  xml.tag! 'n2:BillingType', options[:billing_agreement][:type]
+                  xml.tag! 'n2:BillingAgreementDescription', options[:billing_agreement][:description]
+                  xml.tag! 'n2:PaymentType', options[:billing_agreement][:payment_type] || 'InstantOnly'
+                end
+              end
+
+              if !options[:allow_note].nil?
+                xml.tag! 'n2:AllowNote', options[:allow_note] ? '1' : '0'
+              end
+
+              if options[:funding_sources]
+                xml.tag! 'n2:FundingSourceDetails' do
+                  xml.tag! 'n2:UserSelectedFundingSource', options[:funding_sources][:source]
+                end
+              end
+
+              xml.tag! 'n2:CallbackURL', options[:callback_url] unless options[:callback_url].blank?
+
+              add_payment_details(xml, money, currency_code, options)
+              if options[:shipping_options]
+                options[:shipping_options].each do |shipping_option|
+                  xml.tag! 'n2:FlatRateShippingOptions' do
+                    xml.tag! 'n2:ShippingOptionIsDefault', shipping_option[:default]
+                    xml.tag! 'n2:ShippingOptionAmount', localized_amount(shipping_option[:amount], currency_code), 'currencyID' => currency_code
+                    xml.tag! 'n2:ShippingOptionName', shipping_option[:name]
+                  end
+                end
+              end
+
+              xml.tag! 'n2:CallbackTimeout', options[:callback_timeout] unless options[:callback_timeout].blank?
+              xml.tag! 'n2:CallbackVersion', options[:callback_version] unless options[:callback_version].blank?
+
+              if options.has_key?(:allow_buyer_optin)
+                xml.tag! 'n2:BuyerEmailOptInEnable', (options[:allow_buyer_optin] ? '1' : '0')
+              end
+
+              xml.tag! 'n2:TotalType', options[:total_type] unless options[:total_type].blank?
+            end
+          end
+        end
+
+        xml.target!
+      end
+
+      def build_create_billing_agreement_request(token, options = {})
+        xml = Builder::XmlMarkup.new :indent => 2
+        xml.tag! 'CreateBillingAgreementReq', 'xmlns' => PAYPAL_NAMESPACE do
+          xml.tag! 'CreateBillingAgreementRequest', 'xmlns:n2' => EBAY_NAMESPACE do
+            xml.tag! 'n2:Version', API_VERSION
+            xml.tag! 'Token', token
+          end
+        end
+
+        xml.target!
+      end
+
+      def build_cancel_billing_agreement_request(token)
+        xml = Builder::XmlMarkup.new :indent => 2
+        xml.tag! 'BillAgreementUpdateReq', 'xmlns' => PAYPAL_NAMESPACE do
+          xml.tag! 'BAUpdateRequest', 'xmlns:n2' => EBAY_NAMESPACE do
+            xml.tag! 'n2:Version', API_VERSION
+            xml.tag! 'ReferenceID', token
+            xml.tag! 'BillingAgreementStatus', "Canceled"
+          end
+        end
+
+        xml.target!
+      end
+
+      def build_details_billing_agreement_request(reference_id)
+        xml = Builder::XmlMarkup.new :indent => 2
+        xml.tag! 'BillAgreementUpdateReq', 'xmlns' => PAYPAL_NAMESPACE do
+          xml.tag! 'BAUpdateRequest', 'xmlns:n2' => EBAY_NAMESPACE do
+            xml.tag! 'n2:Version', API_VERSION
+            xml.tag! 'ReferenceID', reference_id
+          end
+        end
+
+        xml.target!
+      end
+
+      def build_reference_transaction_request(action, money, options)
+        currency_code = options[:currency] || currency(money)
+
+        # I am not sure why it's set like this for express gateway
+        # but I don't want to break the existing behavior
+        xml = Builder::XmlMarkup.new :indent => 2
+        xml.tag! 'DoReferenceTransactionReq', 'xmlns' => PAYPAL_NAMESPACE do
+          xml.tag! 'DoReferenceTransactionRequest', 'xmlns:n2' => EBAY_NAMESPACE do
+            xml.tag! 'n2:Version', API_VERSION
+            xml.tag! 'n2:DoReferenceTransactionRequestDetails' do
+              xml.tag! 'n2:ReferenceID', options[:reference_id]
+              xml.tag! 'n2:PaymentAction', action
+              xml.tag! 'n2:PaymentType', options[:payment_type] || 'Any'
+              add_payment_details(xml, money, currency_code, options)
+              xml.tag! 'n2:IPAddress', options[:ip]
+              xml.tag! 'n2:MerchantSessionId', options[:merchant_session_id] if options[:merchant_session_id].present?
+              xml.tag! 'n2:MsgSubID', options[:idempotency_key] if options[:idempotency_key]
+            end
+          end
+        end
+
+        xml.target!
+      end
+
+      def build_response(success, message, response, options = {})
+        PaypalExpressResponse.new(success, message, response, options)
+      end
+
+      def locale_code(country_code)
+        NON_STANDARD_LOCALE_CODES[country_code] || country_code
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/gateways/paypal_express_common.rb

@@ -0,0 +1,30 @@
+module ActiveMerchant
+  module Billing
+    module PaypalExpressCommon
+      def self.included(base)
+        if base.respond_to?(:class_attribute)
+          base.class_attribute :test_redirect_url
+          base.class_attribute :live_redirect_url
+        else
+          base.class_inheritable_accessor :test_redirect_url
+          base.class_inheritable_accessor :live_redirect_url
+        end
+        base.live_redirect_url = 'https://www.paypal.com/cgi-bin/webscr'
+      end
+
+      def redirect_url
+        test? ? test_redirect_url : live_redirect_url
+      end
+
+      def redirect_url_for(token, options = {})
+        options = { review: true, mobile: false }.update(options)
+
+        cmd  = options[:mobile] ? '_express-checkout-mobile' : '_express-checkout'
+        url  = "#{redirect_url}?cmd=#{cmd}&token=#{token}"
+        url += '&useraction=commit' unless options[:review]
+
+        url
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/gateways/paypal_standard.rb

@@ -0,0 +1,281 @@
+module ActiveMerchant
+  module Billing
+    class PaypalStandardGateway < Gateway
+      self.test_url = 'https://api-m.sandbox.paypal.com'
+      self.live_url = 'https://api-m.paypal.com'
+      self.supported_countries = %w[AL DZ AD AO AI AG AR AM AW AU AT AZ BS BH BB BY BE BZ BJ BM BT BO BA BW BR VG BN BG BF BI KH CM CA CV KY TD CL CO KM CG CD CK CR CI HR CY CZ DK DJ DM DO EC EG SV ER EE ET FK FO FJ FI FR GF PF GA GM GE DE GI GR GL GD GP GT GN GW GY HN HK HU IS IN ID IE IL IT JM JP JO KZ KE KI KW KG LA LV LS LI LT LU MK MG MW MY MV ML MT MH MQ MR MU YT MX FM MD MC MN ME MS MA MZ NA NR NP NL NC NZ NI NE NG NU NF NO OM PW PA PG PY PE PH PN PL PT QA RE RO RU RW WS SM ST SA SN RS SC SL SG SK SI SB SO ZA KR ES LK SH KN LC PM VC SR SJ SZ SE CH TW TJ TZ TH TG TO TT TN TM TC TV UG UA AE GB US UY VU VA VE VN WF YE ZM ZW].freeze
+      self.default_currency = 'USD'
+      self.money_format = :cents
+      self.supported_cardtypes = %i[visa master american_express diners_club maestro discover jcb mada bp_plus]
+      self.display_name = 'PayPal'
+
+      ENDPOINTS = {
+        generate_token: '/v1/oauth2/token',
+        create_order: '/v2/checkout/orders',
+        capture_order: '/v2/checkout/orders/%{id}/capture',
+        refund: '/v2/payments/captures/%{id}/refund'
+      }
+
+      SOFT_DECLINE_CODES = %w[INVALID_REQUEST AUTHENTICATION_FAILURE UNPROCESSABLE_ENTITY RATE_LIMIT_REACHED].freeze
+      SUCCESS_CODES = %w[COMPLETED].freeze
+
+      def initialize(options = {})
+        requires!(options, :client_id, :client_secret)
+        @client_id = options[:client_id]
+        @client_secret = options[:client_secret]
+        @response_http_code = nil
+
+        super
+        @access_token = setup_access_token
+        @request_id = SecureRandom.uuid
+      end
+
+      def purchase(amount, payment_method, options = {})
+        post ||= {}
+
+        amount = to_currency(amount)
+
+        add_payment_intent(post)
+        add_purchase_units(post, amount, options)
+        add_payment_source(post, payment_method, options)
+
+        commit(:create_order, post)
+      end
+
+      def capture(authorization, options = {})
+        post = {}
+
+        commit(:capture_order, post, authorization)
+      end
+
+      def refund(amount, authorization, options = {})
+        post = {}
+
+        amount = to_currency(amount)
+
+        add_refund_amount(post, amount, options)
+        add_refund_reason(post, options)
+
+        commit(:refund, post, authorization)
+      end
+
+      private
+
+      def commit(action, post, id = nil)
+        begin
+          url = build_request_url(action, id)
+          response = parse(ssl_post(url, post_data(post), headers))
+          succeeded = success_from(response)
+        rescue ResponseError => e
+          response = parse(e.response.body, error: e.response)
+        end
+
+        Response.new(
+          succeeded,
+          message_from(succeeded, response),
+          normalize_response(action, response),
+          test: test?,
+          authorization: authorization_from(action, response),
+          error_code: succeeded ? nil : error_code_from(response),
+          avs_result: { code: response['avs'] },
+          cvv_result: response['cvv2'],
+          response_type: response_type(action, response),
+          response_http_code: @response_http_code,
+          request_endpoint: url,
+          request_method: request_method(action),
+          request_body: post,
+          request_id: @request_id
+        )
+      end
+
+      def base_url
+        if test?
+          test_url
+        else
+          live_url
+        end
+      end
+
+      def normalize_response(action, response)
+        if action == :create_order && response.present?
+          redirect_link = response['links'].find { |link| link['rel'] == "payer-action" }
+          response['_links'] = { 'redirect' => { 'href' => redirect_link['href'] } } if redirect_link
+          response['order_id'] = response['id']
+        end
+        response
+      end
+
+      def request_method(action)
+        case action
+        when :generate_token, :create_order, :capture_order, :refund
+          'post'
+        end
+      end
+
+      def setup_access_token
+        headers = {
+          'Content-Type' => 'application/json',
+          'Authorization' => "Basic #{encoded_credentials}"
+        }
+
+        response = ssl_post(build_request_url(:generate_token), grant_type, headers)
+        JSON.parse(response)['access_token']
+      end
+
+      def build_request_url(action, id = nil)
+        base_url = (test? ? test_url : live_url)
+        base_url + ENDPOINTS[action].to_s % { id: id }
+      end
+
+      def encoded_credentials
+        Base64.strict_encode64("#{@client_id}:#{@client_secret}")
+      end
+
+      def headers
+       { 'Authorization' => "Bearer #{@access_token}", 'Content-Type' => 'application/json', 'PayPal-Request-Id' => @request_id}
+      end
+
+      def post_data(post)
+        post.to_json
+      end
+
+      def parse(body, error: nil)
+        JSON.parse(body)
+      rescue JSON::ParserError
+        response = {
+          'error_type' => error&.code,
+          'message' => 'Invalid JSON response received from Paypal.com Unified Payments Gateway. Please contact Paypal.com if you continue to receive this message.'
+        }
+
+        response['error_codes'] = [error&.message] if error&.message
+        response
+      end
+
+      def grant_type
+        "grant_type=client_credentials"
+      end
+
+      def success_from(response)
+        SUCCESS_CODES.include?(response['status'])
+      end
+
+      def message_from(succeeded, response)
+        if succeeded
+          response['status']
+        elsif response['message']
+          response['name'] + ': ' + response['message']
+        else
+          response['error'] || response['error_description'] || response['status'] || response['message'] || 'Unable to read error message'
+        end
+      end
+
+      def authorization_from(action, response)
+        case action
+        when :create_order, :refund_order
+          response.dig('id')
+        when :capture_order
+          purchase_unit = response.dig('purchase_units', 0)
+          captures = purchase_unit&.dig('payments', 'captures', 0)
+          captures&.dig('id')
+        end
+      end
+
+      def error_code_from(response)
+        response['name'] unless success_from(response)
+      end
+
+      def add_purchase_units(post, amount, options)
+        purchase_unit = {}
+        purchase_unit[:reference_id] = options[:order_id]
+        purchase_unit[:amount] = {}
+        purchase_unit[:amount][:value] = amount
+        purchase_unit[:amount][:currency_code] = options[:currency]
+        add_shipping_address(purchase_unit, options)
+
+        post[:purchase_units] ||= []
+        post[:purchase_units] << purchase_unit
+      end
+
+      def add_payment_source(post, payment_method, options)
+        post[:payment_source] = {}
+        redirect_links = options[:redirect_links]
+
+        case payment_method.paypal_method_type
+        when 'paypal'
+          payment_source = post[:payment_source][:paypal] = {}
+          experience_context = payment_source[:experience_context] = {}
+
+          experience_context[:landing_page] = "LOGIN"
+          experience_context[:user_action] = "PAY_NOW"
+          experience_context[:return_url] = redirect_links[:success_url] if redirect_links
+          experience_context[:cancel_url] = redirect_links[:failure_url] if redirect_links
+        when 'giropay'
+          payment_source = post[:payment_source][:giropay] = {}
+
+          add_payment_source_details(payment_source, redirect_links, options)
+        when 'sofort'
+          payment_source = post[:payment_source][:sofort] = {}
+
+          add_payment_source_details(payment_source, redirect_links, options)
+        end
+      end
+
+      def add_shipping_address(purchase_unit, options)
+        purchase_unit[:shipping] = {}
+        purchase_unit[:shipping][:address] = {}
+        purchase_unit[:shipping][:address][:address_line_1] = options[:billing_address][:address1]
+        purchase_unit[:shipping][:address][:admin_area_2] = options[:billing_address][:city]
+        purchase_unit[:shipping][:address][:admin_area_1] = options[:billing_address][:state]
+        purchase_unit[:shipping][:address][:postal_code] = options[:billing_address][:zip]
+        purchase_unit[:shipping][:address][:country_code] = options[:billing_address][:country]
+      end
+
+      def add_payment_source_details(payment_source, redirect_links, options)
+        payment_source[:name] = options[:billing_address] ? options[:billing_address][:name] : ''
+        payment_source[:country_code] = options[:billing_address] ? options[:billing_address][:country] : ''
+
+        payment_source[:experience_context] = {}
+        payment_source[:experience_context][:brand_name] = options[:campaign_name]
+        payment_source[:experience_context][:return_url] = redirect_links[:success_url] if redirect_links
+        payment_source[:experience_context][:cancel_url] = redirect_links[:failure_url] if redirect_links
+      end
+
+      def add_payment_intent(post)
+        post[:intent] = "CAPTURE"
+      end
+
+      def add_refund_amount(post, amount, options)
+        post[:amount] = {
+          "value": amount,
+          "currency_code": options[:currency]
+        }
+      end
+
+      def add_refund_reason(post, options)
+        post[:note_to_payer] = options[:refund_reason]
+      end
+
+      def handle_response(response)
+        @response_http_code = response.code.to_i
+        super
+      end
+
+      def response_type(action, response)
+        return unless action == :capture_order
+
+        if SUCCESS_CODES.include?(response['status'])
+          0
+        elsif SOFT_DECLINE_CODES.include?(response['name'])
+          1
+        else
+          2
+        end
+      end
+
+      def to_currency(amount)
+        dollars = amount.to_f / 100.0
+        sprintf('%.2f', dollars)
+      end
+    end
+  end
+end