solidus_braintree 1.4.0 → 2.0.0

data/config/locales/en.yml

@@ -1,4 +1,96 @@
 en:
+  activerecord:
+    models:
+      solidus_braintree/gateway: Braintree
+    attributes:
+      solidus_braintree/configuration:
+        paypal: PayPal
+        apple_pay: Apple Pay
+        credit_card: Credit Card
+        three_d_secure: 3D Secure
+        venmo: Venmo
+  spree:
+    admin:
+      tab:
+        braintree: Braintree
+    client_sdk_enabled: Client SDK enabled?
+    environment: Environment
+    merchant_currency_map: Merchant currency map
+    merchant_id: Merchant ID
+    paypal_payee_email_map: Paypal payee email map
+    private_key: Private key
+    public_key: Public key
+    token_generation_enabled: Token generation enabled?
+    paypal_flow: PayPal flow
+    paypal_funding: 'PayPal Funding: %{funding}'
+    paypal_funding_source: 'PayPal Funding Source'
   solidus_braintree:
-    paypal_header_html: <h5>Checkout with</h5>
-    creditcard_header_html: <p class="or">or</p><h5>Enter a credit card:</h5>
+    braintree: Braintree
+    nonce: Nonce
+    token: Token
+    errors:
+      default_error: "Something bad happened!"
+      paypal_popup_closed: "PayPal popup has been closed before payment completion."
+      empty_fields: "All fields are empty! Please fill out the form."
+      invalid_fields: "Some payment input fields are invalid."
+      invalid_card: "Credit card data is incorrect."
+      network_error: "Network error occurred."
+      duplicate_iframe: "Duplicate Braintree iframe."
+      fail_on_duplicate: "This payment method already exists in your vault."
+      cvv_verification_failed: "CVV did not pass verification."
+      threeds:
+        authentication_failed: "3D Secure authentication failed. Please try again using a different payment method."
+      venmo:
+        canceled: "App is not available or you aborted the payment flow."
+        desktop_canceled: "Venmo authorization was canceled by closing the Venmo Desktop modal."
+        app_canceled: "Payment flow was canceled."
+    payment_type:
+      label: Payment Type
+      apple_pay_card: Apple Pay
+      credit_card: Credit Card
+      pay_pal_account: PayPal
+      venmo_account: Venmo
+    configurations:
+      title: Braintree Configurations
+      tab: Braintree
+      update_success: Successfully updated Braintree configurations.
+      update_error: An error occurred while updating Braintree configurations.
+    gateway_rejection_reasons:
+      avs: AVS check failed.
+      avs_and_cvv: AVS and CVV check failed.
+      cvv: CVV check failed.
+      duplicate: Duplicate transaction.
+      fraud: Credit card was rejected because of potential fraud.
+      three_d_secure: 3D Secure check failed.
+    transaction_statuses:
+      authorization_expired: Payment authorization has expired.
+      failed: An error occurred when sending the transaction to the processor.
+      gateway_rejected: Gateway rejected this transaction.
+      processor_declined: Processor declined this transaction.
+      settlement_declined: Settlement was declined by processor.
+    paypal_funding_sources:
+       applepay: 'Apple Pay'
+       bancontact: 'Bancontact'
+       blik: 'BLIK'
+       boleto: 'Boleto'
+       card: 'Credit or debit card'
+       credit: 'PayPal Credit'
+       eps: 'eps'
+       giropay: 'giropay'
+       ideal: 'iDEAL'
+       itau: 'Itau'
+       maxima: 'Maxima'
+       mercadopago: 'Mercado Pago'
+       mybank: 'MyBank'
+       oxxo: 'Oxxo'
+       p24: 'Przelewy24'
+       paylater: 'Pay Later'
+       paypal: 'PayPal'
+       payu: 'PayU'
+       sepa: 'SEPA-Lastschrift'
+       sofort: 'Sofort'
+       trustly: 'Trustly'
+       venmo: 'Venmo'
+       verkkopankki: 'Verkkopankki'
+       wechatpay: 'WeChat Pay'
+       zimpler: 'Zimpler'

