solidus_six_saferpay 0.1.5 → 0.3.0

data/app/controllers/spree/solidus_six_saferpay/transaction/checkout_controller.rb

@@ -1,7 +1,7 @@
 module Spree
   module SolidusSixSaferpay
-    # explicit parent must be stated, otherwise Spree::CheckoutController has precendence
     module Transaction
+    # explicit parent must be stated, otherwise Spree::CheckoutController has precendence
       class CheckoutController < SolidusSixSaferpay::CheckoutController
 
         private

data/app/models/spree/payment_method/saferpay_payment_method.rb

@@ -39,7 +39,7 @@ module Spree
       'saferpay_payment'
     end
 
-    def init_path
+    def init_path(order)
       raise NotImplementedError, "Must be implemented in SaferpayPaymentPage or SaferpayTransaction"
     end
   end

data/app/models/spree/payment_method/saferpay_payment_page.rb

@@ -6,8 +6,8 @@ module Spree
       ::SolidusSixSaferpay::PaymentPageGateway
     end
 
-    def init_path
-      url_helpers.solidus_six_saferpay_payment_page_init_path
+    def init_path(order)
+      url_helpers.solidus_six_saferpay_payment_page_init_path(order.number)
     end
   end
 end

data/app/models/spree/payment_method/saferpay_transaction.rb

@@ -5,8 +5,8 @@ module Spree
       ::SolidusSixSaferpay::TransactionGateway
     end
 
-    def init_path
-      url_helpers.solidus_six_saferpay_transaction_init_path
+    def init_path(order)
+      url_helpers.solidus_six_saferpay_transaction_init_path(order.number)
     end
   end
 end

data/app/services/spree/solidus_six_saferpay/cancel_authorized_payment.rb

@@ -0,0 +1,33 @@
+module Spree
+  module SolidusSixSaferpay
+    class CancelAuthorizedPayment
+
+      attr_reader :saferpay_payment
+
+      def self.call(saferpay_payment)
+        new(saferpay_payment).call
+      end
+
+      def initialize(saferpay_payment)
+        @saferpay_payment = saferpay_payment
+      end
+
+      def call
+        if transaction_id = saferpay_payment.transaction_id
+          gateway.void(saferpay_payment.transaction_id)
+        else
+          ::SolidusSixSaferpay::ErrorHandler.handle(
+            ::SolidusSixSaferpay::InvalidSaferpayPayment.new(
+              details: "Can not cancel payment #{saferpay_payment.id} because it has no transaction ID.")
+          )
+        end
+      end
+
+      private
+
+      def gateway
+        ::SolidusSixSaferpay::Gateway.new
+      end
+    end
+  end
+end

data/app/services/spree/solidus_six_saferpay/initialize_payment.rb

@@ -1,6 +1,5 @@
 module Spree
   module SolidusSixSaferpay
-
     class InitializePayment
 
       attr_reader :order, :payment_method, :redirect_url, :success

data/app/services/spree/solidus_six_saferpay/initialize_transaction.rb

@@ -1,6 +1,5 @@
 module Spree
   module SolidusSixSaferpay
-
     class InitializeTransaction < InitializePayment
       include UseTransactionGateway
 

data/app/services/spree/solidus_six_saferpay/inquire_payment.rb

@@ -19,8 +19,9 @@ module Spree
         inquiry = gateway.inquire(saferpay_payment)
 
         if inquiry.success?
-          saferpay_payment.update_attributes(response_hash: inquiry.api_response.to_h)
+          saferpay_payment.update_attributes(saferpay_payment_attributes(inquiry.api_response))
         else
+          saferpay_payment.update_attributes(response_hash: saferpay_payment.response_hash.merge(error: "#{inquiry.error_name}"))
           general_error = I18n.t(:general_error, scope: [:solidus_six_saferpay, :errors])
           specific_error = I18n.t(inquiry.error_name, scope: [:six_saferpay, :error_names])
           @user_message = "#{general_error}: #{specific_error}"
