digiwin_dsp 0.2.2 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85730a801ceb67eaeafaffe50bdbdcf971c33005651e2c3d4483a78f1e076bc4
-  data.tar.gz: a8e441947b5b0b99a437d8572181a29aeac923890fdf76dcff7ef44c7a88e412
+  metadata.gz: feebd7c9c5d89e9d6306b00ecccb402151c9e299201ecf3b98cfbf7c9a1590a1
+  data.tar.gz: 7c9fbb5aa913649c417a4f23caf6bf9f3b10bc92b6c2efb34e9cc1cdce8808ad
 SHA512:
-  metadata.gz: 1b79afb15f4661863fbf0a0cff9a6ac8812fc1d36c52cae6119d488f8eef8fcde5913cecbca5974ae4df2cda4f2cd3bfaf4c7405413a456c1a0afb06d738d139
-  data.tar.gz: 33a97756f3d48e8384631b7706ba5bf8a8bf83586221315d24a71710284494ff4ebb3d013c4aa8ec0fc2254aa9dd9448d0f1e33714dc279870d477e5b0b057df
+  metadata.gz: 292e2d148f9af342959a826cbed33999cbd81b169719fa79882b309bfdfb6b1800e88ed18dfcd3d0210784d85f7df9dea1e02e63b0a0f9e67e276e235c7c403d
+  data.tar.gz: 437cd4412d96aa9914b99cea75ca5ce06274870aada7a2462b53d64e18eb5ebb03b9dbee07bd78cadab08880652aabe49e7ce88ff987c043be7530ff031c3712

data/CHANGELOG.md

@@ -6,6 +6,45 @@ The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and
 
 ## [Unreleased]
 
+## [0.2.4] - 2026-05-22
+
+### Added
+
+- **`Resources::Base`** — shared parent for the 4 resource classes. Each subclass now declares two constants (`PATH`, `SERIALIZER`); the `.create` class shortcut, `#create` instance flow, and the `response_detail` safety check live in one place.
+- **VCR replay coverage.** New `spec/digiwin_dsp/live_replay_spec.rb` + cassettes under `spec/fixtures/cassettes/` verify the gem parses real DSP UAT responses correctly. Credentials filtered via `spec/support/vcr.rb`. Re-record with `RECORD_CASSETTES=1` + real env vars.
+- **`dotenv` auto-loaded in `bin/console`.** Drops a `.env.local` into the IRB session so manual UAT testing is plug-and-play (`bin/console` → `DigiwinDsp::Resources::Order.create(...)`).
+- **GitHub Release auto-created by `release.yml`.** Workflow now extracts the version's CHANGELOG section and posts it with the built `.gem` artifact — no more manual `gh release create` after each version bump.
+
+### Docs
+
+- Idempotency section in README clarified: DSP UAT ignores `X-Idempotency-Key` (live-verified). Dedup is natural-key only (`form_no + platform_id`). The kwarg is still useful as a trace ID.
+
+## [0.2.3] - 2026-05-22
+
+### Docs
+
+- Document the `order_status` enum (`"2"` cancel / `"3"` new / `"5"` invoice / `"7"` return) in README and `docs/dsp-api-spec.md`. DSP rejects others with `WrongStatus:order_status錯誤，請固定給N(...)`. All four live-verified against UAT. The OpenAPI examples don't surface this constraint, so live smoke had to discover each value.
+
+### Changed
+
+- `scripts/smoke.rb` accepts `ORDER_STATUS=…` env override so operators can probe DSP's WrongStatus path without editing the script.
+
+## [0.2.2] - 2026-05-21
+
+### Fixed
+
+- **`Message:"DSP 序號驗證失敗"` now classifies as
+  `DigiwinDsp::AuthenticationError`.** Discovered via live UAT smoke
+  test: when the `DSP-api-key` header is missing or invalid, DSP
+  returns HTTP 200 (not 401/403) with `Status:Failure` and that
+  message. Previously fell through to generic `Error`, defeating
+  typed-rescue logic.
+
+### Docs
+
+- `docs/dsp-api-spec.md` documents the auth-failure envelope shape +
+  the form_no-prefix behavior on `Message`.
+
 ## [0.2.1] - 2026-05-21
 
 ### Fixed
