workarea-paypal 2.0.10 → 3.0.4

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}"

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

@@ -1,2 +1,9 @@
-%p= t('workarea.storefront.paypal.paid_with_paypal')
-%p= number_to_currency(tender.amount)
+- if tender.direct_payment?
+  = render 'workarea/storefront/orders/tenders/credit_card', tender: tender
+- else
+  .data-card
+    .data-card__cell
+      %p.data-card__line
+        = t('workarea.storefront.paypal.paid_with_paypal')
+      %p.data-card__line
+        = number_to_currency(tender.amount)

data/app/views/workarea/storefront/paypal/_paypal_sdk.html.haml

@@ -0,0 +1 @@
+= include_paypal_javascript_tag

data/app/workers/workarea/paypal/handle_webhook_event.rb

@@ -0,0 +1,64 @@
+module Workarea
+  module Paypal
+    class HandleWebhookEvent
+      include Sidekiq::Worker
+
+      def perform(event, resource)
+        event_method = event.optionize
+        return send(event_method, resource) if respond_to?(event_method)
+
+        logger.error("FAILED: #{event} webhook is not supported.")
+      end
+
+      def payment_capture_completed(resource)
+        transaction = Payment::Transaction.where(
+          'response.params.id' => resource['id']
+        ).first
+
+        if transaction.nil?
+          logger.error("FAILED: Transaction with capture ID of #{resource['id']} does not exist.")
+          return
+        end
+
+        tender = transaction.payment.tenders.detect do |t|
+          t.id.to_s == transaction.tender_id
+        end
+        return unless tender.present?
+
+        amount = resource['amount']
+        txn = tender.build_transaction(
+          action: 'capture',
+          success: true,
+          reference: transaction,
+          amount: amount['value'].to_m(amount['currency_code']),
+          response: ActiveMerchant::Billing::Response.new(
+            true,
+            'Paypal capture was confirmed.',
+            resource
+          )
+        )
+
+        txn.save!
+      end
+
+      def payment_capture_denied(resource)
+        transaction = Payment::Transaction.where(
+          'response.params.id' => resource['id']
+        ).first
+
+        if transaction.nil?
+          logger.error("FAILED: Transaction with capture ID of #{resource['id']} does not exist.")
+          return
+        end
+
+        transaction.cancellation = ActiveMerchant::Billing::Response.new(
+          true,
+          "PayPal capture was denied",
+          resource
+        )
+        transaction.canceled_at = Time.current
+        transaction.save!
+      end
+    end
+  end
+end

data/config/initializers/append_points.rb