@@ -38,6 +39,31 @@ module Spree
       def gateway
         raise NotImplementedError, "Must be implemented in AssertPaymentPage or AuthorizeTransaction with UsePaymentPageGateway or UseTransactionGateway"
       end
+
+      private
+
+      def saferpay_payment_attributes(saferpay_response)
+        payment_means = saferpay_response.payment_means
+        brand = payment_means.brand
+        card = payment_means.card
+
+        attributes = {
+          transaction_id: saferpay_response.transaction.id,
+          transaction_status: saferpay_response.transaction.status,
+          transaction_date: DateTime.parse(saferpay_response.transaction.date),
+          six_transaction_reference: saferpay_response.transaction.six_transaction_reference,
+          display_text: saferpay_response.payment_means.display_text,
+          response_hash: saferpay_response.to_h
+        }
+
+        if card
+          attributes[:masked_number] = card.masked_number
+          attributes[:expiration_year] = card.exp_year
+          attributes[:expiration_month] = card.exp_month
+        end
+
+        attributes
+      end
     end
   end
 end

data/app/views/spree/checkout/payment/_saferpay_payment.html.erb

@@ -3,10 +3,10 @@
   <iframe class="saferpay-iframe" width='100%' height='550px' id="<%= payment_container_id %>" src="" frameborder="0">
   </iframe>
   <script charset="utf-8">
-    SaferpayPayment.registerIframePaymentMethod({id: "<%= payment_method.id %>", initUrl: "<%= payment_method.init_path %>", containerId: "#<%= payment_container_id %>"})
+    SaferpayPayment.registerIframePaymentMethod({id: "<%= payment_method.id %>", initUrl: "<%= payment_method.init_path(@order) %>", containerId: "#<%= payment_container_id %>"})
   </script>
 <% else %>
   <script charset="utf-8">
-    SaferpayPayment.registerExternalRedirectPaymentMethod({id: "<%= payment_method.id %>", initUrl: "<%= payment_method.init_path %>"})
+    SaferpayPayment.registerExternalRedirectPaymentMethod({id: "<%= payment_method.id %>", initUrl: "<%= payment_method.init_path(@order) %>"})
   </script>
 <% end %>

data/app/views/spree/solidus_six_saferpay/checkout/{iframe_breakout_redirect.html.erb → iframe_breakout_redirect.erb}

@@ -1,7 +1,7 @@
 <html>
   <body>
     <script type='text/javascript' charset='utf-8'>
-      window.parent.document.location.href = "<%= @redirect_path %>"
+      window.parent.document.location.replace("<%= @redirect_path %>");
     </script>
   </body>
 </html>

data/bin/console

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "solidus_six_saferpay"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+$LOAD_PATH.unshift(*Dir["#{__dir__}/../app/*"])
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rails

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+app_root = 'sandbox'
+
+unless File.exist? "#{app_root}/bin/rails"
+  warn 'Creating the sandbox app...'
+  Dir.chdir "#{__dir__}/.." do
+    system "#{__dir__}/sandbox" or begin # rubocop:disable Style/AndOr
+      warn 'Automatic creation of the sandbox app failed'
+      exit 1
+    end
+  end
+end
+
+Dir.chdir app_root
+exec 'bin/rails', *ARGV

data/bin/rake

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+gem install bundler --conservative
+bundle update
+bin/rake clobber

data/config/initializers/assets.rb

@@ -0,0 +1,3 @@
+if Rails.application.config.respond_to?(:assets)
+  Rails.application.config.assets.precompile << 'solidus_six_saferpay_manifest.js'
+end

data/config/locales/de.yml

@@ -5,8 +5,10 @@ de:
       checkout: &checkout
         init:
           checkout_not_initialized: Zahlung konnte nicht gestartet werden.
