solidus_braintree 1.2.0 → 2.0.0

data/app/assets/javascripts/spree/backend/solidus_braintree.js

@@ -0,0 +1,96 @@
+//= require solidus_braintree/constants
+//= require solidus_braintree/client
+//= require solidus_braintree/promise
+//= require solidus_braintree/hosted_form
+
+$(function() {
+  var $paymentForm = $("#new_payment"),
+      $hostedFields = $("[data-braintree-hosted-fields]"),
+      hostedFieldsInstance = null;
+
+  function onError (err) {
+    var msg = err.name + ": " + err.message;
+    show_flash("error", msg);
+  }
+
+  function showForm(id) {
+    $("#card_form" + id).show();
+  }
+
+  function hideForm(id) {
+    $("#card_form" + id).hide();
+  }
+
+  function addFormHook(braintreeForm, errorCallback) {
+    var shouldSubmit = false;
+
+    function submit(payload) {
+      shouldSubmit = true;
+
+      $("#payment_method_nonce", braintreeForm.hostedFields).val(payload.nonce);
+      $paymentForm.submit();
+    }
+
+    return function(hostedFields) {
+      $paymentForm.on("submit", function(e) {
+        if ($hostedFields.is(":visible") && !shouldSubmit) {
+          e.preventDefault();
+
+          hostedFields.tokenize(function(err, payload) {
+            if (err) {
+              errorCallback(err);
+            } else {
+              submit(payload);
+            }
+          });
+        }
+      });
+    };
+  }
+
+  function initFields($container, id) {
+    function setHostedFieldsInstance(instance) {
+      hostedFieldsInstance = instance;
+      return instance;
+    }
+
+    if (hostedFieldsInstance === null) {
+      braintreeForm = new SolidusBraintree.createHostedForm(id);
+      braintreeForm.initialize().
+        then(setHostedFieldsInstance).
+        then(addFormHook(braintreeForm, onError)).
+        fail(onError);
+    }
+  }
+
+  // exit early if we're not looking at the New Payment form, or if no
+  // SolidusBraintree payment methods have been configured.
+  if (!$paymentForm.length || !$hostedFields.length) { return; }
+
+  $.when(
+    $.getScript("https://js.braintreegateway.com/web/3.84.0/js/client.min.js"),
+    $.getScript("https://js.braintreegateway.com/web/3.84.0/js/hosted-fields.min.js")
+  ).done(function() {
+    $hostedFields.each(function() {
+      var $this = $(this),
+          $radios = $("[name=card]", $this),
+          id = $this.data("payment-method-id");
+
+      // If we have previous cards, init fields on change of radio button
+      if ($radios.length) {
+        $radios.on("change", function() {
+          if ($(this).val() == 'new') {
+            showForm(id);
+            initFields($this, id);
+          } else {
+            hideForm(id);
+          }
+        });
+      } else {
+        // If we don't have previous cards, init fields immediately
+        initFields($this, id);
+        showForm(id);
+      }
+    });
+  });
+});

data/app/assets/javascripts/spree/frontend/paypal_button.js

@@ -0,0 +1,34 @@
+//= require solidus_braintree/paypal_button
+
+// This is the PayPal button on the cart page
+$(document).ready(function() {
+  if (document.getElementById("empty-cart")) {
+    $.when(
+      $.getScript("https://js.braintreegateway.com/3.84.0/js/client.min.js"),
+      $.getScript("https://js.braintreegateway.com/3.84.0/js/paypal-checkout.min.js"),
+      $.getScript("https://js.braintreegateway.com/3.84.0/js/data-collector.min.js")
+    ).done(function() {
+      $("#content").append('<div id="paypal-button"/>');
+      $('<script/>').attr({
+        'data-version-4' : "true"
+      }).
+      load(function() {
+        var paypalOptions = {
+          flow: 'vault',
+          enableShippingAddress: true
+        }
+        var options = {
+          restart_checkout: true
+        }
+        var button = new SolidusBraintree.createPaypalButton(
+          document.querySelector("#paypal-button"),
+          paypalOptions,
+          options
+        );
+        return button.initialize();
+      }).
+      insertAfter("#content").
+      attr('src', 'https://www.paypalobjects.com/api/checkout.js');
+    });
+  }
+});

data/app/assets/javascripts/spree/frontend/solidus_braintree.js

@@ -0,0 +1 @@
+//= require solidus_braintree/frontend

data/app/assets/stylesheets/spree/backend/solidus_braintree.scss