data/config/locales/it.yml

@@ -0,0 +1,56 @@
+it:
+  activerecord:
+    models:
+      solidus_braintree/gateway: Braintree
+  spree:
+    admin:
+      tab:
+        braintree: Braintree
+    client_sdk_enabled: Client SDK abilitato?
+    environment: Environment
+    merchant_currency_map: Associazioni tra merchant Braintree e valute
+    merchant_id: Merchant ID
+    paypal_payee_email_map: Associazioni tra email beneficiari PayPal e valute
+    private_key: Private key
+    public_key: Public key
+    token_generation_enabled: Generazione dei Token abilitata?
+    paypal_flow: Flusso PayPal
+  solidus_braintree:
+    braintree: Braintree
+    nonce: Nonce
+    token: Token
+    errors:
+      default_error: Qualcosa è andato storto!
+      paypal_popup_closed: La finestra di PayPal è stata chiusa prima di completare il pagamento.
+      empty_fields: I campi non possono essere vuoti!
+      invalid_fields: Alcuni campi non sono corretti.
+      invalid_card: I dati della carta di credito non sono corretti.
+      network_error: Si è verificato un errore di rete.
+      duplicate_iframe: Ci sono due iframe di Braintree.
+      fail_on_duplicate: Questo metodo di pagamento esiste già.
+      cvv_verification_failed: Il codice CVV non è corretto.
+      threeds:
+        authentication_failed: "Autenticazione 3D Secure fallita. Riprova usando un altro metodo di pagamento."
+    payment_type:
+      label: Metodo di Pagamento
+      apple_pay_card: Apple Pay
+      credit_card: Carta di credito
+      pay_pal_account: PayPal
+    configurations:
+      title: Configurazioni di Braintree
+      tab: Braintree
+      update_success: Configurazioni di Braintree aggiornate con successo.
+      update_error: Si è verificato un errore durante l'aggiornamento delle configurazioni di Braintree.
+    gateway_rejection_reasons:
+      avs: Controllo AVS fallito.
+      avs_and_cvv: Controlli AVS e CVV falliti.
+      cvv: Controllo CVV fallito.
+      duplicate: Transazione duplicata.
+      fraud: La carta di credito è stata rifiutata a seguito di un potenziale uso fraudolento.
+      three_d_secure: Controllo '3D Secure' fallito.
+    transaction_statuses:
+      authorization_expired: L'autorizzazione di pagamento è scaduta.
+      failed: Si è verificato un errore durante l'invio della transazione al sistema di pagamento.
+      gateway_rejected: Il gateway di pagamento ha rifiutato questa transazione.
+      processor_declined: Il sistema di pagamento ha rifiutato questa transazione.
+      settlement_declined: Il saldo di questa transazione è stato rifiutato dal sistema di pagamento.

data/config/routes.rb

@@ -1,5 +1,14 @@
-Spree::Core::Engine.routes.draw do
-  namespace :api, defaults: { format: 'json' } do
-    resource  :payment_client_token, only: [:create], controller: 'braintree_client_token'
+# frozen_string_literal: true
+
+SolidusBraintree::Engine.routes.draw do
+  resource :checkout, only: [:update, :edit]
+  resource :client_token, only: [:create], format: :json
+  resource :transactions, only: [:create]
+
+  resources :configurations do
+    collection do
+      get :list
+      post :update
+    end
   end
 end

data/db/migrate/20160830061749_create_solidus_paypal_braintree_sources.rb

@@ -0,0 +1,16 @@
+class CreateSolidusPaypalBraintreeSources < SolidusSupport::Migration[4.2]
+  def change
+    create_table :solidus_paypal_braintree_sources do |t|
+      t.string :nonce
+      t.string :token
+      t.string :payment_type
+      t.integer :user_id, index: true
+      t.references :customer, index: true
+      t.references :payment_method, index: true
+
+      t.timestamps null: false
+    end
+
+    add_foreign_key :solidus_paypal_braintree_sources, :spree_payment_methods, column: :payment_method_id
+  end
+end