+          order_was_modified_after_confirmation: Bestellung wurde nach der Bestätigung verändert. Bitte starten Sie den Zahlungsvorgang erneut.
         success:
-          payment_source_not_created: Six Saferpay Zahlungsquelle konnte nicht erstellt werden.
+          error_while_processing_payment: Beim Verarbeiten der Bezahlung ist ein Fehler aufgetreten. Bitte starten Sie den Zahlungsvorgang erneut.
+          saferpay_payment_not_found: Six Saferpay Zahlung kann nicht gefunden werden.
         fail:
           payment_failed: Die Zahlung konnte nicht abgeschlossen werden.
       payment_page:
@@ -19,6 +21,7 @@ de:
     errors:
       general_error: Bezahlungsfehler
       liability_shift_not_granted:  Haftungsumkehr wurde abgelehnt
+      saferpay_payment_not_found: Saferpay Payment konnte nicht gefunden werden
   six_saferpay:
     error_names:
       ACTION_NOT_SUPPORTED: Die angeforderte Aktion wird im Kontext der Aktion nicht unterstützt un kann mit den Anforderungsdaten nicht ausgeführt werden.

data/config/locales/en.yml

@@ -5,8 +5,10 @@ en:
       checkout: &checkout
         init:
           checkout_not_initialized: Payment could not be initialized.
+          order_was_modified_after_confirmation: Order was modified after confirmation. Please restart the checkout process.
         success:
-          payment_source_not_created: Six Saferpay payment source could not be created.
+          error_while_processing_payment: An error occurred while processing the payment. Please restart the checkout process.
+          saferpay_payment_not_found: Six Saferpay payment can not be found.
         fail:
           payment_failed: The payment could not be completed.
       payment_page:
@@ -19,6 +21,7 @@ en:
     errors:
       general_error: Payment Error
       liability_shift_not_granted:  Liability Shift was rejected
+      saferpay_payment_not_found: Saferpay Payment could not be found
   six_saferpay:
     error_names:
       ACTION_NOT_SUPPORTED:	The requested action is not supported in the given context or the action can't be executed with the request data.

data/config/locales/fr.yml

@@ -5,8 +5,10 @@ fr:
       checkout: &checkout
         init:
           checkout_not_initialized: Le paiement n'a pas pu être initialisé.
+          order_was_modified_after_confirmation: La commande a été modifiée après confirmation. Veuillez redémarrer le processus de paiement.
         success:
-          payment_source_not_created: La source de paiement Six Saferpay n'a pas pu être créée.
+          error_while_processing_payment: Une erreur s'est produite lors du traitement du paiement. Veuillez redémarrer le processus de paiement.
+          saferpay_payment_not_found: Paiement Six Saferpay est introuvable.
         fail:
           payment_failed: Le paiement n'a pas pu être complété.
       payment_page:
@@ -18,6 +20,7 @@ fr:
   solidus_six_saferpay:
     errors:
       liability_shift_not_granted:  Le transfert de responsabilité a été rejeté
+      saferpay_payment_not_found: Saferpay Payment est introuvable
   six_saferpay:
     error_names:
       ACTION_NOT_SUPPORTED: l'action demandé n'es pas prise en charge dans le contexte de l'action et ne peut pas être exécutée avec les données de la demande.

data/config/routes.rb

@@ -1,17 +1,17 @@
-Spree::Core::Engine.routes.draw do
+# frozen_string_literal: true
 
+Spree::Core::Engine.routes.draw do
   namespace :solidus_six_saferpay do
     namespace :payment_page do
-      get :init, controller: :checkout, defaults: { format: :json }
-      get :success, controller: :checkout
-      get :fail, controller: :checkout
+      get 'init/:order_number', to: 'checkout#init', as: :init, defaults: { format: :json }
+      get 'success/:order_number', to: 'checkout#success', as: :success
+      get 'fail/:order_number', to: 'checkout#fail', as: :fail
     end
 
     namespace :transaction do
