workarea-paypal 2.0.9 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 298668e8ec2b951d889abc29f581329a15d242f44a365e1050117623b3a0c8b3
-  data.tar.gz: 07da63a473d39b51c0176a1e6893111462e61480b6a6fdbd02cfac21986535a9
+  metadata.gz: d56a6bbb39e0357ffa880a99749bf18d52baa6b2dade6b95c32faf821d9abacb
+  data.tar.gz: df0d898d029a70f52ecc93d0a176aa032c382fb9684b85e9d1fe1fc7b30ec8a8
 SHA512:
-  metadata.gz: 78fe19e9ef4c724f395fc0c07b77d610a4696d82550cea831bd16f227878a880467ebc1593d9601fb84c8cb6905657d4d523572c97aa19d56ffdaedb009211df
-  data.tar.gz: d82ba2eb4fcb99766bbeb1920512432af582bfcf0fac7316ff85e8ca565104f25d8084aab586413ca77f1736abbd2cb783e89642227cd0d4b710da7e0c32834b
+  metadata.gz: 59924950c8cf492d04107d95a8835cb1c008246904df6f651d2b4a88280b5f40f12458943b620757557b0aeb266643b433a374c940b3d3f31bd340fe7fb44657
+  data.tar.gz: e4c66e7939c429a706063b346738520485a02e239cfe50aad505d49c88148a54926d180e459e8f97cb4eb63777fda85b3b385df7018fafd62e505298496028ed

data/.eslintrc.json

@@ -30,6 +30,7 @@
       "expect": true,
       "sinon": true,
       "fixture": true,
-      "chai": true
+      "chai": true,
+      "paypal": true
     }
 }

data/.gitignore

@@ -1,20 +1,25 @@
-.byebug_history
 .bundle/
