spree_paypal_checkout 0.5.1

data/app/serializers/spree/api/v2/storefront/paypal_order_serializer.rb

@@ -0,0 +1,11 @@
+module Spree
+  module Api
+    module V2
+      module Storefront
+        class PaypalOrderSerializer < BaseSerializer
+          attributes :paypal_id, :data, :amount
+        end
+      end
+    end
+  end
+end

data/app/services/spree_paypal_checkout/capture_order.rb

@@ -0,0 +1,104 @@
+module SpreePaypalCheckout
+  class CaptureOrder
+    def initialize(paypal_order:)
+      @paypal_order = paypal_order
+      @order = paypal_order.order
+      @gateway = paypal_order.gateway
+      @amount = paypal_order.amount
+    end
+
+    attr_reader :paypal_order, :order, :gateway, :amount
+
+    def call
+      return paypal_order if order.completed? || order.canceled?
+
+      # capture the order in PayPal API
+      gateway_response = gateway.capture(
+        Money.new(amount, order.currency).cents,
+        paypal_order.paypal_id,
+        {
+          order_id: order.number
+        }
+      )
+
+      order.with_lock do
+        # gateway_response.params is a JSON response from PayPal APIs
+        paypal_order.update!(data: gateway_response.params)
+
+        # create the Spree::Payment record
+        paypal_order.create_payment!
+
+        # complete the order in Spree
+        Spree::Dependencies.checkout_complete_service.constantize.call(order: order)
+      end
+
+      paypal_order
+    end
+
+    private
+
+    # we need to perform this for quick checkout orders which do not have these fields filled
+    def add_customer_information(order, charge)
+      billing_details = charge.billing_details
+      address = billing_details.address
+
+      order.email ||= billing_details.email
+      order.save! if order.email_changed?
+
+      # we don't need to perform this if we already have the billing address filled
+      return order if order.bill_address.present? && order.bill_address.valid?
+
+      # determine country...
+      country_iso = address.country
+      country = Spree::Country.find_by(iso: country_iso) || Spree::Country.default
+
+      # assign new address if we don't have one
+      order.bill_address ||= Spree::Address.new(country: country, user: order.user)
+
+      # assign attributes
+      order.bill_address.quick_checkout = true # skipping some validations
+
+      # sometimes google pay doesn't provide name (geez)
+      first_name = billing_details.name&.split(' ')&.first || order.ship_address&.first_name || order.user&.first_name
+      last_name = billing_details.name&.split(' ')&.last || order.ship_address&.last_name || order.user&.last_name
+
+      order.bill_address.first_name ||= first_name
+      order.bill_address.last_name ||= last_name
+      order.bill_address.phone ||= billing_details.phone
+      order.bill_address.address1 ||= address.line1
+      order.bill_address.address2 ||= address.line2
+      order.bill_address.city ||= address.city
+      order.bill_address.zipcode ||= address.postal_code
+
+      state_name = address.state
+      if country.states_required?
+        order.bill_address.state = country.states.find_all_by_name_or_abbr(state_name)&.first if country.states_required?
+      else
+        order.bill_address.state_name = state_name
+      end
+
+      order.bill_address.state_name ||= state_name
+
+      if order.bill_address.invalid?
+        order.bill_address = order.ship_address
+      else
+        order.bill_address.save!
+      end
+
+      order.save!
+
+      copy_bill_info_to_user(order) if order.user.present?
+
+      order
+    end
+
+    def copy_bill_info_to_user(order)
+      user = order.user
+      user.first_name ||= order.bill_address.first_name
+      user.last_name ||= order.bill_address.last_name
+      user.phone ||= order.bill_address.phone
+      user.bill_address_id ||= order.bill_address.id
+      user.save! if user.changed?
+    end
+  end
+end

data/app/services/spree_paypal_checkout/create_payment.rb

