solidus_paypal_commerce_platform 0.0.1 → 0.3.0

data/app/controllers/solidus_paypal_commerce_platform/orders_controller.rb

@@ -11,7 +11,8 @@ module SolidusPaypalCommercePlatform
 
       @order = ::Spree::Order.create!(
         user: try_spree_current_user,
-        store: current_store
+        store: current_store,
+        currency: current_pricing_options.currency
       )
 
       if @order.contents.update_cart order_params
@@ -64,10 +65,12 @@ module SolidusPaypalCommercePlatform
         ],
         recipient: [
           :email_address,
-          name: [
-            :given_name,
-            :surname,
-          ]
+          {
+            name: [
+              :given_name,
+              :surname,
+            ]
+          }
         ]
       )
     end

data/app/controllers/solidus_paypal_commerce_platform/paypal_orders_controller.rb

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

data/app/decorators/models/solidus_paypal_commerce_platform/spree/address_decorator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module SolidusPaypalCommercePlatform
+  module Spree
+    module AddressDecorator
+      # PayPal doesn't use the phone number, so in cases where the user checks out via
+      # PayPal, this field will be unpopulated. If you want to require phone numbers,
+      # you'll need to turn off cart & product page displays on the payment method edit
+      # page.
+      def require_phone?
+        super && false
+      end
+
+      ::Spree::Address.prepend self
+    end
+  end
+end

data/app/jobs/solidus_paypal_commerce_platform/webhook_job.rb

@@ -6,15 +6,15 @@ module SolidusPaypalCommercePlatform
       case payload["resource_type"]
       when "checkout-order"
         payment_source = PaymentSource.find_by!(paypal_order_id: payload.dig("resource", "id"))
-        payment = Spree::Payment.where(source: payment_source).last!
+        payment = ::Spree::Payment.where(source: payment_source).last!
         payment.log_entries.create!(details: payload.to_yaml)
       when "capture"
         payment_source = PaymentSource.find_by!(capture_id: payload.dig("resource", "id"))
-        payment = Spree::Payment.where(source: payment_source).last!
+        payment = ::Spree::Payment.where(source: payment_source).last!
         payment.log_entries.create!(details: payload.to_yaml)
       when "refund"
         payment_source = PaymentSource.find_by!(refund_id: payload.dig("resource", "id"))
-        payment = Spree::Payment.where(source: payment_source).last!
+        payment = ::Spree::Payment.where(source: payment_source).last!
         payment.log_entries.create!(details: payload.to_yaml)
       end
     end

data/app/models/solidus_paypal_commerce_platform/gateway.rb

@@ -77,8 +77,7 @@ module SolidusPaypalCommercePlatform
       request = OrdersCreateRequest.new
       paypal_order = SolidusPaypalCommercePlatform::PaypalOrder.new(order)
       request.request_body paypal_order.to_json(intent)
-
-      @client.execute(request).result
+      @client.execute(request)
     end
 
     def get_order(order_id)

data/app/models/solidus_paypal_commerce_platform/payment_method.rb

@@ -11,6 +11,7 @@ module SolidusPaypalCommercePlatform
     preference :paypal_button_layout, :paypal_select, default: "vertical"
     preference :display_on_cart, :boolean, default: true
     preference :display_on_product_page, :boolean, default: true
+    preference :display_credit_messaging, :boolean, default: true
 
     def partial_name
       "paypal_commerce_platform"
@@ -57,7 +58,7 @@ module SolidusPaypalCommercePlatform
       }
     end
 
-    def javascript_sdk_url(order: nil)
+    def javascript_sdk_url(order: nil, currency: nil)
       # Both instance and class respond to checkout_steps.
       step_names = order ? order.checkout_steps : ::Spree::Order.checkout_steps.keys
 
@@ -67,6 +68,8 @@ module SolidusPaypalCommercePlatform
         'client-id': client_id,
         intent: auto_capture ? "capture" : "authorize",
         commit: commit_immediately ? "false" : "true",
+        components: options[:display_credit_messaging] ? "buttons,messages" : "buttons",
+        currency: currency
       }
 
       "https://www.paypal.com/sdk/js?#{parameters.to_query}"