-      get :init, controller: :checkout, defaults: { format: :json }
-      get :success, controller: :checkout
-      get :fail, controller: :checkout
+      get 'init/:order_number', to: 'checkout#init', as: :init, defaults: { format: :json }
+      get 'success/:order_number', to: 'checkout#success', as: :success
+      get 'fail/:order_number', to: 'checkout#fail', as: :fail
     end
   end
-
 end

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

@@ -1,18 +1,30 @@
+# frozen_string_literal: true
+
 module SolidusSixSaferpay
   module Generators
     class InstallGenerator < Rails::Generators::Base
       class_option :auto_run_migrations, type: :boolean, default: false
 
+      def add_javascripts
+        append_file 'vendor/assets/javascripts/spree/frontend/all.js', "//= require spree/frontend/solidus_six_saferpay\n"
+        append_file 'vendor/assets/javascripts/spree/backend/all.js', "//= require spree/backend/solidus_six_saferpay\n"
+      end
+
+      def add_stylesheets
+        inject_into_file 'vendor/assets/stylesheets/spree/frontend/all.css', " *= require spree/frontend/solidus_six_saferpay\n", before: %r{\*/}, verbose: true
+        inject_into_file 'vendor/assets/stylesheets/spree/backend/all.css', " *= require spree/backend/solidus_six_saferpay\n", before: %r{\*/}, verbose: true
+      end
+
       def add_migrations
-        run 'bundle exec rake railties:install:migrations FROM=solidus_six_saferpay'
+        run 'bin/rails railties:install:migrations FROM=solidus_six_saferpay'
       end
 
       def run_migrations
         run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]'))
         if run_migrations
-          run 'bundle exec rake db:migrate'
+          run 'bin/rails db:migrate'
         else
-          puts 'Skipping rake db:migrate, don\'t forget to run it!'
+          puts 'Skipping bin/rails db:migrate, don\'t forget to run it!' # rubocop:disable Rails/Output
         end
       end
     end

data/lib/solidus_six_saferpay.rb

@@ -1,5 +1,8 @@
-require 'solidus_core'
-require "solidus_support"
+# frozen_string_literal: true
 
-require "solidus_six_saferpay/engine"
+require 'solidus_core'
+require 'solidus_support'
 require 'six_saferpay'
+
+require 'solidus_six_saferpay/version'
+require 'solidus_six_saferpay/engine'

data/lib/solidus_six_saferpay/configuration.rb

@@ -1,12 +1,11 @@
 module SolidusSixSaferpay
-
   class Configuration
-    def self.config
-      yield(self)
-    end
+    include ActiveSupport::Configurable
+
 
-    def self.error_handlers
-      @error_handlers ||= []
-    end
+    config_accessor(:payment_processing_order_not_found_handler)
+    config_accessor(:payment_processing_payment_not_found_handler)
+    config_accessor(:payment_processing_success_handler)
+    config_accessor(:error_handlers) { [] }
   end
 end

data/lib/solidus_six_saferpay/engine.rb

@@ -1,6 +1,22 @@
+# frozen_string_literal: true
+
+require 'spree/core'
 module SolidusSixSaferpay
-  class Engine < ::Rails::Engine
-    isolate_namespace SolidusSixSaferpay
+
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  def self.configure
+    yield config
+  end
+
+  class Engine < Rails::Engine
+    include SolidusSupport::EngineExtensions::Decorators
+
+    isolate_namespace ::Spree
+
+    engine_name 'solidus_six_saferpay'
 
     config.autoload_paths += Dir["#{config.root}/lib/**/"]
     config.eager_load_paths += Dir["#{config.root}/lib/**/"]
@@ -10,16 +26,9 @@ module SolidusSixSaferpay
       app.config.spree.payment_methods << Spree::PaymentMethod::SaferpayTransaction
     end
 
