solidus_paypal_commerce_platform 0.7.0 → 1.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b52bbb8e31d082c1202fc2ffa6a587492ecedfd6f975dba8523619cab84831d1
-  data.tar.gz: c4b0684da1b34c7612688d3fe64af5f9abfe2045a5d68b453dc6b64ee5d7f2d1
+  metadata.gz: bd0c77c30a42db324d623a2bd37e7ca2d80d107d06c11e5c9c5829bf06e793cf
+  data.tar.gz: 33336091ab82d3af94df502291cbfbe0be94d8d5c839e3c73082210a8b4813b8
 SHA512:
-  metadata.gz: 1a7f24f611ed07c49285287aede4c9de8436b3374249c6611b024f5bbeab98e332d7c3123aab53998c74190333d088884901a88c67100e7849493ab21b4c0a0c
-  data.tar.gz: 16fea0636664456280fc3e92de96110750dc81e6d7121a027c93b00a8b15c0b9ed940b51d98e4aa4dab6f429866adb3128005cab28d039e8f9d2e439089f2dee
+  metadata.gz: 90f698b25df4994cd5037eba1ae264769c1a3667e57f73f415bc38c9d1004bf0e5a4f9404caf57dfba81d65a31340dbe1966d0ef464e673f8ef84b95689ca6b2
+  data.tar.gz: f42016a399a1d7d38d942589df248419f0a5395a62891cda436daa0725c377e4c4518076337a1354553fc9e9a9124424e47f27bfd50f4ebf32ee2863673091dd

data/.circleci/config.yml

@@ -9,33 +9,45 @@ orbs:
   # or goes EOL.
   solidusio_extensions: solidusio/extensions@volatile
 
+commands:
+  test-with-starter-frontend:
+    steps:
+      - checkout
+      - browser-tools/install-chrome
+      - run:
+          name: Install libvips
+          command: sudo apt-get install -y libvips
+      - solidusio_extensions/test-branch:
+          branch: master
+          command: |
+            export FRONTEND=starter
+            sudo gem update --system
+            gem install bundler
+            bin/dummy-app
+            bin/rspec
+      - solidusio_extensions/store-test-results
+
 jobs:
   run-specs-with-postgres:
     executor:
       name: solidusio_extensions/postgres
       ruby_version: '3.1'
     steps:
-      - checkout
-      - browser-tools/install-chrome
-      - solidusio_extensions/run-tests
+      - test-with-starter-frontend
 
   run-specs-with-mysql:
     executor:
       name: solidusio_extensions/mysql
       ruby_version: '3.0'
     steps:
-      - checkout
-      - browser-tools/install-chrome
-      - solidusio_extensions/run-tests
+      - test-with-starter-frontend
 
   run-specs-with-sqlite:
     executor:
       name: solidusio_extensions/sqlite
       ruby_version: '2.7'
     steps:
-      - checkout
-      - browser-tools/install-chrome
-      - solidusio_extensions/run-tests
+      - test-with-starter-frontend
 
   lint-code:
     executor: solidusio_extensions/sqlite-memory

data/.gem_release.yml

@@ -2,4 +2,4 @@ bump:
   recurse: false
   file: 'lib/solidus_paypal_commerce_platform/version.rb'
   message: Bump SolidusPaypalCommercePlatform to %{version}
-  tag: false
+  tag: true

data/.gitignore

@@ -15,6 +15,7 @@ pkg
 spec/dummy
 spec/examples.txt
 /sandbox
+/dummy-app
 .rvmrc
 .ruby-version
 .ruby-gemset

data/.rspec

@@ -1,2 +1 @@
 --color
---require spec_helper

data/.rubocop.yml

@@ -6,6 +6,7 @@ AllCops:
   TargetRubyVersion: '2.7'
   Exclude:
     - sandbox/**/*
+    - dummy-app/**/*
     - spec/dummy/**/*
     - vendor/bundle/**/*
 
@@ -23,10 +24,10 @@ Naming/VariableNumber:
 RSpec/AnyInstance:
   Enabled: false
 
-# Feature specs are not describing any class or module.
+# System specs are not describing any class or module.
 RSpec/DescribeClass:
   Exclude:
-    - spec/features/**/*
+    - spec/system/**/*
 
 # No need to make the code more complex for no real gain.
 RSpec/MessageSpies:

data/CHANGELOG.md

@@ -1,13 +1,21 @@
 # Changelog
 