@@ -0,0 +1,34 @@
+module SpreePaypalCheckout
+  class CreatePayment
+    def initialize(paypal_order:, order: nil, gateway: nil, amount: nil)
+      @paypal_order = paypal_order
+      @order = order || paypal_order.order
+      @gateway = gateway || paypal_order.gateway
+      @amount = amount || paypal_order.amount
+    end
+
+    def call
+      source = SpreePaypalCheckout::CreateSource.new(
+        paypal_payment_source: paypal_order.payment_source,
+        gateway: gateway,
+        order: order
+      ).call
+
+      # sometimes a job is re-tried and creates a double payment record so we need to avoid it!
+      payment = order.payments.find_or_initialize_by(
+        payment_method_id: gateway.id,
+        response_code: paypal_order.paypal_payment_id,
+        amount: amount
+      )
+
+      payment.source = source if source.present?
+      payment.state = 'completed' # we're creating the payment record after the order is captured in PayPal API
+      payment.save!
+      payment
+    end
+
+    private
+
+    attr_reader :order, :gateway, :paypal_order, :amount
+  end
+end

data/app/services/spree_paypal_checkout/create_source.rb

@@ -0,0 +1,52 @@
+module SpreePaypalCheckout
+  class CreateSource
+    def initialize(paypal_payment_source:, gateway:, order: nil, user: nil)
+      @paypal_payment_source = paypal_payment_source
+      @gateway = gateway
+      @user = user || order&.user
+      @order = order
+    end
+
+    # TODO: add support for venmo and other providers
+    def call
+      if paypal_payment_source['paypal'].present?
+        create_paypal_source
+      else
+        raise 'Invalid payment source', paypal_payment_source
+      end
+    end
+
+    private
+
+    attr_reader :gateway, :user, :paypal_payment_source, :order
+
+    # "payment_source": {
+    #   "paypal": {
+    #     "email_address": "sb-fxqy4743082799@personal.example.com",
+    #     "account_id": "RX8ZD67CZ67RU",
+    #     "account_status": "VERIFIED",
+    #     "name": {
+    #       "given_name": "John",
+    #       "surname": "Doe"
+    #     },
+    #     "address": {
+    #       "country_code": "US"
+    #     }
+    #   }
+    # },
+    def create_paypal_source
+      source = SpreePaypalCheckout::PaymentSources::Paypal.find_or_create_by!(
+        payment_method: gateway,
+        user: user,
+        gateway_payment_profile_id: paypal_payment_source['paypal']['account_id']
+      )
+      source.update!(
+        email: paypal_payment_source['paypal']['email_address'],
+        name: "#{paypal_payment_source['paypal']['name']['given_name']} #{paypal_payment_source['paypal']['name']['surname']}".strip,
+        account_id: paypal_payment_source['paypal']['account_id'],
+        account_status: paypal_payment_source['paypal']['account_status']
+      )
+      source
+    end
+  end
+end

data/app/views/spree/admin/payment_methods/configuration_guides/_spree_paypal_checkout.html.erb

@@ -0,0 +1,6 @@
+<div class="alert alert-info">
+  <p class="mb-0">
+    To find your <strong>Client ID</strong> and <strong>Client Secret</strong>, go to the 
+    <%= external_link_to 'PayPal dashboard', 'https://www.paypal.com/mep/merchantapps/setup/checkout/apicredentials', class: 'alert-link' %>
+  </p>
+</div>

data/app/views/spree/admin/payment_methods/descriptions/_spree_paypal_checkout.html.erb

@@ -0,0 +1,10 @@
+<p class="mb-1">
+  From paying friends to saving money or getting cash back when you shop, explore what the new PayPal app has to offer.
+</p>
+
+<div class="d-flex align-items-center">
+  <%= payment_method_icon_tag 'paypal', class: 'm-1' %>
+  <%= payment_method_icon_tag 'visa', class: 'm-1' %>
+  <%= payment_method_icon_tag 'master', class: 'm-1' %>
+  <%= payment_method_icon_tag 'venmo', class: 'm-1' %>
+</div>

