spree_adyen 0.10.0

data/app/presenters/spree_adyen/application_info_presenter.rb

@@ -0,0 +1,21 @@
+# see: https://docs.adyen.com/partners/application-information/?tab=partner-built_0_1#application-information-fields
+# some endpoints used in SpreeAdyen does not support applicationInfo (e.g. creating webhook)
+module SpreeAdyen
+  class ApplicationInfoPresenter
+    def to_h
+      {
+        applicationInfo: {
+          externalPlatform: {
+            name: 'Spree Commerce',
+            version: Spree.version,
+            integrator: 'Vendo Sp. z o.o.'
+          },
+          merchantApplication: {
+            name: defined?(SpreeEnterprise) ? 'Enterprise Edition' : 'Community Edition',
+            version: SpreeAdyen.version
+          }
+        }
+      }
+    end
+  end
+end

data/app/presenters/spree_adyen/cancel_payload_presenter.rb

@@ -0,0 +1,31 @@
+module SpreeAdyen
+  class CancelPayloadPresenter
+    REFERENCE_SUFFIX = 'cancel'.freeze
+
+    def initialize(payment:, payment_method:)
+      @payment = payment
+      @order = payment.order
+      @payment_method = payment_method
+    end
+
+    def to_h
+      {
+        reference: reference,
+        merchantAccount: payment_method.preferred_merchant_account
+      }.merge!(SpreeAdyen::ApplicationInfoPresenter.new.to_h)
+    end
+
+    private
+
+    attr_reader :payment, :order, :payment_method
+
+    def reference
+      [
+        order.number,
+        payment_method.id,
+        payment.response_code,
+        REFERENCE_SUFFIX
+      ].join('_')
+    end
+  end
+end

data/app/presenters/spree_adyen/capture_payload_presenter.rb

@@ -0,0 +1,36 @@
+module SpreeAdyen
+  class CapturePayloadPresenter
+    REFERENCE_SUFFIX = 'capture'.freeze
+
+    def initialize(amount_in_cents:, payment:, payment_method:)
+      @amount_in_cents = amount_in_cents
+      @payment = payment
+      @order = payment.order
+      @payment_method = payment_method
+    end
+
+    def to_h
+      {
+        amount: {
+          value: amount_in_cents,
+          currency: payment.currency
+        },
+        reference: reference,
+        merchantAccount: payment_method.preferred_merchant_account
+      }.merge!(SpreeAdyen::ApplicationInfoPresenter.new.to_h)
+    end
+
+    private
+
+    attr_reader :amount_in_cents, :payment, :order, :payment_method
+
+    def reference
+      [
+        order.number,
+        payment_method.id,
+        payment.response_code,
+        REFERENCE_SUFFIX
+      ].join('_')
+    end
+  end
+end

data/app/presenters/spree_adyen/checkout_presenter.rb

@@ -0,0 +1,51 @@
+module SpreeAdyen
+  # use this serializer to configure the Adyen Drop-in component
+  # https://docs.adyen.com/online-payments/build-your-integration/sessions-flow/?platform=Web&integration=Drop-in&version=6.18.1&tab=embed_script_and_stylesheet_1_2#configure
+  class CheckoutPresenter
+    def initialize(payment_session)
+      @payment_session = payment_session
+    end
+
+    def to_json(*_args)
+      @to_json ||= to_h.to_json
+    end
+
+    def to_h
+      @to_h ||= {
+        session: {
+          id: payment_session.adyen_id,
+          sessionData: payment_session.adyen_data
+        },
+        environment: payment_session.payment_method.environment,
+
+        amount: {
+          value: Spree::Money.new(payment_session.amount, currency: currency).cents,
+          currency: currency
+        },
+        countryCode: country_iso,
+        locale: locale,
+        clientKey: payment_session.payment_method.preferred_client_key,
+        showPayButton: true
+      }
+    end
+
+    private
+
+    attr_reader :payment_session
+
+    delegate :currency, :order, to: :payment_session
+    delegate :store, :user, to: :order
+
+    def locale
+      order.try(:locale) || 'en-US'
+    end
+
+    def country_iso
+      address&.country_iso || store.default_country_iso || 'US'
+    end
+
+    def address
+      @address ||= order.bill_address || order.ship_address || user&.bill_address || user&.ship_address
+    end
+  end
+end

