workarea-paypal 3.0.0 → 3.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 159d0b080b0fb36119cdf1c15e0ca07936e938237fd012ed67ddf8f6121dbb53
-  data.tar.gz: 7d8812db2e69fc22092bfcca4aa61d30a7578f2d7b5852bbc2f321d47a28f734
+  metadata.gz: 92bdac05441fd966fa90acc4cb18badd013d583b0cc69b98a36a79144e5e5fac
+  data.tar.gz: 519be45e1b7a3e27167df514ae49fe1ac32eaf5250156c9ed88b6c15e7c1bf7d
 SHA512:
-  metadata.gz: 834c524e29ee8e810f6e9ee3dace1ab105e8665c19315a1a3664f14e88118bb1bb0705af5729fbbc11b4ba439bdf7e4f9c8d19dfe9a840938cef9f84255dfc0f
-  data.tar.gz: b0ffa2b76120f84ecccf2973cc2dee52e3001a2a5403a5f4c249b82cc222a01f8e391ad420557840737730429ed5ce36a2c867736413ad38a9efefe3277bb65a
+  metadata.gz: a6d388830f585b699138e407415190f6d8d21489d22666010d2a1a3e3c2499320c0b26b9b3c1cfb7082e0e23ea53cd11d49eba8662852e34deaefb1b7624d731
+  data.tar.gz: ff569d2f2291693dfbb839c84b678ccb662b8f69286c3194233550ccc7731e2b13f854d42184e635ec1a2303e5c31352f307a2a518ed5b78f706666afa099840

data/CHANGELOG.md

@@ -1,3 +1,88 @@
+Workarea Paypal 3.0.5 (2020-08-14)
+--------------------------------------------------------------------------------
+
+*   Address Race Condition When Using PayPal's SDK
+
+    It's possible that our modules that use the PayPal SDK will be
+    initialized prior to `window.paypal` being available on the page, now
+    that the JS is loaded in asynchronously, causing unnecessary loss in
+    functionality. Additionally, there doesn't seem to be a way to bind to
+    any kind of event given off by the SDK on `window` that would allow us
+    to know whether the SDK is truly loaded or not. To address this, when
+    the `window.paypal` object is not available yet, and there's a
+    `<script>` tag on the page loading the PayPal SDK (indicating that we
+    are indeed expecting the SDK to be there), the PayPal modules will
+    re-try initializing every 5 seconds until `window.paypal` is available.
+
+    PAYPAL-7
+
+    Tom Scott
+
+*   Load JavaScript From PayPal Asynchronously
+
+    Using the `async` attribute in the `<script>` tag that loads PayPal's
+    JavaScript code, Workarea can now prevent it blocking the page in case
+    of a failure, and improve load time performance to boot.
+
+    PAYPAL-7
+
+    Fixes #10
+
+    Tom Scott
+
+
+
+Workarea Paypal 3.0.4 (2020-06-17)
+--------------------------------------------------------------------------------
+
+*   Scope routes to include locale
+
+
+    Ben Crouse
+
+*   Corrected minor typo
+
+
+    JurgenHahn
+
+
+
+Workarea Paypal 3.0.3 (2020-05-26)
+--------------------------------------------------------------------------------
+
+*   Update Paypal BN
+
+
+    Ben Crouse
+
+
+
+Workarea Paypal 3.0.2 (2020-05-14)
+--------------------------------------------------------------------------------
+
+*   Fix wrong protocol when using SSL
+
+    Fixes #11
+
+    Ben Crouse
+
+*   Fix field name on #refund
+
+
+    Alejandro Babio
+
+
+
+Workarea Paypal 3.0.1 (2020-03-17)
+--------------------------------------------------------------------------------
+
+*   Add upgrade guide
+
+    PAYPAL-6
+    Matt Duffy
+
+
+
 Workarea Paypal 3.0.0 (2020-03-03)
 --------------------------------------------------------------------------------
 

data/Gemfile

@@ -3,4 +3,4 @@ git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
 gemspec
 
-gem 'workarea'
+gem 'workarea', github: 'workarea-commerce/workarea', branch: 'v3.5-stable'

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/app/assets/javascripts/workarea/storefront/paypal/modules/paypal.js

