solidus_braintree 1.4.0 → 2.0.0

data/app/models/solidus_braintree/transaction_address.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require 'active_model'
+require 'solidus_braintree/country_mapper'
+
+module SolidusBraintree
+  class TransactionAddress
+    include ActiveModel::Model
+    include ActiveModel::Validations::Callbacks
+    include SolidusBraintree::CountryMapper
+
+    attr_accessor :country_code, :name, :city, :zip, :state_code,
+      :address_line_1, :address_line_2, :first_name, :last_name
+
+    validates :address_line_1, :city, :zip, :country_code, presence: true
+    validates :name, presence: true, unless: ->(address){ address.first_name.present? }
+
+    before_validation do
+      self.country_code = country_code.presence || "us"
+    end
+
+    validates :spree_country, presence: true
+    validates :state_code, :spree_state, presence: true, if: :should_match_state_model?
+
+    def initialize(attributes = {})
+      country_name = attributes.delete(:country_name) || ""
+      if attributes[:country_code].blank?
+        attributes[:country_code] = iso_from_name(country_name)
+      end
+
+      super(attributes)
+    end
+
+    def spree_country
+      country_code && (@country ||= ::Spree::Country.find_by(iso: country_code.upcase))
+    end
+
+    def spree_state
+      spree_country && state_code && ( @state ||= spree_country.states.find_by(
+        ::Spree::State.arel_table[:name].matches(state_code).or(
+          ::Spree::State.arel_table[:abbr].matches(state_code)
+        )
+      ))
+    end
+
+    def to_spree_address
+      address = ::Spree::Address.new(
+        city: city,
+        country: spree_country,
+        address1: address_line_1,
+        address2: address_line_2,
+        zipcode: zip
+      )
+
+      if SolidusSupport.combined_first_and_last_name_in_address?
+        address.name = begin
+          if first_name.nil?
+            name
+          else
+            [first_name, last_name].join(" ")
+          end
+        end
+      else
+        ::Spree::Deprecation.warn("first_name and last_name are deprecated. Use name instead.", caller)
+        if first_name.nil?
+          first, last = SolidusBraintree::Address.split_name(name)
+          address.firstname = first
+          address.lastname = last || "(left blank)"
+        else
+          address.firstname = first_name
+          address.lastname = last_name || "(left blank)"
+        end
+      end
+
+      if spree_state
+        address.state = spree_state
+      else
+        address.state_name = state_code
+      end
+      address
+    end
+
+    # Check to see if this address should match to a state model in the database
+    def should_match_state_model?
+      spree_country&.states_required?
+    end
+  end
+end

data/app/models/solidus_braintree/transaction_import.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require 'active_model'
+
+module SolidusBraintree
+  class TransactionImport
+    class InvalidImportError < StandardError; end
+
+    include ActiveModel::Model
+
+    validate do
+      errors.add("Address", "is invalid") if address&.invalid?
+
+      if transaction.invalid?
+        transaction.errors.each do |error|
+          errors.add(error.attribute, error.message)
+        end
+      end
+      errors.none?
+    end
+
+    attr_reader :transaction, :order
+
+    def initialize(order, transaction)
+      @order = order
+      @transaction = transaction
+    end
+
+    def source
+      SolidusBraintree::Source.new(
+        nonce: transaction.nonce,
+        payment_type: transaction.payment_type,
+        payment_method: transaction.payment_method,
+        paypal_funding_source: transaction.paypal_funding_source,
+        user: user
+      )
+    end
+
+    delegate :user, to: :order
+
+    def import!(end_state, restart_checkout: false)
+      if valid?
+        order.email = user&.email || transaction.email
+
+        if address
+          order.shipping_address = order.billing_address = address
+          # work around a bug in most solidus versions
+          # about tax zone cachine between address changes
+          order.instance_variable_set(:@tax_zone, nil)
+        end
+
+        payment = order.payments.new(
+          source: source,
+          payment_method: transaction.payment_method,
+          amount: order.total
+        )
+
+        order.save!
+        order.restart_checkout_flow if restart_checkout
+        advance_order(payment, end_state)
+      else
+        raise InvalidImportError,
+          "Validation failed: #{errors.full_messages.join(', ')}"
+      end
+    end
+
+    def address
+      transaction.address && transaction.address.to_spree_address.tap do |address|
+        address.phone = transaction.phone
+      end
+    end
+
+    def state_before_current?(state)
+      steps = order.checkout_steps
+      steps.index(state) < (steps.index(order.state) || 0)
+    end
+
+    protected
+
+    def advance_order(payment, end_state)
+      return if state_before_current?(end_state)
+
+      until order.state == end_state
+        order.next!
+        update_payment_total(payment) if order.payment?
+      end
+    end
+
+    def update_payment_total(payment)
+      payment_total = order.payments.where(state: %w[checkout pending]).sum(:amount)
+      payment_difference = order.outstanding_balance - payment_total
+
+      return unless payment_difference != 0
+
+      payment.update!(amount: payment.amount + payment_difference)
+    end
+  end
+end