data/app/presenters/spree_adyen/payment_sessions/request_payload_presenter.rb

@@ -0,0 +1,140 @@
+module SpreeAdyen
+  module PaymentSessions
+    class RequestPayloadPresenter
+      DEFAULT_PARAMS = {
+        recurringProcessingModel: 'UnscheduledCardOnFile',
+        shopperInteraction: 'Ecommerce',
+        storePaymentMethodMode: 'enabled'
+      }.freeze
+
+      def initialize(order:, amount:, user:, merchant_account:, payment_method:, channel:, return_url:)
+        @order = order
+        @amount = amount
+        @user = user
+        @merchant_account = merchant_account
+        @payment_method = payment_method
+        @channel = channel
+        @return_url = return_url
+      end
+
+      def to_h
+        {
+          metadata: { # unfortunately metadata is not always available in webhooks, even for AUTHORISATION events
+            spree_payment_method_id: payment_method.id,
+            spree_order_id: order_number
+          },
+          amount: {
+            value: Spree::Money.new(amount, currency: currency).cents,
+            currency: currency
+          },
+          returnUrl: return_url,
+          reference: reference,
+          countryCode: country_iso,
+          lineItems: line_items,
+          merchantAccount: merchant_account,
+          merchantOrderReference: order_number,
+          expiresAt: expires_at
+        }.merge!(shopper_details, DEFAULT_PARAMS, channel_params, additional_data_params, SpreeAdyen::ApplicationInfoPresenter.new.to_h)
+      end
+
+      private
+
+      attr_reader :order, :amount, :user, :merchant_account, :payment_method, :channel, :return_url
+
+      delegate :number, to: :order, prefix: true
+      delegate :currency, :store, to: :order
+
+      # since we cannot count on metadata reference is the simplest way to store data for webhooks
+      # so let's keep its format as ORDERNUMBER_PAYMENTMETHODID_UNIQGUARANTER
+      def reference
+        [
+          order.number,
+          payment_method.id,
+          payment_sessions_count + 1
+        ].join('_')
+      end
+
+      def payment_sessions_count
+        if SpreeAdyen::Config[:use_legacy_adyen_payment_sessions]
+          order.adyen_payment_sessions.with_deleted.count
+        else
+          order.payment_sessions.with_deleted.where(payment_method: payment_method).count
+        end
+      end
+
+      def channel_params
+        case channel
+        when 'iOS'
+          { blockedPaymentMethods: ['googlepay'], channel: 'iOS' }
+        when 'Android'
+          { blockedPaymentMethods: ['applepay'], channel: 'Android' }
+        when 'Web'
+          { channel: 'Web' }
+        else
+          {}
+        end
+      end
+
+      def additional_data_params
+        return {} if payment_method.auto_capture?
+
+        {
+          additionalData: {
+            manualCapture: true
+          }
+        }
+      end
+
+      def shopper_details
+        {
+          shopperName: {
+            firstName: address&.firstname || user&.first_name,
+            lastName: address&.lastname || user&.last_name
+          },
+          shopperEmail: order.email || user&.email,
+          shopperReference: shopper_reference
+        }
+      end
+
+      # we need to send reference even for guest users, otherwise we can't tokenize the card
+      def shopper_reference
+        if user.present?
+          "customer_#{user.id}"
+        else
+          "guest_#{order.number}"
+        end
+      end
+
+      # Returns the address for the order
+      # @return [Spree::Address, nil]
+      def address
+        @address ||= order.bill_address || order.ship_address || user&.bill_address || user&.ship_address
+      end
+
+      # Returns the country ISO code for the order
+      # @return [String]
+      def country_iso
+        address&.country_iso || store.try(:default_country_iso) || 'US'
+      end
+
+      # Returns Order Line Items
+      # @return [Array<Hash>]
+      def line_items
+        order.line_items.includes(variant: :product).map do |line_item|
+          {
+            amountExcludingTax: Spree::Money.new(line_item.price - line_item.included_tax_total, currency: currency).cents,
+            amountIncludingTax: Spree::Money.new(line_item.price + line_item.additional_tax_total, currency: currency).cents,
+            description: line_item.name,
+            id: line_item.id,
+            sku: line_item.sku,
+            quantity: line_item.quantity
+          }
+        end
+      end
+
+      def expires_at
+        SpreeAdyen::Config.payment_session_expiration_in_minutes.minutes.from_now.iso8601
+      end
+    end
+  end
+end

