workarea-paypal 3.0.1 → 3.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec2de3863ee37303126a6f3b58f9e0e0e0081f983fcc7436eeef937b8429115d
-  data.tar.gz: 976987d8fb51788da045850771b4b7c76ee9dbe2b6d7c781dc4e9874e1dde8cf
+  metadata.gz: 27dfab5d8540a4e61595f227cf290eb29fb2d34d9bc181cba014f7781a3140ac
+  data.tar.gz: bfe8c845f4500f04ae08b7fafd9d3d5a974a93100ffefccc6143e9573d697e5b
 SHA512:
-  metadata.gz: 3d92e73fd62a729f1a0bc9d94798f181f266958cf6bd03cf05ed753650edf7cf00d12b054d0aa219bd361c57be979f116a0b605c48d9fcb857776a39c4450bde
-  data.tar.gz: 82ed3baaf020fbaded7337706681b204bff951827f13180ccb8d91a13c5df1bed0d08ddcda4b44858bcade41ecf9ea7c6cdfd60575cef110d148255532d8e44d
+  metadata.gz: de7027b9c4c4db16885d0aad7d6c0725e4c5164fd9bda65bd1a82994cff6c90ec42158d1b19d353eaf882913392b79fb1882866d2f9633c97247cbdc214bf4b2
+  data.tar.gz: ca75b25562d13a7f04087df81749b74e141e1c129dcc40d903725c63ed4244521873b127849a0e3c2f28f081e59c58f9150143df33b56c5b682ccddc11e1fde6

data/CHANGELOG.md

@@ -1,3 +1,94 @@
+Workarea Paypal 3.0.6 (2020-08-18)
+--------------------------------------------------------------------------------
+
+*   Fix Typo in PayPal Environment
+
+    The `Workarea.config.paypal_environment` setting is constantized in
+    order to load the correct class for that environment. A missing case
+    caused the constantization to error out in the gateway and cause 500
+    errors on production.
+
+    PAYPAL-9
+
+    Tom Scott
+
+
+
+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)
 --------------------------------------------------------------------------------
 

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/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/initializers/workarea.rb

@@ -10,7 +10,7 @@ Workarea.configure do |config|
   #
   config.paypal_environment =
     if Rails.env.production?
-      'Paypal::LiveEnvironment'
+      'PayPal::LiveEnvironment'
     else
       'PayPal::SandboxEnvironment'
     end

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.1'.freeze
+    VERSION = '3.0.6'.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.1
+  version: 3.0.6
 platform: ruby
 authors:
 - bcrouse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-17 00:00:00.000000000 Z
+date: 2020-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: workarea
@@ -76,6 +76,7 @@ files:
 - 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
@@ -218,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