-    initializer "solidus_six_payments.assets.precompile" do |app|
-      app.config.assets.precompile += %w( solidus_six_saferpay/application.css )
-      app.config.assets.precompile += %w( solidus_six_saferpay/saferpay_payment.js )
-      app.config.assets.precompile += %w( solidus_six_saferpay/credit_cards/**/*.png )
-    end
-
+    # use rspec for tests
     config.generators do |g|
       g.test_framework :rspec
-      g.fixture_replacement :factory_bot
-      g.factory_bot dir: 'spec/factories'
     end
   end
 end

data/lib/solidus_six_saferpay/gateway.rb

@@ -5,9 +5,6 @@ module SolidusSixSaferpay
 
     def initialize(options = {})
       SixSaferpay.configure do |config|
-        config.success_url = options.fetch(:success_url)
-        config.fail_url = options.fetch(:fail_url)
-
         # Allow config via ENV for static values
         config.customer_id = options.fetch(:customer_id) { ENV.fetch('SIX_SAFERPAY_CUSTOMER_ID') }
         config.terminal_id = options.fetch(:terminal_id) { ENV.fetch('SIX_SAFERPAY_TERMINAL_ID') }
@@ -43,7 +40,7 @@ module SolidusSixSaferpay
       capture(amount, saferpay_payment.transaction_id, options)
     end
 
-    def capture(amount, transaction_id, options={})
+    def capture(_amount, transaction_id, options={})
       transaction_reference = SixSaferpay::TransactionReference.new(transaction_id: transaction_id)
       payment_capture = SixSaferpay::SixTransaction::Capture.new(transaction_reference: transaction_reference)
 
@@ -82,15 +79,14 @@ module SolidusSixSaferpay
     end
 
     # aliased to #refund for compatibility with solidus internals
-    def credit(amount, transaction_id, options = {})
-      refund(amount, transaction_id, options)
+    def credit(amount_cents, transaction_id, options = {})
+      refund(amount_cents, transaction_id, options)
     end
 
-    def refund(amount, transaction_id, options = {})
+    def refund(amount_cents, transaction_id, options = {})
       payment = Spree::Payment.find_by!(response_code: transaction_id)
-      refund_amount = Spree::Money.new(amount, currency: payment.currency)
 
-      saferpay_amount = SixSaferpay::Amount.new(value: refund_amount.cents, currency_code: payment.currency)
+      saferpay_amount = SixSaferpay::Amount.new(value: amount_cents, currency_code: payment.currency)
       saferpay_refund = SixSaferpay::Refund.new(amount: saferpay_amount, order_id: payment.order.number)
       capture_reference = SixSaferpay::CaptureReference.new(capture_id: payment.transaction_id)
 
@@ -99,7 +95,7 @@ module SolidusSixSaferpay
       if refund_response = SixSaferpay::Client.post(payment_refund)
 
         # actually capture the refund
-        capture(amount, refund_response.transaction.id, options)
+        capture(amount_cents, refund_response.transaction.id, options)
       end
 
     rescue SixSaferpay::Error => e
@@ -156,7 +152,7 @@ module SolidusSixSaferpay
       )
       payer = SixSaferpay::Payer.new(language_code: I18n.locale, billing_address: billing_address, delivery_address: delivery_address)
 
-      params = { payment: payment, payer: payer }
+      params = { payment: payment, payer: payer, return_urls: return_urls(order) }
 
       six_payment_methods = payment_method.enabled_payment_methods
       params.merge!(payment_methods: six_payment_methods) unless six_payment_methods.blank?
@@ -164,6 +160,10 @@ module SolidusSixSaferpay
       params
     end
 
+    def return_urls(order)
+      raise NotImplementedError, "Must be implemented in PaymentPageGateway or TransactionGateway"
+    end
+
     def response(success, message, api_response, options = {})
       GatewayResponse.new(success, message, api_response, options)
     end