data/app/presenters/spree_adyen/payments/request_payload_presenter.rb

@@ -0,0 +1,85 @@
+module SpreeAdyen
+  module Payments
+    class RequestPayloadPresenter
+      DEFAULT_PARAMS = {
+        recurringProcessingModel: 'UnscheduledCardOnFile',
+        shopperInteraction: 'ContAuth'
+      }.freeze
+
+      def initialize(source:, amount_in_cents:, manual_capture:, gateway_options:)
+        @source = source
+        @amount_in_cents = amount_in_cents
+        @manual_capture = manual_capture
+        @gateway_options = gateway_options.with_indifferent_access
+      end
+
+      def to_h
+        {
+          metadata: { # unfortunately metadata is not always available in webhooks, even for AUTHORISATION events
+            spree_payment_method_id: source.payment_method_id,
+            spree_order_id: order_number
+          },
+          amount: {
+            value: amount_in_cents,
+            currency: currency
+          },
+          paymentMethod: {
+            type: 'scheme',
+            storedPaymentMethodId: source.gateway_payment_profile_id
+          },
+          reference: reference,
+          shopperReference: shopper_reference,
+          merchantAccount: source.payment_method.preferred_merchant_account
+        }.merge!(DEFAULT_PARAMS, additional_data_params, SpreeAdyen::ApplicationInfoPresenter.new.to_h)
+      end
+
+      private
+
+      attr_reader :source, :amount_in_cents, :manual_capture, :gateway_options
+
+      delegate :currency, to: :order
+      delegate :user, to: :order, allow_nil: true
+
+      # since we cannot count on metadata reference is the simplest way to store data for webhooks
+      # so let's keep its format as ORDERNUMBER_PAYMENTMETHODID_UNIQGUARANTER
+      def reference
+        [
+          order_number,
+          source.payment_method_id,
+          payment_number
+        ].join('_')
+      end
+
+      # we need to send reference even for guest users, otherwise we can't tokenize the card
+      def shopper_reference
+        if user.present?
+          "customer_#{user.id}"
+        else
+          "guest_#{order_number}"
+        end
+      end
+
+      def order_number
+        @order_number ||= gateway_options[:order_id].split('-').first
+      end
+
+      def payment_number
+        @payment_number ||= gateway_options[:order_id].split('-').last
+      end
+
+      def order
+        @order ||= Spree::Order.find_by!(number: order_number)
+      end
+
+      def additional_data_params
+        return {} unless manual_capture
+
+        {
+          additionalData: {
+            manualCapture: true
+          }
+        }
+      end
+    end
+  end
+end

data/app/presenters/spree_adyen/refund_payload_presenter.rb

@@ -0,0 +1,38 @@
+module SpreeAdyen
+  class RefundPayloadPresenter
+    REFERENCE_SUFFIX = 'refund'.freeze
+
+    def initialize(amount_in_cents:, currency:, payment_method:, payment:, refund:)
+      @amount_in_cents = amount_in_cents
+      @currency = currency
+      @payment_method = payment_method
+      @payment = payment
+      @refund = refund
+    end
+
+    def to_h
+      {
+        amount: {
+          value: amount_in_cents,
+          currency: currency
+        },
+        reference: reference,
+        merchantAccount: payment_method.preferred_merchant_account
+      }.merge!(SpreeAdyen::ApplicationInfoPresenter.new.to_h)
+    end
+
+    private
+
+    attr_reader :amount_in_cents, :currency, :payment_method, :payment, :refund
+
+    def reference
+      [
+        payment.order.number,
+        payment_method.id,
+        payment.response_code,
+        REFERENCE_SUFFIX,
+        refund&.id
+      ].compact_blank.join('_')
+    end
+  end
+end