@@ -0,0 +1,63 @@
+/**
+ *
+ * Reliably ensure that the PayPal SDK is either loaded or will
+ * be loading.
+ *
+ * @namespace WORKAREA.paypal
+ */
+WORKAREA.registerModule('paypal', (function () {
+    'use strict';
+
+    var handlers = [],
+        attempts = 0,
+        paypalLoaded = null,
+
+        /**
+         * Define a function that will be called when the paypal SDK has
+         * loaded.
+         *
+         * @method
+         * @name ready
+         * @param function handler - A function to be called when PayPal
+         *                           is available.
+         * @memberof WORKAREA.paypal
+         */
+        ready = function(handler) {
+            if (paypalLoaded) {
+                handler();
+            } else {
+                handlers.push(handler);
+            }
+        },
+
+        /**
+         * Continuously check for whether the Paypal SDK has loaded
+         * every 5 seconds, and call function handlers defined in
+         * `ready()` when the `window.paypal` object is available. This
+         * will only occur if the `<script>` tag containing the PayPal
+         * SDK is detected to be on the page.
+         *
+         * @method
+         * @name init
+         * @memberof WORKAREA.paypal
+         */
+        init = function() {
+            var $sdk = $('script[data-partner-attribution-id]'),
+                paypalExpectedToLoad = !_.isEmpty($sdk);
+
+            attempts += 1;
+            paypalLoaded = window.paypal !== undefined;
+
+            if (!paypalLoaded && paypalExpectedToLoad && attempts <= 20) {
+                window.setTimeout(init, 2000);
+            } else if (paypalLoaded) {
+                _.each(handlers, function(handler) { handler(); });
+                handlers = [];
+            }
+        };
+
+    return {
+        ready: ready,
+        init: init
+    };
+}()));

data/app/assets/javascripts/workarea/storefront/paypal/modules/paypal_buttons.js