-Gemfile.lock
-.sass-cache/
 log/*.log
 pkg/
-spec/dummy/public/system/dragonfly
-spec/dummy/db/*.sqlite3
-spec/dummy/log/*.log
-spec/dummy/tmp/
-spec/dummy/.sass-cache
-test/dummy/public/system/
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
 test/dummy/log/*.log
+test/dummy/node_modules/
+test/dummy/yarn-error.log
+test/dummy/storage/
 test/dummy/tmp/
 .DS_Store
+.byebug_history
+.bundle/
+.sass-cache/
+Gemfile.lock
+pkg/
+test/dummy/tmp/
+test/dummy/public/
+log/*.log
+test/dummy/log/*.log
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
 node_modules
-test/reports
-package.json
 yarn.lock
 .rubocop-http*

data/CHANGELOG.md

@@ -1,3 +1,82 @@
+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)
+--------------------------------------------------------------------------------
+
+*   Improve handling of failed captures
+
+    PAYPAL-5
+    Matt Duffy
+
+*   Clean up NullAddress display, add partner id to all PayPal requests
+
+    PAYPAL-5
+    Matt Duffy
+
+*   Update README
+
+    PAYPAL-4
+    Matt Duffy
+
+*   Update PayPal integration for PayPal Commerce Platform API
+
+    PAYPAL-3
+    Matt Duffy
+
+
+
+Workarea Paypal 2.0.9 (2019-10-30)
+--------------------------------------------------------------------------------
+
+*   Fix Integration Test Failure When PO Box Config Changes
+
+    When `config.allow_shipping_address_po_box` is set to `true`, an
+    integration test in the PayPal plugin failed due to the shipping step
+    raising an error since no shipping option is available for the address.
+    To ensure the test is configured correctly, it's now wrapped in a
+    `Workarea.with_config` block, with `config.allow_shipping_address_po_box`
+    set to `false`. This allows the test to ensure that the proper redirect
+    occurs when a shipping address coming back from PayPal is invalid.
+
+    PAYPAL-83
+    Tom Scott
+
+
+
 Workarea Paypal 2.0.8 (2019-08-21)
 --------------------------------------------------------------------------------
 

data/README.md

@@ -3,6 +3,13 @@ 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 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
 --------------------------------------------------------------------------------
 
@@ -21,21 +28,113 @@ cd path/to/application
 bundle
 ```
 
-Then, configure your secrets.
+Then, add your client ID and secret to Workarea. See "Account Setup" below for more details.
+
+For production environments, we recommend you run the webhooks rake task to register critical callbacks from PayPal to help keep the state of your orders on Workarea inline with the state of the PayPal transaction. See the `default_webhook_events` description under "Configuration Options" for more information.
+
+```bash
+bin/rails workarea:paypal:create_webhooks
+```
+
+Account Setup
+--------------------------------------------------------------------------------
+
+To begin using PayPal on your site, you will need to have a PayPal merchant account. For development, you can create an account on [developer.paypal.com](htttps://developer.paypal.com). From there you can create a sandbox REST API app, and use those credentials for any non-live environments.
+
+Once you have a REST API application in your PayPal sandbox, you must add the client ID and secret to your Workarea application. This can be done through admin configuration, environment variables, Rails credentials, or hard-coded Workarea configuration.
+
+### Admin configuration
+
+The PayPal plugin adds admin configuration fields to allow admin user's to set credentials without the need for developer intervention. Log in as an admin user, navigate to the Configuration page, find the PayPal section and add the client ID and secret.
+
+### Environment Variables
+
+If the storing and setting of credentials needs to be more dynamic, you can utilize environment variables. Set the environment variables below to connect to PayPal.
+
+`WORKAREA_PAYPAL_CLIENT_ID`   
+`WORKAREA_PAYPAL_CLIENT_SECRET`
+
+### Rails Credentials
+
+This option can be used for any environment, but is most useful in development to store the sandbox credentials within the codebase securely, allowing anyone with the `master.key` of your application to have PayPal configured when they load their application in development.
+
+To add your PayPal info to your Rails credentials, open your credentials file for editing:
+
+```bash
+EDITOR=vi bin/rails credentials:edit
+```
+
+Then, add a PayPal section:
 
 ```yaml
 paypal:
-  login:
-  password:
-  signature:
+  client_id: YOUR_CLIENT_ID
+  client_secret: YOUR_CLIENT_SECRET
+```
+
+### Hard-coded configuration
+
+This option is not ideal, as it will prevent admin configuration from ever being used, but can be necessary if you need to automate the switching of PayPal accounts in a multi-site environment. It is **strongly** recommended that you store the credentials elsewhere and load them into your configuration dynamically if you need to use this option.
+
+In your `config/initializers/workarea.rb`, add:
+
+```ruby
+Workarea.configure do |config|
+  config.paypal_client_id = 'YOUR_CLIENT_ID'
+  config.paypal_client_secret = 'YOUR_CLIENT_SECRET'
+end
 ```
 
-These credentials will be sent to you by your client, who should have a PayPal merchant account set up already. If not, or you wish to develop locally, [sign up for a sandbox account](https://developer.paypal.com/developer/accounts/).
+Configuration Options
+--------------------------------------------------------------------------------
+
+`config.paypal_environment`
+
+The [PayPal Checkout SDK](https://github.com/paypal/Checkout-Ruby-SDK) gem uses different environment classes depending on whether you are interacting with sandbox or live environments. This config by default will point to the sandbox environment unless you are in production. If you need to customize which environment you wish to connect to you'll have to modify the value of this config. Accepted values are `'Paypal::LiveEnvironment'` or
+`'PayPal::SandboxEnvironment'`.
+
+`config.paypal_sdk_params`
+
+This config holds a hash of values to be passed as query string arguments to the PayPal when fetching the javascript SDK. See the [PayPal documentation](https://developer.paypal.com/docs/checkout/reference/customize-sdk/) for options. By default, the plugin will pass the client_id, and `'commit' => false`. It will add `'debug' => true` if you are in development for easier troubleshooting.
+
+`config.default_webhook_events`
+
+PayPal offers a number of [webhook integration options](https://developer.paypal.com/docs/integration/direct/webhooks/rest-webhooks/) that will make calls to your application when something happens within PayPal. You can [create webhooks manually](https://developer.paypal.com/docs/integration/direct/webhooks/rest-webhooks/#to-use-the-dashboard-to-subscribe-to-events) within the PayPal dashboard, but Workarea provides a more automated way to subscribe to events through the `workarea:paypal:create_webhooks` rake task. When run, this rake task will clear any existing webhooks and create a webhook for each event in `config.default_webhook_events`. By default, `PAYMENT.CAPTURE.COMPLETED` and `PAYMENT.CAPTURE.DENIED` are the only events supported by the plugin. If you wish to add more supported events you will also have to provide logic within [`Workarea::Paypal::HandleWebhookEvent`](https://github.com/workarea-commerce/workarea-paypal/blob/master/app/workers/workarea/paypal/handle_webhook_event.rb) to update your application appropriately.
+
+
+`config.use_paypal_hosted_fields`
+
+This configuration toggles on [PayPal Custom Card Fields](https://developer.paypal.com/docs/limited-release/custom-card-fields/) which allows you to use PayPal as your primary credit card payment processor. See "Hosted Fields" below for more information.
+
+### Javascript Configuration
 
-## International Addresses
+Both Smart Payment Buttons and Hosted Fields provide configuration within the javascript `WORKAREA.config` object to customize options passed when initializing those behaviors.
+
+`WORKAREA.config.paypalButtons`
+
+Customize the Smart Payment Buttons options. See the [PayPal documentation](https://developer.paypal.com/docs/checkout/integration-features/customize-button/) for options.
+
+`WORKAREA.config.paypalHostedFields`
+
+Customize the Hosted Fields options. See the [PayPal documentation](https://developer.paypal.com/docs/limited-release/custom-card-fields/reference) for options.
+
+Hosted Fields
+--------------------------------------------------------------------------------
+
+The PayPal Commerce Platform allows you to add unbranded, custom credit card fields to your checkout to accept payments directly on your site. When enabled via `config.use_paypal_hosted_fields`, the Workarea plugin integrates this directly into the existing checkout payment step by replacing the default credit card fields with fields rendered by PayPal. This enables you to accept credit card payments with no other payment processor except PayPal.
+
+This does require providing additional information to PayPal through a Workarea-specific partner signup. For sandbox accounts, You can [complete this process](https://www.sandbox.paypal.com/bizsignup/partner/entry?channelId=partner&channel=marketplace&product=ppcp&partnerId=M3XMHZJKTFK88&integrationType=FO) without additional communication using your **sandbox business account login** (found in the PayPal developer dashboard under Sandbox > Accounts). For live environments, contact [Workarea](https://www.workarea.com/pages/contact-us) or reach out to PayPal for more information how you can enable this behavior for your site.
+
+Additional Information
+--------------------------------------------------------------------------------
+
+See the [PayPal Documentation](https://developer.paypal.com/docs/commerce-platform/) for more information on the PayPal Commerce Platform.
+
+### International Addresses
 
 When working with international addresses, the data from PayPal regarding country and region codes is not guaranteed to match the identifiers used in Workarea (derived from our usage of the [countries](https://github.com/hexorx/countries) gem), because the 2-digit codes identifying countries and regions are not the same. Therefore, you may have some issues when accepting international payments through PayPal, and thus some changes will need to be applied to ensure a seamless checkout process for international PayPal users.
 
+
 Workarea Commerce Documentation
 --------------------------------------------------------------------------------
 

data/Rakefile

@@ -39,13 +39,12 @@ desc "Release version #{Workarea::Paypal::VERSION} of the gem"
 task :release do
   host = "https://#{ENV['BUNDLE_GEMS__WEBLINC__COM']}@gems.weblinc.com"
 
-  #Rake::Task['workarea:changelog'].execute
-  #system 'git add CHANGELOG.md'
-  #system 'git commit -m "Update CHANGELOG"'
-  #system 'git push origin HEAD'
+  Rake::Task['workarea:changelog'].execute
+  system 'git add CHANGELOG.md'
+  system 'git commit -m "Update CHANGELOG"'
 
   system "git tag -a v#{Workarea::Paypal::VERSION} -m 'Tagging #{Workarea::Paypal::VERSION}'"
-  system 'git push --tags'
+  system 'git push origin HEAD --follow-tags'
 
   system 'gem build workarea-paypal.gemspec'
   system "gem push workarea-paypal-#{Workarea::Paypal::VERSION}.gem"

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/config.js.erb

@@ -0,0 +1,44 @@
+/**
+ * @namespace WORKAREA
+ */
+
+(function () {
+    'use strict';
+
+    /**
+     * @namespace WORKAREA.config
+     * @property {object} paypalButtons
+     *  See https://developer.paypal.com/docs/checkout/integration-features/customize-button/
+     *  for information on configuration options.
+     */
+    WORKAREA.config.paypalButtons = {
+        style: {
+            color: 'blue',
+            tagline: false,
+        }
+    };
+
+    /**
+     * @namespace WORKAREA.config
+     * @property {object} paypalHostedFields
+     *  See https://developer.paypal.com/docs/limited-release/custom-card-fields/reference
+     *  for information on configuration options.
+     */
+    WORKAREA.config.paypalHostedFields = {
+        fields: {
+            number: {
+                selector: '#paypal-credit-card-number',
+                placeholder: 'Credit Card Number',
+            },
+            cvv: {
+                selector: '#paypal-cvv-field',
+                placeholder: 'CVV',
+            },
+            expirationDate: {
+                selector: '#paypal-expiration-field',
+                placeholder: 'MM/YYYY',
+            }
+        }
+    };
+
+})();

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

