solidus_braintree 2.0.0 → 3.0.1

data/app/models/solidus_braintree/transaction_import.rb

@@ -32,6 +32,7 @@ module SolidusBraintree
         payment_type: transaction.payment_type,
         payment_method: transaction.payment_method,
         paypal_funding_source: transaction.paypal_funding_source,
+        device_data: transaction.device_data,
         user: user
       )
     end

data/bin/dummy-app

@@ -0,0 +1,37 @@
+#!/usr/bin/env bash
+
+set -e
+
+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)' -- "$@"
+}
+
+# "sqlite" is set by the ORB extension instead of "sqlite3",
+# all other options are already in the format expected by `rails new`.
+test "$DB" = "sqlite" && export DB="sqlite3"
+
+rm -rf ./dummy-app
+rails new dummy-app \
+  --database=${DB:-sqlite3} \
+  --skip-git \
+  --skip-keeps \
+  --skip-rc \
+  --skip-bootsnap \
+  --skip-test
+
+if [ ! -d "dummy-app" ]; then
+  echo 'dummy-app rails application failed'
+  exit 1
+fi
+
+cd ./dummy-app
+unbundled bundle add solidus --github solidusio/solidus --branch "${BRANCH:-master}" --version '> 0.a'
+unbundled bundle exec rake db:drop db:create
+unbundled bundle exec rails generate solidus:install --auto-accept --payment-method=none --no-seed --no-sample "$@"
+unbundled bundle add $extension_name --path ..
+unbundled bundle exec rails generate $extension_name:install --migrate --specs=all
+
+

data/bin/rails-dummy-app

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

data/bin/rspec

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+set -e
+
+bin/rails-dummy-app generate solidus_braintree:install --force --migrate --specs=all
+
+cd dummy-app/
+rspec "$@"
+exit_status=$?
+cd -
+exit $exit_status

data/bin/sandbox

@@ -1,10 +1,6 @@
 #!/usr/bin/env bash
 
 set -e
-if [ -n "$DEBUG" ]
-then
-  set -x
-fi
 
 case "$DB" in
 postgres|postgresql)
@@ -13,51 +9,37 @@ postgres|postgresql)
 mysql)
   RAILSDB="mysql"
   ;;
-sqlite3|sqlite)
-  RAILSDB="sqlite3"
-  ;;
-'')
-  echo "~~> Use 'export DB=[postgres|mysql|sqlite]' to control the DB adapter"
+sqlite|'')
   RAILSDB="sqlite3"
   ;;
 *)
-  echo "Invalid value specified for the Solidus sandbox: DB=\"$DB\"."
-  echo "Please use 'postgres', 'mysql', or 'sqlite' instead."
+  echo "Invalid DB specified: $DB"
   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" ]
+if [ ! -z $SOLIDUS_BRANCH ]
 then
-  echo "~~> Use 'export SOLIDUS_FRONTEND=[solidus_frontend|solidus_starter_frontend]' to control the Solidus frontend"
-  SOLIDUS_FRONTEND="solidus_frontend"
+  BRANCH=$SOLIDUS_BRANCH
+else
+  BRANCH="master"
 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)' -- $@
+  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 \
+rails new sandbox \
+  --database="$RAILSDB" \
   --skip-git \
   --skip-keeps \
   --skip-rc \
-  --skip-spring \
-  --skip-test \
-  --skip-javascript
+  --skip-bootsnap \
+  --skip-test
 
 if [ ! -d "sandbox" ]; then
   echo 'sandbox rails application failed'
@@ -65,39 +47,15 @@ if [ ! -d "sandbox" ]; then
 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 add solidus --github solidusio/solidus --branch "${BRANCH:-master}" --version '> 0.a'
 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
+unbundled bundle exec rails generate solidus:install --payment-method=none --auto-accept "$@"
+unbundled bundle add ${extension_name} --path '../'
+unbundled bundle exec rails generate ${extension_name}:install --frontend=starter --migrate=true
 
 echo
-echo "🚀 Sandbox app successfully created for $extension_name!"
-echo "🧪 This app is intended for test purposes."
+echo "🚀 Sandbox app successfully created for ${extension_name}!"
+echo "🚀 Using $RAILSDB and Solidus $BRANCH"
+echo "🚀 Use 'export DB=[postgres|mysql|sqlite]' to control the DB adapter"
+echo "🚀 Use 'export SOLIDUS_BRANCH=<BRANCH-NAME>' to control the Solidus version"
+echo "🚀 This app is intended for test purposes."

