solidus_paypal_commerce_platform 1.0.0.beta2 → 1.0.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ca5d1fd0c7ccd99dc39a66a53f0c9ddf902b8114bb420c9f1a070c13cb96ffa
-  data.tar.gz: 9a16b551e567947e0e6b743626de2793113e7e12e51cc08dddaf7a00ea60d97c
+  metadata.gz: 8de51ca7968f49267b90b11183b233f9c2cdf643a2dcf1ba4cdb2de71b701708
+  data.tar.gz: efd5050d954c26c4948fcd5aa278c18722ad6868bb820f13ed1056da47bed7b9
 SHA512:
-  metadata.gz: d6b54f9d01a843a63645844b65626aaefc85cad5885aaca64c2d72050e3b02502f0e00510b9a9ec1bcbd611025957fe2b008b4db85c1fed7558f2c1ccd4f056f
-  data.tar.gz: 2bdd87d6c92d31282eb4cf566dfb59a247d759583553b670e7326ec806b6b1a1ea7c5a82f6eb49e9155b671f2933eb977d1bf02004b56dce37b00e4559a79bcf
+  metadata.gz: d166c6cfe27e852d8285b02c6a6d0d165c1121ff0f8c476ea1a3bfb7944bfbc9a6b54fe51dda40523917c51300a1b206ebcb331f2c6b928d88c0ae317c5675ac
+  data.tar.gz: cd177e48b2428f415c033238ac7ded3ac5e468cc65ff3047feddba5b7edc5a19f0c30bad1223ebf308bf0dec7a5f604740e667002e9855517520a491e75c2728

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## [v1.0.0.beta3](https://github.com/solidusio/solidus_paypal_commerce_platform/tree/v1.0.0.beta3) (2023-01-18)
+
+[Full Changelog](https://github.com/solidusio/solidus_paypal_commerce_platform/compare/v1.0.0.beta2...v1.0.0.beta3)
+
+**Fixed bugs:**
+
+- Allow cancelling orders \(v1 port of \#180\) [\#182](https://github.com/solidusio/solidus_paypal_commerce_platform/issues/182)
+- Preferred paypal button color error message should be translated [\#178](https://github.com/solidusio/solidus_paypal_commerce_platform/issues/178)
+- Allow cancelling orders [\#183](https://github.com/solidusio/solidus_paypal_commerce_platform/pull/183) ([kennyadsl](https://github.com/kennyadsl))
+
+**Closed issues:**
+
+- Make the Venmo button testable from outside US contries [\#137](https://github.com/solidusio/solidus_paypal_commerce_platform/issues/137)
+
+**Merged pull requests:**
+
+- \[v1\] Allow to use the auto\_capture global preference [\#186](https://github.com/solidusio/solidus_paypal_commerce_platform/pull/186) ([kennyadsl](https://github.com/kennyadsl))
+- Uniform installer with Solidus Starter Frontend [\#184](https://github.com/solidusio/solidus_paypal_commerce_platform/pull/184) ([kennyadsl](https://github.com/kennyadsl))
+- Do not break custom pricing options classes [\#181](https://github.com/solidusio/solidus_paypal_commerce_platform/pull/181) ([mamhoff](https://github.com/mamhoff))
+- Fix: preferred\_paypal\_button\_color error message should be translated dynamically [\#179](https://github.com/solidusio/solidus_paypal_commerce_platform/pull/179) ([gsmendoza](https://github.com/gsmendoza))
+- Add instructions on how to use the PayPal sandbox [\#177](https://github.com/solidusio/solidus_paypal_commerce_platform/pull/177) ([elia](https://github.com/elia))
+
 ## [v1.0.0.beta2](https://github.com/solidusio/solidus_paypal_commerce_platform/tree/v1.0.0.beta2) (2022-12-12)
 
 [Full Changelog](https://github.com/solidusio/solidus_paypal_commerce_platform/compare/v1.0.0.beta1...v1.0.0.beta2)
@@ -86,10 +108,6 @@
 
 [Full Changelog](https://github.com/solidusio/solidus_paypal_commerce_platform/compare/v0.3.1...v0.3.2)
 
-**Closed issues:**
-
-- Unable To Cancel An Order [\#120](https://github.com/solidusio/solidus_paypal_commerce_platform/issues/120)
-
 **Merged pull requests:**
 
 - Update solidus using solidus\_dev\_support [\#124](https://github.com/solidusio/solidus_paypal_commerce_platform/pull/124) ([DanielePalombo](https://github.com/DanielePalombo))

data/README.md

@@ -16,6 +16,24 @@ gem 'solidus_paypal_commerce_platform'
 Bundle your dependencies and run the installation generator:
 
 ```shell
+bundle install
+bin/rails generate solidus_paypal_commerce_platform:install
+```
+
+### Compatibility with solidus_frontend (deprecated)
+
+Support for the old frontend is terminated but if you are using the
+`solidus_frontend` gem instead of Solidus Starter Frontend, you can
+still use this gem for some time. Please, use `0.x` version.
+
+```ruby
+gem 'solidus_paypal_commerce_platform', '< 1'
+```
+
+Bundle your dependencies and run the installation generator:
+
+```shell
+bundle install
 bin/rails generate solidus_paypal_commerce_platform:install
 ```
 
@@ -45,27 +63,46 @@ them in as a preference on initialization.
 
 ```ruby
 # config/initializers/spree.rb
-Spree::Config.configure do |config|
-  config.static_model_preferences.add(
-    SolidusPaypalCommercePlatform::PaymentMethod,
-    'paypal_commerce_platform_credentials', {
-      test_mode: !Rails.env.production?,
-      client_id: ENV['PAYPAL_CLIENT_ID'],
-      client_secret: ENV['PAYPAL_CLIENT_SECRET'],
-      display_on_product_page: true,
-      display_on_cart: true,
-    }
-  )
+Rails.application.config.to_prepare do
+  Spree::Config.configure do |config|
+    config.static_model_preferences.add(
+      SolidusPaypalCommercePlatform::PaymentMethod,
+      'paypal_commerce_platform_credentials', {
+        test_mode: !Rails.env.production?,
+        client_id: ENV['PAYPAL_CLIENT_ID'],
+        client_secret: ENV['PAYPAL_CLIENT_SECRET'],
+        display_on_product_page: true,
+        display_on_cart: true,
+        venmo_standalone: 'disabled'
+      }
+    )
+  end
 end
 ```
 
+With the payment method credentials statically configured, you can now go to the payment methods admin page and
+create a payment method for PayPal. Remember that you need to create the payment method first before you can set its
+Preference Source to `paypal_commerce_platform_credentials`.
+
 ### I don't have API credentials
 
 In this case, we still recommend following the above flow for security, but we have made a payment method setup
-wizard to make it easier to get started. On the payment_methods index page, you'll see a button to set up your
+wizard to make it easier to get started. On the payment methods admin page, you'll see a button to set up your
 PayPal Commerce Platform payment method. Click on this button and follow the instructions provided by PayPal.
 When you return to your app, your payment method should be set up and ready to go.
 
+## Usage in development environment
+
+When testing your PayPal integration, we recommend that you utilize the sandbox business and personal accounts that come
+with your PayPal developer account. These sandbox accounts are designed to generate mock transactions for testing your
+app. You can learn more about sandbox accounts at https://developer.paypal.com/tools/sandbox.
+
+Please take note of a gotcha when you're in development environment and you click on the "Setup PayPal Commerce
+Platform" button in the payment methods admin page. Once PayPal asks you to connect to a business account, we recommend
+that you log in with the sandbox business account that comes with your PayPal developer account. If you create a new
+sandbox business account here, the resulting account may not recognize your sandbox personal accounts, which can make
+it difficult to test a successful cart checkout.
+
 ### Email Confirmation
 
 A confirmed email is required to get paid by PayPal. You'll need to check `Paypal Email Confirmed` on your new

data/app/decorators/models/solidus_paypal_commerce_platform/spree/variant/pricing_options_decorator.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module SolidusPaypalCommercePlatform
+  module Spree
+    module Variant
+      module PricingOptionsDecorator
+        def cache_key
+          SolidusPaypalCommercePlatform::PaymentMethod.
+            active.
+            map(&:cache_key_with_version).
+            sort + [super]
+        end
+
+        ::Spree::Variant::PricingOptions.prepend self
+      end
+    end
+  end
+end

data/app/models/solidus_paypal_commerce_platform/payment_method.rb

@@ -17,7 +17,9 @@ module SolidusPaypalCommercePlatform
 
     validates :preferred_paypal_button_color, exclusion: {
       in: %w[gold],
-      message: I18n.t("solidus_paypal_commerce_platform.payment_method.gold_button_message")
+      message: ->(_object, _data) do
+        I18n.t("solidus_paypal_commerce_platform.payment_method.gold_button_message")
+      end
     }, if: :venmo_standalone_enabled?
 
     def venmo_standalone_enabled?
@@ -83,7 +85,7 @@ module SolidusPaypalCommercePlatform
 
       parameters = {
         'client-id': client_id,
-        intent: auto_capture ? "capture" : "authorize",
+        intent: auto_capture? ? "capture" : "authorize",
         commit: commit_immediately ? "false" : "true",
         components: options[:display_credit_messaging] ? "buttons,messages" : "buttons",
         currency: currency,
@@ -97,5 +99,22 @@ module SolidusPaypalCommercePlatform
 
       "https://www.paypal.com/sdk/js?#{parameters.compact.to_query}".html_safe # rubocop:disable Rails/OutputSafety
     end
+
+    # Will void the payment depending on its state or return false
+    #
+    # If the payment has not yet been captured, we can void the transaction.
+    # Otherwise, we return false so Solidus creates a refund instead.
+    #
+    # https://developer.paypal.com/docs/api/payments/v2/#authorizations_void
+    #
+    # @api public
+    # @param payment [Spree::Payment] the payment to void
+    # @return [Response|FalseClass]
+    def try_void(payment)
+      void_attempt = void(nil, { originator: payment })
+      return void_attempt if void_attempt.success?
+
+      false
+    end
   end
 end

data/bin/sandbox

@@ -50,10 +50,12 @@ fi
 cd ./sandbox
 unbundled bundle add solidus --github solidusio/solidus --branch "${BRANCH:-master}" --version '> 0.a'
 unbundled bundle exec rake db:drop db:create
-unbundled bundle exec rails generate solidus:install --auto-accept "$@"
+unbundled bundle exec rails generate solidus:install --payment-method=none --auto-accept "$@"
+unbundled bundle add ${extension_name} --path '../'
+unbundled bundle exec rails generate ${extension_name}:install --frontend=starter --migrate=true
 
 echo
-echo "🚀 Sandbox app successfully created for $extension_name!"
+echo "🚀 Sandbox app successfully created for ${extension_name}!"
 echo "🚀 Using $RAILSDB and Solidus $BRANCH"
 echo "🚀 Use 'export DB=[postgres|mysql|sqlite]' to control the DB adapter"
 echo "🚀 Use 'export SOLIDUS_BRANCH=<BRANCH-NAME>' to control the Solidus version"

data/config/locales/en.yml

@@ -40,6 +40,7 @@ en:
         success: "Payment refunded for %{amount}"
       pay_pal_checkout_sdk/payments/authorizations_void_request:
         success: "Payment voided"
+        failure: "This payment can't be voided"
     payment_method:
       gold_button_message: "cannot be 'gold' when Venmo standalone is enabled."
     paypal_funding_sources:

data/lib/generators/solidus_paypal_commerce_platform/install/install_generator.rb

@@ -5,7 +5,7 @@ module SolidusPaypalCommercePlatform
     class InstallGenerator < Rails::Generators::Base
       class_option :migrate, type: :boolean, default: true
       class_option :backend, type: :boolean, default: true
-      class_option :starter_frontend, type: :boolean, default: true
+      class_option :frontend, type: :string, default: 'starter'
 
       # This is only used to run all-specs during development and CI,  regular installation limits
       # installed specs to frontend, which are the ones related to code copied to the target application.
@@ -13,6 +13,14 @@ module SolidusPaypalCommercePlatform
 
       source_root File.expand_path('templates', __dir__)
 
+      def normalize_components_options
+        @components = {
+          backend: options[:backend],
+          starter_frontend: options[:frontend] == 'starter',
+          classic_frontend: options[:frontend] == 'classic',
+        }
+      end
+
       def install_solidus_core_support
         directory 'config/initializers', 'config/initializers'
         rake 'railties:install:migrations FROM=solidus_paypal_commerce_platform'
@@ -70,10 +78,21 @@ module SolidusPaypalCommercePlatform
         end
       end
 
+      def alert_no_classic_frontend_support
+        support_code_for(:classic_frontend) do
+          message = <<~TEXT
+            For solidus_frontend compatibility, please use the deprecated version 0.x.
+            The new version of this extension only supports Solidus Starter Frontend.
+            No frontend code has been copied to your application.
+          TEXT
+          say_status :error, set_color(message.tr("\n", ' '), :red), :red
+        end
+      end
+
       private
 
       def support_code_for(component_name, &block)
-        if options[component_name]
+        if @components[component_name]
           say_status :install, "[#{engine.engine_name}] solidus_#{component_name}", :blue
           shell.indent(&block)
         else

data/lib/generators/solidus_paypal_commerce_platform/install/templates/app/controllers/solidus_paypal_commerce_platform/paypal_orders_controller.rb

@@ -7,7 +7,7 @@ module SolidusPaypalCommercePlatform
 
     def show
       authorize! :show, @order, order_token
-      order_request = @payment_method.gateway.create_order(@order, @payment_method.auto_capture)
+      order_request = @payment_method.gateway.create_order(@order, @payment_method.auto_capture?)
 
       render json: order_request, status: order_request.status_code
     end

data/lib/solidus_paypal_commerce_platform/engine.rb

@@ -34,12 +34,6 @@ module SolidusPaypalCommercePlatform
       app.config.spree.payment_setup_wizards << "SolidusPaypalCommercePlatform::Wizard"
     end
 
-    initializer "solidus_paypal_commerce_platform.set_pricing_options_class" do
-      def (Spree::Config).pricing_options_class
-        SolidusPaypalCommercePlatform::PricingOptions
-      end
-    end
-
     initializer "solidus_paypal_commerce_platform.webhooks" do
       SolidusWebhooks.config.register_webhook_handler :solidus_paypal_commerce_platform, ->(payload) {
         SolidusPaypalCommercePlatform::WebhooksJob.perform_now(payload)

data/lib/solidus_paypal_commerce_platform/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SolidusPaypalCommercePlatform
-  VERSION = '1.0.0.beta2'
+  VERSION = '1.0.0.beta3'
 end

data/spec/models/solidus_paypal_commerce_platform/payment_method_spec.rb

@@ -24,8 +24,12 @@ RSpec.describe SolidusPaypalCommercePlatform::PaymentMethod, type: :model do
 
       it 'cannot be gold when Venmo standalone is enabled' do
         expect(paypal_payment_method).to be_valid
+
         paypal_payment_method.preferences.update(venmo_standalone: 'enabled')
         expect(paypal_payment_method).to be_invalid
+        expect(paypal_payment_method.errors[:preferred_paypal_button_color])
+          .to include(I18n.t("solidus_paypal_commerce_platform.payment_method.gold_button_message"))
+
         paypal_payment_method.preferences.update(venmo_standalone: 'only render standalone')
         expect(paypal_payment_method).to be_invalid
       end
@@ -96,6 +100,32 @@ RSpec.describe SolidusPaypalCommercePlatform::PaymentMethod, type: :model do
     end
   end
 
+  describe "#try_void" do
+    context "when the payment is already captured" do
+      let(:status_code) { 500 }
+
+      it "returns false" do
+        authorization_id = SecureRandom.hex(8)
+        source = paypal_payment_method.payment_source_class.create(authorization_id: authorization_id)
+        payment.source = source
+
+        expect(paypal_payment_method.try_void(payment)).to be_falsey
+      end
+    end
+
+    context "when the payment is not yet captured" do
+      let(:status_code) { 204 }
+
+      it "returns the success response" do
+        authorization_id = SecureRandom.hex(8)
+        source = paypal_payment_method.payment_source_class.create(authorization_id: authorization_id)
+        payment.source = source
+
+        expect(paypal_payment_method.try_void(payment)).to be_success
+      end
+    end
+  end
+
   describe "#credit" do
     let(:result) { Struct(id: SecureRandom.hex(4)) }
 
@@ -127,6 +157,31 @@ RSpec.describe SolidusPaypalCommercePlatform::PaymentMethod, type: :model do
       end
     end
 
+    context 'when autocapture value is true' do
+      it 'sets the intent to capture' do
+        paypal_payment_method.update(auto_capture: true)
+
+        expect(url.query.split("&")).to include("intent=capture")
+      end
+    end
+
+    context 'when autocapture value is false' do
+      it 'sets the intent to capture' do
+        paypal_payment_method.update(auto_capture: false)
+
+        expect(url.query.split("&")).to include("intent=authorize")
+      end
+    end
+
+    context 'when autocapture value is nil' do
+      it 'sets the intent to the global auto_capture value' do
+        paypal_payment_method.update(auto_capture: nil)
+        stub_spree_preferences(auto_capture: true)
+
+        expect(url.query.split("&")).to include("intent=capture")
+      end
+    end
+
     context 'when messaging is turned on' do
       it 'includes messaging component' do
         paypal_payment_method.preferences.update(display_credit_messaging: true)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solidus_paypal_commerce_platform
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta2
+  version: 1.0.0.beta3
 platform: ruby
 authors:
 - Sean Denny
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-12 00:00:00.000000000 Z
+date: 2023-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deface
@@ -132,6 +132,7 @@ files:
 - app/assets/javascripts/spree/backend/solidus_paypal_commerce_platform/wizard.js
 - app/assets/stylesheets/spree/backend/solidus_paypal_commerce_platform.css
 - app/decorators/models/solidus_paypal_commerce_platform/spree/address_decorator.rb
+- app/decorators/models/solidus_paypal_commerce_platform/spree/variant/pricing_options_decorator.rb
 - app/helpers/solidus_paypal_commerce_platform/button_options_helper.rb
 - app/jobs/solidus_paypal_commerce_platform/application_job.rb
 - app/jobs/solidus_paypal_commerce_platform/webhook_job.rb
@@ -140,7 +141,6 @@ files:
 - app/models/solidus_paypal_commerce_platform/payment_source.rb
 - app/models/solidus_paypal_commerce_platform/paypal_address.rb
 - app/models/solidus_paypal_commerce_platform/paypal_order.rb
-- app/models/solidus_paypal_commerce_platform/pricing_options.rb
 - app/models/solidus_paypal_commerce_platform/state_guesser.rb
 - app/models/solidus_paypal_commerce_platform/wizard.rb
 - app/overrides/spree/admin/payment_methods/form/insert_email_verification_notification.rb
@@ -274,7 +274,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.3.23
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Integrate Solidus with Paypal Commerce Platform

data/app/models/solidus_paypal_commerce_platform/pricing_options.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module SolidusPaypalCommercePlatform
-  class PricingOptions < ::Spree::Variant::PricingOptions
-    def cache_key
-      SolidusPaypalCommercePlatform::PaymentMethod.active.map(&:cache_key_with_version).sort + [super]
-    end
-  end
-end