solidus_stripe 3.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9e6ec7ddfb05d802b145edb2e2e50d58510148be740c085dd0a7eb99a8e367b
-  data.tar.gz: c6598070cbe6c6e18504f27ab999ef0ca6d1b331ecdee9e1838434c261fe699d
+  metadata.gz: c27f15c92bf2fcee8f467f66e8c1c261baf7d0909f86e7df87e8ce9547cc2951
+  data.tar.gz: b6ae23186cd51fc4b7938081d26df066a1b45903a3fcbb29db39d83106e520e4
 SHA512:
-  metadata.gz: 8faba0fdc2be35b90a936273a8d3aedf2411a10e8c01489c5a66b5859fbbcccb38ffcfec3e9d2a34dcdbf065228396b3047210cdbcbb0818c495ff2abf76f098
-  data.tar.gz: 82f01e68ff9a5fa8bcc74c759c3974d78cf05411b83cb732ca0ef32553d62d920697093db371a174c826d3391ca19908f0e4a35a4ae152863c61a94ae595f2c4
+  metadata.gz: 799216217f0bf2353e94c598dc9e49187c44004f9c25dc254d13a3e5805751e8fddabaf45f83c3cc422ed561b12d0e7260cf4367d71dd614086c4d9f2d2521c6
+  data.tar.gz: 322e5c0299a3afc1555057cd10685a1f5c6ad3f446dd592326084be7959e93c009cb092f8d9fe688682527653d7078ec58c49506ba593f4b4b688d8fa81a549e

data/.gitignore

@@ -16,3 +16,4 @@ pkg
 *.swp
 spec/dummy
 spec/examples.txt
+/sandbox

data/.rubocop.yml

@@ -1,2 +1,7 @@
 require:
   - solidus_dev_support/rubocop
+
+AllCops:
+  Exclude:
+    - sandbox/**/*
+    - spec/dummy/**/*

data/CHANGELOG.md

@@ -1,5 +1,60 @@
 # Changelog
 
