solidus-adyen 0.1.2

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

@@ -0,0 +1,101 @@
+# This models the response that is received after a user is redirected from the
+# Adyen Hosted Payment Pages. It's used as the the source for the Spree::Payment
+# and keeps track of the messages received from the notifications end point.
+#
+# Attributes defined are dervived from the docs:
+# https://docs.adyen.com/display/TD/HPP+payment+response
+#
+# Information about when certain action are valid:
+# https://docs.adyen.com/display/TD/HPP+modifications
+module Spree::Adyen
+  class HppSource < ::ActiveRecord::Base
+    MANUALLY_REFUNDABLE = [
+      "directEbanking"
+    ].freeze
+
+    PENDING = "PENDING".freeze
+    AUTHORISED = "AUTHORISED".freeze
+    REFUSED = "REFUSED".freeze
+    CANCELLED = "CANCELLED".freeze
+
+    # support updates from capital-cased responses, which is what adyen gives
+    # us
+    alias_attribute :authResult, :auth_result
+    alias_attribute :pspReference, :psp_reference
+    alias_attribute :merchantReference, :merchant_reference
+    alias_attribute :skinCode, :skin_code
+    alias_attribute :merchantSig, :merchant_sig
+    alias_attribute :paymentMethod, :payment_method
+    alias_attribute :shopperLocale, :shopper_locale
+    alias_attribute :merchantReturnData, :merchant_return_data
+
+    belongs_to :order, class_name: "Spree::Order",
+      primary_key: :number,
+      foreign_key: :merchant_reference
+
+    has_one :payment, class_name: "Spree::Payment", as: :source
+
+    # FIXME should change this to find the auth notification by order number,
+    # then all notification that have a original ref that matches it's psp
+    has_many :notifications,
+      class_name: "AdyenNotification",
+      foreign_key: :merchant_reference,
+      primary_key: :merchant_reference
+
+    def can_capture? payment
+      payment.uncaptured_amount != 0.0
+    end
+
+    def actions
+      if mutable?
+        authorised_actions
+      else
+        []
+      end
+    end
+
+    def can_cancel? payment
+      payment.refunds.empty?
+    end
+
+    def requires_manual_refund?
+      MANUALLY_REFUNDABLE.include?(payment_method)
+    end
+
+    def authorised?
+      # Many banks return pending, this is considered a valid response and
+      # the order should proceed.
+      [PENDING, AUTHORISED].include? auth_result
+    end
+
+    private
+    def mutable?
+      !payment.void? && !payment.processing?
+    end
+
+    # authorised_actions :: [String] | []
+    def authorised_actions
+      if auth_notification
+        auth_notification.
+          actions.map(&method(:transform_action))
+
+      else
+        []
+
+      end
+    end
+
+    def transform_action action
+      if action == "refund"
+        # return credit so that we go to the new refund action
+        "credit"
+      else
+        action
+      end
+    end
+
+    def auth_notification
+      notifications.processed.authorisation.last
+    end
+  end
+end

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

