workarea-paypal 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 159d0b080b0fb36119cdf1c15e0ca07936e938237fd012ed67ddf8f6121dbb53
-  data.tar.gz: 7d8812db2e69fc22092bfcca4aa61d30a7578f2d7b5852bbc2f321d47a28f734
+  metadata.gz: ec2de3863ee37303126a6f3b58f9e0e0e0081f983fcc7436eeef937b8429115d
+  data.tar.gz: 976987d8fb51788da045850771b4b7c76ee9dbe2b6d7c781dc4e9874e1dde8cf
 SHA512:
-  metadata.gz: 834c524e29ee8e810f6e9ee3dace1ab105e8665c19315a1a3664f14e88118bb1bb0705af5729fbbc11b4ba439bdf7e4f9c8d19dfe9a840938cef9f84255dfc0f
-  data.tar.gz: b0ffa2b76120f84ecccf2973cc2dee52e3001a2a5403a5f4c249b82cc222a01f8e391ad420557840737730429ed5ce36a2c867736413ad38a9efefe3277bb65a
+  metadata.gz: 3d92e73fd62a729f1a0bc9d94798f181f266958cf6bd03cf05ed753650edf7cf00d12b054d0aa219bd361c57be979f116a0b605c48d9fcb857776a39c4450bde
+  data.tar.gz: 82ed3baaf020fbaded7337706681b204bff951827f13180ccb8d91a13c5df1bed0d08ddcda4b44858bcade41ecf9ea7c6cdfd60575cef110d148255532d8e44d

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+Workarea Paypal 3.0.1 (2020-03-17)
+--------------------------------------------------------------------------------
+
+*   Add upgrade guide
+
+    PAYPAL-6
+    Matt Duffy
+
+
+
 Workarea Paypal 3.0.0 (2020-03-03)
 --------------------------------------------------------------------------------
 

data/README.md

@@ -3,7 +3,12 @@ Workarea PayPal
 
 A Workarea Commerce plugin that adds support for PayPal payments. This plugin adds a new tender type in checkout, which allows users to pay for their items with PayPal.
 