@@ -0,0 +1,28 @@
+/*
+Placeholder manifest file.
+the installer will append this file to the app vendored assets here: 'vendor/assets/stylesheets/spree/backend/all.css'
+*/
+
+// Set Bootstrap variables if they're not already defined
+// e.g if we're on Solidus < v1.4
+$input-border-color: #cee1f4 !default;
+$border-radius: 3px !default;
+$input-color: #5498DA !default;
+$brand-danger: #C60F13 !default;
+$brand-success: #9FC820 !default;
+
+.braintree-hosted-fields .input {
+  border: 1px solid $input-border-color;
+  border-radius: $border-radius;
+  color: $input-color;
+  height: 30px;
+  padding: 7px 10px;
+
+  &.braintree-hosted-fields-invalid {
+    border-color: $brand-danger;
+  }
+
+  &.braintree-hosted-fields-valid {
+    border-color: $brand-success;
+  }
+}

data/app/assets/stylesheets/spree/frontend/solidus_braintree.scss

@@ -0,0 +1,51 @@
+/*
+Placeholder manifest file.
+the installer will append this file to the app vendored assets here: 'vendor/assets/stylesheets/spree/frontend/all.css'
+*/
+
+.braintree-hosted-fields .input {
+  border: 1px solid #d9d9db;
+  border-radius: 3px;
+  color: #5498DA;
+  height: 30px;
+  padding: 5px 10px;
+}
+
+.paypal-button-widget .paypal-button:hover {
+  background: transparent;
+}
+
+.apple-pay-button {
+  -webkit-appearance: -apple-pay-button;
+  -apple-pay-button-type: buy;
+  visibility: hidden;
+  display: inline-block;
+  min-height: 30px;
+  border: 1px solid black;
+  background-image: -webkit-named-image(apple-pay-logo-black);
+  background-size: 100% calc(60% + 2px);
+  background-repeat: no-repeat;
+  background-color: white;
+  background-position: 50% 50%;
+  border-radius: 5px;
+  padding: 0;
+  margin: 5px auto;
+  transition: background-color .15s;
+  width: auto;
+}
+
+.apple-pay-button.visible {
+  visibility: visible;
+}
+
+.venmo-button {
+  visibility: hidden;
+  border: none;
+  height: 48px;
+  background-color: transparent;
+  background-repeat: no-repeat;
+}
+
+.venmo-button.visible {
+  visibility: visible;
+}

data/app/decorators/controllers/solidus_braintree/admin_payments_controller_decorator.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module SolidusBraintree
+  module AdminPaymentsControllerDecorator
+    def self.prepended(base)
+      base.helper ::SolidusBraintree::BraintreeAdminHelper
+    end
+
+    ::Spree::Admin::PaymentsController.prepend(self)
+  end
+end

data/app/decorators/controllers/solidus_braintree/checkout_controller_decorator.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module SolidusBraintree
+  module CheckoutControllerDecorator
+    def self.prepended(base)
+      base.helper ::SolidusBraintree::BraintreeCheckoutHelper
+    end
+
+    ::Spree::CheckoutController.prepend(self) if SolidusSupport.frontend_available?
+  end
+end

data/app/decorators/controllers/solidus_braintree/client_tokens_controller.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module SolidusBraintree
+  class ClientTokensController < ::Spree::Api::BaseController
+    skip_before_action :authenticate_user
+
+    before_action :load_gateway
+
+    def create
+      token = @gateway.generate_token
+      if token
+        render json: { client_token: token, payment_method_id: @gateway.id }
+      else
+        render json: { error: Gateway::TOKEN_GENERATION_DISABLED_MESSAGE }, status: :unprocessable_entity
+      end
+    end
+
+    private
+
+    def load_gateway
+      if params[:payment_method_id]
+        @gateway = ::SolidusBraintree::Gateway.find(params[:payment_method_id])
+      else
+        store_payment_methods_scope =
+          if current_store.payment_methods.empty?
+            ::SolidusBraintree::Gateway.all
+          else
+            ::SolidusBraintree::Gateway.where(id: current_store.payment_method_ids)
+          end
+        @gateway = ::SolidusBraintree::Gateway.where(active: true).merge(store_payment_methods_scope).first!
+      end
+    end
+
+    def generate_token
+      @gateway.generate_token
+    rescue ::SolidusBraintree::Gateway::TokenGenerationDisabledError => e
+      Rails.logger.error e
+      nil
+    end
+  end
+end

data/app/decorators/controllers/solidus_braintree/orders_controller_decorator.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module SolidusBraintree
+  module OrdersControllerDecorator
+    def self.prepended(base)
+      base.helper ::SolidusBraintree::BraintreeCheckoutHelper
+    end
+
+    ::Spree::OrdersController.prepend(self) if SolidusSupport.frontend_available?
+  end
+end