data/app/overrides/spree/payments/payment/add_paypal_funding_source_to_payment.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+Deface::Override.new(
+  name: "payments/payment/add_paypal_funding_source_to_payment",
+  virtual_path: "spree/payments/_payment",
+  original: "0b5b5ae53626059cb3a202ef95d10827dd399925",
+  insert_after: "erb[loud]:contains('content_tag(:span, payment.payment_method.name)')",
+  partial: "solidus_braintree/payments/payment"
+)

data/app/views/spree/api/payments/source_views/_braintree.json.jbuilder

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-json.call(payment_source, :id, :created_at)
+json.call(payment_source, :id, :token, :created_at)

data/app/views/spree/checkout/existing_payment/_braintree.html.erb

@@ -0,0 +1,10 @@
+<tr id="<%= dom_id(wallet_payment_source, 'spree')%>" class="<%= cycle('even', 'odd') %>">
+  <td>
+    <%= radio_button_tag "order[wallet_payment_source_id]",
+                          wallet_payment_source.id,
+                          default,
+                          class: "existing-cc-radio" %>
+  </td>
+  <td><%= wallet_payment_source.payment_source.friendly_payment_type %></td>
+  <td><%= wallet_payment_source.payment_source.display_number %></td>
+</tr>

data/app/views/spree/shared/_apple_pay_button.html.erb

@@ -0,0 +1,27 @@
+<% address = current_order.ship_address %>
+
+<button id="apple-pay-button" class="apple-pay-button"></button>
+
+<script>
+  var applePayButtonElement = document.getElementById('apple-pay-button');
+  var applePayOptions = {
+    paymentMethodId: <%= id %>,
+    storeName: "<%= current_store.name %>",
+    orderEmail: "<%= current_order.email %>",
+    amount: "<%= current_order.total %>",
+    shippingContact: {
+      emailAddress: '<%= current_order.email %>',
+      givenName: '<%= address.firstname %>',
+      familyName: '<%= address.lastname %>',
+      phoneNumber: '<%= address.phone %>',
+      addressLines: ['<%= address.address1 %>','<%= address.address2 %>'],
+      locality: '<%= address.city %>',
+      administrativeArea: '<%= address.state.name %>',
+      postalCode: '<%= address.zipcode %>',
+      country: '<%= address.country.name %>',
+      countryCode: '<%= address.country.iso %>'
+    }
+  };
+  var button = new SolidusBraintree.createApplePayButton(applePayButtonElement, applePayOptions);
+  button.initialize();
+</script>

data/app/views/spree/shared/_braintree_errors.html.erb

@@ -0,0 +1,16 @@
+<script type="text/javascript">
+  BraintreeError.DEFAULT = "<%= I18n.t('solidus_braintree.errors.default_error')%>"
+  BraintreeError.PAYPAL_POPUP_CLOSED = "<%= I18n.t('solidus_braintree.errors.paypal_popup_closed') %>"
+  BraintreeError.HOSTED_FIELDS_FIELDS_EMPTY = "<%= I18n.t('solidus_braintree.errors.empty_fields')%>"
+  BraintreeError.HOSTED_FIELDS_FIELDS_INVALID = "<%= I18n.t('solidus_braintree.errors.invalid_fields')%>"
+  BraintreeError.HOSTED_FIELDS_FAILED_TOKENIZATION = "<%= I18n.t('solidus_braintree.errors.invalid_card')%>"
+  BraintreeError.HOSTED_FIELDS_TOKENIZATION_NETWORK_ERROR = "<%= I18n.t('solidus_braintree.errors.network_error')%>"
+  BraintreeError.HOSTED_FIELDS_FIELD_DUPLICATE_IFRAME = "<%= I18n.t('solidus_braintree.errors.duplicate_iframe')%>"
+  BraintreeError.HOSTED_FIELDS_TOKENIZATION_FAIL_ON_DUPLICATE = "<%= I18n.t('solidus_braintree.errors.fail_on_duplicate')%>"
+  BraintreeError.HOSTED_FIELDS_TOKENIZATION_CVV_VERIFICATION_FAILED = "<%= I18n.t('solidus_braintree.errors.cvv_verification_failed')%>"
+  BraintreeError.THREEDS_AUTHENTICATION_FAILED = "<%= t('solidus_braintree.errors.threeds.authentication_failed') %>";
+  BraintreeError.THREEDS_CARDINAL_SDK_ERROR = "<%= t('solidus_braintree.errors.threeds.authentication_failed') %>";
+  BraintreeError.VENMO_CANCELED = "<%= t('solidus_braintree.errors.venmo.canceled') %>";
+  BraintreeError.VENMO_DESKTOP_CANCELED = "<%= t('solidus_braintree.errors.venmo.desktop_canceled') %>";
+  BraintreeError.VENMO_APP_CANCELED = "<%= t('solidus_braintree.errors.venmo.app_canceled') %>";
+</script>