data/app/presenters/spree_adyen/webhook_payload_presenter.rb

@@ -0,0 +1,28 @@
+module SpreeAdyen
+  class WebhookPayloadPresenter
+    DEFAULT_PARAMS = {
+      active: true,
+      communicationFormat: 'json',
+      type: 'standard'
+    }.freeze
+
+    def initialize(url)
+      @url = url
+    end
+
+    def to_h
+      {
+        url: url,
+        description: description
+      }.merge!(DEFAULT_PARAMS)
+    end
+
+    private
+
+    attr_reader :url
+
+    def description
+      "Webhook created by SpreeAdyen on #{Time.zone.now.strftime('%Y-%m-%d %H:%M:%S')}"
+    end
+  end
+end

data/app/presenters/spree_adyen/webhooks/credit_card_presenter.rb

@@ -0,0 +1,43 @@
+module SpreeAdyen
+  module Webhooks
+    class CreditCardPresenter
+      CREDIT_CARD_BRANDS = {
+        'mc' => 'master',
+        'mc_googlepay' => 'master',
+        'maestro' => 'master',
+        'maestro_googlepay' => 'master',
+        'amex' => 'american_express',
+        'amex_googlepay' => 'american_express',
+        'cartebancaire' => 'cartes_bancaires',
+        'diners' => 'diners_club',
+        'eftpos_australia' => 'eftpos_au',
+        'googlepay' => 'google_pay',
+        'visa_googlepay' => 'visa'
+      }.freeze
+
+      def initialize(event)
+        @event = event
+      end
+
+      def to_h
+        {
+          name: event.card_details['type'],
+          month: event.card_details['expiryDate']&.split('/')&.first,
+          year: event.card_details['expiryDate']&.split('/')&.last,
+          cc_type: CREDIT_CARD_BRANDS.fetch(payment_method_reference, payment_method_reference),
+          last_digits: event.card_details['cardSummary'],
+          gateway_customer_profile_id: nil,
+          gateway_payment_profile_id: event.stored_payment_method_id
+        }
+      end
+
+      private
+
+      attr_reader :event, :payment_session
+
+      def payment_method_reference
+        @payment_method_reference ||= event.payment_method_reference.to_s.downcase
+      end
+    end
+  end
+end

data/app/services/spree_adyen/gateways/add_allowed_origin.rb

@@ -0,0 +1,36 @@
+module SpreeAdyen
+  module Gateways
+    class AddAllowedOrigin
+      ALREADY_EXISTS_ERROR_CODE = '31_004'.freeze
+
+      def initialize(record, gateway)
+        @record = record
+        @gateway = gateway
+      end
+
+      def call
+        response = gateway.add_allowed_origin(allowed_origin)
+
+        if response.success?
+          log("added to gateway #{gateway.id}")
+        elsif response.message['errorCode'] == ALREADY_EXISTS_ERROR_CODE
+          log('already exists', :warn)
+        else
+          Rails.error.unexpected('Cannot create allowed origin', context: { url: allowed_origin, gateway_id: gateway.id }, source: 'spree_adyen')
+        end
+      end
+
+      private
+
+      attr_reader :record, :gateway
+
+      def log(message, level = :info)
+        Rails.logger.send(level, "[SpreeAdyen][AddAllowedOrigin]: Origin #{allowed_origin} #{message}")
+      end
+
+      def allowed_origin
+        @allowed_origin ||= URI::HTTPS.build(host: record.url).to_s
+      end
+    end
+  end
+end

data/app/services/spree_adyen/gateways/configuration.rb

@@ -0,0 +1,41 @@
+module SpreeAdyen
+  module Gateways
+    class Configuration
+      def initialize(response_body)
+        @response_body = response_body
+      end
+
+      def client_key
+        response_body['clientKey']
+      end
+
+      def roles
+        response_body['roles']
+      end
+
+      def active?
+        response_body['active'].to_s == 'true'
+      end
+
+      def allowed_origins
+        response_body['allowedOrigins'].map { |origin| origin['domain'] }
+      end
+
+      def merchant_account
+        response_body['associatedMerchantAccounts'].first
+      end
+
+      def id
+        response_body['id']
+      end
+
+      def company
+        response_body['companyName']
+      end
+
+      private
+
+      attr_reader :response_body
+    end
+  end
+end

