solidus_paypal_commerce_platform 0.4.0 → 0.6.0

data/README.md

@@ -1,7 +1,7 @@
 # Solidus Paypal Commerce Platform
 
-[![CircleCI](https://circleci.com/gh/solidusio-contrib/solidus_paypal_commerce_platform.svg?style=shield)](https://circleci.com/gh/solidusio-contrib/solidus_paypal_commerce_platform)
-[![codecov](https://codecov.io/gh/solidusio-contrib/solidus_paypal_commerce_platform/branch/master/graph/badge.svg)](https://codecov.io/gh/solidusio-contrib/solidus_paypal_commerce_platform)
+[![CircleCI](https://circleci.com/gh/solidusio/solidus_paypal_commerce_platform.svg?style=shield)](https://circleci.com/gh/solidusio/solidus_paypal_commerce_platform)
+[![codecov](https://codecov.io/gh/solidusio/solidus_paypal_commerce_platform/branch/master/graph/badge.svg)](https://codecov.io/gh/solidusio/solidus_paypal_commerce_platform)
 
 The official PayPal integration of Solidus.
 

data/app/assets/javascripts/spree/frontend/solidus_paypal_commerce_platform/button_actions.js

@@ -7,9 +7,9 @@ SolidusPaypalCommercePlatform.hideOverlay = function() {
 }
 
 SolidusPaypalCommercePlatform.handleError = function(error) {
-  console.log(error.name, error.message)
-  console.log("PayPal Debug ID: " + error.debug_id)
+  console.error(error);
   alert("There was a problem connecting with PayPal.")
+  throw error
 }
 
 SolidusPaypalCommercePlatform.sendOrder = function(payment_method_id) {
@@ -181,8 +181,11 @@ SolidusPaypalCommercePlatform.addPayment = function(paypal_amount, payment_metho
   })
 }
 
-SolidusPaypalCommercePlatform.updateAddress = function(response) { 
-  var updated_address = response.purchase_units[0].shipping.address
+SolidusPaypalCommercePlatform.updateAddress = function(response) {
+  var shipping = response.purchase_units[0].shipping;
+  if (!shipping) return Promise.resolve({});
+
+  var updated_address = shipping.address;
   return Spree.ajax({
     url: '/solidus_paypal_commerce_platform/update_address',
     method: 'POST',

data/app/controllers/solidus_paypal_commerce_platform/orders_controller.rb

@@ -2,7 +2,6 @@
 
 module SolidusPaypalCommercePlatform
   class OrdersController < ::Spree::Api::BaseController
-    before_action :load_order, except: :create
     skip_before_action :authenticate_user
     include ::Spree::Core::ControllerHelpers::Auth
 
@@ -10,7 +9,7 @@ module SolidusPaypalCommercePlatform
       authorize! :create, ::Spree::Order
 
       @order = ::Spree::Order.create!(
-        user: try_spree_current_user,
+        user: current_api_user,
         store: current_store,
         currency: current_pricing_options.currency
       )
@@ -25,6 +24,7 @@ module SolidusPaypalCommercePlatform
     end
 
     def update_address
+      load_order
       authorize! :update, @order, order_token
       paypal_address = SolidusPaypalCommercePlatform::PaypalAddress.new(@order)
 
@@ -38,6 +38,7 @@ module SolidusPaypalCommercePlatform
     end
 
     def verify_total
+      load_order
       authorize! :show, @order, order_token
 
       if total_is_correct?(params[:paypal_total])

data/app/controllers/solidus_paypal_commerce_platform/paypal_orders_controller.rb

@@ -15,7 +15,7 @@ module SolidusPaypalCommercePlatform
     private
 
     def load_payment_method
-      @payment_method = ::Spree::PaymentMethod.find(params[:payment_method_id])
+      @payment_method = ::Spree::PaymentMethod.find(params.require(:payment_method_id))
     end
   end
 end

data/app/models/solidus_paypal_commerce_platform/gateway.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'paypal-checkout-sdk'
-
 module SolidusPaypalCommercePlatform
   class Gateway
     include PayPalCheckoutSdk::Orders

data/app/models/solidus_paypal_commerce_platform/payment_method.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module SolidusPaypalCommercePlatform
-  class PaymentMethod < SolidusSupport.payment_method_parent_class
+  class PaymentMethod < ::Spree::PaymentMethod
     include SolidusPaypalCommercePlatform::ButtonOptionsHelper
     preference :client_id, :string
     preference :client_secret, :string
@@ -74,6 +74,8 @@ module SolidusPaypalCommercePlatform
     end
 
     def javascript_sdk_url(order: nil, currency: nil)
+      # Ref: https://developer.paypal.com/sdk/js/configuration/
+
       # Both instance and class respond to checkout_steps.
       step_names = order ? order.checkout_steps : ::Spree::Order.checkout_steps.keys
 
@@ -84,17 +86,16 @@ module SolidusPaypalCommercePlatform
         intent: auto_capture ? "capture" : "authorize",
         commit: commit_immediately ? "false" : "true",
         components: options[:display_credit_messaging] ? "buttons,messages" : "buttons",
-        currency: currency
+        currency: currency,
       }
 
-      parameters[:shipping_preference] = 'NO_SHIPPING' if step_names.exclude? 'delivery'
       parameters['enable-funding'] = 'venmo' if venmo_standalone_enabled?
 
-      if !Rails.env.production? && options[:force_buyer_country].present?
-        parameters['buyer-country'] = options[:force_buyer_country]
+      unless Rails.env.production?
+        parameters['buyer-country'] = options[:force_buyer_country].presence
       end
 
-      "https://www.paypal.com/sdk/js?#{parameters.to_query}"
+      "https://www.paypal.com/sdk/js?#{parameters.compact.to_query}".html_safe # rubocop:disable Rails/OutputSafety
     end
   end
 end

data/app/models/solidus_paypal_commerce_platform/payment_source.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module SolidusPaypalCommercePlatform
-  class PaymentSource < SolidusSupport.payment_source_parent_class
+  class PaymentSource < ::Spree::PaymentSource
     self.table_name = "paypal_commerce_platform_sources"
     enum paypal_funding_source: {
       applepay: 0, bancontact: 1, blik: 2, boleto: 3, card: 4, credit: 5, eps: 6, giropay: 7, ideal: 8,

data/app/models/solidus_paypal_commerce_platform/paypal_address.rb

@@ -61,12 +61,16 @@ module SolidusPaypalCommercePlatform
 
     def address_attributes(address, recipient)
       country = ::Spree::Country.find_by(iso: address[:country_code])
+      state = find_state(
+        address[:admin_area_1] || address[:admin_area_2] || address[:state],
+        country,
+      )
 
       attributes = {
         address1: address[:address_line_1],
         address2: address[:address_line_2],
-        state: find_state(address[:admin_area_1] || address[:state], country),
-        state_name: address[:admin_area_1] || address[:state],
+        state_id: state.try(:id),
+        state_name: state.try(:name),
         city: address[:admin_area_2] || address[:city],
         country: country,
         zipcode: address[:postal_code],

data/app/models/solidus_paypal_commerce_platform/paypal_order.rb

@@ -10,14 +10,15 @@ module SolidusPaypalCommercePlatform
       {
         intent: intent,
         purchase_units: purchase_units,
-        payer: (payer if @order.bill_address)
+        payer: (payer if @order.bill_address),
+        application_context: application_context
       }
     end
 
     def to_replace_json
       {
         op: 'replace',
-        path: '/purchase_units/@reference_id==\'default\'',
+        path: "/purchase_units/@reference_id=='default'",
         value: purchase_units(include_shipping_address: false)[0]
       }
     end
@@ -44,28 +45,21 @@ module SolidusPaypalCommercePlatform
     end
 
     def name(address)
-      if greater_than_2_10?
-        name = ::Spree::Address::Name.new @order.ship_address.name
+      name = ::Spree::Address::Name.new address.name
 
-        {
-          given_name: name.first_name,
-          surname: name.last_name
-        }
-      else
-        {
-          given_name: address.firstname,
-          surname: address.lastname
-        }
-      end
+      {
+        given_name: name.first_name,
+        surname: name.last_name
+      }
     end
 
     def purchase_units(include_shipping_address: true)
       [
         {
-          amount: amount,
+          amount: price(@order.total).merge(breakdown: breakdown),
           items: line_items,
           shipping: (shipping_info if @order.ship_address && include_shipping_address)
-        }
+        }.compact
       ]
     end
 
@@ -80,31 +74,19 @@ module SolidusPaypalCommercePlatform
     end
 
     def full_name
-      if greater_than_2_10?
-        @order.ship_address.name
-      else
-        @order.ship_address.full_name
-      end
+      @order.ship_address.name
     end
 
     def line_items
       @order.line_items.map{ |line_item|
         {
-          name: line_item.product.name,
+          name: line_item.product.name.truncate(127),
           unit_amount: price(line_item.price),
-          quantity: line_item.quantity
+          quantity: line_item.quantity.to_i.to_s
         }
       }
     end
 
-    def amount
-      {
-        currency_code: @order.currency,
-        value: @order.total,
-        breakdown: breakdown
-      }
-    end
-
     def breakdown
       {
         item_total: price(@order.item_total),
@@ -117,12 +99,22 @@ module SolidusPaypalCommercePlatform
     def price(amount)
       {
         currency_code: @order.currency,
-        value: amount
+        value: ('%.2f' % amount.to_f)
       }
     end
 
-    def greater_than_2_10?
-      ::Spree.solidus_gem_version >= Gem::Version.new('2.11')
+    def application_context
+      {
+        shipping_preference: require_shipping? ? 'SET_PROVIDED_ADDRESS' : 'NO_SHIPPING'
+      }
+    end
+
+    def require_shipping?
+      step_names.include? :delivery
+    end
+
+    def step_names
+      @order ? @order.checkout_steps.map(&:to_sym) : ::Spree::Order.checkout_steps.keys
     end
   end
 end

data/bin/sandbox

@@ -49,34 +49,13 @@ fi
 
 cd ./sandbox
 cat <<RUBY >> Gemfile
-gem 'solidus', github: 'solidusio/solidus', branch: '$BRANCH'
-gem 'solidus_auth_devise', '>= 2.1.0'
-gem 'rails-i18n'
-gem 'solidus_i18n'
-
-gem '$extension_name', path: '..'
-
-group :test, :development do
-  platforms :mri do
-    gem 'pry-byebug'
-  end
-end
+  gem 'solidus', github: 'solidusio/solidus', branch: '$BRANCH'
+  gem 'pry-byebug', platforms: :mri, groups: [:test, :development]
 RUBY
 
 unbundled bundle install --gemfile Gemfile
-
 unbundled bundle exec rake db:drop db:create
-
-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
+unbundled bundle exec rails generate solidus:install --auto-accept $@
 
 echo
 echo "🚀 Sandbox app successfully created for $extension_name!"

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

@@ -4,44 +4,69 @@ 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
+
+      # This should only be used by the solidus installer prior to v3.3.
+      class_option :skip_migrations, type: :boolean, default: false, hide: true
 
       source_root File.expand_path('templates', __dir__)
 
-      def copy_initializer
+      def install_solidus_core_support
         template 'initializer.rb', 'config/initializers/solidus_paypal_commerce_platform.rb'
+        rake 'railties:install:migrations FROM=solidus_paypal_commerce_platform'
+        route "mount SolidusPaypalCommercePlatform::Engine, at: '/solidus_paypal_commerce_platform'"
       end
 
-      def add_javascripts
-        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
+      def install_solidus_backend_support
+        support_code_for('solidus_backend') do
+          append_file(
+            'vendor/assets/javascripts/spree/backend/all.js',
+            "//= require spree/backend/solidus_paypal_commerce_platform\n"
+          )
+          inject_into_file(
+            'vendor/assets/stylesheets/spree/backend/all.css',
+            " *= require spree/backend/solidus_paypal_commerce_platform\n",
+            before: %r{\*/},
+            verbose: true,
+          )
+        end
       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 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
+      def install_solidus_frontend_support
+        support_code_for('solidus_frontend') do
+          append_file(
+            'vendor/assets/javascripts/spree/frontend/all.js',
+            "//= require spree/frontend/solidus_paypal_commerce_platform\n",
+          )
+          inject_into_file(
+            'vendor/assets/stylesheets/spree/frontend/all.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 add_migrations
-        run 'bin/rails railties:install:migrations FROM=solidus_paypal_commerce_platform'
-      end
+      def run_migrations
+        return rake 'db:migrate' if options[:auto_run_migrations] && !options[:skip_migrations]
 
-      def mount_engine
-        insert_into_file File.join('config', 'routes.rb'), after: "Rails.application.routes.draw do\n" do
-          "mount SolidusPaypalCommercePlatform::Engine, at: '/solidus_paypal_commerce_platform'\n"
-        end
+        say_status :skip, 'db:migrate'
       end
 
-      def run_migrations
-        return if options[:skip_migrations]
+      private
 
-        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'
+      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
+          shell.indent(&block)
         else
-          puts 'Skipping bin/rails db:migrate, don\'t forget to run it!' # rubocop:disable Rails/Output
+          say_status :skip, "[#{engine.engine_name}] #{gem_name} code", :blue
         end
       end
+
+      def engine
+        SolidusPaypalCommercePlatform::Engine
+      end
     end
   end
 end

data/lib/paypal/access_token.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: false
+
+module PayPal
+  class AccessToken
+    attr_accessor :access_token, :token_type, :expires_in, :date_created
+
+    def initialize(options)
+      @access_token = options.access_token
+      @token_type = options.token_type
+      @expires_in = options.expires_in
+      @date_created = Time.zone.now
+    end
+
+    def expired?
+      Time.zone.now > @date_created + @expires_in
+    end
+
+    def authorization_string
+      "#{@token_type} #{@access_token}"
+    end
+  end
+end

data/lib/paypal/lib.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: false
+
+require 'paypal/paypal_environment'
+require 'paypal/paypal_http_client'
+require 'paypal/token_requests'
+require 'paypal/access_token'
+require 'paypal/paypal_checkout_sdk/orders/orders_authorize_request'
+require 'paypal/paypal_checkout_sdk/orders/orders_capture_request'
+require 'paypal/paypal_checkout_sdk/orders/orders_create_request'
+require 'paypal/paypal_checkout_sdk/orders/orders_get_request'
+require 'paypal/paypal_checkout_sdk/orders/orders_patch_request'
+require 'paypal/paypal_checkout_sdk/orders/orders_validate_request'
+require 'paypal/paypal_checkout_sdk/payments/authorizations_capture_request'
+require 'paypal/paypal_checkout_sdk/payments/authorizations_get_request'
+require 'paypal/paypal_checkout_sdk/payments/authorizations_reauthorize_request'
+require 'paypal/paypal_checkout_sdk/payments/authorizations_void_request'
+require 'paypal/paypal_checkout_sdk/payments/captures_get_request'
+require 'paypal/paypal_checkout_sdk/payments/refunds_get_request'
+require 'paypal/paypal_checkout_sdk/payments/captures_refund_request'

data/lib/paypal/paypal_checkout_sdk/orders/orders_authorize_request.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: false
+
+require 'cgi'
+
+module PayPalCheckoutSdk
+  module Orders
+    #
+    # Authorizes payment for an order. The response shows details
+    # of authorizations. You can make this call only if you specified
+    # `intent=AUTHORIZE` in the create order call.
+    #
+    class OrdersAuthorizeRequest
+      attr_accessor :path, :body, :headers, :verb
+
+      def initialize(order_id)
+        @headers = {}
+        @body = nil
+        @verb = "POST"
+        @path = "/v2/checkout/orders/{order_id}/authorize?"
+
+        @path = @path.gsub("{order_id}", CGI.escape(order_id.to_s))
+        @headers["Content-Type"] = "application/json"
+      end
+
+      def pay_pal_client_metadata_id(pay_pal_client_metadata_id)
+        @headers["PayPal-Client-Metadata-Id"] = pay_pal_client_metadata_id
+      end
+
+      def pay_pal_request_id(pay_pal_request_id)
+        @headers["PayPal-Request-Id"] = pay_pal_request_id
+      end
+
+      def prefer(prefer)
+        @headers["Prefer"] = prefer
+      end
+
+      def request_body(order_action_request)
+        @body = order_action_request
+      end
+    end
+  end
+end

data/lib/paypal/paypal_checkout_sdk/orders/orders_capture_request.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: false
+
+require 'cgi'
+
+module PayPalCheckoutSdk
+  module Orders
+    #
+    # Captures a payment for an order.
+    #
+    class OrdersCaptureRequest
+      attr_accessor :path, :body, :headers, :verb
+
+      def initialize(order_id)
+        @headers = {}
+        @body = nil
+        @verb = "POST"
+        @path = "/v2/checkout/orders/{order_id}/capture?"
+
+        @path = @path.gsub("{order_id}", CGI.escape(order_id.to_s))
+        @headers["Content-Type"] = "application/json"
+      end
+
+      def pay_pal_client_metadata_id(pay_pal_client_metadata_id)
+        @headers["PayPal-Client-Metadata-Id"] = pay_pal_client_metadata_id
+      end
+
+      def pay_pal_request_id(pay_pal_request_id)
+        @headers["PayPal-Request-Id"] = pay_pal_request_id
+      end
+
+      def prefer(prefer)
+        @headers["Prefer"] = prefer
+      end
+
+      def request_body(order_action_request)
+        @body = order_action_request
+      end
+    end
+  end
+end

data/lib/paypal/paypal_checkout_sdk/orders/orders_create_request.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: false
+
+require 'cgi'
+
+module PayPalCheckoutSdk
+  module Orders
+    #
+    # Creates an order. Supports only orders with one purchase unit.
+    #
+    class OrdersCreateRequest
+      attr_accessor :path, :body, :headers, :verb
+
+      def initialize
+        @headers = {}
+        @body = nil
+        @verb = "POST"
+        @path = "/v2/checkout/orders?"
+        @headers["Content-Type"] = "application/json"
+      end
+
+      def pay_pal_partner_attribution_id(pay_pal_partner_attribution_id)
+        @headers["PayPal-Partner-Attribution-Id"] = pay_pal_partner_attribution_id
+      end
+
+      def prefer(prefer)
+        @headers["Prefer"] = prefer
+      end
+
+      def request_body(order)
+        @body = order
+      end
+    end
+  end
+end

data/lib/paypal/paypal_checkout_sdk/orders/orders_get_request.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: false
+
+require 'cgi'
+
+module PayPalCheckoutSdk
+  module Orders
+    #
+    # Shows details for an order, by ID.
+    #
+    class OrdersGetRequest
+      attr_accessor :path, :body, :headers, :verb
+
+      def initialize(order_id)
+        @headers = {}
+        @body = nil
+        @verb = "GET"
+        @path = "/v2/checkout/orders/{order_id}?"
+
+        @path = @path.gsub("{order_id}", CGI.escape(order_id.to_s))
+        @headers["Content-Type"] = "application/json"
+      end
+    end
+  end
+end

data/lib/paypal/paypal_checkout_sdk/orders/orders_patch_request.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: false
+
+require 'cgi'
+
+module PayPalCheckoutSdk
+  module Orders
+    class OrdersPatchRequest
+      attr_accessor :path, :body, :headers, :verb
+
+      def initialize(order_id)
+        @headers = {}
+        @body = nil
+        @verb = "PATCH"
+        @path = "/v2/checkout/orders/{order_id}?"
+
+        @path = @path.gsub("{order_id}", CGI.escape(order_id.to_s))
+        @headers["Content-Type"] = "application/json"
+      end
+
+      def request_body(patch_request)
+        @body = patch_request
+      end
+    end
+  end
+end

data/lib/paypal/paypal_checkout_sdk/orders/orders_validate_request.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: false
+
+require 'cgi'
+
+module PayPalCheckoutSdk
+  module Orders
+    #
+    # Validates a payment method and checks it for contingencies.
+    #
+    class OrdersValidateRequest
+      attr_accessor :path, :body, :headers, :verb
+
+      def initialize(order_id)
+        @headers = {}
+        @body = nil
+        @verb = "POST"
+        @path = "/v2/checkout/orders/{order_id}/validate-payment-method?"
+
+        @path = @path.gsub("{order_id}", CGI.escape(order_id.to_s))
+        @headers["Content-Type"] = "application/json"
+      end
+
+      def pay_pal_client_metadata_id(pay_pal_client_metadata_id)
+        @headers["PayPal-Client-Metadata-Id"] = pay_pal_client_metadata_id
+      end
+
+      def request_body(order_action_request)
+        @body = order_action_request
+      end
+    end
+  end
+end