data/app/views/spree/shared/_braintree_head_scripts.html.erb

@@ -0,0 +1,26 @@
+<% content_for :head do %>
+  <script src="https://js.braintreegateway.com/web/3.84.0/js/client.min.js"></script>
+  <script src="https://js.braintreegateway.com/web/3.84.0/js/data-collector.min.js"></script>
+
+  <% if current_store.braintree_configuration.paypal? %>
+    <script src="https://js.braintreegateway.com/web/3.84.0/js/paypal-checkout.min.js"></script>
+  <% end %>
+
+  <% if current_store.braintree_configuration.credit_card? %>
+    <script src="https://js.braintreegateway.com/web/3.84.0/js/hosted-fields.min.js"></script>
+
+    <% if current_store.braintree_configuration.three_d_secure? %>
+      <script src="https://js.braintreegateway.com/web/3.84.0/js/three-d-secure.min.js"></script>
+    <% end %>
+  <% end %>
+
+  <% if current_store.braintree_configuration.apple_pay? %>
+    <script src="https://js.braintreegateway.com/web/3.84.0/js/apple-pay.min.js"></script>
+  <% end %>
+
+  <% if current_store.braintree_configuration.venmo? %>
+    <script src="https://js.braintreegateway.com/web/3.84.0/js/venmo.min.js"></script>
+  <% end %>
+
+  <%= javascript_include_tag "solidus_braintree/checkout" %>
+<% end %>

data/app/views/spree/shared/_braintree_hosted_fields.html.erb

@@ -0,0 +1,43 @@
+<% if defined?(id) && !defined?(payment_method) %>
+  <% payment_method = Spree::PaymentMethod.find(id) %>
+  <% Spree::Deprecation.warn(
+    "passing id to _braintree_hosted_fields.html.erb is deprecated. Please pass the payment_method directly.",
+    caller
+  ) %>
+<% end %>
+
+<% prefix = "payment_source[#{payment_method.id}]" %>
+
+<div class="hosted-fields">
+  <div class="field" data-hook="card_number">
+    <%= label_tag "card_number#{payment_method.id}", Spree::CreditCard.human_attribute_name(:number), class: "required" %>
+    <div class="input" id="card_number<%= payment_method.id %>"></div>
+  </div>
+
+  <div class="field" data-hook="card_expiration">
+    <%= label_tag "card_expiry#{payment_method.id}", Spree::CreditCard.human_attribute_name(:expiration), class: "required" %>
+    <div class="input" id="card_expiry<%= payment_method.id %>"></div>
+  </div>
+
+  <div class="field" data-hook="card_code">
+    <%= label_tag "card_code#{payment_method.id}", Spree::CreditCard.human_attribute_name(:card_code), class: "required" %>
+    <div class="input" id="card_code<%= payment_method.id %>"></div>
+
+    <a href="/content/cvv" class="info cvvLink" target="_blank">
+      (<%= I18n.t("spree.what_is_this") %>)
+    </a>
+  </div>
+
+  <div class="clear"></div>
+  <input type="hidden" name="<%= prefix %>[payment_type]" value="<%= SolidusBraintree::Source::CREDIT_CARD %>">
+  <input type="hidden" id="payment_method_nonce" name="<%= prefix %>[nonce]">
+</div>
+
+
+<script>
+  <% if current_store.braintree_configuration.three_d_secure? %>
+    var threeDSecureOptions = <%= raw braintree_3ds_options_for(current_order).to_json %>;
+  <% end -%>
+  var credit_card_fields_style = <%= raw payment_method.preferred_credit_card_fields_style.to_json %>
+  var placeholder_text = <%= raw payment_method.preferred_placeholder_text.to_json %>
+</script>

data/app/views/spree/shared/_paypal_cart_button.html.erb