-As of v3.0, this plugin utilizes the [PayPal Commerce Platform](https://www.paypal.com/us/webapps/mpp/commerce-platform). By default this integrates PayPal's [Smart Payment Buttons](https://developer.paypal.com/docs/commerce-platform/payment/checkout/) into your Workarea Application to allow customer's to use any payment method supported in their area to complete checkout on your storefront.
+As of v3.0, this plugin utilizes the [PayPal Commerce Platform](https://www.paypal.com/us/webapps/mpp/commerce-platform). By default this integrates PayPal's [Smart Payment Buttons](https://developer.paypal.com/docs/commerce-platform/payment/checkout/) into your Workarea Application to allow customers to use any payment method supported in their area to complete checkout on your storefront.
+
+Upgrading to v3.0.0
+--------------------------------------------------------------------------------
+
+See the [upgrade guide](UPGRADE.md) for information on upgrading from v2.x of this plugin.
 
 Getting Started
 --------------------------------------------------------------------------------
@@ -63,7 +68,7 @@ Then, add a PayPal section:
 
 ```yaml
 paypal:
-  client_Id: YOUR_CLIENT_ID
+  client_id: YOUR_CLIENT_ID
   client_secret: YOUR_CLIENT_SECRET
 ```
 

data/UPGRADE.md

@@ -0,0 +1,46 @@
+Upgrading This Gem from v2.x to v3.0.0
+================================================================================
+
+As of this gem's v3.0 version, this plugin utilizes the [PayPal Commerce Platform](https://www.paypal.com/us/webapps/mpp/commerce-platform). By default this integrates PayPal's [Smart Payment Buttons](https://developer.paypal.com/docs/commerce-platform/payment/checkout/) into your Workarea Application to allow customers to use any payment method supported in their area to complete checkout on your storefront.
+
+Upgrading will require approximately the following steps:
+
+1. New PayPal Account Setup (see [README](https://github.com/workarea-commerce/workarea-paypal#account-setup))
+    *  Create a new [PayPal business account](https://www.paypal.com/signin/client?flow=provisionUser) to generate sandbox credentials.
+    *  Add credentials to your application.   
+
+
+2. Update your application Gemfile
+
+   `gem 'workarea-paypal', '~> 3.0.0'`
+
+3. Rework any customizations your application made around PayPal. Information around what change is provided below to give you an idea of areas you might need to address.
+
+4. Test locally and/or staging to ensure your application is communicating with PayPal.
+
+5. Generate a live REST API app within PayPal to get production credentials.
+
+6. Add production credentials and deploy.
+
+Plugin Changes
+---------------
+
+This represents a completely new integration that will require any customizations your application has made to PayPal behavior to be updated to be compatible with v3 of this plugin. As with any change, you should follow the setup steps for the plugin and test extensively to ensure everything is working properly before deploying to production.
+
+This upgrade will require a new PayPal merchant account and updating credentials for both your sandbox and live environments. Contact Workarea Support or PayPal directly with any questions regarding transitioning your application.
+
+### Storefront Changes
+
+Previous versions of this plugin rendered a static PayPal button on the top and bottom of the cart page, and provided a text-based payment option on the payment step of checkout.
+
+The PayPal Commerce Platform integration is more dynamic. The cart page and the step both render a single instance of the [Smart Payment Buttons](https://developer.paypal.com/docs/commerce-platform/payment/checkout/). This generates a dynamic set of PayPal payment options that can vary based on device, customer location, and more. You will need to take this change into consideration and update your views to accommodate the visual change.
+
+These buttons are rendered within an iframe controlled by PayPal. This iframe can change height for certain payment options, so its container should be flexible to account for that potential behavior. There is set of configuration options you can pass to the `paypal.Buttons` javascript method to customize how these buttons are rendered. Workarea provides a javascript configuration object, `WORKAREA.config.paypalButtons` to modify options passed. See the [PayPal documentation](https://developer.paypal.com/docs/checkout/integration-features/customize-button/) for valid options.
+
+Smart Payment Buttons are entirely javascript-based. Part of this behavior eliminates a full redirect away from your site to PayPal, in favor of a separate window that allows the customer to interact with PayPal, and the PayPal javascript SDK to communicate back to your application without leaving the page.
+
+### Payment Processing Changes
+
+Previously, this plugin relied on the ActiveMerchant PayPal implementation to process payments with PayPal. As of v3, this is no longer the case, and instead utilizes PayPal's own [Checkout Ruby SDK](https://github.com/paypal/Checkout-Ruby-SDK). This provides the environment and client logic to securely communicate with PayPal.
+
+With this new gateway, PayPal payments are captured immediately at the time a customer places an order. This is a change from the authorization behavior of the old API that allowed for captures at a later time. You will want to make sure your OMS and other payment related behaviors work with this change. If you need to continue doing authorizations when an order is placed, contact PayPal or Workarea Support to discuss options. As of this writing, the PayPal Commerce Platform has some features that do not yet support authorizations.

data/lib/workarea/paypal/version.rb

@@ -1,5 +1,5 @@
 module Workarea
   module Paypal
-    VERSION = '3.0.0'.freeze
+    VERSION = '3.0.1'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workarea-paypal
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - bcrouse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-03 00:00:00.000000000 Z
+date: 2020-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: workarea
@@ -72,6 +72,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- UPGRADE.md
 - app/assets/images/workarea/admin/payment_icons/paypal.svg
 - app/assets/images/workarea/storefront/payment_icons/paypal.svg
 - app/assets/javascripts/workarea/storefront/paypal/config.js.erb
@@ -172,8 +173,8 @@ files:
 - test/factories/workarea/capture_denied_webhook.json
 - test/factories/workarea/paypal.rb
 - test/helpers/workarea/storefront/paypal_helper_test.rb
-- test/integration/workarea/storefront/papyal_place_order_integration_test.rb
 - test/integration/workarea/storefront/paypal_integration_test.rb
+- test/integration/workarea/storefront/paypal_place_order_integration_test.rb
 - test/lib/workarea/paypal/gateway_test.rb
 - test/models/workarea/payment/authorize/paypal_test.rb
 - test/models/workarea/payment/capture/paypal_test.rb