@@ -140,7 +179,9 @@ Initial release. Covers the four Self-hosted Website Module (自有官網模組)
 - The gem is **synchronous on purpose**. Callers wrap requests in their own background job runner (e.g. ActiveJob) when needed.
 - Idempotency: clients can send `X-Idempotency-Key` via the `idempotency_key:` kwarg. DSP also dedupes server-side by `form_no + platform_id`.
 
-[Unreleased]: https://github.com/7a6163/digiwin_dsp/compare/v0.2.2...HEAD
+[Unreleased]: https://github.com/7a6163/digiwin_dsp/compare/v0.2.4...HEAD
+[0.2.4]: https://github.com/7a6163/digiwin_dsp/compare/v0.2.3...v0.2.4
+[0.2.3]: https://github.com/7a6163/digiwin_dsp/compare/v0.2.2...v0.2.3
 [0.2.2]: https://github.com/7a6163/digiwin_dsp/compare/v0.2.1...v0.2.2
 [0.2.1]: https://github.com/7a6163/digiwin_dsp/compare/v0.2.0...v0.2.1
 [0.2.0]: https://github.com/7a6163/digiwin_dsp/compare/v0.1.1...v0.2.0

data/README.md

@@ -141,6 +141,17 @@ Each has its own required-field set (8 / 11 / 19 fields respectively). Inspect `
 DigiwinDsp::Serializers::CancellationSerializer::REQUIRED_FIELDS
 ```
 
+### `order_status` enum
+
+Each endpoint requires a specific `order_status` value inside `request_detail`. DSP rejects others with `WrongStatus:order_status錯誤，請固定給N(...)`. The OpenAPI examples don't document this — verified live against UAT 2026-05-21:
+
+| Resource | `order_status` | Meaning |
+|---|---|---|
+| `Resources::Order` | `"3"` | 新增訂單 (new order) |
+| `Resources::Cancellation` | `"2"` | 取消訂單 (cancel order) |
+| `Resources::Invoice` | `"5"` | 發票更新 (invoice update) |
+| `Resources::Return` | `"7"` | 退貨訂單 (return order) |
+
 ### Idempotency
 
 Pass `idempotency_key:` to attach an `X-Idempotency-Key` request header. DSP also dedupes server-side by `form_no + platform_id` and returns `Duplicated:訂單不可重複` on a re-send (mapped to `DuplicateRequestError`).

data/lib/digiwin_dsp/resources/base.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module DigiwinDsp
+  module Resources
+    # Subclasses declare two constants:
+    #   PATH       — endpoint path (e.g. "/v1/SalesOrder/add")
+    #   SERIALIZER — a module/class responding to `.serialize(records, digi_header:)`
+    #
+    # Base then handles the .create class shortcut, the instance #create flow,
+    # and the response_detail safety check.
+    class Base
+      def self.create(records, idempotency_key: nil, digi_header: nil)
+        new.create(records, idempotency_key: idempotency_key, digi_header: digi_header)
+      end
+
+      def initialize(client = Client.new)
+        @client = client
+      end
+
+      def create(records, idempotency_key: nil, digi_header: nil)
+        body = self.class::SERIALIZER.serialize(records, digi_header: digi_header)
+        response = @client.post(self.class::PATH, body, idempotency_key: idempotency_key)
+        response.fetch("response_detail") do
+          raise DigiwinDsp::ServerError, "DSP returned Status=Success without response_detail"
+        end
+      end
+    end
+  end
+end

data/lib/digiwin_dsp/resources/cancellation.rb

@@ -2,24 +2,9 @@
 
 module DigiwinDsp
   module Resources
-    class Cancellation
+    class Cancellation < Base
       PATH = "/v1/SalesOrder/cancel"