@@ -0,0 +1,38 @@
+<%= render "spree/shared/braintree_head_scripts" %>
+
+<div id="paypal-button"></div>
+<div data-pp-message data-pp-placement="payment" data-pp-amount="<%= current_order.total %>"></div>
+
+<script>
+  var paypalOptions = {
+    flow: '<%= SolidusBraintree::Gateway.first.preferred_paypal_flow %>',
+    amount: '<%= current_order.total %>',
+    currency: '<%= current_order.currency %>',
+    enableShippingAddress: true,
+    buyerCountry: '<%= SolidusBraintree::Gateway.first.preferred_force_buyer_country %>',
+    environment: '<%= Rails.env.production? ? "production" : "sandbox" %>',
+    locale: '<%= paypal_button_preference(:paypal_button_locale, store: current_store) %>',
+    useDataCollector: <%= SolidusBraintree::Gateway.first.preferred_use_data_collector %>,
+    style: {
+      color: '<%= paypal_button_preference(:paypal_button_color, store: current_store) %>',
+      shape: '<%= paypal_button_preference(:paypal_button_shape, store: current_store) %>',
+      label: '<%= paypal_button_preference(:paypal_button_label, store: current_store) %>',
+      layout: '<%= paypal_button_preference(:paypal_button_layout, store: current_store) %>',
+      <% if paypal_button_preference(:paypal_button_layout, store: current_store) == "horizontal" %>
+        tagline: '<%= paypal_button_preference(:paypal_button_tagline, store: current_store) %>',
+      <% end %>
+      messaging: '<%= paypal_button_preference(:paypal_button_messaging, store: current_store) %>'
+    }
+  }
+  var options = {
+    restart_checkout: true
+  }
+
+  var button = new SolidusBraintree.createPaypalButton(
+    document.querySelector("#paypal-button"),
+    paypalOptions,
+    options
+  )
+
+  button.initialize();
+</script>

data/app/views/spree/shared/_paypal_messaging.html.erb

@@ -0,0 +1,13 @@
+<%= render "spree/shared/braintree_head_scripts" %>
+
+<div data-pp-message data-pp-placement="<%= options[:placement] %>" data-pp-amount="<%= options[:total] %>"></div>
+
+<script>
+  var message = new SolidusBraintree.createPaypalMessaging(
+    {
+      currency: "<%= options[:currency] %>"
+    }
+  )
+
+  message.initialize();
+</script>

data/app/views/spree/shared/_venmo_button.html.erb

@@ -0,0 +1,33 @@
+<%= button_tag '', id: 'venmo-button', class: 'venmo-button', type: 'button' %>
+
+<% store = Spree::Store.default %>
+<% style = venmo_button_style(store) %>
+
+<style>
+  .venmo-button {
+    width: <%= style[:width] %>px;
+    background-image: url('<%= venmo_button_asset_url(style)%>');
+  }
+  .venmo-button:active, .venmo-button:hover {
+    background-color: transparent !important;
+    background-image: url('<%= venmo_button_asset_url(style, active: true)%>') !important;
+  }
+</style>
+
+<% prefix = "payment_source[#{payment_method.id}]" %>
+
+<div class="venmo-fields">
+  <div class="clear"></div>
+  <input disabled type="hidden" name="<%= prefix %>[payment_type]" value="<%= SolidusBraintree::Source::VENMO %>">
+  <input disabled type="hidden" id="venmo_payment_method_nonce" name="<%= prefix %>[nonce]">
+</div>
+
+<script>
+  var venmoButtonElement = document.getElementById('venmo-button');
+  var venmoOptions = {
+    newBrowserTabSupported: <%= SolidusBraintree::Gateway.first.preferred_venmo_new_tab_support %>,
+    flow: '<%= SolidusBraintree::Gateway.first.preferred_paypal_flow %>'
+  };
+  var button = new SolidusBraintree.createVenmoButton(venmoButtonElement, venmoOptions);
+  button.initialize();
+</script>

data/bin/console

@@ -1,14 +1,17 @@
 #!/usr/bin/env ruby
 
+# frozen_string_literal: true
+
 require "bundler/setup"
 require "solidus_braintree"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
+$LOAD_PATH.unshift(*Dir["#{__dir__}/../app/*"])
 
 # (If you use this, don't forget to add pry to your Gemfile!)
 # require "pry"
 # Pry.start
 
 require "irb"
-IRB.start
+IRB.start(__FILE__)

data/bin/rails

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-ENGINE_ROOT = File.expand_path('../..', __FILE__)
-ENGINE_PATH = File.expand_path('../../lib/solidus_braintree/engine', __FILE__)
-
-require 'rails/all'
-require 'rails/engine/commands'
+if %w[g generate].include? ARGV.first
+  exec "#{__dir__}/rails-engine", *ARGV
+else
+  exec "#{__dir__}/rails-sandbox", *ARGV
+end