data/app/decorators/models/solidus_braintree/spree/store_decorator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module SolidusBraintree
+  module Spree
+    module StoreDecorator
+      def self.prepended(base)
+        base.has_one :braintree_configuration, class_name: "SolidusBraintree::Configuration", dependent: :destroy
+        base.before_create :build_default_configuration
+      end
+
+      private
+
+      def build_default_configuration
+        build_braintree_configuration unless braintree_configuration
+      end
+
+      ::Spree::Store.prepend self
+    end
+  end
+end

data/app/decorators/models/solidus_braintree/spree/user_decorator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module SolidusBraintree
+  module Spree
+    module UserDecorator
+      def self.prepended(base)
+        base.has_one :braintree_customer, class_name: 'SolidusBraintree::Customer', inverse_of: :user
+      end
+
+      ::Spree.user_class.prepend self
+    end
+  end
+end

data/app/helpers/solidus_braintree/braintree_admin_helper.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module SolidusBraintree
+  module BraintreeAdminHelper
+    # Returns a link to the Braintree web UI for the given Braintree payment
+    def braintree_transaction_link(payment)
+      environment = payment.payment_method.preferred_environment == 'sandbox' ? 'sandbox' : 'www'
+      merchant_id = payment.payment_method.preferred_merchant_id
+      response_code = payment.response_code
+
+      return if response_code.blank?
+      return response_code if merchant_id.blank?
+
+      link_to(
+        response_code,
+        "https://#{environment}.braintreegateway.com/merchants/#{merchant_id}/transactions/#{response_code}",
+        title: 'Show payment on Braintree',
+        target: '_blank',
+        rel: 'noopener'
+      )
+    end
+  end
+end

data/app/helpers/solidus_braintree/braintree_checkout_helper.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module SolidusBraintree
+  module BraintreeCheckoutHelper
+    def braintree_3ds_options_for(order)
+      ship_address = SolidusBraintree::Address.new(order.ship_address)
+      bill_address = SolidusBraintree::Address.new(order.bill_address)
+      {
+        nonce: nil, # populated after tokenization
+        bin: nil, # populated after tokenization
+        onLookupComplete: nil, # populated after tokenization
+        amount: order.total,
+        email: order.email,
+        billingAddress: {
+          givenName: bill_address.firstname,
+          surname: bill_address.lastname,
+          phoneNumber: bill_address.phone,
+          streetAddress: bill_address.address1,
+          extendedAddress: bill_address.address2,
+          locality: bill_address.city,
+          region: bill_address.state&.abbr,
+          postalCode: bill_address.zipcode,
+          countryCodeAlpha2: bill_address.country&.iso,
+        },
+        additionalInformation: {
+          shippingGivenName: ship_address.firstname,
+          shippingSurname: ship_address.lastname,
+          shippingPhone: ship_address.phone,
+          shippingAddress: {
+            streedAddress: ship_address.address1,
+            extendedAddress: ship_address.address2,
+            locality: ship_address.city,
+            region: ship_address.state&.abbr,
+            postalCode: ship_address.zipcode,
+            countryCodeAlpha2: ship_address.country&.iso,
+          }
+        }
+      }
+    end
+
+    def paypal_button_preference(key, store:)
+      store.braintree_configuration.preferences[key]
+    end
+
+    def venmo_button_style(store)
+      configuration = store.braintree_configuration
+      color = configuration.preferred_venmo_button_color
+      width = configuration.preferred_venmo_button_width
+
+      { width: width, color: color }
+    end
+
+    def venmo_button_asset_url(style, active: false)
+      prefix = 'solidus_braintree/venmo/venmo_'
+      active_string = active ? 'active_' : ''
+      path = "#{prefix}#{active_string}#{style[:color]}_button_#{style[:width]}x48.svg"
+      asset_path(path)
+    end
+  end
+end

