solidus_paypal_braintree 0.4.0 → 1.0.0

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2016 Stembolt
+Copyright (c) 2016-2020 Stembolt 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 Spree nor the names of its contributors may be used to
+    * Neither the name Solidus 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

@@ -1,7 +1,7 @@
 SolidusPaypalBraintree
 ======================
 
-[![Build Status](https://travis-ci.org/solidusio/solidus_paypal_braintree.svg?branch=master)](https://travis-ci.org/solidusio/solidus_paypal_braintree)
+[![CircleCI](https://circleci.com/gh/solidusio/solidus_paypal_braintree.svg?style=svg)](https://circleci.com/gh/solidusio/solidus_paypal_braintree)
 
 `solidus_paypal_braintree` is an extension that adds support for using [Braintree](https://www.braintreepayments.com) as a payment source in your [Solidus](https://solidus.io/) store. It supports Apple Pay, PayPal, and credit card transactions.
 
@@ -39,14 +39,15 @@ Payment methods can accept preferences either directly entered in admin, or from
 1. Set static preferences in an initializer
   ```ruby
   # config/initializers/spree.rb
-  Spree::Config.configure do |config|
+  Spree::Config.config do |config|
     config.static_model_preferences.add(
       SolidusPaypalBraintree::Gateway,
       'braintree_credentials', {
         environment: Rails.env.production? ? 'production' : 'sandbox',
         merchant_id: ENV['BRAINTREE_MERCHANT_ID'],
         public_key: ENV['BRAINTREE_PUBLIC_KEY'],
-        private_key: ENV['BRAINTREE_PRIVATE_KEY']
+        private_key: ENV['BRAINTREE_PRIVATE_KEY'],
+        paypal_flow: 'vault', # 'checkout' is accepted too
       }
     )
   end
@@ -72,7 +73,7 @@ SolidusPaypalBraintree::Gateway.new(
 ```
 
 ### Configure payment types
-Your payment method can accept payments in three ways: through Paypal, through ApplePay, or with credit card details entered directly by the customer. By default all are disabled for all your site's stores.
+Your payment method can accept payments in three ways: through Paypal, through ApplePay, or with credit card details entered directly by the customer. By default all are disabled for all your site's stores. Before proceeding to checkout, ensure you've created a Braintree configuration for your store:
 
 1. Visit /solidus_paypal_braintree/configurations/list
 
@@ -122,8 +123,8 @@ The following is a relatively bare-bones implementation to enable Apple Pay on t
       amount: "<%= current_order.total %>",
       shippingContact: {
         emailAddress: '<%= current_order.email %>',
-        familyName: '<%= address.firstname %>',
-        givenName: '<%= address.lastname %>',
+        givenName: '<%= address.firstname %>',
+        familyName: '<%= address.lastname %>',
         phoneNumber: '<%= address.phone %>',
         addressLines: ['<%= address.address1 %>','<%= address.address2 %>'],
         locality: '<%= address.city %>',
@@ -152,32 +153,32 @@ It will only be displayed if the `SolidusPaypalBraintree::Gateway` payment
 method is configured to display on the frontend and PayPal is enabled in the
 store's configuration.
 
+You can find button configuration options in 
+`/solidus_paypal_braintree/configurations/list` if you want to change the color,
+shape, layout, and a few other options. Keep in mind that the `paypal_button_tagline`
+does not work when the `paypal_button_layout` is set to `vertical`, and will be
+ignored in that case.
+
 The checkout view
 [initializes the PayPal button](/lib/views/frontend/spree/checkout/payment/_paypal_braintree.html.erb)
 using the
-[vault flow](https://developers.braintreepayments.com/guides/paypal/overview/javascript/v3),
-which allows the source to be reused.
+[Vault flow](https://developers.braintreepayments.com/guides/paypal/overview/javascript/v3),
+which allows the source to be reused. Please note that PayPal messaging is disabled with vault flow. If you want, you can use [Checkout with PayPal](https://developers.braintreepayments.com/guides/paypal/checkout-with-paypal/javascript/v3)
+instead, which doesn't allow you to reuse sources but allows your customers to pay with their PayPal
+balance and with PayPal financing options ([see setup instructions](#create-a-new-payment-method)).
 
 If you are creating your own checkout view or would like to customize the
 [options that get passed to tokenize](https://braintree.github.io/braintree-web/3.6.3/PayPal.html#tokenize)
-, you can initialize your own using the `PaypalButton` JS object:
+, you can initialize your own using the `CreatePaypalButton` JS object:
 
 ```javascript
-var button = new PaypalButton(document.querySelector("#your-button-id"));
-
-button.initialize({
+var paypalOptions = {
   // your configuration options here
-});
-```
+}
 
-After successful tokenization, a callback function is invoked that submits the
-transaction via AJAX and advances the order to confirm. It is possible to provide
-your own callback function to customize the behaviour after tokenize as follows:
+var button = new SolidusPaypalBraintree.createPaypalButton(document.querySelector("#your-button-id"), paypalOptions);
 
-```javascript
-var button = new PaypalButton(document.querySelector("#your-button-id"));
-
-button.setTokenizeCallback(your-callback);
+button.initialize();
 ```
 
 ### Express checkout from the cart
@@ -187,6 +188,30 @@ A PayPal button can also be included on the cart view to enable express checkout
 render "spree/shared/paypal_cart_button"
 ```
 
+### PayPal Financing Messaging
+
+PayPal offers an [on-site messaging component](https://www.paypal.com/us/webapps/mpp/on-site-messaging) to notify the customer that there are financing options available. This component is included in both the cart and checkout partials, but is disabled by default. To enable this option, you'll need to use the `checkout` flow, and set the `paypal button messaging` option to `true` in your Braintree configuration.
+
+You can also include this view partial to implement this messaging component anywhere - for instance, on the product page:
+```ruby
+render "spree/shared/paypal_messaging, options: {total: @product.price, placement: "product", currency: 'USD'}"
+```
+
+While we provide the messaging component on the payment buttons for cart and checkout, you're expected to move these to where they make the most sense for your frontend. PayPal recommends keeping the messaging directly below wherever the order or product total is located.
+
+#### PayPal configuration
+
+If your store requires the [phone number into user addresses](https://github.com/solidusio/solidus/blob/859143f3f061de79cc1b385234599422b8ae8e21/core/app/models/spree/address.rb#L151-L153)
+you'll need to configure PayPal to return the phone back when it returns the
+address used by the user:
+
+1. Log into your PayPal account
+2. Go to Profile -> My Selling Tools -> Website preferences
+3. Set Contact Telephone to `On (Required Field)` or `On (Optional Field)`
+
+Using the option `Off` will not make the address valid and will raise a
+validation error.
+
 ## Optional configuration
 
 ### Accepting multiple currencies
@@ -195,7 +220,12 @@ This preference allows users to provide different Merchant Account Ids for
 different currencies. If you only plan to accept payment in one currency, the
 defaut Merchant Account Id will be used and you can omit this option.
 An example of setting this preference can be found
-[here](https://github.com/solidusio/solidus_paypal_braintree/blob/master/spec/spec_helper.rb#L70-L72).
+[here](https://github.com/solidusio/solidus_paypal_braintree/blob/bf5fe0e154d38f7c498f1c54450bb4de7608ff04/spec/support/gateway_helpers.rb#L11-L13).
+
+In addition to this, you can also specify different PayPal accounts for each
+currency by using the `paypal_payee_email_map` preference. If you only want
+to use one PayPal account for all currencies, then you can ignore this option.
+You can find an example of setting this preference [here](https://github.com/solidusio/solidus_paypal_braintree/blob/bf5fe0e154d38f7c498f1c54450bb4de7608ff04/spec/support/gateway_helpers.rb#L14-L16).
 
 ### Default store configuration
 The migrations for this gem will add a default configuration to all stores that
@@ -204,9 +234,33 @@ has each payment type disabled. It also adds a `before_create` callback to
 default configuration that gets created by overriding the private
 `build_default_configuration` method on `Spree::Store`.
 
+### Hosted Fields Styling
+You can style the Braintree credit card fields by using the `credit_card_fields_style` preference on the payment method. The `credit_card_fields_style` will be passed to the `style` key when initializing the credit card fields. You can find more information about styling hosted fields can be found [here.](https://developers.braintreepayments.com/guides/hosted-fields/styling/javascript/v3)
+
+You can also use the `placeholder_text` preference on the payment method to set the placeholder text you'd like to use for each of the hosted fields. You'll pass the field name in as the key, and the placeholder text you'd like to use as the value. For example:
+```ruby
+  { number: "Enter card number", cvv: "Enter CVV", expirationDate: "mm/yy" }
+```
+
+### 3D Secure
+
+This gem supports [3D Secure 2](https://developers.braintreepayments.com/guides/3d-secure/overview),
+which satisfies the [Strong Customer Authentication (SCA)](https://www.braintreepayments.com/blog/getting-up-to-speed-on-psd2-regulation-2/)
+requirements introduced by PSD2.
+
+3D Secure can be enabled from Solidus Admin -> Braintree (left-side menu) ->
+tick _3D Secure_ checkbox.
+
+Once enabled, you can use the following card numbers to test 3DS 2 on your
+client side in sandbox:
+https://developers.braintreepayments.com/guides/3d-secure/migration/javascript/v3#client-side-sandbox-testing.
+
 Testing
 -------
 
+To run the specs it is required to set the Braintree test account data in these environment variables:
+`BRAINTREE_PUBLIC_KEY`, `BRAINTREE_PRIVATE_KEY`, `BRAINTREE_MERCHANT_ID` and `BRAINTREE_PAYPAL_PAYEE_EMAIL`
+
 First bundle your dependencies, then run `rake`. `rake` will default to building the dummy app if it does not exist, then it will run specs, and [Rubocop](https://github.com/bbatsov/rubocop) static code analysis. The dummy app can be regenerated by using `rake test_app`.
 
 ```shell
@@ -221,4 +275,4 @@ Simply add this require statement to your spec_helper:
 require 'solidus_paypal_braintree/factories'
 ```
 
-Copyright (c) 2016 Stembolt, released under the New BSD License
+Copyright (c) 2016-2020 Stembolt and others contributors, released under the New BSD License

data/Rakefile

@@ -1,27 +1,6 @@
-require 'bundler'
+# frozen_string_literal: true
 
-Bundler::GemHelper.install_tasks
+require 'solidus_dev_support/rake_tasks'
+SolidusDevSupport::RakeTasks.install
 
-begin
-  require 'spree/testing_support/extension_rake'
-  require 'rspec/core/rake_task'
-
-  RSpec::Core::RakeTask.new(:spec)
-
-  task default: %i(first_run spec)
-rescue LoadError
-  # no rspec available
-end
-
-task :first_run do
-  if Dir['spec/dummy'].empty?
-    Rake::Task[:test_app].invoke
-    Dir.chdir('../../')
-  end
-end
-
-desc 'Generates a dummy app for testing'
-task :test_app do
-  ENV['LIB_NAME'] = 'solidus_paypal_braintree'
-  Rake::Task['extension:test_app'].invoke
-end
+task default: 'extension:specs'

data/app/assets/javascripts/solidus_paypal_braintree/checkout.js

@@ -15,11 +15,18 @@ $(function() {
      * https://github.com/rails/jquery-rails/blob/master/vendor/assets/javascripts/jquery_ujs.js#L517
      * The only way we can re-enable it is by delaying longer than that timeout
      * or stopping propagation so their submit handler doesn't run. */
-    if ($.rails) {
+    if ($.rails && typeof $.rails.enableFormElement !== 'undefined') {
       setTimeout(function () {
         $.rails.enableFormElement($submitButton);
         $submitButton.attr("disabled", false).removeClass("disabled").addClass("primary");
       }, 100);
+    } else if (typeof Rails !== 'undefined' && typeof Rails.enableElement !== 'undefined') {
+      /* Indicates that we have rails-ujs instead of jquery-ujs. Rails-ujs was added to rails
+       * core in Rails 5.1.0 */
+      setTimeout(function () {
+        Rails.enableElement($submitButton[0]);
+        $submitButton.attr("disabled", false).removeClass("disabled").addClass("primary");
+      }, 100);
     } else {
       $submitButton.attr("disabled", false).removeClass("disabled").addClass("primary");
     }
@@ -37,16 +44,38 @@ $(function() {
         var $nonce = $("#payment_method_nonce", $field);
 
         if ($nonce.length > 0 && $nonce.val() === "") {
+          var client = braintreeForm._merchantConfigurationOptions._solidusClient;
+
           event.preventDefault();
           disableSubmit();
 
           braintreeForm.tokenize(function(error, payload) {
             if (error) {
               braintreeError(error);
-            } else {
-              $nonce.val(payload.nonce);
+              return;
+            }
+
+            $nonce.val(payload.nonce);
+
+            if (!client.useThreeDSecure) {
               $paymentForm.submit();
+              return;
+            }
+
+            threeDSecureOptions.nonce = payload.nonce;
+            threeDSecureOptions.bin = payload.details.bin;
+            threeDSecureOptions.onLookupComplete = function(data, next) {
+              next();
             }
+            client._threeDSecureInstance.verifyCard(threeDSecureOptions, function(error, response) {
+              if (error === null && (!response.liabilityShiftPossible || response.liabilityShifted)) {
+                $nonce.val(response.nonce);
+                $paymentForm.submit();
+              } else {
+                $nonce.val('');
+                braintreeError(error || { code: 'THREEDS_AUTHENTICATION_FAILED' });
+              }
+            });
           });
         }
       }

data/app/assets/javascripts/solidus_paypal_braintree/client.js

@@ -57,10 +57,12 @@ SolidusPaypalBraintree.Client = function(config) {
   this.useDataCollector = config.useDataCollector;
   this.usePaypal = config.usePaypal;
   this.useApplepay = config.useApplepay;
+  this.useThreeDSecure = config.useThreeDSecure;
 
   this._braintreeInstance = null;
   this._dataCollectorInstance = null;
   this._paypalInstance = null;
+  this._threeDSecureInstance = null;
 };
 
 /**
@@ -71,18 +73,22 @@ SolidusPaypalBraintree.Client.prototype.initialize = function() {
   var initializationPromise = this._fetchToken().
     then(this._createBraintreeInstance.bind(this));
 
-  if(this.useDataCollector) {
+  if (this.useDataCollector) {
     initializationPromise = initializationPromise.then(this._createDataCollector.bind(this));
   }
 
-  if(this.usePaypal) {
+  if (this.usePaypal) {
     initializationPromise = initializationPromise.then(this._createPaypal.bind(this));
   }
 
-  if(this.useApplepay) {
+  if (this.useApplepay) {
     initializationPromise = initializationPromise.then(this._createApplepay.bind(this));
   }
 
+  if (this.useThreeDSecure) {
+    initializationPromise = initializationPromise.then(this._createThreeDSecure.bind(this));
+  }
+
   return initializationPromise.then(this._invokeReadyCallback.bind(this));
 };
 
@@ -173,7 +179,9 @@ SolidusPaypalBraintree.Client.prototype._createPaypal = function() {
   }]).then(function (paypalInstance) {
     this._paypalInstance = paypalInstance;
     return paypalInstance;
-  }.bind(this));
+  }.bind(this), function(error) {
+    console.error(error.name + ':', error.message);
+  });
 };
 
 SolidusPaypalBraintree.Client.prototype._createApplepay = function() {
@@ -184,3 +192,14 @@ SolidusPaypalBraintree.Client.prototype._createApplepay = function() {
     return applePayInstance;
   }.bind(this));
 };
+
+SolidusPaypalBraintree.Client.prototype._createThreeDSecure = function() {
+  return SolidusPaypalBraintree.PromiseShim.convertBraintreePromise(braintree.threeDSecure.create, [{
+    client: this._braintreeInstance,
+    version: 2
+  }]).then(function (threeDSecureInstance) {
+    this._threeDSecureInstance = threeDSecureInstance;
+  }.bind(this), function(error) {
+    console.log(error);
+  });
+};

data/app/assets/javascripts/solidus_paypal_braintree/constants.js

@@ -26,6 +26,10 @@ SolidusPaypalBraintree = {
         return SolidusPaypalBraintree.PaypalButton;
       },
 
+      paypalMessaging: function() {
+        return SolidusPaypalBraintree.PaypalMessaging;
+      },
+
       applepayButton: function() {
         return SolidusPaypalBraintree.ApplepayButton;
       }
@@ -51,6 +55,10 @@ SolidusPaypalBraintree = {
     return SolidusPaypalBraintree._factory(SolidusPaypalBraintree.config.classes.paypalButton(), arguments);
   },
 
+  createPaypalMessaging: function() {
+    return SolidusPaypalBraintree._factory(SolidusPaypalBraintree.config.classes.paypalMessaging(), arguments);
+  },
+
   createApplePayButton: function() {
     return SolidusPaypalBraintree._factory(SolidusPaypalBraintree.config.classes.applepayButton(), arguments);
   },
@@ -60,3 +68,14 @@ SolidusPaypalBraintree = {
     return new (Function.prototype.bind.apply(klass, [null].concat(normalizedArgs)));
   }
 };
+
+BraintreeError = {
+  DEFAULT: "Something bad happened!",
+
+  getErrorFromSlug: function(slug) {
+    error = BraintreeError.DEFAULT
+    if (slug in BraintreeError)
+      error = BraintreeError[slug]
+    return error
+  }
+}

data/app/assets/javascripts/solidus_paypal_braintree/frontend.js

@@ -9,4 +9,5 @@
 //= require solidus_paypal_braintree/client
 //= require solidus_paypal_braintree/hosted_form
 //= require solidus_paypal_braintree/paypal_button
+//= require solidus_paypal_braintree/paypal_messaging
 //= require solidus_paypal_braintree/apple_pay_button

data/app/assets/javascripts/solidus_paypal_braintree/hosted_form.js

@@ -4,7 +4,11 @@ SolidusPaypalBraintree.HostedForm = function(paymentMethodId) {
 };
 
 SolidusPaypalBraintree.HostedForm.prototype.initialize = function() {
-  this.client = SolidusPaypalBraintree.createClient({paymentMethodId: this.paymentMethodId});
+  this.client = SolidusPaypalBraintree.createClient({
+    paymentMethodId: this.paymentMethodId,
+    useThreeDSecure: (typeof(window.threeDSecureOptions) !== 'undefined'),
+  });
+
   return this.client.initialize().
     then(this._createHostedFields.bind(this));
 };
@@ -15,21 +19,27 @@ SolidusPaypalBraintree.HostedForm.prototype._createHostedFields = function () {
   }
 
   var opts = {
+    _solidusClient: this.client,
     client: this.client.getBraintreeInstance(),
 
     fields: {
       number: {
-        selector: "#card_number" + this.paymentMethodId
+        selector: "#card_number" + this.paymentMethodId,
+        placeholder: placeholder_text["number"]
       },
 
       cvv: {
-        selector: "#card_code" + this.paymentMethodId
+        selector: "#card_code" + this.paymentMethodId,
+        placeholder: placeholder_text["cvv"]
       },
 
       expirationDate: {
-        selector: "#card_expiry" + this.paymentMethodId
+        selector: "#card_expiry" + this.paymentMethodId,
+        placeholder: placeholder_text["expirationDate"]
       }
-    }
+    },
+
+    styles: credit_card_fields_style
   };
 
   return SolidusPaypalBraintree.PromiseShim.convertBraintreePromise(braintree.hostedFields.create, [opts]);

data/app/assets/javascripts/solidus_paypal_braintree/paypal_button.js

@@ -7,6 +7,12 @@
 SolidusPaypalBraintree.PaypalButton = function(element, paypalOptions, options) {
   this._element = element;
   this._paypalOptions = paypalOptions || {};
+
+  this.locale = paypalOptions['locale'] || "en_US";
+  this.style = paypalOptions['style'] || {};
+  delete paypalOptions['locale'];
+  delete paypalOptions['style'];
+
   this._options = options || {};
   this._client = null;
   this._environment = this._paypalOptions.environment || 'sandbox';
@@ -34,17 +40,27 @@ SolidusPaypalBraintree.PaypalButton.prototype.initialize = function() {
 SolidusPaypalBraintree.PaypalButton.prototype.initializeCallback = function() {
   this._paymentMethodId = this._client.paymentMethodId;
 
-  paypal.Button.render({
-    env: this._environment,
+  this._client.getPaypalInstance().loadPayPalSDK({
+    currency: this._paypalOptions.currency,
+    commit: true,
+    vault: this._paypalOptions.flow == "vault",
+    components: this.style['messaging'] == "true" && this._paypalOptions.flow != "vault" ? "buttons,messages" : "buttons",
+    intent: this._paypalOptions.flow == "vault" ? "tokenize" : "authorize"
+  }).then(() => {
+    var create_method = this._paypalOptions.flow == "vault" ? "createBillingAgreement" : "createOrder"
 
-    payment: function () {
-      return this._client.getPaypalInstance().createPayment(this._paypalOptions);
-    }.bind(this),
+    var render_config = {
+      style: this.style,
+      [create_method]: function () {
+        return this._client.getPaypalInstance().createPayment(this._paypalOptions);
+      }.bind(this),
+      onApprove: function (data, actions) {
+        return this._client.getPaypalInstance().tokenizePayment(data, this._tokenizeCallback.bind(this));
+      }.bind(this)
+    };
 
-    onAuthorize: function (data, actions) {
-      return this._client.getPaypalInstance().tokenizePayment(data, this._tokenizeCallback.bind(this));
-    }.bind(this)
-  }, this._element);
+    paypal.Buttons(render_config).render(this._element);
+  })
 };
 
 /**
@@ -70,7 +86,22 @@ SolidusPaypalBraintree.PaypalButton.prototype._tokenizeCallback = function(token
       window.location.href = response.redirectUrl;
     },
     error: function(xhr) {
-      console.error("Error submitting transaction");
+      var errorText = BraintreeError.DEFAULT;
+
+      if (xhr.responseJSON && xhr.responseJSON.errors) {
+        var errors = [];
+        $.each(xhr.responseJSON.errors, function(key, values) {
+          $.each(values, function(index, value) {
+            errors.push(key + " " + value)
+          });
+        });
+
+        if (errors.length > 0)
+          errorText = errors.join(", ");
+      }
+
+      console.error("Error submitting transaction: " + errorText);
+      SolidusPaypalBraintree.showError(errorText);
     },
   });
 };
@@ -102,22 +133,18 @@ SolidusPaypalBraintree.PaypalButton.prototype._transactionParams = function(payl
  * @param {object} payload - The payload returned by Braintree after tokenization
  */
 SolidusPaypalBraintree.PaypalButton.prototype._addressParams = function(payload) {
-  var first_name, last_name;
+  var name;
   var payload_address = payload.details.shippingAddress || payload.details.billingAddress;
+  if (!payload_address) return {};
 
   if (payload_address.recipientName) {
-    first_name = payload_address.recipientName.split(" ")[0];
-    last_name = payload_address.recipientName.split(" ")[1];
-  }
-
-  if (!first_name || !last_name) {
-    first_name = payload.details.firstName;
-    last_name = payload.details.lastName;
+    name = payload_address.recipientName
+  } else {
+    name = payload.details.firstName + " " + payload.details.lastName;
   }
 
   return {
-    "first_name" : first_name,
-    "last_name" : last_name,
+    "name" : name,
     "address_line_1" : payload_address.line1,
     "address_line_2" : payload_address.line2,
     "city" : payload_address.city,