@@ -1,11 +1,11 @@
 Workarea::Plugin.append_partials(
-  'storefront.cart_checkout_actions',
-  'workarea/storefront/carts/paypal_checkout'
+  'storefront.document_head',
+  'workarea/storefront/paypal/paypal_sdk'
 )
 
 Workarea::Plugin.append_partials(
-  'storefront.payment_error',
-  'workarea/storefront/checkouts/paypal_error'
+  'storefront.cart_show',
+  'workarea/storefront/carts/paypal_checkout'
 )
 
 Workarea::Plugin.append_partials(
@@ -13,7 +13,19 @@ Workarea::Plugin.append_partials(
   'workarea/storefront/checkouts/paypal_payment'
 )
 
+Workarea::Plugin.append_javascripts(
+  'storefront.config',
+  'workarea/storefront/paypal/config'
+)
+
+Workarea::Plugin.append_javascripts(
+  'storefront.templates',
+  'workarea/storefront/paypal/templates/paypal_fields'
+)
+
 Workarea::Plugin.append_javascripts(
   'storefront.modules',
-  'workarea/storefront/paypal/modules/update_checkout_submit_text'
+  'workarea/storefront/paypal/modules/update_checkout_submit_text',
+  'workarea/storefront/paypal/modules/paypal_buttons',
+  'workarea/storefront/paypal/modules/paypal_hosted_fields'
 )

data/config/initializers/fields.rb

@@ -0,0 +1,27 @@
+Workarea::Configuration.define_fields do
+  fieldset 'PayPal', namespaced: false do
+    # PayPal credentials can be configured via environment variables:
+    #   WORKAREA_PAYPAL_CLIENT_ID
+    #   WORKAREA_PAYPAL_CLIENT_SECRET
+    #
+    # via rails credentials:
+    #   paypal:
+    #     client_id: YOUR_CLIENT_ID
+    #     client_secret: YOUR_CLIENT_SECRET
+    #
+    # Or through the workarea admin configuration. Setting credentials through
+    # the configuration allows for dyanmically changing credentials if, for
+    # example, you are using the multi-site plugin and wish to use different
+    # PayPal accounts for some or all sites.
+    #
+    field 'Client ID',
+      type: :string,
+      id: 'paypal_client_id',
+      description: 'Your Paypal Merchant Account Application Client ID'
+    field 'Client Secret',
+      type: :string,
+      id: 'paypal_client_secret',
+      encrypted: true,
+      description: 'Your Paypal Merchant Account Application Client Secret'
+  end
+end

data/config/initializers/workarea.rb

@@ -1,7 +1,43 @@
-Workarea.config.tender_types << :paypal
 
-# Gateway application_id is sent as PayPal BN code for revenue sharing
-# 'Workarea_SP' should be used for all WebLinc installations
-ActiveMerchant::Billing::PaypalGateway.application_id = 'Workarea_SP'
+Workarea.configure do |config|
+  config.tender_types << :paypal
 
-Workarea::Paypal.auto_configure_gateway
+  # Determines which environment class to use. The PayPal SDK requires the
+  # use of different classes depending on the type of environment you are
+  # interacting with. By default, sandbox will be used unless in production.
+  # This behavior can be changed within your application by redefining this
+  # configuration.
+  #
+  config.paypal_environment =
+    if Rails.env.production?
+      'Paypal::LiveEnvironment'
+    else
+      'PayPal::SandboxEnvironment'
+    end
+
+  # Parameters passed as a query string to the paypal javascript sdk script
+  # when loaded on the storefront. This can be used to customize settings and
+  # display options.
+  # See https://developer.paypal.com/docs/checkout/reference/customize-sdk/
+  # for more information.
+  #
+  config.paypal_sdk_params = {
+    commit: false,
+    debug: Rails.env.development?
+  }
+
+  # Enable/Disable paypal as your credit card processor. This will enable
+  # code that takes over the credit card fields during checkout and submits
+  # payment info directly to paypal. You will need to enable unbranded credit
+  # cards through PayPal. Contact PayPal directly for more information.
+  #
+  config.use_paypal_hosted_fields = false
+
+  # Events to register a webhook for when running the rake tasks to setup
+  # webhooks, workarea:payal:create_webhooks.
+  #
+  config.default_webhook_events = %w(
+    PAYMENT.CAPTURE.COMPLETED
+    PAYMENT.CAPTURE.DENIED
+  )
+end

data/config/locales/en.yml

@@ -1,4 +1,3 @@
----
 en:
   workarea:
     admin:
@@ -6,14 +5,25 @@ en:
         tenders:
           paypal:
             title: PayPal
+    payment:
+      paypal_capture: Paypal funding is pending capture and cannot be completed manually. Capture will be recorded after an update from PayPal.
+    paypal:
+      gateway:
+        http_error: "%{status} : PayPal request error, debug ID %{debug_id}"
+        capture_error: Select a new payment option and try again.
     storefront:
       paypal:
-        address_error: We can not ship to this address. Please enter a new address.
         check_out: Check Out with PayPal
-        checkout_submit_text: Continue to PayPal
-        on_continue: When you continue, you will be taken to the PayPal website.
+        checkout_submit_text: Select a PayPal payment option to continue
+        checkout_review_text: Submit Payment and Review
+        errors:
+          order_incomplete: Your checkout is incomplete. Please review your shipping and billing information and try again.
+          place_order: You must complete your paypal transaction before submitting your order.
+          request_failed: There was a problem contacting PayPal. Please try again. If the problem persists, try a different payment method or contact customer support.
+        on_continue: Select a PayPal payment option.
         paid_with_paypal: Paid with PayPal
-        payment_recieved: Thank You! We have received your information back from PayPal.
+        payment_failed: Your submitted PayPal payment could not be completed. Select a new method and try again.
+        payment_received: Thank You! We have received your information back from PayPal.
           Please confirm that the shipping address and shipping method are correct,
           then click on 'Place Order'.
         paypal: PayPal

data/config/routes.rb

@@ -1,4 +1,7 @@
 Workarea::Storefront::Engine.routes.draw do
-  get 'paypal/start' => 'paypal#start', as: :start_paypal
-  get 'paypal/complete/:order_id' => 'paypal#complete', as: :complete_paypal
+  scope '(:locale)', constraints: Workarea::I18n.routes_constraint do
+    post 'paypal' => 'paypal#create'
+    put 'paypal/:id/approved' => 'paypal#update', as: :paypal_approved
+    post 'paypal/event' => 'paypal#event', as: :paypal_event
+  end
 end

data/lib/tasks/workarea/create_webhooks.rake

@@ -0,0 +1,29 @@
+namespace :workarea do
+  namespace :paypal do
+    desc 'Register webhook listeners for PayPal'
+    task create_webhooks: :environment do
+      puts 'Unsubscribing existing webhooks...'
+      webhooks = Workarea::Paypal.gateway.list_webhooks.result.webhooks
+
+
+      webhooks.each do |webhook|
+        begin
+          Workarea::Paypal.gateway.delete_webhook(webhook.id)
+        rescue Workarea::Paypal::Gateway::RequestError => e
+          puts "Webhook deletion #{id} failed. #{e.message}"
+        end
+      end
+
+      puts 'Subscribing to PayPal webhook events...'
+      Workarea::Paypal.gateway.create_webhook(
+        url: Workarea::Storefront::Engine.routes.url_helpers.paypal_event_url(
+          host: Workarea.config.host,
+          protocol: Rails.application.config.force_ssl ? 'https' : 'http'
+        ),
+        event_types: Workarea.config.default_webhook_events
+      )
+
+      puts 'completed successfully!'
+    end
+  end
+end

data/lib/workarea/paypal.rb

@@ -2,29 +2,33 @@ require 'workarea'
 require 'workarea/storefront'
 require 'workarea/admin'
 
+require 'paypal-checkout-sdk'
+require 'workarea/paypal/requests/generate_token'
+require 'workarea/paypal/requests/list_webhooks'
+require 'workarea/paypal/requests/create_webhook'
+require 'workarea/paypal/requests/delete_webhook'
+require 'workarea/paypal/gateway'
+
 module Workarea
   module Paypal
-    def self.gateway
-      Workarea.config.gateways.paypal
-    end
-
-    def self.gateway=(gateway)
-      Workarea.config.gateways.paypal = gateway
-    end
+    class << self
+      delegate :client, to: :gateway
 
-    def self.auto_configure_gateway
-      if Rails.application.secrets.paypal.present?
-        self.gateway = ActiveMerchant::Billing::PaypalExpressGateway.new(
-          Rails.application.secrets.paypal.deep_symbolize_keys
-        )
-      elsif gateway.blank?
-        self.gateway = ActiveMerchant::Billing::BogusGateway.new
+      def gateway
+        Workarea::Paypal::Gateway.new
       end
 
-      if ENV['HTTP_PROXY'].present? && gateway.present?
-        parsed = URI.parse(ENV['HTTP_PROXY'])
-        gateway.proxy_address = parsed.host
-        gateway.proxy_port = parsed.port
+      def transform_values(value)
+        case value
+        when OpenStruct
+          transform_values(value.to_h)
+        when Hash
+          value.transform_values(&method(:transform_values))
+        when Array
+          value.map(&method(:transform_values))
+        else
+          value
+        end
       end
     end
   end

data/lib/workarea/paypal/engine.rb

@@ -3,6 +3,10 @@ module Workarea
     class Engine < ::Rails::Engine
       include Workarea::Plugin
       isolate_namespace Workarea::Paypal
+
+      config.to_prepare do
+        Storefront::ApplicationController.helper(Storefront::PaypalHelper)
+      end
     end
   end
 end

data/lib/workarea/paypal/gateway.rb

@@ -0,0 +1,200 @@
+module Workarea
+  module Paypal
+    class Gateway
+      class RequestError < StandardError; end
+
+      def environment
+        @environment =
+          Workarea.config.paypal_environment.constantize.new(
+            client_id,
+            client_secret
+          )
+      end
+
+      def client
+        PayPal::PayPalHttpClient.new(environment)
+      end
+
+      def send_request(request)
+        # Do not change this
+        request.headers["PayPal-Partner-Attribution-Id"] = 'Workarea_SP'
+
+        client.execute(request)
+      end
+
+      # This gets a token required to render hosted fields. Not used for
+      # smart payment buttons.
+      def generate_token(user: nil)
+        request = Workarea::Paypal::Requests::GenerateToken.new
+        id = user&.id.to_s.last(22) # length limit
+        request.request_body(customer_id: id) if user.present?
+
+        handle_connection_errors { send_request(request) }
+      end
+
+      def get_order(order_id)
+        request = PayPalCheckoutSdk::Orders::OrdersGetRequest.new(order_id)
+        handle_connection_errors { send_request(request) }
+      end
+
+      def create_order(body:)
+        request = PayPalCheckoutSdk::Orders::OrdersCreateRequest.new
+        request.request_body(body)
+
+        handle_connection_errors do
+          response = send_request(request)
+          response.result
+        end
+      end
+
+      def update_order(order_id, body: {})
+        request = PayPalCheckoutSdk::Orders::OrdersPatchRequest.new(order_id)
+        request.request_body(body)
+
+        handle_connection_errors do
+          response = send_request(request)
+          response.result
+        end
+      end
+
+      def capture(order_id)
+        request = PayPalCheckoutSdk::Orders::OrdersCaptureRequest.new(order_id)
+        request.prefer("return=representation")
+
+        if ENV['PAYPAL_MOCK_RESPONSE'].present? && Rails.env.in?(%w(test development))
+          request.headers['PayPal-Mock-Response'] = ENV['PAYPAL_MOCK_RESPONSE']
+        end
+
+        handle_transaction_errors do
+          response = send_request(request)
+          result = response.result
+          capture = result&.purchase_units&.first&.payments&.captures&.last
+          success = response.status_code == 201 && capture&.status != 'DECLINED'
+
+          ActiveMerchant::Billing::Response.new(
+            success,
+            "PayPal capture #{success ? 'succeeded' : 'failed'}",
+            Paypal.transform_values(success ? capture : result)
+          )
+        end
+      end
+
+      # No body means refunding the entire captured amount, otherwise an amount
+      # object needs to be supplied.
+      #
+      def refund(capture_id, amount: nil)
+        request = PayPalCheckoutSdk::Payments::CapturesRefundRequest.new(capture_id)
+        request.prefer("return=representation")
+
+        if amount.present?
+          request.request_body(
+            amount: {
+              value: amount.to_s,
+              currency_code: amount.currency.iso_code
+            }
+          )
+        end
+
+        handle_transaction_errors do
+          response = send_request(request)
+          refund = response.result
+          success = response.status_code == 201 && refund.status != 'CANCELLED'
+
+          ActiveMerchant::Billing::Response.new(
+            success,
+            "PayPal refund #{success ? 'succeeded' : 'failed'}",
+            {
+              id: refund.id,
+              status: refund.status,
+              status_details: refund.status_details.to_h,
+              capture_id: capture_id,
+              amount: amount.to_s
+            }
+          )
+        end
+      end
+
+      def create_webhook(url:, event_types:)
+        request = Workarea::Paypal::Requests::CreateWebhook.new
+        request.request_body(
+          url: url,
+          event_types: Array.wrap(event_types).map { |type| { name: type } }
+        )
+
+        response = handle_connection_errors { send_request(request) }
+
+        throw_request_error(response) unless response.status_code == 201
+        response
+      end
+
+      def delete_webhook(webhook_id)
+        request = Workarea::Paypal::Requests::DeleteWebhook.new(webhook_id)
+        response = handle_connection_errors { send_request(request) }
+
+        throw_request_error(response) unless response.status_code == 204
+        response
+      end
+
+      def list_webhooks
+        request = Workarea::Paypal::Requests::ListWebhooks.new
+        response = handle_connection_errors { send_request(request) }
+
+        throw_request_error(response) unless response.status_code == 200
+        response
+      end
+
+      def configured?
+        client_id.present? && client_secret.present?
+      end
+
+      def client_id
+        ENV['WORKAREA_PAYPAL_CLIENT_ID'].presence ||
+          Rails.application.credentials.paypal.try(:[], :client_id) ||
+          Workarea.config.paypal_client_id
+      end
+
+      private
+
+      def client_secret
+        ENV['WORKAREA_PAYPAL_CLIENT_SECRET'].presence ||
+          Rails.application.credentials.paypal.try(:[], :client_secret) ||
+          Workarea.config.paypal_client_secret
+      end
+
+      def throw_request_error(error)
+        raise RequestError.new(
+          I18n.t(
+            'workarea.paypal.gateway.http_error',
+            status: error.status_code,
+            debug_id: error.headers['paypal-debug-id']
+          )
+        )
+      end
+
+      def handle_connection_errors
+        begin
+          yield
+        rescue PayPalHttp::HttpError => error
+          Rails.logger.error(error.message)
+          Rails.logger.error(error.result)
+          throw_request_error(error)
+        end
+      end
+
+      def handle_transaction_errors
+        begin
+          yield
+        rescue PayPalHttp::HttpError => error
+          ActiveMerchant::Billing::Response.new(
+            false,
+            I18n.t('workarea.paypal.gateway.capture_error'),
+            status_code: error.status_code,
+            debug_id: error.headers['paypal-debug-id']
+          )
+        rescue StandardError => error
+          ActiveMerchant::Billing::Response.new(false, error.message, {})
+        end
+      end
+    end
+  end
+end