spree-kashflow 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff9334bd3e09ee1cdb9965f3eddc61af9d887161dd95901c9b54bc6feaf15cdc
-  data.tar.gz: 7e4576dd85f13c15326591811c0d05a6efa17de61a44e1b82b6a62fca8dd0717
+  metadata.gz: d20212552f51bc299bb20645fc8f5dbca833b2bdb63a1678d752b29a15f00a17
+  data.tar.gz: fb65959bc02ff1ac1b1eb7b38257ca03b9fba95386efb49b40baf91378b7c0bb
 SHA512:
-  metadata.gz: d55939c427bc7154665e69801126b67a35cc95f01024f9303f9d380377b3b290db422ce3e67cd802c98465a65db9b85bdb47f01c015e84340062bdcebe60856a
-  data.tar.gz: b785bbb7a59d6a80686fe13b3cab2f37b83e4d7d7d97d87369c13c09a469852a76604a51d431f5a6e433953ce1e1242feb68f67ffecc10397ee5dff8576f28e7
+  metadata.gz: a257c8a10a8576b39a5b58613568cc1faf751f3fa28caa505df9d190404be40d12e0e52272a48c3f2f141cc7e2b0c540b59bf32bb2501d7c2dd60b01b31ecf9b
+  data.tar.gz: 19f304c825178155659864ba3b064507ade831b27632d385befd8d27a60f84ccd74471b0eef8ce94cea0f1bd1391ce900fc034af404377e578d87e292527a276

data/CHANGELOG.md

@@ -1,5 +1,40 @@
 # Changelog
 
+## 0.1.2
+
+- **Fix: every order sync still failed against a live KashFlow account**, now on
+  the invoice rather than the customer. KashFlow types every date field in the
+  WSDL as `s:dateTime`, and its .NET `XmlSerializer` rejected the whole envelope
+  with `The string '2026-08-18 10:53:48 UTC' is not a valid AllXsd value` —
+  no invoice created, and the fault naming only a character offset. Gyoku
+  type-switches with `Module#===`, so `ActiveSupport::TimeWithZone` (a
+  delegator, not a `Time` subclass) fell through to `to_s`; plain `Time` did
+  too, and `Date` emitted an xsd `date` rather than a `dateTime`. Since
+  `Time.current` and Active Record datetime attributes all return
+  `TimeWithZone`, this was the default path, affecting `InvoiceDate`, `DueDate`
+  and `PayDate` on orders and `InvoiceDate` / `DueDate` on refunds.
+  `Client#call` now normalises every temporal value in an outgoing message to
+  UTC xsd `dateTime`, so the wire format is owned by the one class that touches
+  the wire and any date field added later is correct by default.
+- Assert the *serialised* SOAP body for temporal values. The suite doubled the
+  client and asserted the payload Hash, where a `TimeWithZone` looks correct
+  right up until it reaches the wire — which is why 0.1.1 shipped with this
+  defect behind a green build.
+
+## 0.1.1
+
+- **Fix: every order sync failed against a live KashFlow account.** The customer
+  `Code` was set to the order's email address, which KashFlow rejects — "the
+  customer code specified is invalid, please re-enter without any special
+  characters" — on the customer upsert, before an invoice was ever attempted.
+  Codes are now uppercase-alphanumeric and derived from the customer rather than
+  the order: `SPU<user id>` for a registered user, `SPG<email digest>` for a
+  guest. Both are stable across that customer's orders, which is what keeps
+  `InsertCustomer` an update rather than a duplicate.
+- Require `digest` explicitly rather than relying on a transitive dependency to
+  load it.
+- Replace the placeholder integration logo with the IRIS KashFlow brand asset.
+
 ## 0.1.0
 
 - Initial release.

data/app/presenters/spree/kashflow/customer_payload.rb

@@ -23,6 +23,42 @@ module Spree
       #   column, so this gem reads it out of `order.metadata` under this key.
       VAT_NUMBER_METADATA_KEY = "vat_number"
 
+      ##
+      # KashFlow rejects a customer `Code` that carries special characters:
+      #
+      #   NO: The customer code specified is invalid, please re-enter without
+      #       any special characters.
+      #
+      # v0.1.0 sent `order.email` here, so EVERY sync failed on the customer
+      # upsert before an invoice was ever attempted — caught on the first live
+      # order (tkf-prd order 12, 2026-08-18). The WSDL types `Code` as a bare
+      # `s:string` with no facets, so the rule is server-side and undiscoverable
+      # from the schema; these codes are therefore deliberately conservative —
+      # uppercase alphanumerics only, comfortably short.
+      #
+      # `InsertCustomer` upserts BY `Code`, so the code identifies the CUSTOMER,
+      # not the order. Anything per-order would create a fresh KashFlow customer
+      # on every purchase instead of updating the existing one.
+
+      # @return [String] format for a registered user's code, keyed on the Spree
+      #   user id so it survives the customer changing their email address.
+      USER_CODE_FORMAT = "SPU%d"
+
+      # @return [String] format for a guest's code. Guests have no stable id, so
+      #   the normalised email is hashed — same email in, same code out, which is
+      #   what keeps the upsert an update rather than a duplicate.
+      GUEST_CODE_FORMAT = "SPG%s"
+
+      # @return [Integer] hex characters of the email digest kept in a guest code.
+      #   12 hex chars is 48 bits: collision-safe at any plausible customer count
+      #   while leaving the total code short.
+      GUEST_CODE_DIGEST_LENGTH = 12
+
+      # @return [Integer] the longest code this presenter will emit. KashFlow does
+      #   not publish the limit in the WSDL; this is a conservative ceiling that
+      #   both formats stay well inside.
+      CODE_MAX_LENGTH = 20
+
       ##
       # @param order [Spree::Order] a completed order with a billing address
       #
