spree_adyen 0.10.0

data/app/views/spree_adyen/_head.html.erb

@@ -0,0 +1,2 @@
+<%= javascript_import_module_tag 'application-spree-adyen' %>  
+<%= stylesheet_link_tag 'adyen.css', media: 'all' %>

data/app/views/spree_adyen/payment_sessions/redirect.html.erb

@@ -0,0 +1,5 @@
+<div data-controller="redirect-adyen"></div>
+
+<%= render 'spree_adyen/drop_in', payment_session: @payment_session, auto_mount: false %>
+
+<%= javascript_import_module_tag 'application-spree-adyen' %>

data/config/importmap.rb

@@ -0,0 +1,7 @@
+pin 'application-spree-adyen', to: 'spree_adyen/application.js', preload: false
+
+pin_all_from SpreeAdyen::Engine.root.join('app/javascript/spree_adyen/controllers'),
+             under: 'spree_adyen/controllers',
+             to:    'spree_adyen/controllers',
+             preload: 'application-spree-adyen'
+pin "@adyen/adyen-web/auto", to: "@adyen--adyen-web.js" # @6.18.0

data/config/initializers/spree.rb

@@ -0,0 +1,34 @@
+# Uncomment lines below to add your own custom business logic
+# such as promotions, shipping methods, etc.
+Rails.application.config.after_initialize do
+  # Rails.application.config.spree.shipping_methods << Spree::ShippingMethods::SuperExpensiveNotVeryFastShipping
+  Rails.application.config.spree.payment_methods << SpreeAdyen::Gateway
+
+  # Rails.application.config.spree.calculators.tax_rates << Spree::TaxRates::FinanceTeamForcedMeToCodeThis
+
+  # Rails.application.config.spree.stock_splitters << Spree::Stock::Splitters::SecretLogicSplitter
+
+  # Rails.application.config.spree.adjusters << Spree::Adjustable::Adjuster::TaxTheRich
+
+  # Custom promotions
+  # Rails.application.config.spree.calculators.promotion_actions_create_adjustments << Spree::Calculators::PromotionActions::CreateAdjustments::AddDiscountForFriends
+  # Rails.application.config.spree.calculators.promotion_actions_create_item_adjustments << Spree::Calculators::PromotionActions::CreateItemAdjustments::FinanceTeamForcedMeToCodeThis
+  # Rails.application.config.spree.promotions.rules << Spree::Promotions::Rules::OnlyForVIPCustomers
+  # Rails.application.config.spree.promotions.actions << Spree::Promotions::Actions::GiftWithPurchase
+
+  # Rails.application.config.spree.taxon_rules << Spree::TaxonRules::ProductsWithColor
+
+  # Rails.application.config.spree.exports << Spree::Exports::Payments
+  # Rails.application.config.spree.reports << Spree::Reports::MassivelyOvercomplexReportForCfo
+
+  # Themes and page builder
+  # Rails.application.config.spree.themes << Spree::Themes::NewShinyTheme
+  # Rails.application.config.spree.theme_layout_sections << Spree::PageSections::SuperImportantCeoBio
+  # Rails.application.config.spree.page_sections << Spree::PageSections::ContactFormToGetInTouch
+  # Rails.application.config.spree.page_blocks << Spree::PageBlocks::BigRedButtonToCallSales
+
+  # Storefront partials
+  if Rails.application.config.respond_to?(:spree_storefront)
+    Rails.application.config.spree_storefront.head_partials << 'spree_adyen/head'
+  end
+end

data/config/initializers/spree_permitted_attributes.rb

@@ -0,0 +1,5 @@
+module Spree
+  module PermittedAttributes
+    @@payment_method_attributes << :apple_developer_merchantid_domain_association
+  end
+end

data/config/locales/en.yml

@@ -0,0 +1,11 @@
+---
+en:
+  spree:
+    adyen:
+      payment_session_errors:
+        canceled: Payment canceled
+        expired: Payment has been expired. Try again.
+        refused: Payment refused
+    payment_states:
+      capture_pending: Capture Pending
+      void_pending: Void Pending

data/config/routes.rb