data/db/migrate/20230210104310_add_device_data_to_braintree_sources.rb

@@ -0,0 +1,5 @@
+class AddDeviceDataToBraintreeSources < ActiveRecord::Migration[5.1]
+  def change
+    add_column :solidus_paypal_braintree_sources, :device_data, :string
+  end
+end

data/lib/generators/solidus_braintree/install/install_generator.rb

@@ -1,12 +1,41 @@
 # frozen_string_literal: true
 
+require 'rails/generators/app_base'
+
 module SolidusBraintree
   module Generators
-    class InstallGenerator < Rails::Generators::Base
-      class_option :auto_run_migrations, type: :boolean, default: false
+    class InstallGenerator < Rails::Generators::AppBase
+      argument :app_path, type: :string, default: Rails.root
+
+      class_option :migrate, type: :boolean, default: true
+      class_option :backend, type: :boolean, default: true
+      class_option :frontend, type: :string, default: 'starter'
+
+      # This is only used to run all-specs during development and CI,  regular installation limits
+      # installed specs to frontend, which are the ones related to code copied to the target application.
+      class_option :specs, type: :string, enum: %w[all frontend], default: 'frontend', hide: true
+
       source_root File.expand_path('templates', __dir__)
 
-      def setup_initializer
+      def normalize_components_options
+        @components = {
+          backend: options[:backend],
+          starter_frontend: options[:frontend] == 'starter',
+          classic_frontend: options[:frontend] == 'classic',
+        }
+      end
+
+      def add_test_gems
+        gem_group :test do
+          ['vcr', 'webmock'].each do |gem_name|
+            gem gem_name unless Bundler.locked_gems.dependencies[gem_name]
+          end
+        end
+
+        bundle_command 'install'
+      end
+
+      def setup_initializers
         legacy_initializer_pathname =
           Pathname.new(destination_root).join('config/initializers/solidus_paypal_braintree.rb')
 
@@ -17,57 +46,128 @@ module SolidusBraintree
             "SolidusPaypalBraintree.configure do |config|\n",
             "SolidusBraintree.configure do |config|\n"
         else
-          template 'initializer.rb', 'config/initializers/solidus_braintree.rb'
+          directory 'config/initializers', 'config/initializers'
         end
       end
 
-      def setup_javascripts
-        gsub_file 'vendor/assets/javascripts/spree/frontend/all.js',
-          "//= require spree/frontend/solidus_paypal_braintree\n", ''
-
-        append_file 'vendor/assets/javascripts/spree/frontend/all.js', "//= require spree/frontend/solidus_braintree\n"
+      def run_migrations
+        rake 'railties:install:migrations FROM=solidus_braintree'
+        run 'bin/rails db:migrate' if options[:migrate]
+      end
 
-        gsub_file 'vendor/assets/javascripts/spree/backend/all.js',
-          "//= require spree/backend/solidus_paypal_braintree\n", ''
+      def mount_engine
+        gsub_file 'config/routes.rb',
+          "mount SolidusPaypalBraintree::Engine, at: '/solidus_paypal_braintree'\n", ''
 
-        append_file 'vendor/assets/javascripts/spree/backend/all.js', "//= require spree/backend/solidus_braintree\n"
+        route "mount SolidusBraintree::Engine, at: '/solidus_braintree'"
       end
 
-      def setup_stylesheets
-        gsub_file 'vendor/assets/stylesheets/spree/frontend/all.css',
-          " *= require spree/frontend/solidus_paypal_braintree\n", ''
+      def install_solidus_backend_support
+        support_code_for(:backend) do
+          gsub_file 'vendor/assets/javascripts/spree/backend/all.js',
+            "//= require spree/backend/solidus_paypal_braintree\n", ''
 
-        inject_into_file 'vendor/assets/stylesheets/spree/frontend/all.css',
-          " *= require spree/frontend/solidus_braintree\n", before: %r{\*/}, verbose: true
+          append_file 'vendor/assets/javascripts/spree/backend/all.js',
+            "//= require spree/backend/solidus_braintree\n"
 