data/app/models/application_record.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/app/models/solidus_braintree/address.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module SolidusBraintree
+  class Address
+    delegate :address1,
+      :address2,
+      :city,
+      :country,
+      :phone,
+      :state,
+      :zipcode,
+      to: :spree_address
+
+    def self.split_name(name)
+      if defined?(Spree::Address::Name)
+        address_name = Spree::Address::Name.new(name)
+        [address_name.first_name, address_name.last_name]
+      else
+        name.strip.split(' ', 2)
+      end
+    end
+
+    def initialize(spree_address)
+      @spree_address = spree_address
+    end
+
+    def to_json(*_args)
+      address_hash = {
+        line1: address1,
+        line2: address2,
+        city: city,
+        postalCode: zipcode,
+        countryCode: country.iso,
+        phone: phone,
+        recipientName: "#{firstname} #{lastname}"
+      }
+
+      if ::Spree::Config.address_requires_state && country.states_required
+        address_hash[:state] = state.name
+      end
+      address_hash.to_json
+    end
+
+    def firstname
+      if SolidusSupport.combined_first_and_last_name_in_address?
+        self.class.split_name(spree_address.name).first
+      else
+        spree_address.firstname
+      end
+    end
+
+    def lastname
+      if SolidusSupport.combined_first_and_last_name_in_address?
+        self.class.split_name(spree_address.name).last
+      else
+        spree_address.lastname
+      end
+    end
+
+    private
+
+    attr_reader :spree_address
+  end
+end

data/app/models/solidus_braintree/avs_result.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'active_merchant/billing/avs_result'
+
+module SolidusBraintree
+  class AVSResult < ActiveMerchant::Billing::AVSResult
+    # Mapping took from ActiveMerchant::Billing::BraintreeBlueGateway
+    AVS_MAPPING = {
+      'M' => {
+        'M' => 'M',
+        'N' => 'A',
+        'U' => 'B',
+        'I' => 'B',
+        'A' => 'B'
+      },
+      'N' => {
+        'M' => 'Z',
+        'N' => 'C',
+        'U' => 'C',
+        'I' => 'C',
+        'A' => 'C'
+      },
+      'U' => {
+        'M' => 'P',
+        'N' => 'N',
+        'U' => 'I',
+        'I' => 'I',
+        'A' => 'I'
+      },
+      'I' => {
+        'M' => 'P',
+        'N' => 'C',
+        'U' => 'I',
+        'I' => 'I',
+        'A' => 'I'
+      },
+      'A' => {
+        'M' => 'P',
+        'N' => 'C',
+        'U' => 'I',
+        'I' => 'I',
+        'A' => 'I'
+      },
+      'B' => {
+        'B' => 'B'
+      },
+      nil => { nil => nil }
+    }.freeze
+
+    class << self
+      private :new
+
+      def build(transaction)
+        new(
+          code: avs_code_from(transaction),
+          street_match: transaction.avs_street_address_response_code,
+          postal_match: transaction.avs_postal_code_response_code
+        )
+      end
+
+      private
+
+      def avs_code_from(transaction)
+        transaction.avs_error_response_code ||
+          AVS_MAPPING[transaction.avs_street_address_response_code][transaction.avs_postal_code_response_code]
+      end
+    end
+  end
+end

data/app/models/solidus_braintree/configuration.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module SolidusBraintree
+  class Configuration < ::Spree::Base
+    PAYPAL_BUTTON_PREFERENCES = {
+      color: { availables: %w[gold blue silver white black], default: 'white' },
+      shape: { availables: %w[pill rect], default: 'rect' },
+      label: { availables: %w[checkout credit pay buynow paypal installment], default: 'checkout' },
+      tagline: { availables: %w[true false], default: 'false' },
+      layout: { availables: %w[horizontal vertical], default: 'horizontal' },
+      messaging: { availables: %w[true false], default: 'false' }
+    }.freeze
+
+    include ::Spree::Preferences::Persistable
+
+    belongs_to :store, class_name: 'Spree::Store', optional: false
+
+    # Preferences for Paypal button
+    PAYPAL_BUTTON_PREFERENCES.each do |name, desc|
+      preference_name = "paypal_button_#{name}".to_sym
+      attribute_name = "preferred_#{preference_name}".to_sym
+
+      preference preference_name, :string, default: desc[:default]
+
+      validates attribute_name, inclusion: desc[:availables]
+    end
+
+    preference :venmo_button_color, :preference_select, default: 'blue'
+    preference :venmo_button_width, :preference_select, default: '320'
+
+    def preferred_venmo_button_color_options
+      [["Blue", "blue"], ["White", "white"]]
+    end
+
+    def preferred_venmo_button_width_options
+      [["280", "280"], ["320", "320"], ["375", "375"]]
+    end
+  end
+end

data/app/models/solidus_braintree/customer.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SolidusBraintree
+  class Customer < ApplicationRecord
+    belongs_to :user, class_name: ::Spree::UserClassHandle.new, optional: true
+    has_many :sources, class_name: "SolidusBraintree::Source", inverse_of: :customer, dependent: :destroy
+  end
+end