@@ -0,0 +1,35 @@
+Spree::Core::Engine.add_routes do
+  # Apple Pay domain verification certificate for Apple Pay
+  get '/.well-known/apple-developer-merchantid-domain-association' => '/spree_adyen/apple_pay_domain_verification#show'
+
+  # redirection after redirect flow payment (f.e. klarna)
+  # checking the redirect result status in frontend
+  get '/adyen/payment_sessions/redirect', to: '/spree_adyen/payment_sessions#redirect',
+                                           as: :redirect_adyen_payment_session,
+                                           controller: '/spree_adyen/payment_sessions'
+
+  # redirection after non-redirect flow payment for checking payment session result (f.e. credit cards)
+  # checking the session result status in frontend
+  get '/adyen/payment_sessions', to: '/spree_adyen/payment_sessions#show',
+                                     as: :adyen_payment_session,
+                                     controller: '/spree_adyen/payment_sessions'
+
+  post '/adyen/webhooks', to: '/spree_adyen/webhooks#create', controller: '/spree_adyen/webhooks'
+
+  # Storefront API v2 (only available when spree_legacy_api_v2 gem is installed)
+  if defined?(SpreeLegacyApiV2::Engine)
+    namespace :api, defaults: { format: 'json' } do
+      namespace :v2 do
+        namespace :storefront do
+          namespace :adyen do
+            resources :payment_sessions, only: %i[show create] do
+              member do
+                post :complete
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/db/migrate/20250630150000_setup_spree_adyen_models.rb

@@ -0,0 +1,17 @@
+class SetupSpreeAdyenModels < ActiveRecord::Migration[7.2]
+  def change
+    create_table :spree_adyen_payment_sessions do |t|
+      t.decimal :amount, precision: 10, scale: 2, default: '0.0', null: false, index: true
+      t.string :currency, null: false
+      t.references :order, null: false, index: true
+      t.references :user, null: true, index: true
+      t.string :status, null: false, index: true
+      t.datetime :expires_at, null: false, index: true
+      t.datetime :deleted_at, index: true
+      t.references :payment_method, null: false, index: true
+      t.string :adyen_id, null: false, index: { unique: true }
+      t.text :adyen_data, null: false
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20250811140113_add_channel_to_adyen_payment_sessions.rb

@@ -0,0 +1,10 @@
+class AddChannelToAdyenPaymentSessions < ActiveRecord::Migration[7.2]
+  def change
+    add_column :spree_adyen_payment_sessions, :channel, :string
+
+    SpreeAdyen::PaymentSession.reset_column_information
+    SpreeAdyen::PaymentSession.where(channel: nil).update_all(channel: 'Web')
+
+    add_index :spree_adyen_payment_sessions, :channel
+  end
+end

data/db/migrate/20250813152608_add_return_url_to_spree_adyen_payment_sessions.rb

@@ -0,0 +1,15 @@
+class AddReturnUrlToSpreeAdyenPaymentSessions < ActiveRecord::Migration[7.2]
+  def change
+    add_column :spree_adyen_payment_sessions, :return_url, :string
+
+    SpreeAdyen::PaymentSession.reset_column_information
+    Spree::Store.find_each do |store|
+      redirect_to = Spree::Core::Engine.routes.url_helpers.redirect_adyen_payment_session_url(host: store.url_or_custom_domain)
+      store.payment_methods.adyen.find_each do |gateway|
+        store.adyen_gateway.payment_sessions.with_deleted.where(return_url: nil).update_all(return_url: redirect_to)
+      end
+    end
+
+    add_index :spree_adyen_payment_sessions, :return_url
+  end
+end

data/lib/generators/spree_adyen/install/install_generator.rb

@@ -0,0 +1,20 @@
+module SpreeAdyen
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      class_option :migrate, type: :boolean, default: true
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=spree_adyen'
+      end
+
+      def run_migrations
+        run_migrations = options[:migrate] || ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]'))
+        if run_migrations
+          run 'bin/rails db:migrate'
+        else
+          puts 'Skipping rails db:migrate, don\'t forget to run it!'
+        end
+      end
+    end
+  end
+end

data/lib/spree_adyen/configuration.rb