data/app/views/spree/checkout/payment/_spree_paypal_checkout.html.erb

@@ -0,0 +1,13 @@
+<div
+  data-controller="checkout-paypal"
+  data-checkout-paypal-client-key-value="<%= current_paypal_checkout_gateway.try(:preferred_client_key) %>"
+  data-checkout-paypal-order-number-value="<%= @order.number %>"
+  data-checkout-paypal-order-token-value="<%= @order.token %>"
+  data-checkout-paypal-currency-value="<%= @order.currency %>"
+  data-checkout-paypal-amount-value="<%= @order.total %>"
+  data-checkout-paypal-api-create-order-path-value="<%= spree.api_v2_storefront_paypal_orders_path %>"
+  data-checkout-paypal-api-capture-order-path-value="<%= spree.capture_api_v2_storefront_paypal_order_path(@order.number) %>"
+  data-checkout-paypal-api-checkout-update-path-value="<%= spree.api_v2_storefront_checkout_path %>"
+  data-checkout-paypal-return-url-value="<%= spree.checkout_complete_path(@order.token) %>"
+>
+</div>

data/app/views/spree/payment_sources/_paypal_checkout.html.erb

@@ -0,0 +1,16 @@
+<% if source.is_a?(SpreePaypalCheckout::PaymentSources::Paypal) %>
+  <p class="mb-2">
+    <code><%= source.account_id %></code>
+    <% if source.account_status == 'VERIFIED' %>
+      <code class="text-success"><%= source.account_status %></code>
+    <% else %>
+      <code class="text-danger"><%= source.account_status %></code>
+    <% end %>
+  </p>
+  <p class="mb-0">
+    <%= source.email %>
+  </p>
+  <p class="mb-0">
+    <%= source.name %>
+  </p>
+<% end %>

data/app/views/spree_paypal_checkout/_head.html.erb

@@ -0,0 +1,10 @@
+<% if current_store.paypal_checkout_gateway.present? %>
+  <!-- Initialize the JS-SDK -->
+  <script
+    src="https://www.paypal.com/sdk/js?client-id=<%= current_store.paypal_checkout_gateway.preferred_client_id %>&currency=<%= current_currency %>&components=buttons&enable-funding=paylater&disable-funding=venmo,card,p24"
+    data-sdk-integration-source="developer-studio"
+    defer
+  ></script>
+
+  <%= javascript_import_module_tag 'application-spree-paypal-checkout' %>
+<% end %>

data/config/importmap.rb

@@ -0,0 +1,6 @@
+pin 'application-spree-paypal-checkout', to: 'spree_paypal_checkout/application.js', preload: false
+
+pin_all_from SpreePaypalCheckout::Engine.root.join('app/javascript/spree_paypal_checkout/controllers'),
+             under: 'spree_paypal_checkout/controllers',
+             to: 'spree_paypal_checkout/controllers',
+             preload: 'application-spree-paypal-checkout'

data/config/initializers/spree.rb

@@ -0,0 +1,7 @@
+Rails.application.config.after_initialize do
+  Rails.application.config.spree.payment_methods << SpreePaypalCheckout::Gateway
+
+  if Rails.application.config.respond_to?(:spree_storefront)
+    Rails.application.config.spree_storefront.head_partials << 'spree_paypal_checkout/head'
+  end
+end

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/config/routes.rb

@@ -0,0 +1,13 @@
+Spree::Core::Engine.add_routes do
+  namespace :api, defaults: { format: 'json' } do
+    namespace :v2 do
+      namespace :storefront do
+        resources :paypal_orders, only: [:create] do
+          member do
+            put :capture
+          end
+        end
+      end
+    end
+  end
+end

data/db/migrate/20250528095719_create_spree_paypal_checkout_orders.rb

