spree-paypal_merchant 6.0.1 → 6.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d09d026a692438a7e89cd1eb47700bc34fb8ef077da6475c94dd61471e70dfed
-  data.tar.gz: fca83a3ef6cfb0bb6e27851d65c0ae0daa35b414506acc25218246bbe0a0c19a
+  metadata.gz: e71ac639e1576f0bce578e79f0cfbb63ab90793d0ef55125b73c4094d7d1c3af
+  data.tar.gz: 3cccfc4d31868f2349e8c402ba45376c0c68ecff8759e9281fbdb137da4d3283
 SHA512:
-  metadata.gz: 765ffdaf6c95115be5c8f51cf31d42b1c3e171ff0cef1435abff604112735d45eae3051dde53ce5da75d6bb52f29108d6b7c811e02b834f997cef954f2c115c8
-  data.tar.gz: 3ddd64eabd1c28835cd4c4760f1c375ede3c45d9dc7251ab69be6f478703633f83f193d4f3498ac13aa7b92c8ea827d12e51e8ceb7f09e9b6a6a65f271c809c2
+  metadata.gz: 25999fba0e7b5b6ab39121c1ed0323069bebe9874a0566daa7738860aa0624a2e69481a88b424ec97f39eff9743170d8602c9e2f6473f042f73bd4bd40ceeff7
+  data.tar.gz: 88048d65d1d028bf004cc803243b376ed7b0d7037d59575197a0d45d4e461cdcf9315031e9567e49e21a9319d3b3812d65c28f7d8eba10f494f96a9d969b79a2

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 6.0.2
+
+### Fixed
+
+- The PayPal SDK no longer writes a `WARN Request …` and `WARN Response …` line
+  to standard output for every PayPal call. Given no logger, the SDK printed to
+  standard output at the level the gem passed, outside the app's log level and
+  format. `Spree::PaypalMerchant::SdkLogger` now hands those lines to the Rails
+  log at `debug`, prefixed `[spree-paypal_merchant]`, so a production log at
+  `info` leaves them out (see "Logging" in the README).
+
 ## 6.0.1
 
 To record refunds made in PayPal, subscribe the webhook to

data/README.md

@@ -207,6 +207,13 @@ Three things to know before you cut over:
    id is now keyed by the cart's (or order's) prefixed id instead of the order
    number. Such a source isn't reused, and a new one is created.
 
+## Logging
+
+The PayPal SDK logs one line per request and one per response: the method, URL,
+status and content type, never bodies or headers. The gem sends these lines to
+the Rails log at `debug`, prefixed `[spree-paypal_merchant]`, so a production
+log at `info` leaves them out. To see them, set the log level to `debug`.
+
 ## Known limitations
 
 - PayPal treats HUF and TWD as zero-decimal currencies, but Spree formats them

data/app/models/spree/paypal_merchant/gateway.rb

@@ -271,8 +271,11 @@ module Spree
           timeout: REQUEST_TIMEOUT,
           max_retries: MAX_RETRIES,
           retry_methods: RETRY_METHODS,
+          # Request and response lines go to the Rails log at debug, so a
+          # production log at info leaves them out.
           logging_configuration: PaypalServerSdk::LoggingConfiguration.new(
-            log_level: Logger::WARN,
+            logger: Spree::PaypalMerchant::SdkLogger.new,
+            log_level: Logger::DEBUG,
             request_logging_config: PaypalServerSdk::RequestLoggingConfiguration.new(
               log_body: false
             ),

data/app/models/spree/paypal_merchant/sdk_logger.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Spree
+  module PaypalMerchant
+    ##
+    # Hands the PayPal SDK's request and response lines to the Rails log.
+    #
+    # Given no logger, the SDK writes each line to standard output, outside
+    # the app's log level and format. It calls #log with a template such as
+    # "Request {method} {url}" and the values that fill it; a plain Logger
+    # would print the template unfilled.
+    #
+    # @example
+    #   PaypalServerSdk::LoggingConfiguration.new(logger: Spree::PaypalMerchant::SdkLogger.new, log_level: Logger::DEBUG)
+    #
+    class SdkLogger
+      PREFIX = '[spree-paypal_merchant]'
+      PLACEHOLDER = /\{([\w-]+)\}/
+
+      ##
+      # @param logger [Logger] where the lines go
+      #
+      def initialize(logger = Rails.logger)
+        @logger = logger
+      end
+
+      ##
+      # @param level [Integer] the Logger severity to write at
+      # @param message [String] the SDK's template, with {name} placeholders
+      # @param params [Hash{String, Symbol => Object}] the placeholder values
+      # @return [true]
+      #
+      def log(level, message, params = {})
+        @logger.add(level) { "#{PREFIX} #{fill(message, params)}" }
+      end
+
+      private
+
+      def fill(message, params)
+        message.gsub(PLACEHOLDER) do
+          key = Regexp.last_match(1)
+          params.fetch(key) { params[key.to_sym] }
+        end
+      end
+    end
+  end
+end

data/lib/spree/paypal_merchant/version.rb

@@ -4,6 +4,6 @@ module Spree
   module PaypalMerchant
     # Major version tracks Spree's major version: 6.x supports Spree 6.
     # 5.2.x supports Spree 5.6 and lives on the `5-2-stable` branch.
-    VERSION = '6.0.1'
+    VERSION = '6.0.2'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spree-paypal_merchant
 version: !ruby/object:Gem::Version
-  version: 6.0.1
+  version: 6.0.2
 platform: ruby
 authors:
 - Aypex
@@ -141,6 +141,7 @@ files:
 - app/models/spree/paypal_merchant/payment_sources/apple_pay.rb
 - app/models/spree/paypal_merchant/payment_sources/card.rb
 - app/models/spree/paypal_merchant/payment_sources/paypal.rb
+- app/models/spree/paypal_merchant/sdk_logger.rb
 - app/models/spree/paypal_merchant/store_decorator.rb
 - app/presenters/spree/paypal_merchant/order_presenter.rb
 - app/serializers/spree/api/v3/payment_method_serializer_decorator.rb