spree_gateway 3.8.0 → 3.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '015491170e10b6b22d98da98f5b8e466ae2df12474e5029bff6bd8926d86732e'
-  data.tar.gz: 39713d557a03b1170dc36f4fcf4a6ec2e4fecb45b3a80376b00a23fd396c200b
+  metadata.gz: a29093f977d40e708b032c608a9e25f1949352bee57b9321fa36488000d7711f
+  data.tar.gz: 5f5d7ff9014be360d444df942dc24d1313ef0881e786ac37a49f4fe884b5d0fe
 SHA512:
-  metadata.gz: c9d5003e95dc31701dbea5239a10dc587300d27659f29ea6deba81a309df2d24729ec3259d253d99f4c327c7f8889bc52b28dc8015d785fbde376a128d05a6f1
-  data.tar.gz: 11a5083fba9163eabd567cef8173d949d6f6ac5b86a97f3c65281671d3fd82f6ed93d2f4626c2ac39e7ae71d16cc559735a9d5eb4024960041a1ba2128997ba8
+  metadata.gz: 807b40308555c5149f146fa3fc38c52f10c47ec765a1988f0562adcc296115d43670f09052a80a2493edd166d6d195092e7861ae07457c8c47eedb0cca90559b
+  data.tar.gz: 0ce03934963ea212e16aed6148eff226362d90544789ec1fa283c69dbff81c1d2834c91bce4aab81794935c5d3e825ffb89f07b95d66d1d9994128b11f8e31de

data/.travis.yml

@@ -1,6 +1,8 @@
 os: linux
 dist: bionic
 
+cache: bundler
+
 addons:
   apt:
     sources:
@@ -11,25 +13,18 @@ addons:
 services:
   - mysql
   - postgresql
+  - redis-server
 
 language: ruby
 
 rvm:
-  - 2.6
+  - 2.7
+  - 3.0
 
 env:
   - DB=mysql
   - DB=postgres
 
-gemfile:
-  # - gemfiles/spree_4_1.gemfile
-  - gemfiles/spree_4_2.gemfile
-  - gemfiles/spree_master.gemfile
-
-jobs:
-  allow_failures:
-    - gemfile: gemfiles/spree_master.gemfile
-
 before_install:
   - mysql -u root -e "GRANT ALL ON *.* TO 'travis'@'%';"
 
@@ -41,4 +36,4 @@ before_script:
 
 script:
   - bundle exec rake test_app
-  - bundle exec rake spec
+  - bundle exec rake spec

data/Gemfile

@@ -1,6 +1,8 @@
 source 'https://rubygems.org'
 
 gem 'rails-controller-testing'
-gem 'spree', github: 'spree/spree', branch: 'master'
+gem 'spree', github: 'spree/spree', branch: 'main'
+gem 'spree_backend', github: 'spree/spree', branch: 'main'
+gem 'spree_frontend', github: 'spree/spree', branch: 'main'
 
 gemspec

data/README.md

@@ -1,6 +1,6 @@
 # Spree Gateway
 