@@ -0,0 +1,20 @@
+class CreateSpreePaypalCheckoutOrders < ActiveRecord::Migration[8.0]
+  def change
+    create_table :spree_paypal_checkout_orders do |t|
+      t.references :order, null: false
+      t.references :payment_method, null: false
+      t.string :paypal_id, null: false
+      t.decimal :amount, null: false, precision: 10, scale: 2
+
+      if t.respond_to? :jsonb
+        t.jsonb :data
+      else
+        t.json :data
+      end
+
+      t.timestamps
+    end
+
+    add_index :spree_paypal_checkout_orders, [:order_id, :paypal_id], unique: true
+  end
+end

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

@@ -0,0 +1,20 @@
+module SpreePaypalCheckout
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      class_option :migrate, type: :boolean, default: true
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=spree_paypal_checkout'
+      end
+
+      def run_migrations
+        run_migrations = options[:migrate] || ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]'))
+        if run_migrations
+          run 'bin/rails db:migrate'
+        else
+          puts 'Skipping rails db:migrate, don\'t forget to run it!'
+        end
+      end
+    end
+  end
+end

data/lib/spree_paypal_checkout/configuration.rb

@@ -0,0 +1,13 @@
+module SpreePaypalCheckout
+  class Configuration < Spree::Preferences::Configuration
+
+   # Some example preferences are shown below, for more information visit:
+   # https://docs.spreecommerce.org/developer/contributing/creating-an-extension
+
+   # preference :enabled, :boolean, default: true
+   # preference :dark_chocolate, :boolean, default: true
+   # preference :color, :string, default: 'Red'
+   # preference :favorite_number, :integer
+   # preference :supported_locales, :array, default: [:en]
+  end
+end

data/lib/spree_paypal_checkout/engine.rb

@@ -0,0 +1,35 @@
+module SpreePaypalCheckout
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_paypal_checkout'
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    initializer 'spree_paypal_checkout.environment', before: :load_config_initializers do |_app|
+      SpreePaypalCheckout::Config = SpreePaypalCheckout::Configuration.new
+    end
+
+    initializer 'spree_paypal_checkout.assets' do |app|
+      app.config.assets.paths << root.join('app/javascript')
+      app.config.assets.precompile += %w[spree_paypal_checkout_manifest]
+    end
+
+    initializer 'spree_paypal_checkout.importmap', before: 'importmap' do |app|
+      app.config.importmap.paths << root.join('config/importmap.rb')
+      # https://github.com/rails/importmap-rails?tab=readme-ov-file#sweeping-the-cache-in-development-and-test
+      app.config.importmap.cache_sweepers << root.join('app/javascript')
+    end
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+    end
+
+    config.to_prepare(&method(:activate).to_proc)
+  end
+end

data/lib/spree_paypal_checkout/factories.rb

@@ -0,0 +1,33 @@
+FactoryBot.define do
+  # Define your Spree extensions Factories within this file to enable applications, and other extensions to use and override them.
+  #
+  # Example adding this to your spec_helper will load these Factories for use:
+  # require 'spree_paypal_checkout/factories'
+  #
+
+  factory :paypal_checkout_gateway, class: 'SpreePaypalCheckout::Gateway' do
+    name { 'PayPal Checkout' }
+    preferences do
+      {
+        client_id: ENV.fetch('PAYPAL_CLIENT_ID', 'client_id_test'),
+        client_secret: ENV.fetch('PAYPAL_CLIENT_SECRET', 'client_secret_test'),
+        test_mode: true
+      }
+    end
+  end
+
+  factory :paypal_checkout_payment_source, class: 'SpreePaypalCheckout::PaymentSource' do
+    gateway_customer_profile_id { 'PAY-CUSTOMER-ID' }
+  end
+
+  factory :paypal_checkout_order, class: 'SpreePaypalCheckout::Order' do
+    paypal_id { 'PAY-ORDER-ID' }
+    order { create(:order) }
+    amount { order.total }
+    data { JSON.parse(File.read(SpreePaypalCheckout::Engine.root.join('spec', 'fixtures', 'paypal_order.json'))) }
+
+    factory :captured_paypal_checkout_order do
+      data { JSON.parse(File.read(SpreePaypalCheckout::Engine.root.join('spec', 'fixtures', 'captured_paypal_order.json'))) }
+    end
+  end
+end