data/db/migrate/20160906201711_create_solidus_paypal_braintree_customers.rb

@@ -0,0 +1,13 @@
+class CreateSolidusPaypalBraintreeCustomers < SolidusSupport::Migration[4.2]
+  def change
+    create_table :solidus_paypal_braintree_customers do |t|
+      t.references :user
+      t.string :braintree_customer_id
+
+      t.timestamps
+    end
+
+    add_index :solidus_paypal_braintree_customers, :user_id, unique: true, name: "index_braintree_customers_on_user_id"
+    add_index :solidus_paypal_braintree_customers, :braintree_customer_id, unique: true, name: "index_braintree_customers_on_braintree_customer_id" # rubocop:disable Layout/LineLength
+  end
+end

data/db/migrate/20161114231422_create_solidus_paypal_braintree_configurations.rb

@@ -0,0 +1,11 @@
+class CreateSolidusPaypalBraintreeConfigurations < SolidusSupport::Migration[4.2]
+  def change
+    create_table :solidus_paypal_braintree_configurations do |t|
+      t.boolean :paypal,    null: false, default: false
+      t.boolean :apple_pay, null: false, default: false
+      t.integer :store_id,  null: false, index: true, foreign_key: { references: :spree_stores }
+
+      t.timestamps null: false
+    end
+  end
+end

data/db/migrate/20161125172005_add_braintree_configuration_to_stores.rb

@@ -0,0 +1,7 @@
+class AddBraintreeConfigurationToStores < SolidusSupport::Migration[4.2]
+  # The content of this migration has been removed because store's Braintree
+  # configuration doesn't already have paypal_button_preferences fields, so
+  # their validations will break this migration.
+  #
+  # Ref here for more info https://github.com/solidusio/solidus_paypal_braintree/pull/249
+end

data/db/migrate/20170203191030_add_credit_card_to_braintree_configuration.rb

@@ -0,0 +1,6 @@
+class AddCreditCardToBraintreeConfiguration < SolidusSupport::Migration[4.2]
+  def change
+    add_column :solidus_paypal_braintree_configurations, :credit_card,
+      :boolean, null: false, default: false
+  end
+end

data/db/migrate/20170505193712_add_null_constraint_to_sources.rb

@@ -0,0 +1,38 @@
+class AddNullConstraintToSources < SolidusSupport::Migration[4.2]
+  class SpreePayment < ActiveRecord::Base
+  end
+
+  class SolidusPaypalBraintreeSource < ActiveRecord::Base
+  end
+
+  def up
+    payments = SpreePayment.arel_table
+    sources = SolidusPaypalBraintreeSource.arel_table
+    join_sources = payments.join(sources).on(
+      payments[:source_id].eq(sources[:id]).and(
+        payments[:source_type].eq("SolidusPaypalBraintree::Source")
+      ).and(
+        sources[:payment_method_id].eq(nil)
+      )
+    ).join_sources
+
+    count = SpreePayment.joins(join_sources).count
+    Rails.logger.info("Updating #{count} problematic sources")
+
+    SpreePayment.joins(join_sources).find_each do |payment|
+      Rails.logger.info("Updating source #{payment.source_id} with payment method id #{payment.payment_method_id}")
+      SolidusPaypalBraintreeSource.where(id: payment.source_id).update_all(
+        payment_method_id: payment.payment_method_id
+      )
+    end
+
+    # We use a foreign key constraint on the model,
+    # but it doesnt make sense to have this model exist without a payment method
+    # as two of its methods delegate to the payment method.
+    change_column_null(:solidus_paypal_braintree_sources, :payment_method_id, false)
+  end
+
+  def down
+    change_column_null(:solidus_paypal_braintree_sources, :payment_method_id, true)
+  end
+end

data/db/migrate/20170508085402_add_not_null_constraint_to_sources_payment_type.rb