data/bin/rails-engine

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/solidus_braintree/engine', __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/bin/rails-sandbox

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+app_root = 'sandbox'
+
+unless File.exist? "#{app_root}/bin/rails"
+  warn 'Creating the sandbox app...'
+  Dir.chdir "#{__dir__}/.." do
+    system "#{__dir__}/sandbox" or begin
+      warn 'Automatic creation of the sandbox app failed'
+      exit 1
+    end
+  end
+end
+
+Dir.chdir app_root
+exec 'bin/rails', *ARGV

data/bin/rake

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/sandbox

@@ -0,0 +1,103 @@
+#!/usr/bin/env bash
+
+set -e
+if [ -n "$DEBUG" ]
+then
+  set -x
+fi
+
+case "$DB" in
+postgres|postgresql)
+  RAILSDB="postgresql"
+  ;;
+mysql)
+  RAILSDB="mysql"
+  ;;
+sqlite3|sqlite)
+  RAILSDB="sqlite3"
+  ;;
+'')
+  echo "~~> Use 'export DB=[postgres|mysql|sqlite]' to control the DB adapter"
+  RAILSDB="sqlite3"
+  ;;
+*)
+  echo "Invalid value specified for the Solidus sandbox: DB=\"$DB\"."
+  echo "Please use 'postgres', 'mysql', or 'sqlite' instead."
+  exit 1
+  ;;
+esac
+echo "~~> Using $RAILSDB as the database engine"
+
+if [ -z "$SOLIDUS_BRANCH" ]
+then
+  echo "~~> Use 'export SOLIDUS_BRANCH=[master|v3.2|...]' to control the Solidus branch"
+  SOLIDUS_BRANCH="master"
+fi
+echo "~~> Using branch $SOLIDUS_BRANCH of solidus"
+
+if [ -z "$SOLIDUS_FRONTEND" ]
+then
+  echo "~~> Use 'export SOLIDUS_FRONTEND=[solidus_frontend|solidus_starter_frontend]' to control the Solidus frontend"
+  SOLIDUS_FRONTEND="solidus_frontend"
+fi
+echo "~~> Using branch $SOLIDUS_FRONTEND as the solidus frontend"
+
+extension_name="solidus_braintree"
+
+# Stay away from the bundler env of the containing extension.
+function unbundled {
+  ruby -rbundler -e'b = proc {system *ARGV}; Bundler.respond_to?(:with_unbundled_env) ? Bundler.with_unbundled_env(&b) : Bundler.with_clean_env(&b)' -- $@
+}
+
+rm -rf ./sandbox
+unbundled bundle exec rails new sandbox --database="$RAILSDB" \
+  --skip-bundle \
+  --skip-git \
+  --skip-keeps \
+  --skip-rc \
+  --skip-spring \
+  --skip-test \
+  --skip-javascript
+
+if [ ! -d "sandbox" ]; then
+  echo 'sandbox rails application failed'
+  exit 1
+fi
+
+cd ./sandbox
+cat <<RUBY >> Gemfile
+gem 'solidus', github: 'solidusio/solidus', branch: '$SOLIDUS_BRANCH'
+gem 'rails-i18n'
+gem 'solidus_i18n'
+
+# This Braintree extension contains a user decorator, so the user class must be loaded first.
+gem "solidus_auth_devise", "~> 2.5"
+gem '$extension_name', path: '..'
+
+group :test, :development do
+  platforms :mri do
+    gem 'pry-byebug'
+  end
+end
+RUBY
+
+unbundled bundle install --gemfile Gemfile
+
+unbundled bundle exec rake db:drop db:create
+
+# Still request "devise". Solidus will skip installing it again but will include its seeds.
+unbundled bundle exec rails generate solidus:install \
+  --auto-accept \
+  --user_class=Spree::User \
+  --enforce_available_locales=true \
+  --authentication="devise" \
+  --payment-method=none \
+  --frontend=${SOLIDUS_FRONTEND} \
+  $@
+
+unbundled bundle exec rails generate solidus:auth:install --auto-run-migrations
+unbundled bundle exec rails generate ${extension_name}:install --auto-run-migrations
+
+echo
+echo "🚀 Sandbox app successfully created for $extension_name!"
+echo "🧪 This app is intended for test purposes."

data/bin/setup

@@ -1,7 +1,8 @@
-#!/bin/bash
+#!/usr/bin/env bash
 set -euo pipefail
 IFS=$'\n\t'
+set -vx
 
-bundle install
-
-# Do any other automated setup that you need to do here
+gem install bundler --conservative
+bundle update
+bin/rake clobber