spree-kashflow 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d20212552f51bc299bb20645fc8f5dbca833b2bdb63a1678d752b29a15f00a17
-  data.tar.gz: fb65959bc02ff1ac1b1eb7b38257ca03b9fba95386efb49b40baf91378b7c0bb
+  metadata.gz: bf3ea17173c688a2ae5facaa72f582c02b2bb56b3d013d4d64e7467104b200b6
+  data.tar.gz: 14b81280691c79a6d6501cb4ae1e173a1e094be9c504bf90bcfb7de9cb40bc93
 SHA512:
-  metadata.gz: a257c8a10a8576b39a5b58613568cc1faf751f3fa28caa505df9d190404be40d12e0e52272a48c3f2f141cc7e2b0c540b59bf32bb2501d7c2dd60b01b31ecf9b
-  data.tar.gz: 19f304c825178155659864ba3b064507ade831b27632d385befd8d27a60f84ccd74471b0eef8ce94cea0f1bd1391ce900fc034af404377e578d87e292527a276
+  metadata.gz: 4909476c53475670965c33e28bf2ec279e7551bbac94a7a43ddd3777d72577569eb84ec7fc9d216f23afa79c7e2989efef18a3deb8757fea76c20fdc04c51d2e
+  data.tar.gz: 289bc0e640aab7cea52cb96c2b019a00dd11e9bc010035b45056d947990152317755863978b5d16e071b5196a19ffc24429d9544c1fd9de7dfd34244a300f19e

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## 0.1.3
+
+- **Fix: `upsert_customer` only ever inserted.** KashFlow publishes no
+  `InsertOrUpdateCustomer`, and the client called `InsertCustomer`
+  unconditionally with no lookup. 0.1.1 made customer codes stable per customer
+  — which is what keeps one KashFlow customer per Spree customer rather than one
+  per order — and that turned the missing lookup into a hard failure: the insert
+  succeeded exactly once, and the same customer's *second* order was rejected
+  with `Customer Code is not unique`, posting no invoice. `upsert_customer` now
+  looks the code up with `GetCustomer` and either `UpdateCustomer`s the existing
+  record or `InsertCustomer`s a new one, so it is idempotent across repeated
+  syncs.
+- `CustomerID` is prepended to the update payload rather than merged onto the
+  end, because it is the first element of the WSDL's `Customer` sequence and an
+  ASMX endpoint enforcing that sequence drops or mis-binds an out-of-order
+  element rather than raising — an update whose id was dropped would write to
+  the wrong customer, or to none, and still return successfully.
+- How KashFlow signals "no such customer" on `GetCustomer` is undocumented, so
+  both plausible shapes are treated as absent: an empty result, and an in-band
+  business rejection. Only `ApiError` is swallowed; an authentication or
+  transport failure keeps propagating rather than being read as "absent" and
+  turned back into a duplicate insert.
+
 ## 0.1.2
 
 - **Fix: every order sync still failed against a live KashFlow account**, now on

data/lib/spree/kashflow/client.rb

@@ -87,14 +87,28 @@ module Spree
       end
 
       ##
-      # Creates or updates a customer in KashFlow.
-      #
-      # @param payload [Hash] a KashFlow `Customer` structure
-      # @return [Integer] the KashFlow customer id
+      # Creates or updates a customer in KashFlow, keyed on the customer `Code`.
+      #
+      # KashFlow publishes no `InsertOrUpdateCustomer`, so an upsert is a lookup
+      # followed by an `UpdateCustomer` or an `InsertCustomer`. The lookup is not
+      # optional: customer codes are stable per customer (that is what keeps one
+      # KashFlow customer per Spree customer rather than one per order), so an
+      # unconditional insert succeeds exactly once and every subsequent order for
+      # that customer is rejected with "Customer Code is not unique" — with no
+      # invoice posted.
+      #
+      # @param payload [Hash] a KashFlow `Customer` structure, whose `"Code"`
+      #   identifies the customer
+      # @return [Integer] the KashFlow customer id, existing or newly assigned
       # @raise [Spree::Kashflow::ApiError] when the request fails, or when
       #   KashFlow returns no usable customer id
+      # @raise [Spree::Kashflow::AuthenticationError] when KashFlow rejects the
+      #   credentials
       #
       def upsert_customer(payload)
+        existing_id = customer_id_for_code(payload["Code"])
+        return update_customer(existing_id, payload) if existing_id
+
         response = call(:insert_customer, {"custr" => payload})
         result = response.dig("InsertCustomerResponse", "InsertCustomerResult")
         assert_identifier!(result, "customer id")
@@ -196,6 +210,55 @@ module Spree
         raise TransportError, e.message
       end
 
+      ##
+      # Looks a customer up by its KashFlow `Code`.
+      #
+      # How KashFlow signals "no such customer" here is undocumented, and no
+      # spec that stubs the SOAP layer can settle it, so both shapes it can
+      # plausibly take are treated as absent: an empty `GetCustomerResult`, and
+      # an in-band business rejection. Only {ApiError} is swallowed — an
+      # authentication or transport failure must keep propagating, since
+      # reading either as "absent" would turn it into a duplicate insert and
+      # put the caller back on the collision this method exists to avoid.
+      #
+      # @param code [String, nil] the KashFlow customer code
+      # @return [Integer, nil] the customer id, or nil when no customer holds
+      #   that code
+      #
+      def customer_id_for_code(code)
+        return nil if code.to_s.strip.empty?
+
+        result = call(:get_customer, {"CustomerCode" => code})
+          .dig("GetCustomerResponse", "GetCustomerResult")
+        return nil unless result.is_a?(Hash)
+
+        identifier = result["CustomerID"].to_i
+        identifier.zero? ? nil : identifier
+      rescue ApiError
+        nil
+      end
+
+      ##
+      # Updates an existing KashFlow customer in place.
+      #
+      # `CustomerID` is prepended rather than merged onto the end because it is
+      # the first element of the WSDL's `Customer` sequence, and an ASMX
+      # endpoint enforcing that sequence drops or mis-binds an out-of-order
+      # element rather than raising — an update whose id was dropped would write
+      # to the wrong customer, or to none, and still return successfully.
+      #
+      # `UpdateCustomerResult` is a `s:string`, not the customer id, so the id
+      # is carried over from the lookup instead of being read off the response.
+      #
+      # @param identifier [Integer] the KashFlow customer id
+      # @param payload [Hash] a KashFlow `Customer` structure
+      # @return [Integer] the customer id that was updated
+      #
+      def update_customer(identifier, payload)
+        call(:update_customer, {"custr" => {"CustomerID" => identifier}.merge(payload)})
+        identifier
+      end
+
       ##
       # Rewrites every temporal value in an outgoing message to xsd `dateTime`.
       #

data/lib/spree/kashflow/version.rb

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

metadata

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