-[![Build Status](https://api.travis-ci.org/spree/spree_gateway.svg?branch=master)](https://travis-ci.org/spree/spree_gateway)
+[![Build Status](https://api.travis-ci.org/spree/spree_gateway.svg?branch=main)](https://travis-ci.org/spree/spree_gateway)
 [![Code Climate](https://codeclimate.com/github/spree/spree_gateway.svg)](https://codeclimate.com/github/spree/spree_gateway)
 
 Community supported Spree Payment Method Gateways. It works as a wrapper for
@@ -100,6 +100,6 @@ We are [available for hire][spark].
 
 [1]: http://www.fsf.org/licensing/essays/free-sw.html
 [2]: https://github.com/spree/spree_gateway/issues
-[3]: https://github.com/spree/spree_gateway/blob/master/LICENSE.md
+[3]: https://github.com/spree/spree_gateway/blob/main/LICENSE.md
 [4]: https://github.com/spree
 [5]: https://github.com/spree/spree_gateway/graphs/contributors

data/Rakefile

@@ -2,7 +2,7 @@ require 'bundler'
 Bundler::GemHelper.install_tasks
 
 require 'rspec/core/rake_task'
-require 'spree/testing_support/common_rake'
+require 'spree/testing_support/extension_rake'
 
 RSpec::Core::RakeTask.new
 
@@ -11,5 +11,5 @@ task :default => [:spec]
 desc "Generates a dummy app for testing"
 task :test_app do
   ENV['LIB_NAME'] = 'spree_gateway'
-  Rake::Task['common:test_app'].invoke
+  Rake::Task['extension:test_app'].invoke
 end

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

@@ -9,7 +9,7 @@ module Spree
       Check
     end
 
-    def verify(source, **gateway_options)
+    def verify(source, gateway_options)
       provider.verify(source, gateway_options)
     end
 

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

@@ -1,7 +1,61 @@
 module Spree
   class Gateway::StripeElementsGateway < Gateway::StripeGateway
+    preference :intents, :boolean, default: true
+
     def method_type
       'stripe_elements'
     end
+
+    def provider_class
+      if get_preference(:intents)
+        ActiveMerchant::Billing::StripePaymentIntentsGateway
+      else
+        ActiveMerchant::Billing::StripeGateway
+      end
+    end
+
+    def create_profile(payment)
+      return unless payment.source.gateway_customer_profile_id.nil?
+
+      options = {
+        email: payment.order.email,
+        login: preferred_secret_key
+      }.merge! address_for(payment)
+
+      source = update_source!(payment.source)
+      creditcard = source.gateway_payment_profile_id.present? ? source.gateway_payment_profile_id : source
+      response = provider.store(creditcard, options)
+      if response.success?
+        if get_preference(:intents)
+          payment.source.update!(
+            cc_type: payment.source.cc_type,
+            gateway_customer_profile_id: response.params['id'],
+            gateway_payment_profile_id: response.params['sources']['data'].first['id']
+          )
+        else
+          response_cc_type = response.params['sources']['data'].first['brand']
+          cc_type = CARD_TYPE_MAPPING.include?(response_cc_type) ? CARD_TYPE_MAPPING[response_cc_type] : payment.source.cc_type
+          payment.source.update!({
+            cc_type: cc_type, # side-effect of update_source!
+            gateway_customer_profile_id: response.params['id'],
+            gateway_payment_profile_id: response.params['default_source'] || response.params['default_card']
+          })
+        end
+      else
+        payment.send(:gateway_error, response.message)
+      end
+    end
+
+    private
+
+    def options_for_purchase_or_auth(money, creditcard, gateway_options)
+      money, creditcard, options = super
+      options[:execute_threed] = get_preference(:intents)
+      return money, creditcard, options
+    end
+
+    def public_preference_keys
+      %i[publishable_key test_mode intents]
+    end
   end
 end

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

@@ -54,6 +54,7 @@ module Spree
 
     def create_profile(payment)
       return unless payment.source.gateway_customer_profile_id.nil?
+
       options = {
         email: payment.order.email,
         login: preferred_secret_key,
@@ -142,5 +143,9 @@ module Spree
       url = 'https://spreecommerce.org'
       "#{name_with_version} #{url}"
     end
+
+    def public_preference_keys
+      %i[publishable_key test_mode]
+    end
   end
 end

data/app/models/{spree → spree_gateway}/apple_pay_order_decorator.rb

@@ -1,4 +1,4 @@
-module Spree
+module SpreeGateway
   module ApplePayOrderDecorator
     def confirmation_required?
       return false if paid_with_apple_pay?
@@ -17,4 +17,4 @@ module Spree
   end
 end
 
-Spree::Order.prepend Spree::ApplePayOrderDecorator
+::Spree::Order.prepend(::SpreeGateway::ApplePayOrderDecorator)

data/app/models/{spree → spree_gateway}/apple_pay_payment_decorator.rb

@@ -1,4 +1,4 @@
-module Spree
+module SpreeGateway
   module ApplePayPaymentDecorator
     def apple_pay?
       payment_method.is_a? Spree::Gateway::StripeApplePayGateway
@@ -6,4 +6,4 @@ module Spree
   end
 end
 
-Spree::Payment.prepend Spree::ApplePayPaymentDecorator
+::Spree::Payment.prepend(::SpreeGateway::ApplePayPaymentDecorator)

data/app/models/spree_gateway/credit_card_decorator.rb

@@ -0,0 +1,10 @@
+module SpreeGateway
+  module CreditCardDecorator
+    def set_last_digits
+      self.last_digits ||= number.to_s.length <= 4 ? number : number.to_s.slice(-4..-1)
+    end
+
+  end
+end
+
+::Spree::CreditCard.prepend(::SpreeGateway::CreditCardDecorator)

data/app/models/spree_gateway/order_decorator.rb

@@ -0,0 +1,28 @@
+module SpreeGateway
+  module OrderDecorator
+    def self.prepended(base)
+      return if base.checkout_steps.key?(:payment_confirm)
+
+      base.insert_checkout_step(
+        :payment_confirm,
+        before: :complete,
+        if: ->(order) { order.intents? }
+      )
+    end
+
+    def process_payments!
+      # Payments are processed in confirm_payment step where after successful
+      # 3D Secure authentication `intent_client_key` is saved for payment.
+      # In case authentication is unsuccessful, `intent_client_key` is removed.
+      return if intents? && payments.valid.last.intent_client_key.present?
+
+      super
+    end
+
+    def intents?
+      payments.valid.map { |p| p.payment_method&.has_preference?(:intents) && p.payment_method&.get_preference(:intents) }.any?
+    end
+  end
+end
+
+::Spree::Order.prepend(::SpreeGateway::OrderDecorator)

data/app/models/{spree → spree_gateway}/payment_decorator.rb

@@ -1,5 +1,12 @@
-module Spree
+module SpreeGateway
   module PaymentDecorator
+    def handle_response(response, success_state, failure_state)
+      if response.success? && response.respond_to?(:params)
+        self.intent_client_key = response.params['client_secret'] if response.params['client_secret']
+      end
+      super
+    end
+
     def verify!(**options)
       process_verification(options)
     end
@@ -26,4 +33,4 @@ module Spree
   end
 end
 
-Spree::Payment.prepend Spree::PaymentDecorator
+::Spree::Payment.prepend(::SpreeGateway::PaymentDecorator)

data/app/views/spree/checkout/_payment_confirm.html.erb

@@ -0,0 +1,39 @@
+<div id='errorBox' class='errorExplanation alert alert-danger' style='display:none'></div>
+<div id='successBox' class='alert alert-success' style='display:none'></div>
+<div id='infoBox' class='alert alert-info'><%= t('spree.please_wait_for_confirmation_popup') %></div>
+
+<% if @client_secret.present? && @pk_key.present? %>
+  <script type="text/javascript" src="https://js.stripe.com/v3/"></script>
+  <script>
+    var form = document.getElementById('checkout_form_payment_confirm');
+
+    function confirmCardPaymentResponseHandler(response) {
+      $.post("/api/v2/storefront/intents/handle_response", { response: response, order_token: "<%= @order.token %>" }).done(function (result) {
+          // conditional needs for spree 3.7
+          if(form.elements["commit"]) {
+              form.elements["commit"].disabled = false;
+          }
+        $('#successBox').html(result.message);
+        $('#successBox').show();
+        form.submit();
+      }).fail(function(result) {
+          if(form.elements["commit"]) {
+              form.elements["commit"].disabled = false;
+          }
+        $('#errorBox').html(result.responseJSON.error);
+        $('#errorBox').show();
+      });
+    }
+
+    var stripeElements = Stripe("<%= @pk_key %>");
+    stripeElements.confirmCardPayment("<%= @client_secret %>").then(function(result) {
+      $('#infoBox').hide();
+      confirmCardPaymentResponseHandler(result);
+    });
+
+    document.addEventListener('DOMContentLoaded', function(){
+      form.elements["commit"].value = "continue"
+      form.elements["commit"].disabled = true
+    });
+  </script>
+<% end %>

data/config/locales/en.yml

@@ -10,6 +10,10 @@ en:
   spree:
     check: Check
     payment_has_been_cancelled: The payment has been cancelled.
+    please_wait_for_confirmation_popup: Please wait for payment confirmation popup to appear.
+    payment_successfully_authorized: The payment was successfully authorized.
+    order_state:
+      payment_confirm: Verify payment
     log_entry:
       braintree:
         message: Message

data/config/routes.rb

@@ -4,3 +4,15 @@
 Rails.application.routes.draw do
   get '/.well-known/apple-developer-merchantid-domain-association' => 'spree/apple_pay_domain_verification#show'
 end
+
+Spree::Core::Engine.add_routes do
+  namespace :api, defaults: { format: 'json' } do
+    namespace :v2 do
+      namespace :storefront do
+        namespace :intents do
+          post :handle_response
+        end
+      end
+    end
+  end
+end

data/db/migrate/20200422114908_add_intent_key_to_payment.rb

@@ -0,0 +1,5 @@
+class AddIntentKeyToPayment < ActiveRecord::Migration[4.2]
+  def change
+    add_column :spree_payments, :intent_client_key, :string
+  end
+end

data/lib/controllers/spree/api/v2/storefront/intents_controller.rb

@@ -0,0 +1,27 @@
+module Spree
+  module Api
+    module V2
+      module Storefront
+        class IntentsController < ::Spree::Api::V2::BaseController
+          include Spree::Api::V2::Storefront::OrderConcern
+
+          def handle_response
+            if params['response']['error']
+              invalidate_payment
+              render_error_payload(params['response']['error']['message'])
+            else
+              render_serialized_payload { { message: I18n.t('spree.payment_successfully_authorized') } }
+            end
+          end
+
+          private
+
+          def invalidate_payment
+            payment = spree_current_order.payments.find_by!(response_code: params['response']['error']['payment_intent']['id'])
+            payment.update(state: 'failed', intent_client_key: nil)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spree_frontend/controllers/spree/checkout_controller_decorator.rb

@@ -0,0 +1,19 @@
+module Spree
+  module CheckoutControllerDecorator
+    def self.prepended(base)
+      base.before_action :process_payments_and_set_keys, only: :edit, if: proc { params[:state] == 'payment_confirm' }
+    end
+
+    def process_payments_and_set_keys
+      @order.tap do |order|
+        order.process_payments!
+        order.reload.payments.valid.where.not(intent_client_key: nil).last.tap do |payment|
+          @client_secret = payment.intent_client_key
+          @pk_key = payment.payment_method.preferred_publishable_key
+        end
+      end
+    end
+  end
+end
+
+::Spree::CheckoutController.prepend Spree::CheckoutControllerDecorator

data/lib/spree_gateway/engine.rb

@@ -41,9 +41,18 @@ module SpreeGateway
       Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/spree/*_decorator*.rb')) do |c|
         Rails.application.config.cache_classes ? require(c) : load(c)
       end
+      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/spree_gateway/*_decorator*.rb')) do |c|
+        Rails.application.config.cache_classes ? require(c) : load(c)
+      end
       Dir.glob(File.join(File.dirname(__FILE__), '../../lib/active_merchant/**/*_decorator*.rb')) do |c|
         Rails.application.config.cache_classes ? require(c) : load(c)
       end
+
+      if self.frontend_available?
+        Dir.glob(File.join(File.dirname(__FILE__), '../../lib/spree_frontend/controllers/spree/*_decorator*.rb')) do |c|
+          Rails.application.config.cache_classes ? require(c) : load(c)
+        end
+      end
     end
 
     def self.backend_available?
@@ -61,6 +70,7 @@ module SpreeGateway
     paths['app/controllers'] << 'lib/controllers'
 
     if self.frontend_available?
+      paths["app/controllers"] << "lib/spree_frontend/controllers"
       paths["app/views"] << "lib/views/frontend"
     end
 

data/lib/spree_gateway/version.rb

@@ -1,5 +1,5 @@
 module SpreeGateway
   def self.version
-    '3.8.0'
+    '3.9.4'
   end
 end

data/lib/views/frontend/spree/checkout/payment/_stripe_elements.html.erb

@@ -103,7 +103,8 @@
       }
     });
   };
-  
+
 </script>
 
 <%= render 'spree/checkout/payment/stripe_additional_info' %>
+