data/app/services/spree_adyen/gateways/configure.rb

@@ -0,0 +1,60 @@
+module SpreeAdyen
+  module Gateways
+    class Configure
+      def initialize(gateway)
+        @gateway = gateway
+      end
+
+      def call
+        gateway.preferred_client_key = configuration.client_key || gateway.generate_client_key.params['clientKey']
+        gateway.preferred_merchant_account = configuration.merchant_account
+
+        set_up_allowed_origins
+
+        set_up_webhook_with_hmac_key unless current_webhook_is_valid?
+
+        gateway.skip_auto_configuration = true
+        gateway.save!
+      end
+
+      private
+
+      attr_reader :gateway
+
+      def set_up_allowed_origins
+        gateway.stores.each do |store|
+          SpreeAdyen::AddAllowedOriginJob.perform_later(store.id, gateway.id)
+          next unless store.respond_to?(:custom_domains)
+
+          store.custom_domains.each do |custom_domain|
+            SpreeAdyen::AddAllowedOriginJob.perform_later(custom_domain.id, gateway.id, 'custom_domain')
+          end
+        end
+      end
+
+      def configuration
+        @configuration ||= SpreeAdyen::Gateways::Configuration.new(
+          gateway.get_api_credential_details.params
+        )
+      end
+
+      def current_webhook_is_valid?
+        gateway.preferred_webhook_id.present? &&
+          gateway.preferred_hmac_key.present? &&
+          gateway.test_webhook.success?
+      end
+
+      def set_up_webhook_with_hmac_key
+        set_up_webhook_request = gateway.set_up_webhook(gateway.webhook_url)
+        return unless set_up_webhook_request.success?
+
+        gateway.preferred_webhook_id = set_up_webhook_request.authorization
+        generate_hmac_key_request = gateway.generate_hmac_key
+        return unless generate_hmac_key_request.success?
+
+        gateway.previous_hmac_key = gateway.preferred_hmac_key if gateway.preferred_hmac_key.present?
+        gateway.preferred_hmac_key = generate_hmac_key_request.authorization
+      end
+    end
+  end
+end

data/app/services/spree_adyen/payment_sessions/find_or_create.rb

@@ -0,0 +1,51 @@
+module SpreeAdyen
+  module PaymentSessions
+    class FindOrCreate
+      prepend ::Spree::ServiceModule::Base
+
+      def initialize(order:, user:, amount:, payment_method:, channel: nil, return_url: nil)
+        @order = order
+        @amount = amount
+        @user = user
+        @payment_method = payment_method
+        @channel = channel || SpreeAdyen::PaymentSession::AVAILABLE_CHANNELS[:web]
+        @return_url = return_url
+      end
+
+      def call
+        return failure(nil, "Cannot create Adyen payment session for the order in the #{order.state} state") unless order.can_create_adyen_payment_session?
+        return success(payment_session) if payment_session.present?
+
+        create_attributes = {
+          order: order,
+          amount: amount,
+          currency: order.currency,
+          user: user,
+          payment_method: payment_method,
+          channel: channel
+        }
+        create_attributes[:return_url] = return_url if return_url.present?
+
+        payment_session = SpreeAdyen::PaymentSession.create(create_attributes)
+        payment_session.persisted? ? success(payment_session) : failure(payment_session)
+      end
+
+      private
+
+      attr_reader :order, :payment_method, :amount, :user, :channel, :return_url
+
+      def payment_session
+        find_attributes = {
+          payment_method: payment_method,
+          order: order,
+          currency: order.currency,
+          user: user,
+          amount: amount,
+          channel: channel
+        }
+
+        @payment_session ||= PaymentSession.with_status(:initial).not_expired.find_by(find_attributes)
+      end
+    end
+  end
+end