@@ -0,0 +1,42 @@
+module SpreeAdyen
+  class Configuration < Spree::Preferences::Configuration
+    # Some example preferences are shown below, for more information visit:
+    # https://docs.spreecommerce.org/developer/contributing/creating-an-extension
+
+    # preference :enabled, :boolean, default: true
+    # preference :dark_chocolate, :boolean, default: true
+    # preference :color, :string, default: 'Red'
+    # preference :favorite_number, :integer
+    # preference :supported_locales, :array, default: [:en]
+
+    preference :payment_session_expiration_in_minutes, :integer, default: 60
+    preference :webhook_delay_in_seconds, :integer, default: 5
+    preference :use_legacy_webhook_handlers, :boolean, default: false
+    preference :use_legacy_adyen_payment_sessions, :boolean, default: false
+
+    preference :credit_card_sources, :array, default: %i[
+      accel
+      accel_googlepay
+      amex
+      amex_googlepay
+      jcb
+      carnet
+      cartebancaire
+      cup
+      diners
+      discover
+      discover_googlepay
+      eftpos_australia
+      elo
+      googlepay
+      maestro
+      maestro_googlepay
+      maestro_usa
+      maestro_usa_googlepay
+      mc
+      mc_googlepay
+      visa
+      visa_googlepay
+    ]
+  end
+end

data/lib/spree_adyen/engine.rb