-        gsub_file 'vendor/assets/stylesheets/spree/backend/all.css',
-          " *= require spree/backend/solidus_paypal_braintree\n", ''
+          gsub_file 'vendor/assets/stylesheets/spree/backend/all.css',
+            " *= require spree/backend/solidus_paypal_braintree\n", ''
 
-        inject_into_file 'vendor/assets/stylesheets/spree/backend/all.css',
-          " *= require spree/backend/solidus_braintree\n", before: %r{\*/}, verbose: true
+          inject_into_file 'vendor/assets/stylesheets/spree/backend/all.css',
+            " *= require spree/backend/solidus_braintree\n", before: %r{\*/}, verbose: true
+        end
       end
 
-      def add_migrations
-        rake 'railties:install:migrations FROM=solidus_braintree'
+      def install_solidus_starter_frontend_support
+        support_code_for(:starter_frontend) do
+          directory 'app', 'app'
+
+          inject_into_file 'vendor/assets/javascripts/spree/frontend/all.js',
+            "//= require jquery3\n",
+            before: '//= require rails-ujs',
+            verbose: true
+
+          gsub_file 'vendor/assets/javascripts/spree/frontend/all.js',
+            "//= require spree/frontend/solidus_paypal_braintree\n", ''
+
+          append_file 'app/assets/javascripts/solidus_starter_frontend.js',
+            "//= require spree/frontend/solidus_braintree\n"
+
+          gsub_file 'vendor/assets/stylesheets/spree/frontend/all.css',
+            " *= require spree/frontend/solidus_paypal_braintree\n", ''
+
+          inject_into_file 'app/assets/stylesheets/solidus_starter_frontend.css',
+            " *= require spree/frontend/solidus_braintree\n", before: %r{\*/}, verbose: true
+
+          inject_into_class 'app/controllers/checkouts_controller.rb',
+            'CheckoutsController',
+            "  helper SolidusBraintree::BraintreeCheckoutHelper\n\n",
+            verbose: true
+
+          inject_into_class 'app/controllers/carts_controller.rb',
+            'CartsController',
+            "  helper SolidusBraintree::BraintreeCheckoutHelper\n\n",
+            verbose: true
+
+          inject_into_file 'app/views/orders/_payment_info.html.erb',
+            "        <li><%= render 'payments/braintree_payment_details', payment: payment %></li>\n",
+            after: "<li><%= payment.payment_method.name %></li>\n",
+            verbose: true
+
+          spec_paths =
+            case options[:specs]
+            when 'all' then %w[spec]
+            when 'frontend'
+              %w[
+                spec/solidus_braintree_helper.rb
+                spec/system/frontend
+                spec/support
+                spec/fixtures
+              ]
+            end
+
+          spec_paths.each do |path|
+            if engine.root.join(path).directory?
+              directory engine.root.join(path), path
+            else
+              template engine.root.join(path), path
+            end
+          end
+        end
       end
 
-      def mount_engine
-        gsub_file 'config/routes.rb',
-          "mount SolidusPaypalBraintree::Engine, at: '/solidus_paypal_braintree'\n", ''
-
-        route "mount SolidusBraintree::Engine, at: '/solidus_braintree'"
+      def alert_no_classic_frontend_support
+        support_code_for(:classic_frontend) do
+          message = <<~TEXT
+            For solidus_frontend compatibility, please use version 2.x.
+            The new version of this extension only supports Solidus Starter Frontend.
+            No frontend code has been copied to your application.
+          TEXT
+          say_status :error, set_color(message.tr("\n", ' '), :red), :red
+        end
       end
 
-      def run_migrations
-        run_migrations = options[:auto_run_migrations] ||
-          ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]'))
+      private
 
-        if run_migrations
-          rake 'db:migrate'
+      def support_code_for(component_name, &block)
+        if @components[component_name]
+          say_status :install, "[#{engine.engine_name}] solidus_#{component_name}", :blue
+          shell.indent(&block)
         else
-          puts 'Skipping bin/rails db:migrate, don\'t forget to run it!' # rubocop:disable Rails/Output
+          say_status :skip, "[#{engine.engine_name}] solidus_#{component_name}", :blue
         end
       end
