solidus_stripe 4.2.0 → 4.4.0

data/LICENSE

@@ -1,4 +1,5 @@
 Copyright (c) 2014 Spree Commerce Inc. and other contributors.
+Copyright (c) 2021 Solidus Team and other contributors.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,
@@ -9,7 +10,7 @@ are permitted provided that the following conditions are met:
     * Redistributions in binary form must reproduce the above copyright notice,
       this list of conditions and the following disclaimer in the documentation
       and/or other materials provided with the distribution.
-    * Neither the name Spree nor the names of its contributors may be used to
+    * Neither the name Solidus nor the names of its contributors may be used to
       endorse or promote products derived from this software without specific
       prior written permission.
 

data/README.md

@@ -1,27 +1,18 @@
-Solidus Stripe
-===============
+# Solidus Stripe
 
-[![CircleCI](https://circleci.com/gh/solidusio/solidus_stripe.svg?style=svg)](https://circleci.com/gh/solidusio/solidus_stripe)
+[![CircleCI](https://circleci.com/gh/solidusio/solidus_stripe.svg?style=shield)](https://circleci.com/gh/solidusio/solidus_stripe)
+[![codecov](https://codecov.io/gh/solidusio/solidus_stripe/branch/master/graph/badge.svg)](https://codecov.io/gh/solidusio/solidus_stripe)
 
 Stripe Payment Method for Solidus. It works as a wrapper for the ActiveMerchant Stripe gateway.
 
----
+## Installation
 
-Installation
-------------
 
-In your Gemfile:
-
-```ruby
-gem 'solidus_stripe', '~> 3.0'
-```
-
-Then run from the command line:
+Run from the command line:
 
 ```shell
-bundle install
+bundle add solidus_stripe
 bundle exec rails g solidus_stripe:install
-bundle exec rails db:migrate
 ```
 
 Usage
@@ -45,20 +36,15 @@ variables you can create the following static configuration:
 
 ```ruby
 # config/initializers/spree.rb
-
-Spree.config do |config|
-  # ...
-
-  config.static_model_preferences.add(
+Rails.application.config.to_prepare do
+  Spree::Config.static_model_preferences.add(
     Spree::PaymentMethod::StripeCreditCard,
     'stripe_env_credentials',
     secret_key: ENV['STRIPE_SECRET_KEY'],
     publishable_key: ENV['STRIPE_PUBLISHABLE_KEY'],
     stripe_country: 'US',
     v3_elements: false,
-    v3_intents: false,
-    server: Rails.env.production? ? 'production' : 'test',
-    test_mode: !Rails.env.production?
+    v3_intents: false
   )
 end
 ```
@@ -82,7 +68,7 @@ account. Conversely, if you need to disable the button you can simply remove
 the `stripe_country` preference.
 
 Please refer to Stripe official
-[documentation](https://stripe.com/docs/stripe-js/elements/payment-request-button)
+[documentation](https://stripe.com/docs/payments/payment-intents)
 for further instructions on how to make this work properly.
 
 The following configuration will use both Payment Intents and the
@@ -100,9 +86,7 @@ Spree.config do |config|
     publishable_key: ENV['STRIPE_PUBLISHABLE_KEY'],
     stripe_country: 'US',
     v3_elements: false,
-    v3_intents: true,
-    server: Rails.env.production? ? 'production' : 'test',
-    test_mode: !Rails.env.production?
+    v3_intents: true
   )
 end
 ```
@@ -263,52 +247,75 @@ SolidusStripe.Payment.prototype.elementsBaseOptions = function () {
 };
 ```
 
-
-Migrating from solidus_gateway
-------------------------------
+## Migrating from solidus_gateway
 
 If you were previously using `solidus_gateway` gem you might want to
 check out our [Wiki page](https://github.com/solidusio/solidus_stripe/wiki/Migrating-from-solidus_gateway)
 that describes how to handle this migration.
 
-Testing
--------
+## Development
+
+### Testing the extension
 
-Then just run the following to automatically build a dummy app if necessary and
-run the tests:
+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`.
 
 ```shell
-bundle exec rake
+bin/rake
 ```
 
-Releasing
----------
+To run [Rubocop](https://github.com/bbatsov/rubocop) static code analysis run
 
-We use [gem-release](https://github.com/svenfuchs/gem-release) to release this
-extension with ease.
+```shell
+bundle exec rubocop
+```
 
-Supposing you are on the master branch and you are working on a fork of this
-extension, `upstream` is the main remote and you have write access to it, you
-can simply run:
+When testing your application's integration with this extension you may use its factories.
+Simply add this require statement to your `spec/spec_helper.rb`:
 
+```ruby
+require 'solidus_stripe/testing_support/factories'
 ```
-gem bump --version minor --tag --release --remote upstream
+
+Or, if you are using `FactoryBot.definition_file_paths`, you can load Solidus core
+factories along with this extension's factories using this statement:
+
+```ruby
+SolidusDevSupport::TestingSupport::Factories.load_for(SolidusStripe::Engine)
 ```
 
-This command will:
+### Running the sandbox
 
-- bump the gem version to the next minor (changing the `version.rb` file)
-- commit the change and push it to upstream master
-- create a git tag
-- push the tag to the upstream remote
-- release the new version on RubyGems
+To run this extension in a sandboxed Solidus application, you can run `bin/sandbox`. The path for
+the sandbox app is `./sandbox` and `bin/rails` will forward any Rails commands to
+`sandbox/bin/rails`.
 
-Or you can run these commands individually:
+Here's an example:
 
 ```
-gem bump --version minor --remote upstream
-gem tag --remote upstream
-gem release
+$ bin/rails server
+=> Booting Puma
+=> Rails 6.0.2.1 application starting in development
+* Listening on tcp://127.0.0.1:3000
+Use Ctrl-C to stop
+```
+
+### Updating the changelog
+
+Before and after releases the changelog should be updated to reflect the up-to-date status of
+the project:
+
+```shell
+bin/rake changelog
+git add CHANGELOG.md
+git commit -m "Update the changelog"
 ```
 
-Copyright (c) 2020 Spree Commerce Inc., released under the New BSD License
+### Releasing new versions
+
+Please refer to the dedicated [page](https://github.com/solidusio/solidus/wiki/How-to-release-extensions) on Solidus wiki.
+
+## License
+Copyright (c) 2014 Spree Commerce Inc., released under the New BSD License
+Copyright (c) 2021 Solidus Team, released under the New BSD License

data/Rakefile

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+# Don't build a dummy app with solidus_bolt enabled
+ENV['SKIP_SOLIDUS_BOLT'] = 'true'
+
 require 'solidus_dev_support/rake_tasks'
 SolidusDevSupport::RakeTasks.install
 

data/app/assets/javascripts/spree/frontend/solidus_stripe/stripe-cart-page-checkout.js

@@ -53,6 +53,7 @@ SolidusStripe.CartPageCheckout.prototype.onPrPayment = function(payment) {
       shipping_option: payment.shippingOption,
       email: payment.payerEmail,
       name: payment.payerName,
+      phone: payment.payerPhone,
       authenticity_token: this.authToken
     })
   }).then(function(response) {

data/app/assets/javascripts/spree/frontend/solidus_stripe/stripe-payment-request-button-shared.js

@@ -22,6 +22,7 @@
           },
           requestPayerName: true,
           requestPayerEmail: true,
+          requestPayerPhone: true,
           requestShipping: config.requestShipping,
           shippingOptions: []
         });
@@ -50,7 +51,7 @@
         };
         paymentRequest.on('paymentmethod', onPrPaymentMethod.bind(this));
 
-        onShippingAddressChange = function(ev) {
+        var onShippingAddressChange = function(ev) {
           var showError = this.showError.bind(this);
 
           fetch('/stripe/shipping_rates', {

data/app/controllers/solidus_stripe/intents_controller.rb

@@ -19,7 +19,7 @@ module SolidusStripe
       if create_payment_service.call
         render json: { success: true }
       else
-        render json: { error: "Could not create payment" }, status: 500
+        render json: { error: "Could not create payment" }, status: :internal_server_error
       end
     end
 
@@ -45,7 +45,7 @@ module SolidusStripe
           stripe_payment_intent_id: response['id']
         }
       else
-        render json: { error: response['error']['message'] }, status: 500
+        render json: { error: response['error']['message'] }, status: :internal_server_error
       end
     end
 

data/app/controllers/solidus_stripe/payment_request_controller.rb

@@ -14,7 +14,7 @@ module SolidusStripe
       if rates.any?
         render json: { success: true, shipping_rates: rates }
       else
-        render json: { success: false, error: 'No shipping method available for that address' }, status: 500
+        render json: { success: false, error: 'No shipping method available for that address' }, status: :internal_server_error
       end
     end
 
@@ -22,7 +22,7 @@ module SolidusStripe
       current_order.restart_checkout_flow
 
       address = SolidusStripe::AddressFromParamsService.new(
-        params[:shipping_address],
+        shipping_address_from_params,
         spree_current_user
       ).call
 
@@ -32,11 +32,21 @@ module SolidusStripe
         if current_order.payment?
           render json: { success: true }
         else
-          render json: { success: false, error: 'Order not ready for payment. Try manual checkout.' }, status: 500
+          render json: { success: false, error: 'Order not ready for payment. Try manual checkout.' }, status: :internal_server_error
         end
       else
-        render json: { success: false, error: address.errors.full_messages.to_sentence }, status: 500
+        render json: { success: false, error: address.errors.full_messages.to_sentence }, status: :internal_server_error
       end
     end
+
+    private
+
+    def shipping_address_from_params
+      return {} unless params[:shipping_address]
+      return params[:shipping_address] if params.dig(:shipping_address, :phone).present?
+
+      params[:shipping_address][:phone] = params[:phone]
+      params[:shipping_address]
+    end
   end
 end

data/app/decorators/models/spree/refund_decorator.rb

@@ -4,6 +4,6 @@ module Spree
   module RefundDecorator
     attr_reader :response
 
-    Spree::Refund.prepend(self)
+    ::Spree::Refund.prepend(self)
   end
 end

data/app/models/solidus_stripe/address_from_params_service.rb

@@ -26,14 +26,26 @@ module SolidusStripe
           lines = address_params[:addressLine]
           names = address_params[:recipient].split(' ')
 
-          attributes.merge!(
-            state_id: state&.id,
-            firstname: names.first,
-            lastname: names.last,
-            phone: phone,
-            address1: lines.first,
-            address2: lines.second
-          ).reject! { |_, value| value.blank? }
+          name_attributes = if SolidusSupport.combined_first_and_last_name_in_address? && Spree::Address.column_names.include?("name")
+            {
+              name: address_params[:recipient]
+            }
+          else
+            {
+              firstname: names.first,
+              lastname: names.last,
+            }
+          end
+
+          attributes
+            .merge!(name_attributes)
+            .merge!(
+              state_id: state&.id,
+              phone: phone,
+              address1: lines.first,
+              address2: lines.second
+            )
+            .reject! { |_, value| value.blank? }
         end
       end
     end

data/app/models/solidus_stripe/create_intents_payment_service.rb

@@ -102,7 +102,8 @@ module SolidusStripe
     end
 
     def address_full_name
-      current_order.bill_address&.full_name || form_data[:recipient]
+      bill_address_name = SolidusSupport.combined_first_and_last_name_in_address? ? current_order.bill_address&.name : current_order.bill_address&.full_name
+      bill_address_name || form_data[:recipient]
     end
 
     def update_stripe_payment_description

data/app/models/spree/payment_method/stripe_credit_card.rb

@@ -61,20 +61,29 @@ module Spree
         true
       end
 
+      def non_fractional_money(money, currency)
+        amount = money.is_a?(Integer) ? money : money.cents
+        Spree::Money.new((amount * 100), { currency: currency })
+      end
+
+      def localize(money, currency)
+        ActiveMerchant::Billing::Gateway.currencies_without_fractions.include?(currency) ? non_fractional_money(money, currency) : money
+      end
+
       def purchase(money, creditcard, transaction_options)
-        gateway.purchase(*options_for_purchase_or_auth(money, creditcard, transaction_options))
+        gateway.purchase(*options_for_purchase_or_auth(localize(money, transaction_options[:currency]), creditcard, transaction_options))
       end
 
       def authorize(money, creditcard, transaction_options)
-        gateway.authorize(*options_for_purchase_or_auth(money, creditcard, transaction_options))
+        gateway.authorize(*options_for_purchase_or_auth(localize(money, transaction_options[:currency]), creditcard, transaction_options))
       end
 
       def capture(money, response_code, transaction_options)
-        gateway.capture(money, response_code, transaction_options)
+        gateway.capture(localize(money, transaction_options[:currency]), response_code, transaction_options)
       end
 
-      def credit(money, _creditcard, response_code, _transaction_options)
-        gateway.refund(money, response_code, {})
+      def credit(money, _creditcard, response_code, transaction_options)
+        gateway.refund(localize(money, transaction_options[:currency]), response_code, {})
       end
 
       def void(response_code, _creditcard, _transaction_options)
@@ -87,10 +96,13 @@ module Spree
 
       def try_void(payment)
         if v3_intents? && payment.completed?
-          payment.refunds.create!(
-            amount: payment.credit_allowed,
-            reason: payment_intents_refund_reason
-          ).response
+          refund = perform_refund(payment)
+
+          if refund.respond_to?(:perform_response)
+            refund.perform_response
+          else
+            refund.response
+          end
         else
           void(payment.response_code, nil, nil)
         end
@@ -109,7 +121,7 @@ module Spree
         }.merge! address_for(payment)
 
         source = update_source!(payment.source)
-        if source.number.blank? && source.gateway_payment_profile_id.present?
+        if reuse_existing_source?(source)
           if v3_intents?
             creditcard = ActiveMerchant::Billing::StripeGateway::StripePaymentToken.new('id' => source.gateway_payment_profile_id)
           else
@@ -121,7 +133,7 @@ module Spree
 
         response = gateway.store(creditcard, options)
         if response.success?
-          if v3_intents?
+          if v3_intents? && reuse_existing_source?(source)
             payment.source.update!(
               cc_type: payment.source.cc_type,
               gateway_customer_profile_id: response.params['customer'],
@@ -152,6 +164,7 @@ module Spree
         options[:description] = "Solidus Order ID: #{transaction_options[:order_id]}"
         options[:currency] = transaction_options[:currency]
         options[:off_session] = true if v3_intents?
+        options[:statement_descriptor_suffix] = transaction_options[:statement_descriptor_suffix] if transaction_options[:statement_descriptor_suffix]
 
         if customer = creditcard.gateway_customer_profile_id
           options[:customer] = customer
@@ -190,6 +203,28 @@ module Spree
         source.cc_type = CARD_TYPE_MAPPING[source.cc_type] if CARD_TYPE_MAPPING.include?(source.cc_type)
         source
       end
+
+      def perform_refund(payment)
+        refund = payment.refunds.build(
+          amount: payment.credit_allowed,
+          reason: payment_intents_refund_reason
+        )
+
+        if refund.respond_to?(:perform_after_create)
+          refund.perform_after_create = false
+          refund.save!
+          refund.perform!
+        else
+          refund.save!
+          refund.perform! if Gem::Requirement.new('>= 3.0.0.alpha').satisfied_by?(Spree.solidus_gem_version)
+        end
+
+        refund
+      end
+
+      def reuse_existing_source?(source)
+        source.number.blank? && source.gateway_payment_profile_id.present?
+      end
     end
   end
 end

data/bin/rails

@@ -1,15 +1,7 @@
 #!/usr/bin/env ruby
 
-# frozen_string_literal: true
-
-app_root = 'spec/dummy'
-
-unless File.exist? "#{app_root}/bin/rails"
-  system "bin/rake", app_root or begin # rubocop:disable Style/AndOr
-    warn "Automatic creation of the dummy app failed"
-    exit 1
-  end
+if %w[g generate].include? ARGV.first
+  exec "#{__dir__}/rails-engine", *ARGV
+else
+  exec "#{__dir__}/rails-sandbox", *ARGV
 end
-
-Dir.chdir app_root
-exec 'bin/rails', *ARGV

data/bin/rails-engine

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/solidus_stripe/engine', __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/bin/rails-sandbox

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

data/bin/sandbox

@@ -67,14 +67,16 @@ unbundled bundle install --gemfile Gemfile
 
 unbundled bundle exec rake db:drop db:create
 
-unbundled bundle exec rails generate spree:install \
+unbundled bundle exec rails generate solidus:install \
   --auto-accept \
   --user_class=Spree::User \
   --enforce_available_locales=true \
   --with-authentication=false \
+  --payment-method=none \
   $@
 
 unbundled bundle exec rails generate solidus:auth:install
+unbundled bundle exec rails generate ${extension_name}:install
 
 echo
 echo "🚀 Sandbox app successfully created for $extension_name!"

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: Hello world

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

@@ -9,16 +9,12 @@ module SolidusStripe
         append_file 'vendor/assets/javascripts/spree/frontend/all.js', "//= require spree/frontend/solidus_stripe\n"
       end
 
-      def add_migrations
-        run 'bundle exec rake railties:install:migrations FROM=solidus_stripe'
-      end
-
       def add_migrations
         run 'bin/rails railties:install:migrations FROM=solidus_stripe'
       end
 
       def run_migrations
-        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]')) # rubocop:disable Metrics/LineLength
+        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]')) # rubocop:disable Layout/LineLength
         if run_migrations
           run 'bin/rails db:migrate'
         else

data/lib/solidus_stripe/configuration.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module SolidusStripe
+  class Configuration
+    # Define here the settings for this extension, e.g.:
+    #
+    # attr_accessor :my_setting
+  end
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    alias config configuration
+
+    def configure
+      yield configuration
+    end
+  end
+end

data/lib/solidus_stripe/engine.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-require 'spree/core'
+require 'solidus_core'
+require 'solidus_support'
 
 module SolidusStripe
   class Engine < Rails::Engine
@@ -15,20 +16,8 @@ module SolidusStripe
       g.test_framework :rspec
     end
 
-    if SolidusSupport.backend_available?
-      paths["app/views"] << "lib/views/backend"
-    end
-
-    if SolidusSupport.frontend_available?
-      paths["app/views"] << "lib/views/frontend"
-    end
-
-    if SolidusSupport.api_available?
-      paths["app/views"] << "lib/views/api"
-    end
-
     initializer "spree.payment_method.add_stripe_credit_card", after: "spree.register.payment_methods" do |app|
-      app.config.spree.payment_methods << Spree::PaymentMethod::StripeCreditCard
+      app.config.spree.payment_methods << "Spree::PaymentMethod::StripeCreditCard"
     end
   end
 end

data/lib/solidus_stripe/testing_support/card_input_helper.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module SolidusCardInputHelper
+  def fill_in_card(card = {})
+    card[:number] ||= "4242 4242 4242 4242"
+    card[:code] ||= "123"
+    card[:exp_month] ||= "01"
+    card[:exp_year] ||= "#{Time.zone.now.year + 1}"
+
+    if preferred_v3_elements || preferred_v3_intents
+      within_frame find('#card_number iframe') do
+        fill_in_number("cardnumber", card)
+      end
+      within_frame(find '#card_cvc iframe') { fill_in 'cvc', with: card[:code] }
+      within_frame(find '#card_expiry iframe') do
+        fill_in_expiration("exp-date", card)
+      end
+    else
+      fill_in_number("Card Number", card)
+      fill_in "Card Code", with: card[:code]
+      fill_in_expiration("Expiration", card)
+    end
+  end
+
+  private
+
+  def fill_in_number(field_name, card)
+    card[:number].split('').each { |n| find_field(field_name).native.send_keys(n) }
+  end
+
+  def fill_in_expiration(field_name, card)
+    "#{card[:exp_month]}#{card[:exp_year].last(2)}".split('').each { |n| find_field(field_name).native.send_keys(n) }
+  end
+end

data/lib/solidus_stripe/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SolidusStripe
-  VERSION = "4.2.0"
+  VERSION = '4.4.0'
 end

data/lib/solidus_stripe.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require "active_merchant"
-require "solidus_core"
-require "solidus_support"
-require "solidus_stripe/engine"
-require "solidus_stripe/version"
+require 'active_merchant'
+
+require 'solidus_stripe/configuration'
+require 'solidus_stripe/version'
+require 'solidus_stripe/engine'