spree-kashflow 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff9334bd3e09ee1cdb9965f3eddc61af9d887161dd95901c9b54bc6feaf15cdc
-  data.tar.gz: 7e4576dd85f13c15326591811c0d05a6efa17de61a44e1b82b6a62fca8dd0717
+  metadata.gz: b2346845707634b7353b64e8d2a982136ead6009e47f7b1ea5b94d1e905b5455
+  data.tar.gz: 2a238745c13d9cd5a6cf0fde8e2854b2a7bc9c12c3ad35df25e396ea0d8a7159
 SHA512:
-  metadata.gz: d55939c427bc7154665e69801126b67a35cc95f01024f9303f9d380377b3b290db422ce3e67cd802c98465a65db9b85bdb47f01c015e84340062bdcebe60856a
-  data.tar.gz: b785bbb7a59d6a80686fe13b3cab2f37b83e4d7d7d97d87369c13c09a469852a76604a51d431f5a6e433953ce1e1242feb68f67ffecc10397ee5dff8576f28e7
+  metadata.gz: ff74935654982f15a9094b50b36a26d1507705b33955444df4d9490c7511d51008c6c01cd92c42ff036475f5eb7d5ad475e820aa3ddee699fe9c35d895681956
+  data.tar.gz: ecca24ec4c22aef839778a214b0a62e206588836810cb012ac762151e08ef9aed538a5e0c5b8c5a8c90ca21151658003b644691437ac19e4a8244d68a8b46438

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 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/version.rb

@@ -2,6 +2,6 @@
 
 module Spree
   module Kashflow
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   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.1
 platform: ruby
 authors:
 - Aypex