data/app/models/solidus_paypal_commerce_platform/paypal_address.rb

@@ -19,7 +19,7 @@ module SolidusPaypalCommercePlatform
     end
 
     def update(paypal_address)
-      formatted_address = format_address(paypal_address)
+      formatted_address = address_attributes(paypal_address[:updated_address], paypal_address[:recipient])
       new_address = @order.ship_address.dup || ::Spree::Address.new
       new_address.assign_attributes(formatted_address)
 
@@ -42,40 +42,44 @@ module SolidusPaypalCommercePlatform
       @order.update(email: recipient[:email_address])
     end
 
+    def find_state(state_name, country)
+      if state = country.states.find_by(abbr: state_name) || country.states.find_by(name: state_name)
+        state
+      else
+        SolidusPaypalCommercePlatform.config.state_guesser_class.new(state_name, country).guess
+      end
+    end
+
     def format_simulated_address(paypal_address)
-      country = ::Spree::Country.find_by(iso: paypal_address[:country_code])
-      # Also adds fake information for a few fields, so validations can run
+      # Adds fake information for a few fields, so validations can run
+      paypal_address[:address_line_1] = "123 Fake St."
+
       ::Spree::Address.new(
-        city: paypal_address[:city],
-        state: country.states.find_by(abbr: paypal_address[:state]),
-        state_name: paypal_address[:state],
-        zipcode: paypal_address[:postal_code],
-        country: country,
-        address1: "123 Fake St.",
-        phone: "123456789",
-        firstname: "Fake"
+        address_attributes(paypal_address, { name: { given_name: "Fake" } })
       )
     end
 
-    def format_address(paypal_address)
-      address = paypal_address[:updated_address]
-      recipient = paypal_address[:recipient]
+    def address_attributes(address, recipient)
       country = ::Spree::Country.find_by(iso: address[:country_code])
-      state = country.states.where(abbr: address[:admin_area_1]).or(
-        country.states.where(name: address[:admin_area_1])
-      ).first
 
-      {
+      attributes = {
         address1: address[:address_line_1],
         address2: address[:address_line_2],
-        state: state,
-        state_name: address[:admin_area_1],
-        city: address[:admin_area_2],
+        state: find_state(address[:admin_area_1] || address[:state], country),
+        state_name: address[:admin_area_1] || address[:state],
+        city: address[:admin_area_2] || address[:city],
         country: country,
         zipcode: address[:postal_code],
-        firstname: recipient[:name][:given_name],
-        lastname: recipient[:name][:surname]
       }
+
+      if SolidusSupport.combined_first_and_last_name_in_address?
+        attributes[:name] = "#{recipient[:name][:given_name]} #{recipient[:name][:surname]}"
+      else
+        attributes[:firstname] = recipient[:name][:given_name]
+        attributes[:lastname] = recipient[:name][:surname]
+      end
+
+      attributes
     end
   end
 end

data/app/models/solidus_paypal_commerce_platform/paypal_order.rb

@@ -18,7 +18,7 @@ module SolidusPaypalCommercePlatform
       {
         op: 'replace',
         path: '/purchase_units/@reference_id==\'default\'',
-        value: purchase_units[0]
+        value: purchase_units(include_shipping_address: false)[0]
       }
     end
 
@@ -50,12 +50,12 @@ module SolidusPaypalCommercePlatform
       }
     end
 
-    def purchase_units
+    def purchase_units(include_shipping_address: true)
       [
         {
           amount: amount,
           items: line_items,
-          shipping: (shipping_info if @order.ship_address)
+          shipping: (shipping_info if @order.ship_address && include_shipping_address)
         }
       ]
     end

data/app/models/solidus_paypal_commerce_platform/pricing_options.rb

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

data/app/models/solidus_paypal_commerce_platform/state_guesser.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module SolidusPaypalCommercePlatform
+  class StateGuesser
+    def initialize(state_name, country)
+      @state_name = state_name
+      @country = country
+    end
+
+    def guess
+      carmen_state = state_list.find{ |s| s.name == @state_name || s.code == @state_name }
+      return if carmen_state.blank?
+
+      guessed_state = spree_state(carmen_state.name)
+      guessed_state || spree_state(carmen_state.parent.name)
+    end
+
+    private
+
+    def state_list
+      Carmen::Country.coded(@country.iso).subregions.map{ |s| [s, s.subregions] }.flatten
+    end
+
+    def spree_state(name)
+      ::Spree::State.find_by(name: name)
+    end
+  end
+end

