workarea-paypal 2.0.12 → 3.0.0

data/app/helpers/workarea/storefront/paypal_helper.rb

@@ -0,0 +1,38 @@
+module Workarea
+  module Storefront
+    module PaypalHelper
+      def set_paypal_client_token
+        return unless Workarea::Paypal.gateway.configured?
+
+        @paypal_client_token =
+          if Workarea.config.use_paypal_hosted_fields
+            request = Workarea::Paypal.gateway.generate_token(user: current_user)
+            request.result.client_token
+          end
+      end
+
+      def include_paypal_javascript_tag(params: {}, data: {})
+        return unless Workarea::Paypal.gateway.configured?
+
+        params =
+          Workarea.config.paypal_sdk_params
+            .merge('client-id' => Workarea::Paypal.gateway.client_id)
+            .merge(params)
+            .compact
+
+        components = params['components'].to_s.split(',')
+        components << 'buttons'
+        components << 'hosted-fields' if Workarea.config.use_paypal_hosted_fields
+        params['components'] = components.compact.uniq.join(',')
+
+        javascript_include_tag(
+          "https://www.paypal.com/sdk/js?#{params.to_query}",
+          data: {
+            partner_attribution_id: 'Workarea_SP_PCP', # Do not change this
+            client_token: @paypal_client_token
+          }.merge(data)
+        )
+      end
+    end
+  end
+end

data/app/models/workarea/payment/authorize/paypal.rb

@@ -3,27 +3,27 @@ module Workarea
     module Authorize
       class Paypal
         include OperationImplementation
-        include CreditCardOperation
-
-        delegate :gateway, to: Workarea::Paypal
 
         def complete!
-          transaction.response = handle_active_merchant_errors do
-            gateway.authorize(
-              transaction.amount.cents,
-              token: tender.token,
-              payer_id: tender.payer_id,
-              currency: transaction.amount.currency
-            )
+          response = Workarea::Paypal.gateway.capture(tender.paypal_id)
+
+          if response.success? && response.params['status'] == 'PENDING'
+            transaction.action = 'authorize'
+          else
+            transaction.action = 'purchase'
           end
+
+          transaction.response = response
         end
 
         def cancel!
           return unless transaction.success?
 
-          transaction.cancellation = handle_active_merchant_errors do
-            gateway.void(transaction.response.params['transaction_id'])
-          end
+          transaction.cancellation =
+            Workarea::Paypal.gateway.refund(
+              transaction.response.params['id'],
+              amount: transaction.amount
+            )
         end
       end
     end

data/app/models/workarea/payment/capture/paypal.rb

@@ -3,31 +3,21 @@ module Workarea
     class Capture
       class Paypal
         include OperationImplementation
-        include CreditCardOperation
-
-        delegate :gateway, to: Workarea::Paypal
 
         def complete!
-          validate_reference!
-
-          transaction.response = handle_active_merchant_errors do
-            gateway.capture(
-              transaction.amount.cents,
-              transaction.reference.response.params['transaction_id'],
-              currency: transaction.amount.currency
-            )
-          end
+          # Capture can only happen if the initial capture was not completed
+          # immediately. Since we cannot force a pending capture to complete,
+          # this will only fail with an explanation that the capture will
+          # complete via webhook or never be completed.
+          #
+          transaction.response = ActiveMerchant::Billing::Response.new(
+            false,
+            I18n.t('workarea.payment.paypal_capture')
+          )
         end
 
         def cancel!
-          return unless transaction.success?
-
-          transaction.cancellation = handle_active_merchant_errors do
-            gateway.refund(
-              transaction.amount.cents,
-              transaction.response.params['transaction_id']
-            )
-          end
+          # noop, nothing to cancel
         end
       end
     end

data/app/models/workarea/payment/null_address.rb

@@ -0,0 +1,37 @@
+module Workarea
+  class Payment
+    class NullAddress
+      class NullCountry < OpenStruct
+        def to_s; end
+      end
+
+      include Mongoid::Document
+
+      FIELDS = Workarea::Payment::Address.fields.keys.tap { |k| k.delete('_id') }
+
+      attr_writer :reference
+      attr_reader *FIELDS, :region_name
+
+      delegate *FIELDS.map { |f| "#{f}=" }, :assign_attributes, :attributes=,
+        :allow_po_box?, to: :reference
+
+      def reference
+        @reference ||= Workarea::Payment::Address.new
+      end
+
+      def save(*args)
+        true
+      end
+
+      def country
+        NullCountry.new
+      end
+
+      def falsey(*args)
+        false
+      end
+      alias :po_box? :falsey
+      alias :address_eql? :falsey
+    end
+  end
+end