@@ -0,0 +1,14 @@
+class AddNotNullConstraintToSourcesPaymentType < SolidusSupport::Migration[4.2]
+  class SolidusPaypalBraintreeSource < ActiveRecord::Base
+  end
+
+  def change
+    reversible do |dir|
+      dir.up do
+        SolidusPaypalBraintreeSource.where(payment_type: nil).
+          update_all(payment_type: 'CreditCard')
+      end
+    end
+    change_column_null(:solidus_paypal_braintree_sources, :payment_type, false)
+  end
+end

data/db/migrate/20190705115327_add_paypal_button_preferences_to_braintree_configurations.rb

@@ -0,0 +1,5 @@
+class AddPaypalButtonPreferencesToBraintreeConfigurations < ActiveRecord::Migration[5.1]
+  def change
+    add_column :solidus_paypal_braintree_configurations, :preferences, :text
+  end
+end

data/db/migrate/20190911141712_add_3d_secure_to_braintree_configuration.rb

@@ -0,0 +1,5 @@
+class Add3dSecureToBraintreeConfiguration < SolidusSupport::Migration[4.2]
+  def change
+    add_column :solidus_paypal_braintree_configurations, :three_d_secure, :boolean, null: false, default: false
+  end
+end

data/db/migrate/20211222170950_add_paypal_funding_source_to_solidus_paypal_braintree_sources.rb

@@ -0,0 +1,5 @@
+class AddPaypalFundingSourceToSolidusPaypalBraintreeSources < ActiveRecord::Migration[5.0]
+  def change
+    add_column :solidus_paypal_braintree_sources, :paypal_funding_source, :integer
+  end
+end

data/db/migrate/20220104150301_add_venmo_to_braintree_configuration.rb

@@ -0,0 +1,5 @@
+class AddVenmoToBraintreeConfiguration < ActiveRecord::Migration[5.0]
+  def change
+    add_column :solidus_paypal_braintree_configurations, :venmo, :boolean, null: false, default: false
+  end
+end

data/db/migrate/20230109080950_rename_solidus_paypal_braintree_source_type.rb

@@ -0,0 +1,31 @@
+class RenameSolidusPaypalBraintreeSourceType < ActiveRecord::Migration[6.1]
+  # This is based on the best practices recommended in
+  # https://github.com/ankane/strong_migrations#backfilling-data on how to
+  # safely update a table.
+
+  disable_ddl_transaction!
+
+  def up
+    Spree::Payment.unscoped
+      .where(source_type: 'SolidusPaypalBraintree::Source').in_batches do |relation|
+        relation.update_all("source_type = 'SolidusBraintree::Source'")
+        sleep(0.01)
+      end
+
+    Spree::WalletPaymentSource.unscoped
+      .where(payment_source_type: 'SolidusPaypalBraintree::Source').in_batches do |relation|
+        relation.update_all("payment_source_type = 'SolidusBraintree::Source'")
+        sleep(0.01)
+      end
+
+    Spree::PaymentMethod.unscoped
+      .where('type = ?', 'SolidusPaypalBraintree::Gateway').in_batches do |relation|
+        relation.update_all("type = 'SolidusBraintree::Gateway'")
+        sleep(0.01)
+      end
+  end
+
+  def down
+    raise ActiveRecord::IrreversibleMigration
+  end
+end

data/lib/controllers/backend/solidus_braintree/configurations_controller.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module SolidusBraintree
+  class ConfigurationsController < ::Spree::Admin::BaseController
+    helper ::Spree::Core::Engine.routes.url_helpers
+
+    def list
+      authorize! :list, SolidusBraintree::Configuration
+
+      @configurations = ::Spree::Store.all.map { |s| s.braintree_configuration || s.create_braintree_configuration }
+    end
+
+    def update
+      authorize! :update, SolidusBraintree::Configuration
+
+      params = configurations_params[:configuration_fields]
+      results = SolidusBraintree::Configuration.update(params.keys, params.values)
+      if results.all?(&:valid?)
+        flash[:success] = t('update_success', scope: 'solidus_braintree.configurations')
+      else
+        flash[:error] = t('update_error', scope: 'solidus_braintree.configurations')
+      end
+      redirect_to action: :list
+    end
+
+    private
+
+    def configurations_params
+      params.require(:configurations).
+        permit(configuration_fields: [
+          :paypal,
+          :apple_pay,
+          :venmo,
+          :credit_card,
+          :three_d_secure,
+          :preferred_paypal_button_locale,
+          :preferred_paypal_button_color,
+          :preferred_paypal_button_shape,
+          :preferred_paypal_button_label,
+          :preferred_paypal_button_tagline,
+          :preferred_paypal_button_layout,
+          :preferred_paypal_button_messaging,
+          :preferred_venmo_button_color,
+          :preferred_venmo_button_width
+        ])
+    end
+  end
+end