data/bin/rails-sandbox

@@ -1,13 +1,11 @@
 #!/usr/bin/env ruby
 
-# frozen_string_literal: true
-
 app_root = 'sandbox'
 
 unless File.exist? "#{app_root}/bin/rails"
   warn 'Creating the sandbox app...'
   Dir.chdir "#{__dir__}/.." do
-    system "#{__dir__}/sandbox" or begin # rubocop:disable Style/AndOr
+    system "#{__dir__}/sandbox" or begin
       warn 'Automatic creation of the sandbox app failed'
       exit 1
     end

data/bin/sandbox

@@ -72,11 +72,11 @@ unbundled bundle exec rails generate spree:install \
   --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 solidus_paypal_commerce_platform:install
-unbundled bundle exec rails db:migrate
+unbundled bundle exec rails generate ${extension_name}:install
 
 echo
 echo "🚀 Sandbox app successfully created for $extension_name!"

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

@@ -4,15 +4,22 @@ module SolidusPaypalCommercePlatform
   module Generators
     class InstallGenerator < Rails::Generators::Base
       class_option :auto_run_migrations, type: :boolean, default: false
+      class_option :skip_migrations, type: :boolean, default: false
+
+      source_root File.expand_path('templates', __dir__)
+
+      def copy_initializer
+        template 'initializer.rb', 'config/initializers/solidus_paypal_commerce_platform.rb'
+      end
 
       def add_javascripts
-        append_file 'vendor/assets/javascripts/spree/frontend/all.js', "//= require spree/frontend/solidus_paypal_commerce_platform\n" # rubocop:disable Metrics/LineLength
-        append_file 'vendor/assets/javascripts/spree/backend/all.js', "//= require spree/backend/solidus_paypal_commerce_platform\n" # rubocop:disable Metrics/LineLength
+        append_file 'vendor/assets/javascripts/spree/frontend/all.js', "//= require spree/frontend/solidus_paypal_commerce_platform\n" # rubocop:disable Layout/LineLength
+        append_file 'vendor/assets/javascripts/spree/backend/all.js', "//= require spree/backend/solidus_paypal_commerce_platform\n" # rubocop:disable Layout/LineLength
       end
 
       def add_stylesheets
-        inject_into_file 'vendor/assets/stylesheets/spree/frontend/all.css', " *= require spree/frontend/solidus_paypal_commerce_platform\n", before: %r{\*/}, verbose: true # rubocop:disable Metrics/LineLength
-        inject_into_file 'vendor/assets/stylesheets/spree/backend/all.css', " *= require spree/backend/solidus_paypal_commerce_platform\n", before: %r{\*/}, verbose: true # rubocop:disable Metrics/LineLength
+        inject_into_file 'vendor/assets/stylesheets/spree/frontend/all.css', " *= require spree/frontend/solidus_paypal_commerce_platform\n", before: %r{\*/}, verbose: true # rubocop:disable Layout/LineLength
+        inject_into_file 'vendor/assets/stylesheets/spree/backend/all.css', " *= require spree/backend/solidus_paypal_commerce_platform\n", before: %r{\*/}, verbose: true # rubocop:disable Layout/LineLength
       end
 
       def add_migrations
@@ -26,7 +33,9 @@ module SolidusPaypalCommercePlatform
       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
+        return if options[:skip_migrations]
+
+        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/generators/solidus_paypal_commerce_platform/install/templates/initializer.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+SolidusPaypalCommercePlatform.configure do |config|
+  # TODO: Remember to change this with the actual preferences you have implemented!
+  # config.sample_preference = 'sample_value'
+end

data/lib/solidus_paypal_commerce_platform.rb

@@ -3,19 +3,21 @@
 require 'solidus_core'
 require 'solidus_support'
 
-require 'solidus_paypal_commerce_platform/version'
-require 'solidus_paypal_commerce_platform/configuration'
 require 'solidus_paypal_commerce_platform/client'