data/app/models/workarea/payment/purchase/paypal.rb

@@ -1,31 +1,7 @@
 module Workarea
   class Payment
     module Purchase
-      class Paypal
-        include OperationImplementation
-        include CreditCardOperation
-
-        delegate :gateway, to: Workarea::Paypal
-
-        def complete!
-          transaction.response = handle_active_merchant_errors do
-            gateway.purchase(
-              transaction.amount.cents,
-              token: tender.token,
-              payer_id: tender.payer_id,
-              currency: transaction.amount.currency
-            )
-          end
-        end
-
-        def cancel!
-          return unless transaction.success?
-
-          transaction.cancellation = handle_active_merchant_errors do
-            gateway.void(transaction.response.params['transaction_id'])
-          end
-        end
-      end
+      Paypal = Authorize::Paypal
     end
   end
 end

data/app/models/workarea/payment/refund/paypal.rb

@@ -3,18 +3,15 @@ module Workarea
     class Refund
       class Paypal
         include OperationImplementation
-        include CreditCardOperation
 
         def complete!
           validate_reference!
 
-          transaction.response = handle_active_merchant_errors do
+          transaction.response =
             Workarea::Paypal.gateway.refund(
-              transaction.amount.cents,
-              transaction.reference.response.params['transaction_id'],
-              currency: transaction.amount.currency
+              transaction.reference.response.params['id'],
+              amount: transaction.amount
             )
-          end
         end
 
         def cancel!

data/app/models/workarea/payment/tender/paypal.rb

@@ -1,11 +1,23 @@
 module Workarea
   class Payment::Tender::Paypal < Payment::Tender
-    field :token, type: String
+    field :paypal_id, type: String
     field :payer_id, type: String
-    field :details, type: Hash
+    field :details, type: Hash, default: {}
+    field :approved, type: Boolean, default: false
+    field :direct_payment, type: Boolean, default: false
 
     def slug
       :paypal
     end
+
+    def display_number
+      return unless direct_payment?
+      details['display_number']
+    end
+
+    def issuer
+      return unless direct_payment?
+      details['issuer']
+    end
   end
 end

data/app/models/workarea/payment.decorator

@@ -2,26 +2,40 @@ module Workarea
   decorate Payment, with: :paypal do
     decorated do
       embeds_one :paypal, class_name: 'Workarea::Payment::Tender::Paypal'
+      delegate :paypal_id, to: :paypal, allow_nil: true
     end
 
     def set_paypal(attrs)
       build_paypal unless paypal
       paypal.attributes = attrs.slice(
-        :token,
+        :paypal_id,
         :payer_id,
-        :details
+        :details,
+        :approved,
+        :direct_payment
       )
 
       save
     end
 
     def paypal?
-      paypal.present?
+      paypal.present? && paypal.approved?
     end
 
     def set_credit_card(*)
       self.paypal = nil
       super
     end
+
+    def address
+      addr = super
+      return addr if !paypal? || addr&.valid?
+
+      Payment::NullAddress.new.tap { |na| na.reference = addr || build_address }
+    end
+
+    def real_address
+      method(:address).super_method.call
+    end
   end
 end

data/app/services/workarea/paypal/approve_order.rb