data/lib/controllers/frontend/solidus_braintree/checkouts_controller.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module SolidusBraintree
+  class CheckoutsController < ::Spree::CheckoutController
+    PERMITTED_PAYMENT_PARAMS = [
+      :payment_method_id,
+      { source_attributes: [
+        :nonce,
+        :payment_type
+      ] }
+    ].freeze
+
+    def update
+      @payment = ::Spree::PaymentCreate.new(@order, payment_params).build
+
+      if @payment.save
+        render plain: "ok"
+      else
+        render plain: "not-ok"
+      end
+    end
+
+    def payment_params
+      params.
+        require(:order).
+        require(:payments_attributes).
+        first.
+        permit(PERMITTED_PAYMENT_PARAMS)
+    end
+  end
+end

data/lib/controllers/frontend/solidus_braintree/transactions_controller.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module SolidusBraintree
+  class TransactionsController < ::Spree::StoreController
+    class InvalidImportError < StandardError; end
+
+    PERMITTED_BRAINTREE_TRANSACTION_PARAMS = [
+      :nonce,
+      :payment_type,
+      :paypal_funding_source,
+      :phone,
+      :email,
+      { address_attributes: [
+        :country_code, :country_name, :name, :city, :zip, :state_code,
+        :address_line_1, :address_line_2, :first_name, :last_name
+      ] }
+    ].freeze
+
+    def create
+      transaction = SolidusBraintree::Transaction.new transaction_params
+      import = SolidusBraintree::TransactionImport.new(current_order, transaction)
+      restart_checkout = params[:options] && params[:options][:restart_checkout] == "true"
+
+      respond_to do |format|
+        if import.valid?
+          import.import!(import_state, restart_checkout: restart_checkout)
+
+          format.html { redirect_to redirect_url(import) }
+          format.json { render json: { redirectUrl: redirect_url(import) } }
+        else
+          status = 422
+          format.html { import_error(import) }
+          format.json { render json: { errors: import.errors, status: status }, status: status }
+        end
+      end
+    end
+
+    private
+
+    def import_state
+      params[:state] || 'confirm'
+    end
+
+    def import_error(import)
+      raise InvalidImportError,
+        "Import invalid: #{import.errors.full_messages.join(', ')}"
+    end
+
+    def redirect_url(import)
+      if import.order.complete?
+        spree.order_url(import.order)
+      else
+        spree.checkout_state_url(import.order.state)
+      end
+    end
+
+    def transaction_params
+      params.require(:transaction)
+        .permit(PERMITTED_BRAINTREE_TRANSACTION_PARAMS)
+        .merge({ payment_method: payment_method })
+    end
+
+    def payment_method
+      SolidusBraintree::Gateway.find(params[:payment_method_id])
+    end
+  end
+end

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

@@ -1,36 +1,72 @@
+# frozen_string_literal: true
+
 module SolidusBraintree
   module Generators
     class InstallGenerator < Rails::Generators::Base
       class_option :auto_run_migrations, type: :boolean, default: false