-
-      def self.create(records, idempotency_key: nil, digi_header: nil)
-        new.create(records, idempotency_key: idempotency_key, digi_header: digi_header)
-      end
-
-      def initialize(client = Client.new)
-        @client = client
-      end
-
-      def create(records, idempotency_key: nil, digi_header: nil)
-        body = Serializers::CancellationSerializer.serialize(records, digi_header: digi_header)
-        response = @client.post(PATH, body, idempotency_key: idempotency_key)
-        response.fetch("response_detail") do
-          raise DigiwinDsp::ServerError, "DSP returned Status=Success without response_detail"
-        end
-      end
+      SERIALIZER = Serializers::CancellationSerializer
     end
   end
 end

data/lib/digiwin_dsp/resources/invoice.rb

@@ -2,24 +2,9 @@
 
 module DigiwinDsp
   module Resources
-    class Invoice
+    class Invoice < Base
       PATH = "/v1/SalesOrder/invoice"
-
-      def self.create(records, idempotency_key: nil, digi_header: nil)
-        new.create(records, idempotency_key: idempotency_key, digi_header: digi_header)
-      end
-
-      def initialize(client = Client.new)
-        @client = client
-      end
-
-      def create(records, idempotency_key: nil, digi_header: nil)
-        body = Serializers::InvoiceSerializer.serialize(records, digi_header: digi_header)
-        response = @client.post(PATH, body, idempotency_key: idempotency_key)
-        response.fetch("response_detail") do
-          raise DigiwinDsp::ServerError, "DSP returned Status=Success without response_detail"
-        end
-      end
+      SERIALIZER = Serializers::InvoiceSerializer
     end
   end
 end

data/lib/digiwin_dsp/resources/order.rb

@@ -2,24 +2,9 @@
 
 module DigiwinDsp
   module Resources
-    class Order
+    class Order < Base
       PATH = "/v1/SalesOrder/add"
-
-      def self.create(records, idempotency_key: nil, digi_header: nil)
-        new.create(records, idempotency_key: idempotency_key, digi_header: digi_header)
-      end
-
-      def initialize(client = Client.new)
-        @client = client
-      end
-
-      def create(records, idempotency_key: nil, digi_header: nil)
-        body = Serializers::SalesOrderSerializer.serialize(records, digi_header: digi_header)
-        response = @client.post(PATH, body, idempotency_key: idempotency_key)
-        response.fetch("response_detail") do
-          raise DigiwinDsp::ServerError, "DSP returned Status=Success without response_detail"
-        end
-      end
+      SERIALIZER = Serializers::SalesOrderSerializer
     end
   end
 end

data/lib/digiwin_dsp/resources/return.rb

@@ -2,24 +2,9 @@
 
 module DigiwinDsp
   module Resources
-    class Return
+    class Return < Base
       PATH = "/v1/SalesOrder/return"
-
-      def self.create(records, idempotency_key: nil, digi_header: nil)
-        new.create(records, idempotency_key: idempotency_key, digi_header: digi_header)
-      end
-
-      def initialize(client = Client.new)
-        @client = client
-      end
-
-      def create(records, idempotency_key: nil, digi_header: nil)
-        body = Serializers::ReturnSerializer.serialize(records, digi_header: digi_header)
-        response = @client.post(PATH, body, idempotency_key: idempotency_key)
-        response.fetch("response_detail") do
-          raise DigiwinDsp::ServerError, "DSP returned Status=Success without response_detail"
-        end
-      end
+      SERIALIZER = Serializers::ReturnSerializer
     end
   end
 end

data/lib/digiwin_dsp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DigiwinDsp
-  VERSION = "0.2.2"
+  VERSION = "0.2.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: digiwin_dsp
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.4
 platform: ruby
 authors:
 - Zac
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-05-21 00:00:00.000000000 Z
+date: 2026-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -68,6 +68,7 @@ files:
 - lib/digiwin_dsp/authenticator.rb
 - lib/digiwin_dsp/client.rb
 - lib/digiwin_dsp/configuration.rb
+- lib/digiwin_dsp/resources/base.rb
 - lib/digiwin_dsp/resources/cancellation.rb
 - lib/digiwin_dsp/resources/invoice.rb
 - lib/digiwin_dsp/resources/order.rb