@@ -0,0 +1,71 @@
+/**
+ * @namespace WORKAREA.paypalButtons
+ */
+WORKAREA.registerModule('paypalButtons', (function () {
+    'use strict';
+
+    var requestWrapper = function (requestData) {
+            var deferred = $.Deferred();
+
+            $.ajax(requestData)
+            .done(function(data) {
+                deferred.resolve(data);
+            })
+            .fail(function(data, status, xhr) {
+                deferred.reject(xhr);
+            });
+
+            return deferred.promise();
+        },
+
+        createOrder = function() {
+            return requestWrapper({
+                url: WORKAREA.routes.storefront.paypalPath(),
+                type: 'post',
+                dataType: 'json'
+            }).then(function (data) {
+                return data.id;
+            });
+        },
+
+        onApprove = function(data) {
+            return requestWrapper({
+                url: WORKAREA.routes.storefront.paypalApprovedPath({ id: data.orderID }),
+                type: 'put',
+                dataType: 'json'
+            }).then(function(data) {
+                window.location = data.redirect_url; }
+            );
+        },
+
+        getConfig = function () {
+            return _.assign({}, WORKAREA.config.paypalButtons, {
+                createOrder: createOrder,
+                onApprove: onApprove
+            });
+        },
+
+        setup = function($container) {
+            paypal
+            .Buttons(getConfig())
+            .render($container[0]);
+        },
+
+        /**
+         * @method
+         * @name init
+         * @memberof WORKAREA.paypalButtons
+         */
+        init = function ($scope) {
+            var $buttonContainer = $('#paypal-button-container', $scope);
+
+            if (window.paypal === undefined) { return; }
+            if (_.isEmpty($buttonContainer)) { return; }
+
+            setup($buttonContainer);
+        };
+
+    return {
+        init: init
+    };
+}()));