@@ -0,0 +1,104 @@
+module Workarea
+  module Paypal
+    class ApproveOrder
+      delegate :order, :payment, :shippings, :shipping, to: :@checkout
+      delegate :payer, :status, :purchase_units, :payment_source, to: :paypal_order
+
+      def initialize(checkout, paypal_id)
+        @checkout = checkout
+        @paypal_id = paypal_id
+      end
+
+      def paypal_order
+        @paypal_order ||= Workarea::Paypal.gateway.get_order(@paypal_id).result
+      end
+
+      # As of this writing, PayPal only ever allows one purchase unit.
+      #
+      def details
+        purchase_units.first
+      end
+
+      def perform
+        order.email ||= payer&.email_address
+
+        set_shipping_address
+        set_shipping_service
+        set_billing_address
+
+        payment.clear_credit_card
+        payment.set_paypal(
+          direct_payment_details.reverse_merge(
+            paypal_id: @paypal_id,
+            approved: true, #approved?
+            payer_id: payer&.payer_id,
+            details:  Paypal.transform_values(paypal_order)
+          )
+        )
+
+        Pricing.perform(order, shippings)
+        payment.adjust_tender_amounts(order.total_price)
+      end
+
+      def approved?
+        status == 'APPROVED' || direct_payment?
+      end
+
+      private
+
+      def set_shipping_address
+        name = details.shipping.name.full_name.split(' ')
+
+        shipping.set_address(
+          first_name:   name.shift,
+          last_name:    name.join(' '),
+          street:       details.shipping.address.address_line_1,
+          street_2:     details.shipping.address.address_line_2,
+          city:         details.shipping.address.admin_area_2,
+          region:       details.shipping.address.admin_area_1,
+          postal_code:  details.shipping.address.postal_code,
+          country:      details.shipping.address.country_code,
+          phone_number: payer&.phone&.phone_number&.national_number
+        )
+      end
+
+      def set_billing_address
+        return unless payer.present? && payer&.address&.address_line_1.present?
+
+        payment.set_address(
+          first_name:   payer.name&.given_name,
+          last_name:    payer.name&.surname,
+          street:       payer.address.address_line_1,
+          street_2:     payer.address.address_line_2,
+          city:         payer.address.admin_area_2,
+          region:       payer.address.admin_area_1,
+          postal_code:  payer.address.postal_code,
+          country:      payer.address.country_code,
+          phone_number: payer.phone&.phone_number&.national_number
+        )
+      end
+
+      def set_shipping_service
+        Checkout::Steps::Shipping.new(self).update({})
+      end
+
+      def direct_payment?
+        payment_source&.card.present?
+      end
+
+      def direct_payment_details
+        return {} unless direct_payment?
+
+        {
+          details:  {
+            display_number: ActiveMerchant::Billing::CreditCard.mask(
+              payment_source.card.last_digits
+            ),
+            issuer: payment_source.card.brand
+          },
+          direct_payment: true
+        }
+      end
+    end
+  end
+end

data/app/services/workarea/paypal/create_order.rb