+## [v4.0.0](https://github.com/solidusio/solidus_stripe/tree/v4.0.0) (2020-04-29)
+
+[Full Changelog](https://github.com/solidusio/solidus_stripe/compare/v3.0.0...v4.0.0)
+
+**Fixed bugs:**
+
+- Duplicates charges with Payment Intents [\#44](https://github.com/solidusio/solidus_stripe/issues/44)
+- Fix for 3D-Secure payments on cart page checkout [\#49](https://github.com/solidusio/solidus_stripe/pull/49) ([spaghetticode](https://github.com/spaghetticode))
+- Send form data also when paying with payment request button [\#47](https://github.com/solidusio/solidus_stripe/pull/47) ([spaghetticode](https://github.com/spaghetticode))
+- Create a single charge when using Stripe Payment Intents [\#45](https://github.com/solidusio/solidus_stripe/pull/45) ([spaghetticode](https://github.com/spaghetticode))
+
+**Closed issues:**
+
+- Custom stripe element field options \(e.g for showing a credit card icon\) [\#41](https://github.com/solidusio/solidus_stripe/issues/41)
+- Stripe Elements submit button stuck in disabled state. [\#39](https://github.com/solidusio/solidus_stripe/issues/39)
+- Visa credit card type is blank [\#36](https://github.com/solidusio/solidus_stripe/issues/36)
+- Pay with Apple Pay from cart page [\#23](https://github.com/solidusio/solidus_stripe/issues/23)
+- Clearer documentation on how to implement [\#15](https://github.com/solidusio/solidus_stripe/issues/15)
+
+**Merged pull requests:**
+
+- Relax solidus\_support dependency [\#48](https://github.com/solidusio/solidus_stripe/pull/48) ([kennyadsl](https://github.com/kennyadsl))
+- Replace deprecated route `/stripe/confirm\_payment` [\#46](https://github.com/solidusio/solidus_stripe/pull/46) ([spaghetticode](https://github.com/spaghetticode))
+- Custom Stripe Elements field options [\#42](https://github.com/solidusio/solidus_stripe/pull/42) ([stuffmatic](https://github.com/stuffmatic))
+- Improve the way Stripe Elements validation errors are displayed [\#40](https://github.com/solidusio/solidus_stripe/pull/40) ([stuffmatic](https://github.com/stuffmatic))
+- Fix stripe-to-solidus card type mapping [\#38](https://github.com/solidusio/solidus_stripe/pull/38) ([stuffmatic](https://github.com/stuffmatic))
+- Add hook to provide custom Stripe Elements options [\#37](https://github.com/solidusio/solidus_stripe/pull/37) ([stuffmatic](https://github.com/stuffmatic))
+- Change order description that we pass to Stripe [\#35](https://github.com/solidusio/solidus_stripe/pull/35) ([kennyadsl](https://github.com/kennyadsl))
+
+## [v3.0.0](https://github.com/solidusio/solidus_stripe/tree/v3.0.0) (2020-03-11)
+
+[Full Changelog](https://github.com/solidusio/solidus_stripe/compare/v2.1.0...v3.0.0)
+
+**Implemented enhancements:**
+
+- Rename v3/stripe partial as v3/elements [\#30](https://github.com/solidusio/solidus_stripe/pull/30) ([spaghetticode](https://github.com/spaghetticode))
+
+**Merged pull requests:**
+
+- Allow to customize Stripe Elements styles via JS [\#34](https://github.com/solidusio/solidus_stripe/pull/34) ([spaghetticode](https://github.com/spaghetticode))
+- Stop injecting css in host app while installing [\#33](https://github.com/solidusio/solidus_stripe/pull/33) ([kennyadsl](https://github.com/kennyadsl))
+- Manage Stripe V3 JS code via Sprokets [\#32](https://github.com/solidusio/solidus_stripe/pull/32) ([spaghetticode](https://github.com/spaghetticode))
+
+## [v2.1.0](https://github.com/solidusio/solidus_stripe/tree/v2.1.0) (2020-03-11)
+
+[Full Changelog](https://github.com/solidusio/solidus_stripe/compare/v2.0.0...v2.1.0)
+
+**Closed issues:**
+
+- Preference :stripe\_country is not defined on Spree::PaymentMethod::StripeCreditCard \(RuntimeError\) [\#27](https://github.com/solidusio/solidus_stripe/issues/27)
+
+**Merged pull requests:**
+
+- Refactor Stripe V3 Intents, Elements and cart checkout JS code [\#31](https://github.com/solidusio/solidus_stripe/pull/31) ([spaghetticode](https://github.com/spaghetticode))
+
 ## [v2.0.0](https://github.com/solidusio/solidus_stripe/tree/v2.0.0) (2020-03-03)
 
 [Full Changelog](https://github.com/solidusio/solidus_stripe/compare/v1.2.0...v2.0.0)

data/Gemfile

@@ -30,3 +30,10 @@ group :development, :test do
 end
 
 gemspec
+
+# Use a local Gemfile to include development dependencies that might not be
+# relevant for the project or for other contributors, e.g. pry-byebug.
+#
+# We use `send` instead of calling `eval_gemfile` to work around an issue with
+# how Dependabot parses projects: https://github.com/dependabot/dependabot-core/issues/1658.
+send(:eval_gemfile, 'Gemfile-local') if File.exist? 'Gemfile-local'

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2020 Solidus Team
+Copyright (c) 2014 Spree Commerce Inc. and other contributors.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,
@@ -9,7 +9,7 @@ are permitted provided that the following conditions are met:
     * Redistributions in binary form must reproduce the above copyright notice,
       this list of conditions and the following disclaimer in the documentation
       and/or other materials provided with the distribution.
-    * Neither the name Solidus nor the names of its contributors may be used to
+    * Neither the name Spree nor the names of its contributors may be used to
       endorse or promote products derived from this software without specific
       prior written permission.
 

data/README.md

@@ -13,7 +13,7 @@ Installation
 In your Gemfile:
 
 ```ruby
-gem 'solidus_stripe', '~> 1.0.0'
+gem 'solidus_stripe', '~> 3.0'
 ```
 
 Then run from the command line:
@@ -107,6 +107,25 @@ Spree.config do |config|
 end
 ```
 
+When using the Payment Intents API, be aware that the charge flow will be a bit
+different than when using the old V2 API or Elements. It's advisable that all
+Payment Intents charges are captured only by using the Solidus backend, as it is
+the final source of truth in regards of Solidus orders payments.
+
+A Payment Intent is created as soon as the customer enters their credit card
+data. A tentative charge will be created on Stripe, easily recognizable by its
+description: `Solidus Order ID: R987654321 (pending)`. As soon as the credit
+card is confirmed (ie. when the customer passes the 3DSecure authorization, when
+required) then the charge description gets updated to include the Solidus payment
+number: `Solidus Order ID: R987654321-Z4VYUDB3`.
+
+These charges are created `uncaptured` and will need to be captured in Solidus
+backend later, after the customer confirms the order. If the customer never
+completes the checkout, that charge must remain uncaptured. If the customer
+decides to change their payment method after creating a Payment Request, then
+that Payment Request charge will be canceled.
+
+
 Apple Pay and Google Pay
 -----------------------
 
@@ -119,14 +138,11 @@ Stripe account to receive payments via Apple Pay.
 It's possible to pay with Apple Pay and Google Pay directly from the cart
 page. The functionality is self-contained in the view partial
 `_stripe_payment_request_button.html.erb`. In order to use it, you need
-to load that partial in the `orders#edit` frontend page, and pass it the
+to render that partial in the `orders#edit` frontend page, and pass it the
 payment method configured for Stripe via the local variable
-`cart_checkout_payment_method`, for example using `deface`:
+`cart_checkout_payment_method`:
 
 ```ruby
-# app/overrides/spree/orders/edit/add_payment_request_button.html.erb.deface
-
-<!-- insert_after '[data-hook="cart_container"]' -->
 <%= render 'stripe_payment_request_button', cart_checkout_payment_method: Spree::PaymentMethod::StripeCreditCard.first %>
 ```
 
@@ -155,13 +171,13 @@ SolidusStripe.CartPageCheckout.prototype.onPrButtonMounted = function(id, result
 }
 ```
 
-Styling Stripe Elements
+Customizing Stripe Elements
 -----------------------
 
-The Elements feature built in this gem come with some standard styles. If you want
-to customize it, you can override the `SolidusStripe.Elements.prototype.baseStyle`
-method and make it return a valid [Stripe Style](https://stripe.com/docs/js/appendix/style)
-object:
+### Styling input fields
+
+The default style this gem provides for Stripe Elements input fields is defined in `SolidusStripe.Elements.prototype.baseStyle`. You can override this method to return your own custom style (make sure it returns a valid [Stripe Style](https://stripe.com/docs/js/appendix/style)
+object):
 
 ```js
 SolidusStripe.Elements.prototype.baseStyle = function () {
@@ -208,6 +224,46 @@ You can also style your element containers directly by using CSS rules like this
   }
 ```
 
+### Customizing individual input fields
+
+If you want to customize individual input fields, you can override these methods
+
+* `SolidusStripe.Elements.prototype.cardNumberElementOptions`
+* `SolidusStripe.Elements.prototype.cardExpiryElementOptions`
+* `SolidusStripe.Elements.prototype.cardCvcElementOptions`
+
+and return a valid [options object](https://stripe.com/docs/js/elements_object/create_element?type=cardNumber) for the corresponding field type. For example, this code sets a custom placeholder and enables the credit card icon for the card number field
+
+```js
+SolidusStripe.Elements.prototype.cardNumberElementOptions = function () {
+  return {
+    style: this.baseStyle(),
+    showIcon: true,
+    placeholder: "I'm a custom placeholder!"
+  }
+}
+```
+
+### Passing options to the Stripe Elements instance
+
+By overriding the `SolidusStripe.Payment.prototype.elementsBaseOptions` method and returning a [valid options object](https://stripe.com/docs/js/elements_object/create), you can pass custom options to the Stripe Elements instance.
+
+Note that in order to use web fonts with Stripe Elements, you must specify the fonts when creating the Stripe Elements instance. Here's an example specifying a custom web font and locale:
+
+```js
+SolidusStripe.Payment.prototype.elementsBaseOptions = function () {
+  return {
+    locale: 'de',
+    fonts: [
+      {
+        cssSrc: 'https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,600'
+      }
+    ]
+  };
+};
+```
+
+
 Migrating from solidus_gateway
 ------------------------------
 
@@ -254,3 +310,5 @@ gem bump --version minor --remote upstream
 gem tag --remote upstream
 gem release
 ```
+
+Copyright (c) 2020 Spree Commerce Inc., released under the New BSD License

data/Rakefile

@@ -3,4 +3,4 @@
 require 'solidus_dev_support/rake_tasks'
 SolidusDevSupport::RakeTasks.install
 
-task default: %w[extension:test_app extension:specs]
+task default: 'extension:specs'

data/app/assets/javascripts/spree/frontend/solidus_stripe/stripe-cart-page-checkout.js

@@ -16,11 +16,14 @@ SolidusStripe.CartPageCheckout.prototype.init = function() {
 };
 
 SolidusStripe.CartPageCheckout.prototype.showError = function(error) {
-  this.errorElement.text(error).show();
+  var message = error.message || error;
+
+  this.errorElement.text(message).show();
 };
 
 SolidusStripe.CartPageCheckout.prototype.submitPayment = function(payment) {
   var showError = this.showError.bind(this);
+  var prTokenHandler = this.prTokenHandler.bind(this);
 
   $.ajax({
     url: $('[data-submit-url]').data('submit-url'),
@@ -29,7 +32,7 @@ SolidusStripe.CartPageCheckout.prototype.submitPayment = function(payment) {
     },
     type: 'PATCH',
     contentType: 'application/json',
-    data: JSON.stringify(this.prTokenHandler(payment.paymentMethod)),
+    data: JSON.stringify(prTokenHandler(payment.paymentMethod)),
     success: function() {
       window.location = $('[data-complete-url]').data('complete-url');
     },
@@ -39,26 +42,56 @@ SolidusStripe.CartPageCheckout.prototype.submitPayment = function(payment) {
   });
 };
 
-SolidusStripe.CartPageCheckout.prototype.onPrPayment = function(result) {
-  var handleServerResponse = this.handleServerResponse.bind(this);
+SolidusStripe.CartPageCheckout.prototype.onPrPayment = function(payment) {
+  var createIntent = this.createIntent.bind(this);
 
   fetch('/stripe/update_order', {
     method: 'POST',
     headers: { 'Content-Type': 'application/json' },
     body: JSON.stringify({
-      shipping_address: result.shippingAddress,
-      shipping_option: result.shippingOption,
-      email: result.payerEmail,
-      name: result.payerName,
+      shipping_address: payment.shippingAddress,
+      shipping_option: payment.shippingOption,
+      email: payment.payerEmail,
+      name: payment.payerName,
       authenticity_token: this.authToken
     })
   }).then(function(response) {
     response.json().then(function(json) {
-      handleServerResponse(json, result);
+      createIntent(json, payment);
     })
   });
 };
 
+SolidusStripe.CartPageCheckout.prototype.createIntent = function(result, payment) {
+  var handleServerResponse = this.handleServerResponse.bind(this);
+
+  if (result.error) {
+    this.completePaymentRequest(payment, 'fail');
+    this.showError(result.error);
+  } else {
+    if (payment.error) {
+      this.showError(payment.error.message);
+    } else {
+      fetch('/stripe/create_intent', {
+        method: 'POST',
+        headers: {
+          'Content-Type': 'application/json'
+        },
+        body: JSON.stringify({
+          form_data: payment.shippingAddress,
+          spree_payment_method_id: this.config.id,
+          stripe_payment_method_id: payment.paymentMethod.id,
+          authenticity_token: this.authToken
+        })
+      }).then(function(response) {
+        response.json().then(function(result) {
+          handleServerResponse(result, payment)
+        })
+      });
+    }
+  }
+};
+
 SolidusStripe.CartPageCheckout.prototype.onPrButtonMounted = function(buttonId, success) {
   var container = document.getElementById(buttonId).parentElement;
 

data/app/assets/javascripts/spree/frontend/solidus_stripe/stripe-elements.js

@@ -18,29 +18,45 @@ SolidusStripe.Elements.prototype.init = function() {
 };
 
 SolidusStripe.Elements.prototype.initElements = function() {
-  var buildElements = function(elements) {
-    var style = this.baseStyle();
+  var cardExpiry = this.elements.create('cardExpiry', this.cardExpiryElementOptions());
+  cardExpiry.mount('#card_expiry');
 
-    elements.create('cardExpiry', {style: style}).mount('#card_expiry');
-    elements.create('cardCvc', {style: style}).mount('#card_cvc');
+  var cardCvc = this.elements.create('cardCvc', this.cardCvcElementOptions());
+  cardCvc.mount('#card_cvc');
 
-    var cardNumber = elements.create('cardNumber', {style: style});
-    cardNumber.mount('#card_number');
+  this.cardNumber = this.elements.create('cardNumber', this.cardNumberElementOptions());
+  this.cardNumber.mount('#card_number');
 
-    return cardNumber;
-  }.bind(this);
-
-  this.cardNumber = buildElements(this.elements);
-
-  var cardChange = function(event) {
-    if (event.error) {
-      this.showError(event.error.message);
-    } else {
-      this.errorElement.hide().text('');
-    }
-  };
-  this.cardNumber.addEventListener('change', cardChange.bind(this));
   this.form.bind('submit', this.onFormSubmit.bind(this));
+
+  // Listen for errors from each input field.
+  // Adapted from https://github.com/stripe/elements-examples/blob/master/js/index.js
+  var savedErrors = {};
+  [cardExpiry, cardCvc, this.cardNumber].forEach(function(element, idx) {
+    element.on('change', function(event) {
+      if (event.error) {
+        savedErrors[idx] = event.error.message;
+        this.showError(event.error.message);
+      } else {
+        savedErrors[idx] = null;
+
+        // Loop over the saved errors and find the first one, if any.
+        var nextError = Object.keys(savedErrors)
+          .sort()
+          .reduce(function(maybeFoundError, key) {
+            return maybeFoundError || savedErrors[key];
+          }, null);
+
+        if (nextError) {
+          // Now that they've fixed the current error, show another one.
+          this.showError(nextError);
+        } else {
+          // The user fixed the last error; no more errors.
+          this.errorElement.hide().text('');
+        }
+      }
+    }.bind(this));
+  }.bind(this));
 };
 
 SolidusStripe.Elements.prototype.baseStyle = function () {
@@ -61,6 +77,24 @@ SolidusStripe.Elements.prototype.baseStyle = function () {
   };
 };
 
+SolidusStripe.Elements.prototype.cardNumberElementOptions = function () {
+  return {
+    style: this.baseStyle()
+  }
+}
+
+SolidusStripe.Elements.prototype.cardExpiryElementOptions = function () {
+  return {
+    style: this.baseStyle()
+  }
+}
+
+SolidusStripe.Elements.prototype.cardCvcElementOptions = function () {
+  return {
+    style: this.baseStyle()
+  }
+}
+
 SolidusStripe.Elements.prototype.showError = function(error) {
   var message = error.message || error;
 
@@ -87,18 +121,20 @@ SolidusStripe.Elements.prototype.onFormSubmit = function(event) {
 
 SolidusStripe.Elements.prototype.elementsTokenHandler = function(token) {
   var mapCC = function(ccType) {
-    if (ccType === 'MasterCard') {
+    if (ccType === 'MasterCard' || ccType === 'mastercard') {
       return 'mastercard';
-    } else if (ccType === 'Visa') {
+    } else if (ccType === 'Visa' || ccType === 'visa') {
       return 'visa';
-    } else if (ccType === 'American Express') {
+    } else if (ccType === 'American Express' || ccType === 'amex') {
       return 'amex';
-    } else if (ccType === 'Discover') {
+    } else if (ccType === 'Discover' || ccType === 'discover') {
       return 'discover';
-    } else if (ccType === 'Diners Club') {
+    } else if (ccType === 'Diners Club' || ccType === 'diners') {
       return 'dinersclub';
-    } else if (ccType === 'JCB') {
+    } else if (ccType === 'JCB' || ccType === 'jcb') {
       return 'jcb';
+    } else if (ccType === 'Unionpay' || ccType === 'unionpay') {
+      return 'unionpay';
     }
   };
 

data/app/assets/javascripts/spree/frontend/solidus_stripe/stripe-payment-intents.js

@@ -21,12 +21,13 @@ SolidusStripe.PaymentIntents.prototype.onPrPayment = function(payment) {
     var that = this;
 
     this.elementsTokenHandler(payment.paymentMethod);
-    fetch('/stripe/confirm_payment', {
+    fetch('/stripe/create_intent', {
       method: 'POST',
       headers: {
         'Content-Type': 'application/json'
       },
       body: JSON.stringify({
+        form_data: this.form.serialize(),
         spree_payment_method_id: this.config.id,
         stripe_payment_method_id: payment.paymentMethod.id,
         authenticity_token: this.authToken
@@ -63,12 +64,13 @@ SolidusStripe.PaymentIntents.prototype.onIntentsPayment = function(payment) {
     var that = this;
 
     this.elementsTokenHandler(payment.paymentMethod);
-    fetch('/stripe/confirm_intents', {
+    fetch('/stripe/create_intent', {
       method: 'POST',
       headers: {
         'Content-Type': 'application/json'
       },
       body: JSON.stringify({
+        form_data: this.form.serialize(),
         spree_payment_method_id: this.config.id,
         stripe_payment_method_id: payment.paymentMethod.id,
         authenticity_token: this.authToken