@@ -0,0 +1,102 @@
+module Spree
+  module Adyen
+    class NotificationProcessor
+      attr_accessor :notification, :payment
+
+      def initialize(notification, payment = nil)
+        self.notification = notification
+        self.payment = payment ? payment : notification.payment
+      end
+
+      # for the given payment, process all notifications that are currently
+      # unprocessed in the order that they were dispatched.
+      def self.process_outstanding!(payment)
+        Spree::Payment.transaction do
+          payment.
+            source.
+            notifications(true). # bypass caching
+            unprocessed.
+            as_dispatched.
+            map do |notification|
+              new(notification, payment).process!
+            end
+        end
+      end
+
+      # only process the notification if there is a matching payment there's a
+      # number of reasons why there may not be a matching payment such as test
+      # notifications, reports etc, we just log them and then accept
+      def process!
+        Spree::Payment.transaction do
+          if payment
+            if !notification.success?
+              handle_failure
+
+            elsif notification.modification_event?
+              handle_modification_event
+
+            elsif notification.normal_event?
+              handle_normal_event
+
+            end
+          end
+        end
+
+        return notification
+      end
+
+      private
+
+      def handle_failure
+        notification.processed!
+        # ignore failures if the payment was already completed
+        return if payment.completed?
+        # might have to do something else on modification events,
+        # namely refunds
+        payment.failure!
+      end
+
+      def handle_modification_event
+        if notification.capture?
+          notification.processed!
+          complete_payment!
+
+        elsif notification.cancel_or_refund?
+          notification.processed!
+          payment.void
+
+        elsif notification.refund?
+          payment.refunds.create!(
+            amount: notification.value / 100, # cents to dollars
+            transaction_id: notification.psp_reference,
+            refund_reason_id: ::Spree::RefundReason.first.id # FIXME
+          )
+          # payment was processing, move back to completed
+          payment.complete!
+          notification.processed!
+        end
+      end
+
+      # normal event is defined as just AUTHORISATION
+      def handle_normal_event
+        if notification.auto_captured?
+          complete_payment!
+
+        else
+          payment.capture!
+
+        end
+        notification.processed!
+      end
+
+      def complete_payment!
+        money = ::Money.new(notification.value, notification.currency)
+
+        # this is copied from Spree::Payment::Processing#capture
+        payment.capture_events.create!(amount: money.to_f)
+        payment.update!(amount: payment.captured_amount)
+        payment.complete!
+      end
+    end
+  end
+end

data/app/models/spree/adyen/presenters/communication.rb

@@ -0,0 +1,31 @@
+module Spree
+  module Adyen
+    module Presenters
+      # Factory for creating communication presenters, based on a payment
+      # source.
+      class Communication < SimpleDelegator
+        PRESENTERS = [
+          ::Spree::Adyen::Presenters::Communications::AdyenNotification,
+          ::Spree::Adyen::Presenters::Communications::HppSource,
+          ::Spree::Adyen::Presenters::Communications::LogEntry
+        ].freeze
+
+        def self.from_source source
+          ([source] + source.notifications + source.payment.log_entries).
+            sort_by(&:created_at).
+            map { |x| build x }
+        end
+
+        def self.build object
+          presenter_for(object).new(object)
+        end
+
+        def self.presenter_for object
+          PRESENTERS.detect do |klass|
+            klass.applicable? object
+          end || fail("Couldn't map to a communication type")
+        end
+      end
+    end
+  end
+end

data/app/models/spree/adyen/presenters/communications/adyen_notification.rb

@@ -0,0 +1,26 @@
+module Spree
+  module Adyen
+    module Presenters
+      module Communications
+        class AdyenNotification <
+          ::Spree::Adyen::Presenters::Communications::Base
+
+          def fields
+            { event_code: event_code,
+              reason: reason,
+              amount: money.format
+            }
+          end
+
+          def inbound?
+            true
+          end
+
+          def self.applicable? obj
+            obj.is_a? ::AdyenNotification
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/spree/adyen/presenters/communications/base.rb

@@ -0,0 +1,50 @@
+module Spree
+  module Adyen
+    module Presenters
+      module Communications
+        # Base presenters for generic server-api communication representation
+        #
+        # All communication presenters are expected to implement
+        # fields
+        # success?
+        # processed?
+        # inbound?
+        class Base < SimpleDelegator
+          # force to_partial_path to be called on the delegator and not the
+          # delgatee
+          def to_model
+            self
+          end
+
+          def to_partial_path
+            "spree/adyen/communication/communication"
+          end
+
+          def created_at_s
+            created_at.strftime "%d %b %H:%M:%S.%4N"
+          end
+
+          def present_fields
+            fields.compact
+          end
+
+          def css_class
+            [
+              success? ? "success" : "failure",
+              processed? ? "processed" : "unprocessed",
+              inbound? ? "received" : "sent"
+            ].
+            map { |klass| css_prefix klass }.
+            join(" ")
+          end
+
+          private
+
+          def css_prefix klass
+            "adyen-comm-" + klass
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/spree/adyen/presenters/communications/hpp_source.rb