+
+      def engine
+        SolidusBraintree::Engine
+      end
+
+      def bundle_command(command, env = {})
+        # Make `bundle install` less verbose by skipping the "Using ..." messages
+        super(command, env.reverse_merge('BUNDLE_SUPPRESS_INSTALL_USING_MESSAGES' => 'true'))
+      ensure
+        Bundler.reset_paths!
+      end
     end
   end
 end

data/{app → lib/generators/solidus_braintree/install/templates/app}/assets/javascripts/spree/frontend/paypal_button.js

@@ -1,4 +1,4 @@
-//= require solidus_braintree/paypal_button
+//= require spree/frontend/solidus_braintree/paypal_button
 
 // This is the PayPal button on the cart page
 $(document).ready(function() {

data/lib/generators/solidus_braintree/install/templates/app/assets/javascripts/spree/frontend/solidus_braintree/ajax.js

@@ -0,0 +1,13 @@
+SolidusBraintree.ajax = function(url, options) {
+  if (typeof url === "object") {
+    options = url;
+    url = undefined;
+  }
+  options = options || {};
+  options = $.extend(options, {
+    headers: {
+      'Authorization': 'Bearer '
+    }
+  });
+  return $.ajax(url, options);
+};

data/{app/assets/javascripts → lib/generators/solidus_braintree/install/templates/app/assets/javascripts/spree/frontend}/solidus_braintree/apple_pay_button.js

@@ -1,4 +1,4 @@
-//= require solidus_braintree/constants
+//= require spree/frontend/solidus_braintree/constants
 /**
  * Constructor for Apple Pay button object
  * @constructor
@@ -94,7 +94,7 @@ SolidusBraintree.ApplepayButton.prototype.tokenize = function (session, payment)
 };
 
 SolidusBraintree.ApplepayButton.prototype._createTransaction = function (session, payment, payload) {
-  Spree.ajax({
+  SolidusBraintree.ajax({
     data: this._transactionParams(payload, payment.shippingContact),
     dataType: 'json',
     type: 'POST',

data/{app/assets/javascripts → lib/generators/solidus_braintree/install/templates/app/assets/javascripts/spree/frontend}/solidus_braintree/checkout.js

@@ -1,4 +1,4 @@
-//= require solidus_braintree/frontend
+//= require spree/frontend/solidus_braintree/frontend
 
 $(function() {
   /* This provides a default error handler for Braintree. Since we prevent
@@ -40,9 +40,9 @@ $(function() {
     $paymentForm.on("submit",function(event) {
       var $field = $(hostedField);
 
-      if ($field.is(":visible") && !$field.data("submitting")) {
+      if ($field.is(":visible") && $field.is(":enabled") && !$field.data("submitting")) {
         var $nonce = $("#payment_method_nonce", $field);
-
+        var $deviceData = $("#device_data", $field);
         if ($nonce.length > 0 && $nonce.val() === "") {
           var client = braintreeForm._merchantConfigurationOptions._solidusClient;
 
@@ -56,6 +56,10 @@ $(function() {
             }
 
             $nonce.val(payload.nonce);
+            
+            if (client._dataCollectorInstance) {
+              $deviceData.val(client._dataCollectorInstance.deviceData);
+            }
 
             if (!client.useThreeDSecure) {
               $paymentForm.submit();
@@ -84,7 +88,7 @@ $(function() {
 
   var $paymentForm = $("#checkout_form_payment");
   var $hostedFields = $("[data-braintree-hosted-fields]");
-  var $submitButton = $("input[type='submit']", $paymentForm);
+  var $submitButton = $("[type='submit']", $paymentForm);
 
   // If we're not using hosted fields, the form doesn't need to wait.
   if ($hostedFields.length > 0) {
@@ -93,8 +97,9 @@ $(function() {
     var fieldPromises = $hostedFields.map(function(index, field) {
       var $this = $(this);
       var id = $this.data("id");
+      var useDataCollector = $this.data("use-data-collector");
 
-      var braintreeForm = new SolidusBraintree.createHostedForm(id);
+      var braintreeForm = new SolidusBraintree.createHostedForm(id, useDataCollector);
 
       var formInitializationSuccess = function(formObject) {
         addFormHook(formObject, field);