@@ -56,13 +56,14 @@ WORKAREA.registerModule('paypalButtons', (function () {
          * @name init
          * @memberof WORKAREA.paypalButtons
          */
-        init = function ($scope) {
-            var $buttonContainer = $('#paypal-button-container', $scope);
+        init = function($scope) {
+            WORKAREA.paypal.ready(function() {
+                var $buttonContainer = $('#paypal-button-container', $scope);
 
-            if (window.paypal === undefined) { return; }
-            if (_.isEmpty($buttonContainer)) { return; }
+                if (_.isEmpty($buttonContainer)) { return; }
 
-            setup($buttonContainer);
+                setup($buttonContainer);
+            });
         };
 
     return {

data/app/assets/javascripts/workarea/storefront/paypal/modules/paypal_hosted_fields.js

@@ -81,13 +81,14 @@ WORKAREA.registerModule('paypalHostedFields', (function () {
          * @memberof WORKAREA.paypalHostedFields
          */
         init = function ($scope) {
-            var $placeholder = $('[data-paypal-hosted-fields]', $scope);
+            WORKAREA.paypal.ready(function () {
+                var $placeholder = $('[data-paypal-hosted-fields]', $scope);
 
-            if (_.isEmpty($placeholder)) {  return;  }
-            if (window.paypal === undefined) { return; }
-            if (!paypal.HostedFields.isEligible()) { return; }
+                if (_.isEmpty($placeholder)) {  return;  }
+                if (!paypal.HostedFields.isEligible()) { return; }
 
-            setup($placeholder, $scope);
+                setup($placeholder, $scope);
+            });
         };
 
     return {

data/app/helpers/workarea/storefront/paypal_helper.rb

@@ -27,8 +27,9 @@ module Workarea
 
         javascript_include_tag(
           "https://www.paypal.com/sdk/js?#{params.to_query}",
+          async: true,
           data: {
-            partner_attribution_id: 'Workarea_SP_PCP', # Do not change this
+            partner_attribution_id: 'Workarea_SP', # Do not change this
             client_token: @paypal_client_token
           }.merge(data)
         )

data/app/views/workarea/storefront/checkouts/_paypal_payment.html.haml

@@ -11,7 +11,7 @@
       %span.button-property__text= t('workarea.storefront.paypal.paypal')
   %p.checkout-payment__primary-method-description
     - if step.paypal? && step.payment.errors.none?
-      %span= t('workarea.storefront.paypal.payment_recieved')
+      %span= t('workarea.storefront.paypal.payment_received')
     - elsif step.paypal? && step.payment.errors.present?
       %span= t('workarea.storefront.paypal.payment_failed')
     - else

data/config/initializers/append_points.rb

@@ -25,6 +25,7 @@ Workarea::Plugin.append_javascripts(
 
 Workarea::Plugin.append_javascripts(
   'storefront.modules',
+  'workarea/storefront/paypal/modules/paypal',
   'workarea/storefront/paypal/modules/update_checkout_submit_text',
   'workarea/storefront/paypal/modules/paypal_buttons',
   'workarea/storefront/paypal/modules/paypal_hosted_fields'

data/config/locales/en.yml

@@ -23,7 +23,7 @@ en:
         on_continue: Select a PayPal payment option.
         paid_with_paypal: Paid with PayPal
         payment_failed: Your submitted PayPal payment could not be completed. Select a new method and try again.
-        payment_recieved: Thank You! We have received your information back from PayPal.
+        payment_received: Thank You! We have received your information back from PayPal.
           Please confirm that the shipping address and shipping method are correct,
           then click on 'Place Order'.
         paypal: PayPal

data/config/routes.rb

@@ -1,5 +1,7 @@
 Workarea::Storefront::Engine.routes.draw do
-  post 'paypal' => 'paypal#create'
-  put 'paypal/:id/approved' => 'paypal#update', as: :paypal_approved
-  post 'paypal/event' => 'paypal#event', as: :paypal_event
+  scope '(:locale)', constraints: Workarea::I18n.routes_constraint do
+    post 'paypal' => 'paypal#create'
+    put 'paypal/:id/approved' => 'paypal#update', as: :paypal_approved
+    post 'paypal/event' => 'paypal#event', as: :paypal_event
+  end
 end

data/lib/tasks/workarea/create_webhooks.rake

@@ -17,7 +17,8 @@ namespace :workarea do
       puts 'Subscribing to PayPal webhook events...'
       Workarea::Paypal.gateway.create_webhook(
         url: Workarea::Storefront::Engine.routes.url_helpers.paypal_event_url(
-          host: Workarea.config.host
+          host: Workarea.config.host,
+          protocol: Rails.application.config.force_ssl ? 'https' : 'http'
         ),
         event_types: Workarea.config.default_webhook_events
       )

data/lib/workarea/paypal/gateway.rb

@@ -17,7 +17,7 @@ module Workarea
 
       def send_request(request)
         # Do not change this
-        request.headers["PayPal-Partner-Attribution-Id"] = 'Workarea_SP_PCP'
+        request.headers["PayPal-Partner-Attribution-Id"] = 'Workarea_SP'
 
         client.execute(request)
       end
@@ -90,7 +90,7 @@ module Workarea
           request.request_body(
             amount: {
               value: amount.to_s,
-              currency: amount.currency.iso_code
+              currency_code: amount.currency.iso_code
             }
           )
         end

data/lib/workarea/paypal/version.rb

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

data/test/helpers/workarea/storefront/paypal_helper_test.rb

@@ -16,7 +16,7 @@ module Workarea
         assert_includes(result, 'debug=true')
         assert_includes(result, "client-id=#{Workarea::Paypal.gateway.client_id}")
         assert_includes(result, 'components=buttons')
-        assert_includes(result, 'data-partner-attribution-id="Workarea_SP_PCP"')
+        assert_includes(result, 'data-partner-attribution-id="Workarea_SP"')
         refute_includes(result, 'hosted-fields')
         refute_includes(result, 'data-client-token')
 

data/test/vcr_cassettes/paypal_create_order.yml

@@ -69,7 +69,7 @@ http_interactions:
       Content-Type:
       - application/json
       Paypal-Partner-Attribution-Id:
-      - Workarea_SP_PCP
+      - Workarea_SP
       Authorization:
       - Bearer A21AAH8JBaCq97a9fIWYVjR13RiayfAPxcb-o5l9hZ57HACn0JwaefBkRcSfh9rEwmZR6JozBLLU2MsRYTuFsZ91mOZR9jFMQ
       Accept-Encoding:

data/test/vcr_cassettes/paypal_gateway_create_order.yml

@@ -64,7 +64,7 @@ http_interactions:
       Content-Type:
       - application/json
       Paypal-Partner-Attribution-Id:
-      - Workarea_SP_PCP
+      - Workarea_SP
       Authorization:
       - Bearer A21AAEQe49FiVXiExO3v7exrXi-z5BAM4wSeASef6xs6RrkPBHK5Kj9oW3RVniFGVumUb7r0t3JsrQ9YgIb1t2dc5Wir9JX2Q
       Accept-Encoding:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workarea-paypal
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.5
 platform: ruby
 authors:
 - bcrouse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-03 00:00:00.000000000 Z
+date: 2020-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: workarea
@@ -72,9 +72,11 @@ 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
+- app/assets/javascripts/workarea/storefront/paypal/modules/paypal.js
 - app/assets/javascripts/workarea/storefront/paypal/modules/paypal_buttons.js
 - app/assets/javascripts/workarea/storefront/paypal/modules/paypal_hosted_fields.js
 - app/assets/javascripts/workarea/storefront/paypal/modules/update_checkout_submit_text.js
@@ -172,8 +174,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
@@ -217,7 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: PayPal integration for the Workarea Commerce Platform