@@ -43,7 +79,7 @@ module Spree
       #
       def to_h
         payload = {
-          "Code" => order.email,
+          "Code" => customer_code,
           "Name" => customer_name,
           "Email" => order.email,
           "Address1" => bill_address&.address1,
@@ -66,6 +102,41 @@ module Spree
       # @return [Spree::Order]
       attr_reader :order
 
+      ##
+      # The KashFlow customer reference. See {USER_CODE_FORMAT} for why this is
+      # keyed on the customer rather than the order, and why it is alphanumeric.
+      #
+      # The order-number fallback is unreachable for a completed order — Spree
+      # validates email presence — but it exists so a blank email cannot collapse
+      # every such order onto one shared code, which would merge unrelated
+      # customers into a single KashFlow record.
+      #
+      # @return [String] an uppercase-alphanumeric customer code
+      #
+      def customer_code
+        return format(USER_CODE_FORMAT, order.user_id) if order.user_id.present?
+        return order.number if normalized_email.blank?
+
+        format(GUEST_CODE_FORMAT, email_digest)
+      end
+
+      ##
+      # @return [String] the order email, lowercased and stripped, so that the
+      #   same guest is not split across several KashFlow customers by casing or
+      #   stray whitespace
+      #
+      def normalized_email
+        order.email.to_s.strip.downcase
+      end
+
+      ##
+      # @return [String] the leading {GUEST_CODE_DIGEST_LENGTH} hex characters of
+      #   the normalised email's SHA-256, uppercased
+      #
+      def email_digest
+        Digest::SHA256.hexdigest(normalized_email)[0, GUEST_CODE_DIGEST_LENGTH].upcase
+      end
+
       ##
       # Nullable on purpose. A digital-only order can complete with no billing
       # address at all, and a `NoMethodError` here would escape the sync job's

data/lib/spree/kashflow/client.rb

@@ -182,7 +182,8 @@ module Spree
       #
       def call(operation, message = {})
         credentials = {"UserName" => @username, "Password" => @password}
-        response = savon_client.call(operation, message: credentials.merge(message))
+        body = coerce_temporal(credentials.merge(message))
+        response = savon_client.call(operation, message: body)
         body = response.body
         assert_status!(body)
         body
@@ -195,6 +196,48 @@ module Spree
         raise TransportError, e.message
       end
 
+      ##
+      # Rewrites every temporal value in an outgoing message to xsd `dateTime`.
+      #
+      # KashFlow types every date field in the WSDL as `s:dateTime`, and its
+      # .NET `XmlSerializer` rejects the *entire* envelope with a
+      # `FormatException` ("is not a valid AllXsd value") when one of them is
+      # not valid xsd — the invoice is never created, and the fault names only
+      # a character offset, not the field.
+      #
+      # Gyoku cannot be relied on to do this. It type-switches with
+      # `case/when`, i.e. `Module#===`, so:
+      # - `ActiveSupport::TimeWithZone` is a *delegator*, not a `Time`
+      #   subclass, and misses the branch entirely -> `to_s`
+      #   ("2026-08-18 10:53:48 UTC").
+      # - plain `Time` is likewise emitted via `to_s` by Gyoku 1.4.
+      # - `Date` serialises as `2026-08-18`, an xsd `date`, not the `dateTime`
+      #   the schema asks for.
+      #
+      # `Time.current` and every Active Record datetime attribute return
+      # `TimeWithZone`, so the broken path was the default one, which is why
+      # every caller was affected. Normalising here rather than at each call
+      # site keeps the wire format owned by the one class that touches the
+      # wire, and means a date field added to any future payload is correct
+      # without the author having to know this.
+      #
+      # Values are converted to UTC first so the instant is preserved and the
+      # emitted form is unambiguous (`...Z`) regardless of the app's zone.
+      #
+      # @param value [Object] any message value; Hashes and Arrays are walked
+      # @return [Object] the value with temporals replaced by xsd strings
+      #
+      def coerce_temporal(value)
+        case value
+        when Hash then value.transform_values { |element| coerce_temporal(element) }
+        when Array then value.map { |element| coerce_temporal(element) }
+        when ActiveSupport::TimeWithZone, Time then value.utc.xmlschema
+        when DateTime then value.to_time.utc.xmlschema
+        when Date then value.to_time(:utc).xmlschema
+        else value
+        end
+      end
+
       ##
       # KashFlow reports business-level rejections *in band*: the SOAP call
       # succeeds at HTTP 200 with an empty result element and a `Status` /

data/lib/spree/kashflow/version.rb

@@ -2,6 +2,6 @@
 
 module Spree
   module Kashflow
-    VERSION = "0.1.0"
+    VERSION = "0.1.2"
   end
 end

data/lib/spree/kashflow.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "digest"
 require "spree/core"
 require "savon"
 require "spree/kashflow/version"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spree-kashflow
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Aypex