@@ -0,0 +1,177 @@
+module Workarea
+  module Paypal
+    class CreateOrder
+      delegate :order, :user, :payment, :shippings, :shipping, to: :@checkout
+
+      def initialize(checkout)
+        @checkout = checkout
+      end
+
+      def perform
+        Pricing.perform(order, shippings)
+        Paypal.gateway.create_order(body: request_body)
+      end
+
+      def request_body
+        {
+          intent: 'CAPTURE',
+          application_context: {
+            brand_name: Workarea.config.site_name,
+            locale: I18n.locale,
+            landing_page: 'BILLING',
+            shipping_preference: shipping_preference,
+            user_action: 'CONTINUE'
+          },
+          payer: payer,
+          purchase_units: [{
+            custom_id: order.id,
+            amount: amount,
+            items: items,
+            shipping: shipping_info
+          }]
+        }
+      end
+
+      def payer
+        return {} unless order.email.present?
+
+        info = { email_address: order.email }.compact
+        return info unless payment.address&.persisted?
+
+        info[:name] = {
+          given_name: payment.address.first_name,
+          surname: payment.address.last_name,
+        }
+
+        info[:address] = {
+          address_line_1: payment.address.street,
+          address_line_2: payment.address.street_2,
+          admin_area_2: payment.address.city,
+          admin_area_1: payment.address.region,
+          postal_code: payment.address.postal_code,
+          country_code: payment.address.country.alpha2
+        }
+
+        return info unless payment.address.phone_number.present?
+
+        info['phone'] = {
+          phone_type: 'HOME',
+          phone_number: {
+            national_number: payment.address.phone_number
+          }
+        }
+
+        info
+      end
+
+      def amount
+        {
+          currency_code: currency_code,
+          value: (order.total_price - other_tenders_total).to_s,
+          breakdown: {
+            item_total: {
+              currency_code: currency_code,
+              value: order.subtotal_price.to_s
+            },
+            shipping: {
+              currency_code: currency_code,
+              value: order.shipping_total.to_s
+            },
+            tax_total: {
+              currency_code: currency_code,
+              value: order.tax_total.to_s
+            },
+            discount: {
+              currency_code: currency_code,
+              value: (discount_total.abs + other_tenders_total).to_s
+            },
+            shipping_discount: {
+              currency_code: currency_code,
+              value: shipping_discount_total.abs.to_s
+            }
+          }
+        }
+      end
+
+      def items
+        order.items.map do |item|
+          view_model = Storefront::OrderItemViewModel.wrap(item)
+
+          {
+            name: view_model.product_name,
+            description: view_model.details.values.join(' '),
+            sku: item.sku,
+            unit_amount: {
+              currency_code: currency_code,
+              value: item.current_unit_price.to_s
+            },
+            quantity: item.quantity,
+            category: item.fulfilled_by?(:shipping) ? 'PHYSICAL_GOODS' : 'DIGITAL_GOODS'
+          }
+        end
+      end
+
+      def shipping_info
+        return {} unless send_shipping_info?
+
+        {
+          method: shipping.shipping_service&.name,
+          name: {
+            full_name: [
+              shipping.address.first_name,
+              shipping.address.last_name
+            ].compact.join(' ')
+          },
+          address: {
+            address_line_1: shipping.address.street,
+            address_line_2: shipping.address.street_2,
+            admin_area_2: shipping.address.city,
+            admin_area_1: shipping.address.region,
+            postal_code: shipping.address.postal_code,
+            country_code: shipping.address.country.alpha2
+          }
+        }
+      end
+
+      def send_shipping_info?
+        order.requires_shipping? &&
+          shippings.one? &&
+          shipping.shippable?
+      end
+
+      private
+
+      def currency_code
+        order.total_price.currency.iso_code
+      end
+
+      def shipping_preference
+        if send_shipping_info?
+          'SET_PROVIDED_ADDRESS' # Shows addressed provided on PayPal pages
+        elsif order.requires_shipping? && !shipping&.shippable?
+          'GET_FROM_FILE' # Uses customer address from PayPal
+        else
+          'NO_SHIPPING' # Hides shipping on PayPal pages
+        end
+      end
+
+      def price_adjustments
+        @price_adjustments ||=
+          order.price_adjustments +
+            shippings.map(&:price_adjustments).reduce(:+)
+      end
+
+      def discount_total
+        price_adjustments.adjusting('order').discounts.sum(&:amount)
+      end
+
+      def other_tenders_total
+        payment.tenders.reject { |t| t.slug == :paypal }.sum(&:amount).to_m
+      end
+
+      def shipping_discount_total
+        price_adjustments.adjusting('shipping').discounts.sum(&:amount)
+      end
+    end
+  end
+end

data/app/services/workarea/paypal/update_order.rb

@@ -0,0 +1,44 @@
+module Workarea
+  module Paypal
+    class UpdateOrder
+      delegate :order, :user, :payment, :shippings, :shipping, to: :@checkout
+      delegate :paypal_id, to: :payment, allow_nil: true
+
+      def initialize(checkout)
+        @checkout = checkout
+      end
+
+      def create
+        @create ||= Paypal::CreateOrder.new(@checkout)
+      end
+
+      def perform
+        return false unless payment.paypal?
+
+        Paypal.gateway.update_order(paypal_id, body: request_body)
+      end
+
+      def request_body
+        shipping = create.shipping_info
+
+        [
+          {
+            op: 'replace',
+            path: "/purchase_units/@reference_id=='default'/shipping/name",
+            value: shipping[:name]
+          },
+          {
+            op: 'replace',
+            path: "/purchase_units/@reference_id=='default'/shipping/address",
+            value: shipping[:address]
+          },
+          {
+            op: 'replace',
+            path: "/purchase_units/@reference_id=='default'/amount",
+            value: create.amount
+          }
+        ]
+      end
+    end
+  end
+end

data/app/views/workarea/admin/orders/tenders/_paypal.html.haml