+      source_root File.expand_path('templates', __dir__)
+
+      def setup_initializer
+        legacy_initializer_pathname =
+          Pathname.new(destination_root).join('config/initializers/solidus_paypal_braintree.rb')
+
+        if legacy_initializer_pathname.exist?
+          legacy_initializer_pathname.rename('config/initializers/solidus_braintree.rb')
+
+          gsub_file 'config/initializers/solidus_braintree.rb',
+            "SolidusPaypalBraintree.configure do |config|\n",
+            "SolidusBraintree.configure do |config|\n"
+        else
+          template 'initializer.rb', 'config/initializers/solidus_braintree.rb'
+        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 add_javascripts
-        append_file "vendor/assets/javascripts/spree/frontend/all.js", "//= require spree/frontend/braintree/solidus_braintree\n"
-        append_file "vendor/assets/javascripts/spree/backend/all.js", "//= require spree/backend/braintree/solidus_braintree\n"
+        gsub_file 'vendor/assets/javascripts/spree/backend/all.js',
+          "//= require spree/backend/solidus_paypal_braintree\n", ''
+
+        append_file 'vendor/assets/javascripts/spree/backend/all.js', "//= require spree/backend/solidus_braintree\n"
       end
 
-      def add_stylesheets
-        inject_into_file "vendor/assets/stylesheets/spree/frontend/all.css", " *= require spree/frontend/solidus_braintree\n", before: '*/', verbose: true
+      def setup_stylesheets
+        gsub_file 'vendor/assets/stylesheets/spree/frontend/all.css',
+          " *= require spree/frontend/solidus_paypal_braintree\n", ''
+
+        inject_into_file 'vendor/assets/stylesheets/spree/frontend/all.css',
+          " *= require spree/frontend/solidus_braintree\n", before: %r{\*/}, verbose: true
+
+        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
       end
 
       def add_migrations
-        run 'bundle exec rake railties:install:migrations FROM=solidus_braintree'
+        rake 'railties:install:migrations FROM=solidus_braintree'
       end
 
-      def run_migrations
-         if running_migrations?
-           run 'bundle exec rake db:migrate'
-         else
-           puts "Skiping rake db:migrate, don't forget to run it!"
-         end
+      def mount_engine
+        gsub_file 'config/routes.rb',
+          "mount SolidusPaypalBraintree::Engine, at: '/solidus_paypal_braintree'\n", ''
+
+        route "mount SolidusBraintree::Engine, at: '/solidus_braintree'"
       end
 
-      private
+      def run_migrations
+        run_migrations = options[:auto_run_migrations] ||
+          ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]'))
 
-      def running_migrations?
-         options.auto_run_migrations? || begin
-           response = ask 'Would you like to run the migrations now? [Y/n]'
-           ['', 'y'].include? response.downcase
-         end
+        if run_migrations
+          rake 'db:migrate'
+        else
+          puts 'Skipping bin/rails db:migrate, don\'t forget to run it!' # rubocop:disable Rails/Output
+        end
       end
     end
   end

data/lib/generators/solidus_braintree/install/templates/initializer.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+SolidusBraintree.configure do |config|
+  # TODO: Remember to change this with the actual preferences you have implemented!
+  # config.sample_preference = 'sample_value'
+end

data/lib/solidus_braintree/country_mapper.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module SolidusBraintree
+  module CountryMapper
+    extend ActiveSupport::Concern
+
+    USA_VARIANTS = [
+      "the united states of america",
+      "united states of america",
+      "the united states",
+      "united states",
+      "us of a",
+      "u.s.a.",
+      "usa",
+      "u.s.",
+      "us"
+    ].freeze
+
+    CANADA_VARIANTS = [
+      "canada",
+      "ca"
+    ].freeze
+
+    # Generates a hash mapping each variant of the country name to the same ISO
+    # ie: { "usa" => "US", "united states" => "US", "canada" => "CA", ... }
+    COUNTRY_MAP = {
+      USA_VARIANTS => "US",
+      CANADA_VARIANTS => "CA"
+    }.flat_map { |variants, iso| variants.map { |v| [v, iso] } }.to_h
+
+    included do
+      def iso_from_name(country_name)
+        COUNTRY_MAP[country_name.downcase.strip]
+      end
+    end
+  end
+end