spree_adyen 0.10.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: efdb74fe9f9d7848da506be961b930c3b2352d6726a1e5fdf81a160ee1688fc6
+  data.tar.gz: 997de8336c6d59668a1830c576d26778600bf20dcdf79c4307a64b22ee4ab69f
+SHA512:
+  metadata.gz: 9d78966a7463a76cf3dd572d50b09845928be5e6842c30f79cb8139f1c47489cef675c8689ee5b9aaf21a7ec79026d80a081ca8f20e1204ab65f274c5f5f8174
+  data.tar.gz: 90c1367fa54b80f8194252cfe03e19157d38933a6ed64cf6d18e00467ad43c643cf97b9974626bdf814ac250174e8dec89e96088df70317d03b4f287dc23b765

data/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2026 Vendo Connect Inc., Vendo Sp. z o.o.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,59 @@
+# Spree Adyen
+
+Official Adyen payments platform integration for [Spree Commerce](https://spreecommerce.org).
+
+## Installation
+
+1. Add this extension to your Gemfile with this line:
+
+    ```ruby
+    bundle add spree_adyen
+    ```
+
+2. Run the install generator
+
+    ```ruby
+    bundle exec rails g spree_adyen:install
+    ```
+
+3. Restart your server
+
+  If your server was running, restart it so that it can find the assets properly.
+
+## Developing
+
+1. Create a dummy app
+
+    ```bash
+    bundle update
+    bundle exec rake test_app
+    ```
+
+2. Add your new code
+3. Run tests
+
+    ```bash
+    bundle exec rspec
+    ```
+
+When testing your applications integration with this extension you may use it's factories.
+Simply add this require statement to your spec_helper:
+
+```ruby
+require 'spree_adyen/factories'
+```
+
+## Releasing a new version
+
+```shell
+bundle exec gem bump -p -t
+bundle exec gem release
+```
+
+For more options please see [gem-release README](https://github.com/svenfuchs/gem-release)
+
+## Contributing
+
+If you'd like to contribute, please take a look at the
+[instructions](CONTRIBUTING.md) for installing dependencies and crafting a good
+pull request.

data/Rakefile

@@ -0,0 +1,26 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/testing_support/extension_rake'
+
+RSpec::Core::RakeTask.new
+
+task :default do
+  if Dir['spec/dummy'].empty?
+    Rake::Task[:test_app].invoke
+    Dir.chdir('../../')
+  end
+  Rake::Task[:spec].invoke
+end
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'spree_adyen'
+  Rake::Task['extension:test_app'].execute(
+    install_admin: true
+  )
+  system({ 'BUNDLE_GEMFILE' => File.expand_path('Gemfile', __dir__) }, 'rails g spree_posts:install')
+  system({ 'BUNDLE_GEMFILE' => File.expand_path('Gemfile', __dir__) }, 'rails g spree_legacy_product_properties:install')
+  system({ 'BUNDLE_GEMFILE' => File.expand_path('Gemfile', __dir__) }, 'rails g spree_legacy_api_v2:install')
+end

data/app/assets/config/spree_adyen_manifest.js

@@ -0,0 +1,5 @@
+//= link_tree ../images
+//= link spree_adyen/application.js
+//= link_tree ../../javascript/spree_adyen/controllers .js
+//= link_tree ../../../vendor/javascript .js
+//= link_tree ../../../vendor/stylesheets .css

data/app/controllers/spree_adyen/apple_pay_domain_verification_controller.rb

@@ -0,0 +1,11 @@
+module SpreeAdyen
+  class ApplePayDomainVerificationController < ::Spree::BaseController
+    def show
+      gateway = current_store.adyen_gateway
+
+      raise ActiveRecord::RecordNotFound if gateway.nil? || !gateway.apple_developer_merchantid_domain_association.attached?
+
+      render plain: gateway.apple_domain_association_file_content
+    end
+  end
+end

data/app/controllers/spree_adyen/payment_sessions_controller.rb

@@ -0,0 +1,67 @@
+# this is the endpoint that Adyen JS SDK will redirect customer to after payment
+# it will handle the payment session status and process the payment
+
+module SpreeAdyen
+  class PaymentSessionsController < defined?(Spree::StoreController) ? Spree::StoreController : Spree::BaseController
+    include Spree::CheckoutAnalyticsHelper if defined?(Spree::CheckoutAnalyticsHelper)
+
+    # GET /adyen/payment_sessions/redirect
+    def redirect
+      @payment_session = SpreeAdyen::PaymentSession.find_by(adyen_id: params[:sessionId])
+      render layout: 'spree_adyen/default'
+    end
+
+    # GET /adyen/payment_sessions
+    def show
+      @payment_session = SpreeAdyen::PaymentSession.find_by!(adyen_id: params[:sessionId])
+      @order = @payment_session.order
+      # handle duplicated requests or already processed through webhook
+      if @payment_session.canceled? || @order.canceled?
+        redirect_to spree.cart_path, status: :see_other
+        return
+      elsif @order.completed?
+        redirect_to spree.checkout_complete_path(@order.token), status: :see_other
+        return
+      end
+
+      SpreeAdyen::PaymentSessions::ProcessWithResult.new(payment_session: @payment_session, session_result: params[:sessionResult]).call
+
+      if @payment_session.completed?
+        handle_success
+      elsif @payment_session.pending?
+        handle_pending_payment
+      elsif @payment_session.canceled?
+        redirect_to spree.checkout_path(@order.token), status: :see_other
+      elsif @payment_session.refused?
+        handle_failure
+      end
+    rescue Spree::Core::GatewayError => e
+      handle_failure(e.message)
+    end
+
+    private
+
+    # TODO: handle pending payment
+    def handle_pending_payment; end
+
+    def handle_success
+      # update the payment session status
+
+      # set the session flag to indicate that the order was placed now
+      track_checkout_completed if @order.completed? && defined?(track_checkout_completed)
+
+      redirect_to spree.checkout_complete_path(@order.token), status: :see_other
+    end
+
+    def handle_failure(message = nil)
+      flash[:error] = message || Spree.t("adyen.payment_session_errors.#{@payment_session.status}")
+
+      Rails.logger.error("Payment failed for order #{@order.id}: #{@payment_session.status}")
+
+      # this should be a rare race condition, but we need to handle it
+      @order.payments.valid.find_by(response_code: @payment_session.id)&.void!
+
+      redirect_to spree.checkout_path(@order.token), status: :see_other
+    end
+  end
+end

data/app/controllers/spree_adyen/store_controller_decorator.rb

@@ -0,0 +1,9 @@
+module SpreeAdyen
+  module StoreControllerDecorator
+    def self.prepended(base)
+      base.helper SpreeAdyen::BaseHelper
+    end
+  end
+end
+
+Spree::StoreController.prepend(SpreeAdyen::StoreControllerDecorator) if defined?(Spree::StoreController)

data/app/controllers/spree_adyen/webhooks_controller.rb

@@ -0,0 +1,46 @@
+module SpreeAdyen
+  class WebhooksController < ActionController::API
+    include Spree::Core::ControllerHelpers::Store
+
+    before_action :validate_hmac!
+
+    def create
+      SpreeAdyen::Webhooks::HandleEvent.new(event_payload: webhook_params).call
+
+      head :ok
+    end
+
+    private
+
+    def validate_hmac!
+      if hmac_validator_class.nil?
+        Rails.logger.info("[SpreeAdyen][#{event_code}]: Skipping not supported event")
+        head :ok
+        return
+      end
+
+      validator = hmac_validator_class.new(
+        request: request,
+        params: webhook_params,
+        gateway: current_store.adyen_gateway
+      )
+
+      return if validator.call
+
+      Rails.logger.error("[SpreeAdyen]: Failed to validate hmac for #{event_code}")
+      head :unauthorized
+    end
+
+    def hmac_validator_class
+      SpreeAdyen.hmac_validators[event_code]
+    end
+
+    def event_code
+      webhook_params.dig('notificationItems', 0, 'NotificationRequestItem', 'eventCode') || webhook_params['type']
+    end
+
+    def webhook_params
+      @webhook_params ||= JSON.parse(request.raw_post).with_indifferent_access
+    end
+  end
+end

data/app/helpers/spree_adyen/base_helper.rb

@@ -0,0 +1,18 @@
+module SpreeAdyen
+  module BaseHelper
+    def current_adyen_gateway
+      @current_adyen_gateway ||= current_store.adyen_gateway
+    end
+
+    def current_adyen_payment_session
+      return if current_adyen_gateway.nil?
+
+      @current_adyen_payment_session ||= SpreeAdyen::PaymentSessions::FindOrCreate.new(
+        order: @order,
+        amount: @order.total_minus_store_credits,
+        user: @order.user,
+        payment_method: current_adyen_gateway
+      ).call&.value
+    end
+  end
+end

data/app/javascript/spree_adyen/application.js

@@ -0,0 +1,17 @@
+import '@hotwired/turbo-rails'
+
+let application
+
+if (typeof window.Stimulus === "undefined") {
+  application = Application.start()
+  application.debug = false
+  window.Stimulus = application
+} else {
+  application = window.Stimulus
+}
+
+import CheckoutAdyenController from 'spree_adyen/controllers/checkout_adyen_controller' 
+import RedirectAdyenController from 'spree_adyen/controllers/redirect_adyen_controller'
+
+application.register('checkout-adyen', CheckoutAdyenController);
+application.register('redirect-adyen', RedirectAdyenController);

data/app/javascript/spree_adyen/controllers/checkout_adyen_controller.js

@@ -0,0 +1,80 @@
+import { Controller } from '@hotwired/stimulus'
+
+import { AdyenCheckout, Dropin } from '@adyen/adyen-web/auto'
+
+export default class extends Controller {
+  async connect() {
+    await this.initCheckout();
+    this.initEventHandlers();
+    if (this.dropinElement().dataset.checkoutAdyenAutoMountValue == 'true') {
+      this.initDropin();
+    }
+  }
+
+  dropinElement() {
+    return document.getElementById('dropin-container');
+  }
+
+  async initCheckout() {
+    const session = JSON.parse(this.dropinElement().dataset.checkoutAdyenCheckoutAttrubutes)
+    const eventHandlers = {
+      onPaymentCompleted: (result, _component) => {
+        // idk why 3ds are handled here instead of paymentMethodsConfiguration.card.onPaymentCompleted
+        this.redirectToPaymentSession(result);
+      },
+      onError: (error, component) => {
+        console.error(error.name, error.message, error.stack, component);
+      }
+    }
+    const adyenCheckout = await AdyenCheckout(Object.assign(session, eventHandlers));;
+    this.adyenCheckout = adyenCheckout;
+  }
+
+  redirectToPaymentSession(result) {
+    const url = new URL(this.dropinElement().dataset.checkoutAdyenPaymentSessionPathValue);
+    url.searchParams.set('sessionResult', result.sessionResult);
+    window.location.replace(url.href);
+  }
+
+  async initDropin() {
+    const dropinConfiguration = {
+      showStoredPaymentMethods: false,
+      paymentMethodsConfiguration: {
+        card: {
+          onPaymentCompleted: (result, component) => {
+            this.redirectToPaymentSession(result);
+          },
+          onError: (error, component) => {
+            console.error(error.name, error.message, error.stack, component);
+          },
+          showPayButton: false,
+          hasHolderName: true,
+        }
+      }
+    };
+    const dropin = new Dropin(this.adyenCheckout, dropinConfiguration)
+    dropin.mount('#dropin-container');
+    this.dropin = dropin;
+  }
+
+  initEventHandlers() {
+    document.getElementById('checkout-payment-submit').addEventListener('click', (e) => {
+      if (this.dropinElement().classList.contains('hidden')) {
+        return;
+      }
+      e.preventDefault();
+      this.dropin.submit();
+    });
+
+    document.querySelectorAll('#existing_cards input[type="radio"]').forEach(elem => elem.addEventListener("change", (e) => {
+      if (e.target.dataset.show == 'dropin-container') {
+        this.initDropin();
+        this.dropinElement().classList.remove('hidden');
+      }
+      else if (this.dropin) {
+        this.dropin.unmount();
+        this.dropinElement().classList.add('hidden');
+      }
+    }))
+  }
+}

data/app/javascript/spree_adyen/controllers/redirect_adyen_controller.js

@@ -0,0 +1,35 @@
+import { Controller } from '@hotwired/stimulus'
+import { AdyenCheckout } from '@adyen/adyen-web/auto'
+export default class extends Controller {
+  async connect() {
+    await this.initCheckout();
+  }
+
+  redirectElement() {
+    return document.getElementById('dropin-container');
+  }
+
+  async initCheckout() {
+    const session = JSON.parse(this.redirectElement().dataset.checkoutAdyenCheckoutAttrubutes)
+    const urlParams = new URLSearchParams(window.location.search);
+    const redirectResult = urlParams.get('redirectResult');
+
+    const eventHandlers = {
+      onPaymentCompleted: (result, component) => {
+        this.redirectToPaymentSession(result);
+      },
+      onPaymentFailed: (result, component) => {
+        this.redirectToPaymentSession(result);
+      },
+    }
+    const configuration = Object.assign(session, eventHandlers);
+    const adyenCheckout = await AdyenCheckout(configuration);
+    adyenCheckout.submitDetails({ details: { redirectResult: redirectResult } }); 
+  }
+
+  redirectToPaymentSession(result) {
+    const url = new URL(this.redirectElement().dataset.checkoutAdyenPaymentSessionPathValue);
+    url.searchParams.set('sessionResult', result.sessionResult);
+    window.location.replace(url.href);
+  }
+}

data/app/jobs/spree_adyen/add_allowed_origin_job.rb

@@ -0,0 +1,24 @@
+module SpreeAdyen
+  class AddAllowedOriginJob < SpreeAdyen::BaseJob
+    def perform(record_id, gateway_id, klass_type = 'store')
+      @klass_type = klass_type.to_s
+      return unless klass
+
+      record = klass.find(record_id)
+      gateway = SpreeAdyen::Gateway.find(gateway_id)
+
+      SpreeAdyen::Gateways::AddAllowedOrigin.new(record, gateway).call
+    end
+
+    private
+
+    def klass
+      @klass ||= case @klass_type
+                 when 'store' then Spree::Store
+                 when 'custom_domain' then defined?(Spree::CustomDomain) ? Spree::CustomDomain : nil
+                 else
+                   Rails.error.unexpected("Unexpected klass_type: #{@klass_type}")
+                 end
+    end
+  end
+end

data/app/jobs/spree_adyen/base_job.rb

@@ -0,0 +1,5 @@
+module SpreeAdyen
+  class BaseJob < Spree::BaseJob
+    queue_as SpreeAdyen.queue
+  end
+end

data/app/jobs/spree_adyen/webhooks/process_authorisation_event_job.rb

@@ -0,0 +1,10 @@
+module SpreeAdyen
+  module Webhooks
+    class ProcessAuthorisationEventJob < SpreeAdyen::BaseJob
+      def perform(payload)
+        event = SpreeAdyen::Webhooks::Event.new(event_data: payload)
+        SpreeAdyen::Webhooks::EventProcessors::AuthorisationEventProcessor.new(event).call
+      end
+    end
+  end
+end

data/app/jobs/spree_adyen/webhooks/process_cancellation_event_job.rb

@@ -0,0 +1,10 @@
+module SpreeAdyen
+  module Webhooks
+    class ProcessCancellationEventJob < SpreeAdyen::BaseJob
+      def perform(payload)
+        event = SpreeAdyen::Webhooks::Event.new(event_data: payload)
+        SpreeAdyen::Webhooks::EventProcessors::CancellationEventProcessor.new(event).call
+      end
+    end
+  end
+end

data/app/jobs/spree_adyen/webhooks/process_capture_event_job.rb

@@ -0,0 +1,10 @@
+module SpreeAdyen
+  module Webhooks
+    class ProcessCaptureEventJob < SpreeAdyen::BaseJob
+      def perform(payload)
+        event = SpreeAdyen::Webhooks::Event.new(event_data: payload)
+        SpreeAdyen::Webhooks::EventProcessors::CaptureEventProcessor.new(event).call
+      end
+    end
+  end
+end

data/app/models/spree/payment_sessions/adyen.rb

@@ -0,0 +1,59 @@
+module Spree
+  class PaymentSessions::Adyen < PaymentSession
+    AVAILABLE_CHANNELS = {
+      ios: 'iOS',
+      android: 'Android',
+      web: 'Web'
+    }.freeze
+
+    # Adyen-specific accessors from external_data
+    def adyen_id
+      external_id
+    end
+
+    def session_data
+      external_data&.dig('session_data')
+    end
+
+    def client_key
+      payment_method.preferred_client_key
+    end
+
+    def channel
+      external_data&.dig('channel') || AVAILABLE_CHANNELS[:web]
+    end
+
+    def return_url
+      external_data&.dig('return_url')
+    end
+
+    def accepted?
+      status == 'completed'
+    end
+
+    def successful?
+      status == 'completed'
+    end
+
+    def find_or_create_payment!(metadata = {})
+      return unless persisted?
+      return payment if payment.present?
+
+      order.with_lock do
+        existing_payment = order.payments.where(
+          payment_method: payment_method,
+          response_code: external_id
+        ).first
+
+        return existing_payment if existing_payment.present?
+
+        order.payments.create!(
+          payment_method: payment_method,
+          amount: amount,
+          response_code: external_id,
+          skip_source_requirement: true
+        )
+      end
+    end
+  end
+end

data/app/models/spree_adyen/base.rb

@@ -0,0 +1,6 @@
+module SpreeAdyen
+  class Base < Spree.base_class
+    self.abstract_class = true
+    self.table_name_prefix = 'spree_adyen_'
+  end
+end

data/app/models/spree_adyen/custom_domain_decorator.rb

@@ -0,0 +1,17 @@
+module SpreeAdyen
+  module CustomDomainDecorator
+    def self.prepended(base)
+      base.after_commit :add_adyen_allowed_origin
+    end
+
+    def add_adyen_allowed_origin
+      return if store.adyen_gateway.blank?
+
+      SpreeAdyen::AddAllowedOriginJob.perform_later(id, store.adyen_gateway.id, 'custom_domain')
+    end
+  end
+end
+
+if defined?(Spree::CustomDomain)
+  Spree::CustomDomain.prepend(SpreeAdyen::CustomDomainDecorator)
+end