@@ -1,2 +1,5 @@
-= t("workarea.admin.orders.tenders.paypal.title")
-= number_to_currency tender.amount
+- if tender.direct_payment?
+  = render 'workarea/admin/orders/tenders/credit_card', tender: tender
+- else
+  = t("workarea.admin.orders.tenders.paypal.title")
+  = number_to_currency tender.amount

data/app/views/workarea/api/orders/tenders/_paypal.json.jbuilder

@@ -1,3 +1,9 @@
 json.type 'paypal'
-json.token tender.token
+json.amount tender.amount
+json.paypal_id tender.paypal_id
 json.payer_id tender.payer_id
+json.direct_payment tender.direct_payment?
+if tender.direct_payment?
+  json.display_number tender.display_number
+  json.issuer tender.issuer
+end

data/app/views/workarea/storefront/carts/_paypal_checkout.html.haml

@@ -1 +1,6 @@
-%p.cart__checkout-action.cart__checkout-action--paypal= link_to(image_tag('https://www.paypal.com/en_US/i/btn/btn_xpressCheckout.gif'), start_paypal_path, alt: t('workarea.storefront.paypal.check_out'))
+- unless @cart.no_items?
+  - if current_user.present?
+    - set_paypal_client_token
+  .grid.grid--right
+    .grid__cell.grid__cell--50-at-medium
+      #paypal-button-container.cart__checkout-action.cart__checkout-action--paypal

data/app/views/workarea/storefront/checkouts/_paypal_payment.html.haml

@@ -1,12 +1,23 @@
-.checkout-payment__primary-method{ class: ('checkout-payment__primary-method--selected' if @step.paypal?) }
+- if current_user.present? || Workarea.config.use_paypal_hosted_fields
+  - set_paypal_client_token
+
+- if Workarea.config.use_paypal_hosted_fields
+  %div{ data: { paypal_hosted_fields: { show_save_card: logged_in? }.to_json, updated_checkout_submit_text: { prevent: step.credit_card?, text: t('workarea.storefront.paypal.checkout_review_text') }.to_json } }
+
+.checkout-payment__primary-method.checkout-payment__primary-method--paypal{ class: ('checkout-payment__primary-method--selected' if step.paypal?) }
   .button-property
-    = hidden_field_tag 'from_checkout', 'from_checkout'
-    .value= radio_button_tag 'payment', 'paypal', step.paypal?, data: { update_checkout_submit_text: { prevent: step.paypal?, text: t('workarea.storefront.paypal.checkout_submit_text') }.to_json }
+    .value= radio_button_tag 'payment', 'paypal', step.paypal?, data: { update_checkout_submit_text: { prevent: step.paypal?, disabled: true, text: t('workarea.storefront.paypal.checkout_submit_text') }.to_json }
     = label_tag 'payment[paypal]', nil, class: 'button-property__name' do
       %span.button-property__text= t('workarea.storefront.paypal.paypal')
   %p.checkout-payment__primary-method-description
-    = inline_svg('workarea/admin/payment_icons/paypal.svg', class: 'payment-icon', title: 'PayPal')
-    - if @step.paypal?
+    - if step.paypal? && step.payment.errors.none?
       %span= t('workarea.storefront.paypal.payment_recieved')
+    - elsif step.paypal? && step.payment.errors.present?
+      %span= t('workarea.storefront.paypal.payment_failed')
     - else
       %span= t('workarea.storefront.paypal.on_continue')
+  - unless step.paypal? && step.payment.errors.none?
+    .checkout-payment__primary-method-edit
+      .grid
+        .grid__cell.grid__cell--50-at-medium
+          #paypal-button-container.cart__checkout-action.cart__checkout-action--paypal

data/app/views/workarea/storefront/order_mailer/tenders/_paypal.html.haml

@@ -1,3 +1,5 @@
-%p{ style: "margin: 0 0 6px; font: 13px/1.5 arial; color: #{@config.text_color};" }
-  = t('workarea.storefront.paypal.paid_with_paypal')
-  = number_to_currency tender.amount
+- if tender.direct_payment?
+  = render 'workarea/storefront/order_mailer/tenders/credit_card', tender: tender
+- else
+  %p
+    = "#{t('workarea.storefront.paypal.paid_with_paypal')}: #{number_to_currency tender.amount}"