@@ -0,0 +1,31 @@
+module Spree
+  module Adyen
+    module Presenters
+      module Communications
+        class HppSource < ::Spree::Adyen::Presenters::Communications::Base
+          def fields
+            { result: auth_result,
+              payment_method: payment_method
+            }
+          end
+
+          def success?
+            true
+          end
+
+          def processed?
+            true
+          end
+
+          def inbound?
+            true
+          end
+
+          def self.applicable? obj
+            obj.is_a? Spree::Adyen::HppSource
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/spree/adyen/presenters/communications/log_entry.rb

@@ -0,0 +1,28 @@
+module Spree
+  module Adyen
+    module Presenters
+      module Communications
+        class LogEntry < ::Spree::Adyen::Presenters::Communications::Base
+          delegate :success?, :message, to: :parsed_details
+
+          def processed?
+            true
+          end
+
+          def inbound?
+            false
+          end
+
+          def fields
+            { message: message
+            }
+          end
+
+          def self.applicable? obj
+            obj.is_a? Spree::LogEntry
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/spree/adyen/presenters/communications.rb

@@ -0,0 +1,9 @@
+module Spree
+  module Adyen
+    module Presenters
+      # Explicit declaration of module
+      module Communications
+      end
+    end
+  end
+end

data/app/models/spree/gateway/adyen_hpp.rb

@@ -0,0 +1,95 @@
+module Spree
+  # Gateway for Adyen Hosted Payment Pages solution
+  class Gateway::AdyenHPP < Gateway
+    preference :skin_code, :string
+    preference :shared_secret, :string
+    preference :days_to_ship, :integer, default: 1
+    preference :api_username, :string
+    preference :api_password, :string
+    preference :merchant_account, :string
+
+    def merchant_account
+      ENV["ADYEN_MERCHANT_ACCOUNT"] || preferred_merchant_account
+    end
+
+    def provider_class
+      ::Adyen::API
+    end
+
+    def provider
+      ::Adyen.configuration.api_username =
+        (ENV["ADYEN_API_USERNAME"] || preferred_api_username)
+      ::Adyen.configuration.api_password =
+        (ENV["ADYEN_API_PASSWORD"] || preferred_api_password)
+      ::Adyen.configuration.default_api_params[:merchant_account] =
+        merchant_account
+
+      provider_class
+    end
+
+    def method_type
+      "adyen"
+    end
+
+    def shared_secret
+      ENV["ADYEN_SHARED_SECRET"] || preferred_shared_secret
+    end
+
+    def skin_code
+      ENV["ADYEN_SKIN_CODE"] || preferred_skin_code
+    end
+
+    def ship_before_date
+      preferred_days_to_ship.days.from_now
+    end
+
+    def authorize(amount, source, gateway_options)
+      # to get around the order checking for processed payments we create payments
+      # in the checkout state and allow the payment method to attempt to auth
+      # them here. We just return a dummy response here because the payment has
+      # already been authorized
+      ActiveMerchant::Billing::Response.new(true, "successful hpp payment")
+    end
+
+    def capture(amount, psp_reference, currency:, **_opts)
+      value = { currency: currency, value: amount }
+
+      handle_response(
+        provider.capture_payment(psp_reference, value),
+        psp_reference)
+    end
+
+    def cancel(psp_reference, _gateway_options = {})
+      handle_response(
+        provider.cancel_or_refund_payment(psp_reference),
+        psp_reference)
+    end
+
+    def credit(amount, psp_reference, currency:, **_opts)
+      amount = { currency: currency, value: amount }
+
+      handle_response(
+        provider.refund_payment(psp_reference, amount),
+        psp_reference)
+    end
+
+    private
+
+    def handle_response response, original_reference
+      ActiveMerchant::Billing::Response.new(
+        response.success?,
+        message(response),
+        {},
+        authorization: original_reference
+      )
+    end
+
+    def message response
+      if response.success?
+        JSON.pretty_generate(response.params)
+      else
+        response.fault_message
+      end
+    end
+  end
+end

data/app/overrides/spree/admin/shared/_order_summary.rb

@@ -0,0 +1,6 @@
+Deface::Override.new(
+  virtual_path: "spree/admin/shared/_order_summary",
+  name: "manual-refund-button",
+  insert_before: "#order_tab_summary",
+  partial: "spree/adyen/manual_refund"
+)