-## [v0.7.0](https://github.com/solidusio/solidus_paypal_commerce_platform/tree/v0.7.0) (2023-01-18)
+## [v1.0.0.beta1](https://github.com/solidusio/solidus_paypal_commerce_platform/tree/v1.0.0.beta1) (2022-12-05)
 
-[Full Changelog](https://github.com/solidusio/solidus_paypal_commerce_platform/compare/v0.6.0...v0.7.0)
+[Full Changelog](https://github.com/solidusio/solidus_paypal_commerce_platform/compare/v0.6.0...v1.0.0.beta1)
+
+**Closed issues:**
+
+- Release 0.6 and attach that version to a different branch [\#169](https://github.com/solidusio/solidus_paypal_commerce_platform/issues/169)
 
 **Merged pull requests:**
 
-- Allow to use the auto\_capture global preference [\#185](https://github.com/solidusio/solidus_paypal_commerce_platform/pull/185) ([kennyadsl](https://github.com/kennyadsl))
-- Allow cancelling orders [\#180](https://github.com/solidusio/solidus_paypal_commerce_platform/pull/180) ([kennyadsl](https://github.com/kennyadsl))
+- Bugfixes and improvements \(extracted from the SSF support branch\) [\#168](https://github.com/solidusio/solidus_paypal_commerce_platform/pull/168) ([elia](https://github.com/elia))
+- Reorganize the install generator and deprecate `--skip-migrations` [\#167](https://github.com/solidusio/solidus_paypal_commerce_platform/pull/167) ([elia](https://github.com/elia))
+- Setup compatibility with the starter frontend [\#166](https://github.com/solidusio/solidus_paypal_commerce_platform/pull/166) ([elia](https://github.com/elia))
+- Move 'shipping\_preference' preference under PaypalOrder\#to\_json [\#152](https://github.com/solidusio/solidus_paypal_commerce_platform/pull/152) ([retsef](https://github.com/retsef))
+- Truncate the product name to 127 characters [\#139](https://github.com/solidusio/solidus_paypal_commerce_platform/pull/139) ([DanielePalombo](https://github.com/DanielePalombo))
+- Fix issue on international transactions [\#129](https://github.com/solidusio/solidus_paypal_commerce_platform/pull/129) ([jtapia](https://github.com/jtapia))
 
 ## [v0.6.0](https://github.com/solidusio/solidus_paypal_commerce_platform/tree/v0.6.0) (2022-11-25)
 
@@ -22,19 +30,6 @@
 - Invalid string length error [\#135](https://github.com/solidusio/solidus_paypal_commerce_platform/issues/135)
 - PayPal SDK JS Error: Disallowed query param: shipping\_preference [\#133](https://github.com/solidusio/solidus_paypal_commerce_platform/issues/133)
 
-**Merged pull requests:**
-
-- More fixes and improvements extracted from SSF support [\#168](https://github.com/solidusio/solidus_paypal_commerce_platform/pull/168) ([elia](https://github.com/elia))
-  * inline the load_order before action
-  * require the payment_method_id param when loading the payment method
-  * mark the javascript_sdk_url as HTML safe
-  * ensure amounts are presented with 2 decimals for the PayPal API
-  * fixed the sign in requests
-- Reorganize the install generator and deprecate `--skip-migrations` [\#167](https://github.com/solidusio/solidus_paypal_commerce_platform/pull/167) ([elia](https://github.com/elia))
-- Move 'shipping\_preference' preference under PaypalOrder\#to\_json [\#152](https://github.com/solidusio/solidus_paypal_commerce_platform/pull/152) ([retsef](https://github.com/retsef))
-- Truncate the product name to 127 characters [\#139](https://github.com/solidusio/solidus_paypal_commerce_platform/pull/139) ([DanielePalombo](https://github.com/DanielePalombo))
-- Fix issue on international transactions [\#129](https://github.com/solidusio/solidus_paypal_commerce_platform/pull/129) ([jtapia](https://github.com/jtapia))
-
 ## [v0.5.0](https://github.com/solidusio/solidus_paypal_commerce_platform/tree/v0.5.0) (2022-10-07)
 
 [Full Changelog](https://github.com/solidusio/solidus_paypal_commerce_platform/compare/v0.4.0...v0.5.0)

data/Gemfile

@@ -1,46 +1,5 @@
 # frozen_string_literal: true
 
 source 'https://rubygems.org'
-git_source(:github) { |repo| "https://github.com/#{repo}.git" }
-
-branch = ENV.fetch('SOLIDUS_BRANCH', 'master')
-solidus_git, solidus_frontend_git = if (branch == 'master') || (branch >= 'v3.2')
-                                      %w[solidusio/solidus solidusio/solidus_frontend]
-                                    else
-                                      %w[solidusio/solidus] * 2
-                                    end
-gem 'solidus', github: solidus_git, branch: branch
-gem 'solidus_frontend', github: solidus_frontend_git, branch: branch
-
-# Needed to help Bundler figure out how to resolve dependencies,
-# otherwise it takes forever to resolve them.
-# See https://github.com/bundler/bundler/issues/6677
-gem 'rails', ENV.fetch('RAILS_VERSION', '>0.a')
-
-# Provides basic authentication functionality for testing parts of your engine
-gem 'solidus_auth_devise'
-
-case ENV.fetch('DB', nil)
-when 'mysql'
-  gem 'mysql2'
-when 'postgresql'
-  gem 'pg'
-else
-  gem 'sqlite3'
-end
-
-if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('3')
-  # 'net/smtp' is required by 'mail', see:
-  # - https://github.com/ruby/net-protocol/issues/10
-  # - https://stackoverflow.com/a/72474475
-  gem 'net-smtp', require: false
-end
 
 gemspec
-
-# Use a local Gemfile to include development dependencies that might not be
-# relevant for the project or for other contributors, e.g. pry-byebug.
-#
-# We use `send` instead of calling `eval_gemfile` to work around an issue with
-# how Dependabot parses projects: https://github.com/dependabot/dependabot-core/issues/1658.
-send(:eval_gemfile, 'Gemfile-local') if File.exist? 'Gemfile-local'

data/README.md

@@ -31,7 +31,7 @@ Since PayPal is being used as the checkout if the user checks out on the product
 
 A) Turn off cart and product page checkout - configurable on the admin payment method page for PayPal Commerce Platform.
 -OR-
-B) Collect the users phone number seperately
+B) Collect the users phone number separately
 
 and then override the `Spree::Address` method `require_phone?` to return `true`.
 
@@ -93,6 +93,7 @@ end
 The instances of your wizard class should respond to `#name` and `#partial_name`, where `partial_name` will return the path to the partial you'd like to display on the wizard setup section. In our case, we just display a button to direct the user to PayPal.
 
 ## State Guesser
+
 PayPal users can change their shipping address directly on PayPal, which will
 update their address on Solidus as well. However, in some instances, Solidus
 uses the incorrect subregion level for states, which causes validation problems
@@ -101,7 +102,7 @@ with the addresses that PayPal sends to us.
 For instance, if your user lives in Pescara, Italy, then PayPal will return
 "Pescara" as the state. However on older version of Solidus, the region
 "Abruzzo" is used, so the address will not be able to validate. To solve this
-issue, we've implented a class that attempts to guess the state of the user
+issue, we've implemented a class that attempts to guess the state of the user
 using Carmen subregions if the state cannot be initially found. You can, of
 course, implement your own state guesser and set it like this:
 
@@ -121,6 +122,7 @@ With product and cart page checkout, the user is directed to the checkout confir
 PayPals API does not allow for admin-side payments. Instead, backend users taking payments for customers will need to use the PayPal Virtual Terminal to take payments. [More info is available on the PayPal website.](https://www.paypal.com/merchantapps/appcenter/acceptpayments/virtualterminal?locale.x=en_US)
 
 ## Venmo
+
 Venmo is currently available to US merchants and buyers. There are also other [prequisites](https://developer.paypal.com/docs/business/checkout/pay-with-venmo/#eligibility).
 
 If the transaction supports Venmo and it is enabled by the following, then a button should appear for it on checkout payment page. Note, Venmo cannot currently be rendered on the product or cart pages.
@@ -135,6 +137,7 @@ See more about preferences([Configuration](#configuration)) below.
 [_As Venmo is only available in the US, you may want to mock your location for testing_](#mocking-your-buyer-country)
 
 ## Configuration
+
 The easiest way to change the `Payment Method`'s preferences is through admin: `Settings > Payments > "PayPal Commerce Platform" > Edit`.
 
 See more about preferences [here](https://guides.solidus.io/developers/preferences/add-model-preferences.html#access-your-preferences)/
@@ -145,10 +148,10 @@ See more about preferences [here](https://guides.solidus.io/developers/preferenc
 
 First bundle your dependencies, then run `bin/rake`. `bin/rake` will default to building the dummy
 app if it does not exist, then it will run specs. The dummy app can be regenerated by using
-`bin/rake extension:test_app`.
+`bin/dummy-app`.
 
 ```shell
-bundle
+bin/setup
 bin/rake
 ```
 
@@ -158,13 +161,6 @@ To run [Rubocop](https://github.com/bbatsov/rubocop) static code analysis run
 bundle exec rubocop
 ```
 
-When testing your application's integration with this extension you may use its factories.
-Simply add this require statement to your spec_helper:
-
-```ruby
-require 'solidus_paypal_commerce_platform/factories'
-```
-
 ### Running the sandbox
 
 To run this extension in a sandboxed Solidus application, you can run `bin/sandbox`. The path for
@@ -182,6 +178,7 @@ Use Ctrl-C to stop
 ```
 
 ### Mocking your buyer country
+
 PayPal normally looks at your IP geolocation to see where you are located to determine what funding sources are available to you. For example, Venmo is currently only available to US buyers.
 Because of this, you may want to pretend you are from US check that that Venmo is correctly integrated for these customers. To do this, set the payment method's preference of `force_buyer_country` to "US". See more information about preferences above.
 
@@ -206,8 +203,7 @@ Your new extension version can be released using `gem-release` like this:
 bundle exec gem bump -v 1.6.0
 bin/rake changelog
 git commit -a --amend
-git tag v1.6.0
-git push --tags
+git push
 bundle exec gem release
 ```
 
@@ -217,4 +213,4 @@ By using this extension, you are giving back to Solidus. PayPal will pay a fee t
 
 ## License
 
-Copyright (c) 2020 Nebulab srls, released under the New BSD License
+Copyright (c) 2022 Nebulab srls, released under the New BSD License

data/Rakefile

@@ -3,4 +3,9 @@
 require 'solidus_dev_support/rake_tasks'
 SolidusDevSupport::RakeTasks.install
 
-task default: 'extension:specs'
+task :default do
+  require 'bundler'
+  Bundler.with_unbundled_env do
+    sh 'bin/rspec'
+  end
+end

data/app/models/solidus_paypal_commerce_platform/payment_method.rb

@@ -83,7 +83,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,22 +97,5 @@ 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/dummy-app

@@ -0,0 +1,37 @@
+#!/usr/bin/env bash
+
+set -e
+
+extension_name="solidus_paypal_commerce_platform"
+
+# Stay away from the bundler env of the containing extension.
+function unbundled {
+  ruby -rbundler -e'b = proc {system *ARGV}; Bundler.respond_to?(:with_unbundled_env) ? Bundler.with_unbundled_env(&b) : Bundler.with_clean_env(&b)' -- "$@"
+}
+
+# "sqlite" is set by the ORB extension instead of "sqlite3",
+# all other options are already in the format expected by `rails new`.
+test "$DB" = "sqlite" && export DB="sqlite3"
+
+rm -rf ./dummy-app
+unbundled bundle exec rails new dummy-app \
+  --database=${DB:-sqlite3} \
+  --skip-bundle \
+  --skip-git \
+  --skip-keeps \
+  --skip-rc \
+  --skip-spring \
+  --skip-javascript
+
+if [ ! -d "dummy-app" ]; then
+  echo 'dummy-app rails application failed'
+  exit 1
+fi
+
+cd ./dummy-app
+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 --payment-method=none --no-seed --no-sample "$@"
+unbundled bundle add $extension_name --path ..
+unbundled bundle exec rails generate $extension_name:install --migrate --specs=all
+

data/bin/rails-dummy-app

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+root = "#{__dir__}/.."
+app_root = "#{root}/dummy-app"
+
+unless File.exist? "#{app_root}/bin/rails"
+  warn 'Creating the dummy-app app...'
+  Dir.chdir root do
+    system "#{root}/bin/dummy-app" or begin
+      warn 'Automatic creation of the dummy-app app failed'
+      exit 1
+    end
+  end
+end
+
+Dir.chdir app_root
+exec "#{app_root}/bin/rails", *ARGV

data/bin/rspec

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+set -e
+
+bin/rails-dummy-app generate solidus_paypal_commerce_platform:install --force --migrate --specs=all
+
+cd dummy-app/
+rspec "$@"
+exit_status=$?
+cd -
+exit $exit_status

data/bin/sandbox

@@ -29,7 +29,7 @@ extension_name="solidus_paypal_commerce_platform"
 
 # Stay away from the bundler env of the containing extension.
 function unbundled {
-  ruby -rbundler -e'b = proc {system *ARGV}; Bundler.respond_to?(:with_unbundled_env) ? Bundler.with_unbundled_env(&b) : Bundler.with_clean_env(&b)' -- $@
+  ruby -rbundler -e'b = proc {system *ARGV}; Bundler.respond_to?(:with_unbundled_env) ? Bundler.with_unbundled_env(&b) : Bundler.with_clean_env(&b)' -- "$@"
 }
 
 rm -rf ./sandbox
@@ -48,14 +48,9 @@ if [ ! -d "sandbox" ]; then
 fi
 
 cd ./sandbox
-cat <<RUBY >> Gemfile
-  gem 'solidus', github: 'solidusio/solidus', branch: '$BRANCH'
-  gem 'pry-byebug', platforms: :mri, groups: [:test, :development]
-RUBY
-
-unbundled bundle install --gemfile Gemfile
+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 --auto-accept "$@"
 
 echo
 echo "🚀 Sandbox app successfully created for $extension_name!"

data/config/locales/en.yml

@@ -40,7 +40,6 @@ 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

@@ -3,21 +3,22 @@
 module SolidusPaypalCommercePlatform
   module Generators
     class InstallGenerator < Rails::Generators::Base
-      class_option :auto_run_migrations, type: :boolean, default: false
-
-      # This should only be used by the solidus installer prior to v3.3.
-      class_option :skip_migrations, type: :boolean, default: false, hide: true
+      class_option :migrate, type: :boolean, default: true
+      class_option :backend, type: :boolean, default: true
+      class_option :starter_frontend, type: :boolean, default: true
+      class_option :specs, type: :string, enum: %w[all frontend], default: 'frontend'
 
       source_root File.expand_path('templates', __dir__)
 
       def install_solidus_core_support
-        template 'initializer.rb', 'config/initializers/solidus_paypal_commerce_platform.rb'
+        directory 'config/initializers', 'config/initializers'
         rake 'railties:install:migrations FROM=solidus_paypal_commerce_platform'
+        run 'bin/rails db:migrate' if options[:migrate]
         route "mount SolidusPaypalCommercePlatform::Engine, at: '/solidus_paypal_commerce_platform'"
       end
 
       def install_solidus_backend_support
-        support_code_for('solidus_backend') do
+        support_code_for(:solidus_backend) do
           append_file(
             'vendor/assets/javascripts/spree/backend/all.js',
             "//= require spree/backend/solidus_paypal_commerce_platform\n"
@@ -31,36 +32,49 @@ module SolidusPaypalCommercePlatform
         end
       end
 
-      def install_solidus_frontend_support
-        support_code_for('solidus_frontend') do
+      def install_solidus_starter_frontend_support
+        support_code_for(:solidus_starter_frontend) do
+          directory 'app', 'app'
           append_file(
-            'vendor/assets/javascripts/spree/frontend/all.js',
-            "//= require spree/frontend/solidus_paypal_commerce_platform\n",
+            'app/assets/javascripts/solidus_starter_frontend.js',
+            "//= require spree/frontend/solidus_paypal_commerce_platform\n"
           )
           inject_into_file(
-            'vendor/assets/stylesheets/spree/frontend/all.css',
+            'app/assets/stylesheets/solidus_starter_frontend.css',
             " *= require spree/frontend/solidus_paypal_commerce_platform\n",
             before: %r{\*/},
             verbose: true,
           )
-          directory engine.root.join("lib/views/frontend"), 'app/views/'
-        end
-      end
 
-      def run_migrations
-        return rake 'db:migrate' if options[:auto_run_migrations] && !options[:skip_migrations]
+          spec_paths =
+            case options[:specs]
+            when 'all' then %w[spec]
+            when 'frontend'
+              %w[
+                spec/solidus_paypal_commerce_platform_spec_helper.rb
+                spec/system/frontend
+                spec/support
+              ]
+            end
 
-        say_status :skip, 'db:migrate'
+          spec_paths.each do |path|
+            if engine.root.join(path).directory?
+              directory engine.root.join(path), path
+            else
+              template engine.root.join(path), path
+            end
+          end
+        end
       end
 
       private
 
-      def support_code_for(gem_name, run_if: Bundler.locked_gems.specs.map(&:name).include?(gem_name), &block)
-        if run_if
-          say_status :install, "[#{engine.engine_name}] #{gem_name} code", :blue
+      def support_code_for(component_name, &block)
+        if options[component_name]
+          say_status :install, "[#{engine.engine_name}] solidus_#{component_name}", :blue
           shell.indent(&block)
         else
-          say_status :skip, "[#{engine.engine_name}] #{gem_name} code", :blue
+          say_status :skip, "[#{engine.engine_name}] solidus_#{component_name}", :blue
         end
       end