data/lib/spree_paypal_checkout/version.rb

@@ -0,0 +1,7 @@
+module SpreePaypalCheckout
+  VERSION = '0.5.1'.freeze
+
+  def gem_version
+    Gem::Version.new(VERSION)
+  end
+end

data/lib/spree_paypal_checkout.rb

@@ -0,0 +1,7 @@
+require 'spree_core'
+require 'spree_extension'
+require 'spree_paypal_checkout/engine'
+require 'spree_paypal_checkout/version'
+require 'spree_paypal_checkout/configuration'
+
+require 'paypal_server_sdk'

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification
+name: spree_paypal_checkout
+version: !ruby/object:Gem::Version
+  version: 0.5.1
+platform: ruby
+authors:
+- Vendo Connect Inc.
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spree
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0.beta4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0.beta4
+- !ruby/object:Gem::Dependency
+  name: spree_storefront
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0.beta4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0.beta4
+- !ruby/object:Gem::Dependency
+  name: spree_admin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0.beta4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0.beta4
+- !ruby/object:Gem::Dependency
+  name: spree_extension
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: paypal-server-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: spree_dev_tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email: hello@spreecommerce.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- Rakefile
+- app/assets/config/spree_paypal_checkout_manifest.js
+- app/controllers/spree/api/v2/storefront/paypal_orders_controller.rb
+- app/controllers/spree_paypal_checkout/store_controller_decorator.rb
+- app/helpers/spree_paypal_checkout/base_helper.rb
+- app/javascript/spree_paypal_checkout/application.js
+- app/javascript/spree_paypal_checkout/controllers/checkout_paypal_controller.js
+- app/models/spree_paypal_checkout/base.rb
+- app/models/spree_paypal_checkout/gateway.rb
+- app/models/spree_paypal_checkout/order.rb
+- app/models/spree_paypal_checkout/order_decorator.rb
+- app/models/spree_paypal_checkout/payment_method_decorator.rb
+- app/models/spree_paypal_checkout/payment_sources/paypal.rb
+- app/models/spree_paypal_checkout/store_decorator.rb
+- app/presenters/spree_paypal_checkout/order_presenter.rb
+- app/serializers/spree/api/v2/storefront/paypal_order_serializer.rb
+- app/services/spree_paypal_checkout/capture_order.rb
+- app/services/spree_paypal_checkout/create_payment.rb
+- app/services/spree_paypal_checkout/create_source.rb
+- app/views/spree/admin/payment_methods/configuration_guides/_spree_paypal_checkout.html.erb
+- app/views/spree/admin/payment_methods/descriptions/_spree_paypal_checkout.html.erb
+- app/views/spree/checkout/payment/_spree_paypal_checkout.html.erb
+- app/views/spree/payment_sources/_paypal_checkout.html.erb
+- app/views/spree_paypal_checkout/_head.html.erb
+- config/importmap.rb
+- config/initializers/spree.rb
+- config/locales/en.yml
+- config/routes.rb
+- db/migrate/20250528095719_create_spree_paypal_checkout_orders.rb
+- lib/generators/spree_paypal_checkout/install/install_generator.rb
+- lib/spree_paypal_checkout.rb
+- lib/spree_paypal_checkout/configuration.rb
+- lib/spree_paypal_checkout/engine.rb
+- lib/spree_paypal_checkout/factories.rb
+- lib/spree_paypal_checkout/version.rb
+homepage: https://github.com/spree/spree_paypal_checkout
+licenses:
+- AGPL-3.0-or-later
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- none
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Spree Commerce PayPal Checkout payment gateway integration
+test_files: []