@@ -0,0 +1,79 @@
+module SpreeAdyen
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_adyen'
+
+    Environment = Struct.new(:event_handlers, :events, :hmac_validators)
+
+    config.eager_load_paths += %W(#{config.root}/app/services)
+
+    # Only load API v2 controllers and serializers when spree_legacy_api_v2 gem is available
+    if defined?(SpreeLegacyApiV2::Engine)
+      config.autoload_paths << root.join('lib', 'spree_api_v2')
+      config.eager_load_paths << root.join('lib', 'spree_api_v2')
+    end
+
+    config.generators do |g| # use rspec for tests
+      g.test_framework :rspec
+    end
+
+    initializer 'spree_adyen.environment', before: :load_config_initializers do |app|
+      app.config.spree_adyen = Environment.new
+      app.config.spree_adyen.event_handlers = {}
+      app.config.spree_adyen.events = {}
+      app.config.spree_adyen.hmac_validators = {}
+      SpreeAdyen::Config = SpreeAdyen::Configuration.new
+    end
+
+    config.after_initialize do
+      Rails.application.config.spree_adyen.event_handlers.merge!(
+        'AUTHORISATION' => SpreeAdyen::Webhooks::ProcessAuthorisationEventJob,
+        'CAPTURE' => SpreeAdyen::Webhooks::ProcessCaptureEventJob,
+        'CANCELLATION' => SpreeAdyen::Webhooks::ProcessCancellationEventJob
+      )
+
+      Rails.application.config.spree_adyen.events.merge!(
+        'AUTHORISATION' => SpreeAdyen::Webhooks::Event,
+        'CAPTURE' => SpreeAdyen::Webhooks::Event,
+        'CANCELLATION' => SpreeAdyen::Webhooks::Event
+      )
+
+      Rails.application.config.spree_adyen.hmac_validators.merge!(
+        'AUTHORISATION' => SpreeAdyen::Webhooks::StandardHmacValidator,
+        'CAPTURE' => SpreeAdyen::Webhooks::StandardHmacValidator,
+        'CANCELLATION' => SpreeAdyen::Webhooks::StandardHmacValidator
+      )
+    end
+
+    initializer 'spree_adyen.assets' do |app|
+      if app.config.respond_to?(:assets)
+        app.config.assets.paths << root.join('app/javascript')
+        app.config.assets.paths << root.join('vendor/javascript')
+        app.config.assets.paths << root.join('vendor/stylesheets')
+        app.config.assets.precompile += %w[spree_adyen_manifest]
+      end
+    end
+
+    initializer 'spree_adyen.importmap', before: 'importmap' do |app|
+      if app.config.respond_to?(:importmap)
+        app.config.importmap.paths << root.join('config/importmap.rb')
+        # https://github.com/rails/importmap-rails?tab=readme-ov-file#sweeping-the-cache-in-development-and-test
+        app.config.importmap.cache_sweepers << root.join('app/javascript')
+      end
+    end
+
+    def self.activate
+      glob_paths = [File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')]
+      glob_paths << File.join(File.dirname(__FILE__), '../../lib/spree_api_v2/**/*_decorator*.rb') if defined?(SpreeLegacyApiV2::Engine)
+
+      glob_paths.each do |glob_path|
+        Dir.glob(glob_path) do |c|
+          Rails.configuration.cache_classes ? require(c) : load(c)
+        end
+      end
+    end
+
+    config.to_prepare(&method(:activate).to_proc)
+  end
+end

data/lib/spree_adyen/factories.rb

@@ -0,0 +1,3 @@
+Dir["#{File.dirname(__FILE__)}/testing_support/factories/**"].each do |f|
+  load File.expand_path(f)
+end

data/lib/spree_adyen/testing_support/factories/gateway_factory.rb

@@ -0,0 +1,29 @@
+FactoryBot.define do
+  factory :adyen_gateway, parent: :payment_method, class: SpreeAdyen::Gateway do
+    name { 'Adyen' }
+    type { 'SpreeAdyen::Gateway' }
+
+    skip_auto_configuration { true }
+    skip_api_key_validation { true }
+
+    preferences do
+      {
+        api_key: 'secret',
+        merchant_account: 'SpreeCommerceECOM',
+        hmac_key: 'secret123',
+        client_key: 'client123',
+        webhook_id: 'webhook123'
+      }
+    end
+
+    trait :with_apple_domain_association_file do
+      transient do
+        apple_domain_association_file_path do
+          File.join(SpreeAdyen::Engine.root, 'spec', 'fixtures', 'files', 'apple-domain-association-file.txt')
+        end
+      end
+
+      apple_developer_merchantid_domain_association { Rack::Test::UploadedFile.new(apple_domain_association_file_path) }
+    end
+  end
+end

data/lib/spree_adyen/testing_support/factories/payment_session_factory.rb

@@ -0,0 +1,40 @@
+FactoryBot.define do
+  factory :adyen_payment_session, class: SpreeAdyen::PaymentSession do
+    sequence(:adyen_id) { |n| "pi_#{n}" }
+    adyen_data { 'a very long string' }
+    amount { order.total_minus_store_credits }
+    currency { order.currency }
+    channel { 'Web' }
+    status { 'initial' }
+    expires_at { 1.hour.from_now }
+    payment_method { create(:adyen_gateway) }
+
+    association :user
+    association :order, factory: :order_with_line_items
+
+    trait :expired do
+      expires_at { 1.hour.ago }
+      skip_expiration_date_validation { true }
+    end
+
+    trait :initial do
+      status { 'initial' }
+    end
+
+    trait :pending do
+      status { 'pending' }
+    end
+
+    trait :completed do
+      status { 'completed' }
+    end
+
+    trait :outdated do
+      status { 'outdated' }
+    end
+
+    trait :canceled do
+      status { 'canceled' }
+    end
+  end
+end

data/lib/spree_adyen/version.rb

@@ -0,0 +1,7 @@
+module SpreeAdyen
+  VERSION = '0.10.0'.freeze
+
+  def gem_version
+    Gem::Version.new(VERSION)
+  end
+end

data/lib/spree_adyen.rb

@@ -0,0 +1,39 @@
+require 'spree_core'
+require 'spree_adyen/engine'
+require 'spree_adyen/version'
+require 'spree_adyen/configuration'
+require 'adyen-ruby-api-library'
+
+module SpreeAdyen
+  def self.queue
+    'default'
+  end
+
+  def self.version
+    VERSION
+  end
+
+  def self.event_handlers
+    Rails.application.config.spree_adyen.event_handlers
+  end
+
+  def self.event_handlers=(value)
+    Rails.application.config.spree_adyen.event_handlers = value
+  end
+
+  def self.events
+    Rails.application.config.spree_adyen.events
+  end
+
+  def self.events=(value)
+    Rails.application.config.spree_adyen.events = value
+  end
+
+  def self.hmac_validators
+    Rails.application.config.spree_adyen.hmac_validators
+  end
+
+  def self.hmac_validators=(value)
+    Rails.application.config.spree_adyen.hmac_validators = value
+  end
+end

data/lib/spree_api_v2/spree/api/v2/storefront/adyen/base_controller.rb

@@ -0,0 +1,21 @@
+module Spree
+  module Api
+    module V2
+      module Storefront
+        module Adyen
+          class BaseController < ::Spree::Api::V2::BaseController
+            before_action :require_adyen_gateway
+
+            def require_adyen_gateway
+              render_error_payload('Adyen gateway is not present') unless adyen_gateway
+            end
+
+            def adyen_gateway
+              @adyen_gateway ||= current_store.adyen_gateway
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spree_api_v2/spree/api/v2/storefront/adyen/payment_sessions_controller.rb

@@ -0,0 +1,72 @@
+module Spree
+  module Api
+    module V2
+      module Storefront
+        module Adyen
+          class PaymentSessionsController < BaseController
+            include Spree::Api::V2::Storefront::OrderConcern
+            before_action :ensure_order
+            before_action :load_payment_session, only: %i[show complete]
+
+            # POST /api/v2/storefront/adyen/payment_sessions
+            def create
+              spree_authorize! :update, spree_current_order, order_token
+
+              payment_session_result = SpreeAdyen::PaymentSessions::FindOrCreate.new(
+                order: spree_current_order,
+                amount: permitted_attributes[:amount],
+                user: spree_current_user,
+                payment_method: adyen_gateway,
+                channel: permitted_attributes[:channel],
+                return_url: permitted_attributes[:return_url]
+              ).call
+
+              if payment_session_result.success?
+                render_serialized_payload { serialize_resource(payment_session_result.value) }
+              else
+                error = payment_session_result.value&.errors || payment_session_result.error.value
+                render_error_payload(error)
+              end
+            end
+
+            # POST /api/v2/storefront/adyen/payment_sessions/:id/complete
+            def complete
+              spree_authorize! :update, spree_current_order, order_token
+
+              SpreeAdyen::PaymentSessions::ProcessWithResult.new(payment_session: @payment_session, session_result: params[:session_result]).call
+
+              if @payment_session.completed?
+                render_serialized_payload { serialize_resource(@payment_session) }
+              else
+                render_error_payload("Can't complete the order for the payment session in the #{@payment_session.status} state")
+              end
+            rescue Spree::Core::GatewayError => e
+              render_error_payload(e.message, :unprocessable_entity)
+            end
+
+            # GET /api/v2/storefront/adyen/payment_sessions/:id
+            def show
+              spree_authorize! :show, spree_current_order, order_token
+
+              render_serialized_payload { serialize_resource(@payment_session) }
+            end
+
+            private
+
+            def permitted_attributes
+              params.require(:payment_session).permit(:amount, :channel, :return_url)
+            end
+
+            def resource_serializer
+              SpreeAdyen::Api::V2::Storefront::PaymentSessionSerializer
+            end
+
+            def load_payment_session
+              @payment_session = spree_current_order.adyen_payment_sessions.find(params[:id])
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spree_api_v2/spree_adyen/api/v2/storefront/payment_session_serializer.rb

@@ -0,0 +1,21 @@
+module SpreeAdyen
+  module Api
+    module V2
+      module Storefront
+        class PaymentSessionSerializer < ::Spree::Api::V2::BaseSerializer
+          set_type :adyen_payment_session
+
+          attributes :adyen_id, :amount, :currency, :adyen_data, :status, :expires_at, :channel, :return_url
+
+          attribute :client_key do |object|
+            object.payment_method.preferred_client_key
+          end
+
+          belongs_to :order, serializer: ::Spree::Api::Dependencies.storefront_cart_serializer.constantize
+          belongs_to :payment_method, serializer: ::Spree::Api::Dependencies.storefront_payment_method_serializer.constantize
+          belongs_to :user, serializer: ::Spree::Api::Dependencies.storefront_user_serializer.constantize
+        end
+      end
+    end
+  end
+end