data/app/views/spree/admin/payments/source_forms/_adyen.html.erb

@@ -0,0 +1 @@
+Cannot create Hpp payments on the backend.

data/app/views/spree/admin/payments/source_views/_adyen.html.erb

@@ -0,0 +1,14 @@
+<% content_for :page_actions do %>
+  <li>
+    <%=
+      link_to "View in Customer Area",
+        Spree::Adyen::URL.payment_adyen_customer_area_url(
+          merchant_account: payment.payment_method.preferred_merchant_account,
+          psp_reference: payment.response_code
+        ),
+        class: "button fa"
+    %>
+  </li>
+<% end %>
+
+<%= render Spree::Adyen::Presenters::Communication.from_source(payment.source) %>

data/app/views/spree/adyen/_manual_refund.html.erb

@@ -0,0 +1,9 @@
+<% if @order.requires_manual_refund? %>
+  <%=
+    link_to(
+      t("solidus-adyen.manual_refund.order_button"),
+      Spree::Adyen::URL.modify_search_url(query: @order.number),
+      class: "fa fa-warning button button-error",
+      target: "_blank"
+    )%>
+<% end %>

data/app/views/spree/adyen/communication/_communication.html.erb

@@ -0,0 +1,42 @@
+<%= content_tag :div, class: "#{communication.css_class} clearfix" do %>
+  <div class="adyen-comm">
+    <div class="adyen-comm-body">
+      <div class="adyen-comm-icon">
+        <% if !communication.processed? %>
+          <i
+            class="fa fa-warning adyen-comm-icon-unprocessed"
+            title="<%= t("solidus-adyen.payment.unprocessed")%>"
+            ></i>
+        <% end %>
+        <% if communication.success? %>
+          <i
+            class="fa fa-check adyen-comm-icon-success"
+            title="<%= t("solidus-adyen.payment.success")%>"
+            ></i>
+        <% else %>
+          <i
+            class="fa fa-times adyen-comm-icon-failure"
+            title="<%= t("solidus-adyen.payment.failure")%>"
+            ></i>
+        <% end %>
+      </div>
+      <div>
+        <div class="adyen-comm-content">
+          <% communication.present_fields.each do |name, val| %>
+            <div class="adyen-comm-content-row">
+              <div class="adyen-comm-content-cell">
+                <%= t(".#{name}") %>
+              </div>
+              <div class="adyen-comm-content-cell">
+                <%= val %>
+              </div>
+            </div>
+          <% end %>
+        </div>
+        <p class="adyen-comm-timestamp">
+          <%= communication.created_at_s %>
+        </p>
+      </div>
+    </div>
+  </div>
+<% end %>

data/app/views/spree/adyen/hpps/directory.html.erb

@@ -0,0 +1,10 @@
+<dl>
+  <% @brands.each do |brand| %>
+    <dt>
+      <%= brand[:brand_code] %>
+    </dt>
+    <dd>
+      <%= link_to brand[:name], brand[:payment_url] %>
+    </dd>
+  <% end %>
+</dl>

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

@@ -0,0 +1,33 @@
+<% content_for :head do %>
+  <%= javascript_include_tag 'spree/checkout/payment/adyen.js' %>
+<% end %>
+
+<p>
+  You'll be redirected to Adyen Hosted Payment Pages. After completing the
+  payment form you'll be back to the store.
+</p>
+
+<%= content_tag :div, "", id: 'adyen-hpp-details', data: {
+  url: directory_adyen_hpp_path(
+    order_id: @order.id,
+    payment_method_id: payment_method.id) } %>
+
+<script type="text/javascript">
+$(function() {
+  var spreePaymentRadio = $("#checkout_form_payment input:radio")
+
+  var hideCheckoutButtonForAdyen = function() {
+    if ($("#checkout_form_payment input:radio:checked").val() == <%= payment_method.id %>) {
+      $("#checkout_form_payment .form-buttons").hide();
+    } else {
+      $("#checkout_form_payment .form-buttons").show();
+    }
+  }
+
+  spreePaymentRadio.change(function() {
+    hideCheckoutButtonForAdyen();
+  });
+
+  hideCheckoutButtonForAdyen();
+});
+</script>