+require 'solidus_paypal_commerce_platform/configuration'
+require 'solidus_paypal_commerce_platform/version'
 require 'solidus_paypal_commerce_platform/engine'
 
 module SolidusPaypalCommercePlatform
   class << self
-    def config
-      @config ||= Configuration.new
+    def configuration
+      @configuration ||= Configuration.new
     end
 
+    alias config configuration
+
     def configure
-      yield config
+      yield configuration
     end
   end
 end

data/lib/solidus_paypal_commerce_platform/client.rb

@@ -10,12 +10,12 @@ module SolidusPaypalCommercePlatform
     SUCCESS_STATUS_CODES = [201, 204].freeze
 
     PARTNER_ATTRIBUTION_INJECTOR = ->(request) {
-      request.headers["PayPal-Partner-Attribution-Id"] = "Solidus_PCP_SP"
+      request.headers["PayPal-Partner-Attribution-Id"] = SolidusPaypalCommercePlatform.config.partner_code
     }.freeze
 
     attr_reader :environment
 
-    def initialize(test_mode: nil, client_id:, client_secret: "")
+    def initialize(client_id:, client_secret: "", test_mode: nil)
       test_mode = SolidusPaypalCommercePlatform.config.env.sandbox? if test_mode.nil?
       env_class = test_mode ? PayPal::SandboxEnvironment : PayPal::LiveEnvironment
 
@@ -27,8 +27,9 @@ module SolidusPaypalCommercePlatform
 
     def execute(request)
       @paypal_client.execute(request)
-    rescue PayPalHttp::HttpError
-      OpenStruct.new(status_code: nil)
+    rescue PayPalHttp::HttpError => e
+      Rails.logger.error e.result
+      OpenStruct.new(status_code: 422, error: e.result)
     end
 
     def execute_with_response(request, success_message: nil, failure_message: nil)

data/lib/solidus_paypal_commerce_platform/configuration.rb

@@ -4,6 +4,8 @@ require 'paypal-checkout-sdk'
 
 module SolidusPaypalCommercePlatform
   class Configuration
+    attr_writer :state_guesser_class, :partner_id, :partner_client_id
+
     InvalidEnvironment = Class.new(StandardError)
 
     DEFAULT_PARTNER_ID = {
@@ -16,6 +18,12 @@ module SolidusPaypalCommercePlatform
       live: "ASOxaUMkeX5bv7PbXnWUDnqb3SVYkzRSosApmLGFih-eAhB_OS_Wo6juijE5t8NCmWDgpN2ugHMmQFWA",
     }.freeze
 
+    def state_guesser_class
+      self.state_guesser_class = "SolidusPaypalCommercePlatform::StateGuesser" unless @state_guesser_class
+
+      @state_guesser_class.constantize
+    end
+
     def env=(value)
       unless %w[live sandbox].include? value
         raise InvalidEnvironment, "#{value} is not a valid environment"
@@ -35,9 +43,9 @@ module SolidusPaypalCommercePlatform
 
       case Rails.env
       when 'production'
-        return 'live'
+        'live'
       when 'test', 'development'
-        return 'sandbox'
+        'sandbox'
       else
         raise InvalidEnvironment, "Unable to guess the PayPal env, please set #{self}.env= explicitly."
       end
@@ -51,8 +59,6 @@ module SolidusPaypalCommercePlatform
       env.live? ? "www.paypal.com" : "www.sandbox.paypal.com"
     end
 
-    attr_writer :partner_id, :partner_client_id
-
     def partner_id
       @partner_id ||= ENV['PAYPAL_PARTNER_ID'] || DEFAULT_PARTNER_ID[env.to_sym]
     end
@@ -60,5 +66,9 @@ module SolidusPaypalCommercePlatform
     def partner_client_id
       @partner_client_id ||= ENV['PAYPAL_PARTNER_CLIENT_ID'] || DEFAULT_PARTNER_CLIENT_ID[env.to_sym]
     end
+
+    def partner_code
+      "Solidus_PCP_SP"
+    end
   end
 end

data/lib/solidus_paypal_commerce_platform/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SolidusPaypalCommercePlatform
-  VERSION = '0.0.1'
+  VERSION = '0.3.0'
 end