Merge pull request #134 from solidusio/gsmendoza/131-backport-readme-…

…changes

Backport SolidusBraintree README changes to v2.x

README.md

@@ -3,9 +3,12 @@
 [![CircleCI](https://circleci.com/gh/solidusio/solidus_braintree.svg?style=shield)](https://circleci.com/gh/solidusio/solidus_braintree)
 [![codecov](https://codecov.io/gh/solidusio/solidus_braintree/branch/master/graph/badge.svg)](https://codecov.io/gh/solidusio/solidus_braintree)
 
-`solidus_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.
+`solidus_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 uses Braintree's [JavaScript v3 SDK](https://braintree.github.io/braintree-web/current/) to support the following Braintree payment method types:
 
-🚧 This extension is currently only compatible with the legacy `solidus_frontend` 🚧
+* [Apple Pay](https://developer.paypal.com/braintree/docs/guides/apple-pay/overview)
+* [Venmo](https://developer.paypal.com/braintree/docs/guides/venmo/overview)
+* [PayPal Checkout](https://developer.paypal.com/braintree/docs/guides/paypal/overview/javascript/v3)
+* [Credit Cards](https://developer.paypal.com/braintree/docs/guides/credit-cards/overview) via [Hosted Forms](https://developer.paypal.com/braintree/docs/guides/hosted-fields/overview)
 
 ## Installation
 
@@ -22,29 +25,23 @@ bundle
 bundle exec rails g solidus_braintree:install
 ```
 
-## Naming is hard: from SolidusBraintree to SolidusPaypalBraintree and then back to SolidusBraintree
+## Upgrading (including migration from SolidusPaypalBraintree)
 
-This gem is the result of merging two gems: the original SolidusBraintree gem, which was deprecated in 2020, and the SolidusPaypalBraintree gem, which was written from scratch to replace it. The updated codebase is based solely on the SolidusPaypalBraintree code. However, we've renamed the gem back to SolidusBraintree to make it clear that it's backed by Braintree. The name also differentiates it from the official Solidus PayPal extension, SolidusPaypalCommercePlatform.
+See https://github.com/solidusio/solidus_braintree/wiki/Upgrading.
 
-Take note that for now we are keeping the `solidus_paypal_braintree` prefix for SolidusBraintree database tables. Renaming tables can be a potentially risky operation, and we wanted to reduce the friction in updating to v2.0.0. For details, please see https://github.com/solidusio/solidus_braintree/issues/101.
+## Compatibility
 
-## Upgrading from SolidusPaypalBraintree 1.2.0 to SolidusBraintree 2.0.0
+Here are the versions of SolidusBraintree and their compatible Solidus and frontend versions:
 
-With the gem renamed to SolidusBraintree, you'll need to:
+| Version              | Maintenance Status          | Frontend               | Branch   |
+|----------------------|-----------------------------|------------------------|----------|
+| SolidusBraintree 3.0 | New features                | SolidusStarterFrontend | [master] |
+| SolidusBraintree 2.0 | Security patches, bug fixes | SolidusFrontend        | [v2.x]   |
+| SolidusBraintree 1.2 | Deprecated                  | SolidusFrontend        | [v1.x]   |
 
-1. Change the gem in your Gemfile from `gem 'solidus_paypal_braintree'` to `gem 'solidus_braintree', '~> 2.0.0'`. If you have your own references to `SolidusPaypalBraintree` in your app, you may need to require the `solidus_paypal_braintree` alias in your Gemfile, i.e.
-
-    ```ruby
-    gem 'solidus_braintree', '~> 2.0.0'`, require: 'solidus_paypal_braintree'
-    ```
-
-2. Run `bin/rails g solidus_braintree:install`. This will update some references to SolidusPaypalBraintree in your app. It will also add a data migration to update your database.
-
-Additionally, you can rename any other references to SolidusPaypalBraintree in your app to SolidusBraintree. This will fix any deprecation warnings that come with SolidusBraintree 2.0.0.
-
-## Here be dragons: upgrading from SolidusBraintree 1.2.0
-
-Considering that SolidusBraintree 2.0.0 is based on the SolidusPaypalBraintree codebase, please be warned that migrating directly from SolidusBraintree 1.2.0 to 2.0.0 would lead to breaking changes. Since SolidusBraintree 1.x was already [deprecated](https://github.com/solidusio/solidus_braintree/tree/v1.x#deprecation-notice-warning-construction), we don't provide at the moment a ready-made solution for migrating from SolidusBraintree 1.2.0 to 2.0.0.
+[v1.x]: https://github.com/solidusio/solidus_braintree/tree/v1.x
+[v2.x]: https://github.com/solidusio/solidus_braintree/tree/v2.x
+[master]: https://github.com/solidusio/solidus_braintree/tree/master
 
 ## Basic Setup
 
@@ -119,7 +116,7 @@ Your payment method can accept payments in three ways: through Paypal, through A
   end
   ```
 
-4. If your site uses an unmodified `solidus_frontend`, it should now be ready to take payments. See below for more information on configuring Paypal and ApplePay.
+4. If your site uses an unmodified Solidus Starter Frontend, it should now be ready to take payments. See below for more information on configuring Paypal and ApplePay.
 
 5. Typical Solidus sites will have customized frontend code, and may require some additional work. Use `lib/views/frontend/spree/checkout/payment/_braintree.html.erb` and `app/assets/javascripts/solidus_braintree/checkout.js` as models.
 
@@ -321,27 +318,7 @@ information, which we've included by default. You're able to turn off the PayPal
 data collector on the payment method preferences if you desire. If you use
 static preferences, add `use_data_collector: false` to your initializer.
 
-## Optional configuration
-
-### Accepting multiple currencies
-The payment method also provides an optional preference `merchant_currency_map`.
-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_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_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
-has each payment type disabled. It also adds a `before_create` callback to
-`Spree::Store` that builds a default configuration. You can customize the
-default configuration that gets created by overriding the private
-`build_default_configuration` method on `Spree::Store`.
+## Credit cards
 
 ### 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)
@@ -364,6 +341,28 @@ 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.
 
+## Optional configuration
+
+### Accepting multiple currencies
+The payment method also provides an optional preference `merchant_currency_map`.
+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_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_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
+has each payment type disabled. It also adds a `before_create` callback to
+`Spree::Store` that builds a default configuration. You can customize the
+default configuration that gets created by overriding the private
+`build_default_configuration` method on `Spree::Store`.
+
 ## Testing
 
 To run the specs it is required to set the Braintree test account data in these environment variables:

app/models/solidus_braintree/transaction.rb

@@ -17,7 +17,7 @@ class Transaction
       unless payment_method.is_a? SolidusBraintree::Gateway
         errors.add(:payment_method, 'Must be braintree')
       end
-      if address && !address.valid?
+      if address&.invalid?
         address.errors.each do |error|
           errors.add(:address, error.full_message)
         end

app/models/solidus_braintree/transaction_import.rb

@@ -9,9 +9,9 @@ class InvalidImportError < StandardError; end
     include ActiveModel::Model
 
     validate do
-      errors.add("Address", "is invalid") if address && !address.valid?
+      errors.add("Address", "is invalid") if address&.invalid?
 
-      if !transaction.valid?
+      if transaction.invalid?
         transaction.errors.each do |error|
           errors.add(error.attribute, error.message)
         end