+Payment, PaymentTerm, PaymentService

+Custom DTD
FriendsOfCXML · Jan 27, 2025 · 114913e · 114913e
1 parent 1e6069b
commit 114913e
Show file tree

Hide file tree

Showing 9 changed files with 225 additions and 3 deletions.
diff --git a/src/CXml/Model/Classification.php b/src/CXml/Model/Classification.php
@@ -6,7 +6,6 @@
 
 use JMS\Serializer\Annotation as Serializer;
 
-#[Serializer\AccessorOrder(order: 'custom', custom: ['value'])]
 readonly class Classification
 {
     public function __construct(

diff --git a/src/CXml/Model/Payment.php b/src/CXml/Model/Payment.php
@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CXml\Model;
+
+use JMS\Serializer\Annotation as Serializer;
+
+class Payment
+{
+
+    public function __construct(
+        #[Serializer\XmlElement]
+        #[Serializer\SerializedName('PaymentService')]
+        private PaymentService $paymentService)
+    {
+    }
+
+    public function getPaymentService(): PaymentService
+    {
+        return $this->paymentService;
+    }
+
+}
diff --git a/src/CXml/Model/PaymentService.php b/src/CXml/Model/PaymentService.php
@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CXml\Model;
+
+use JMS\Serializer\Annotation as Serializer;
+
+class PaymentService
+{
+
+    use IdReferencesTrait;
+    use ExtrinsicsTrait;
+
+    public function __construct(
+        #[Serializer\XmlAttribute]
+        readonly private string $method,
+        #[Serializer\XmlAttribute]
+        readonly private ?string $provider = null)
+    {}
+
+    public function getMethod(): string
+    {
+        return $this->method;
+    }
+
+    public function getProvider(): ?string
+    {
+        return $this->provider;
+    }
+
+}
diff --git a/src/CXml/Model/PaymentTerm.php b/src/CXml/Model/PaymentTerm.php
@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CXml\Model;
+
+use JMS\Serializer\Annotation as Serializer;
+
+class PaymentTerm
+{
+
+    use ExtrinsicsTrait;
+
+    public function __construct(
+        #[Serializer\XmlAttribute]
+        private int $payInNumberOfDays)
+    {}
+
+}
diff --git a/src/CXml/Model/Request/OrderRequestHeader.php b/src/CXml/Model/Request/OrderRequestHeader.php
@@ -12,14 +12,16 @@
 use CXml\Model\ExtrinsicsTrait;
 use CXml\Model\IdReferencesTrait;
 use CXml\Model\MoneyWrapper;
+use CXml\Model\Payment;
+use CXml\Model\PaymentTerm;
 use CXml\Model\Shipping;
 use CXml\Model\ShipTo;
 use CXml\Model\SupplierOrderInfo;
 use CXml\Model\Tax;
 use DateTimeInterface;
 use JMS\Serializer\Annotation as Serializer;
 
-#[Serializer\AccessorOrder(order: 'custom', custom: ['total', 'shipTo', 'billTo', 'businessPartners', 'shipping', 'tax', 'contacts', 'comments', 'supplierOrderInfo', 'idReferences', 'extrinsics'])]
+#[Serializer\AccessorOrder(order: 'custom', custom: ['total', 'shipTo', 'billTo', 'businessPartners', 'shipping', 'tax', 'payment', 'paymentTerm', 'contacts', 'comments', 'supplierOrderInfo', 'idReferences', 'extrinsics'])]
 class OrderRequestHeader
 {
     use CommentsTrait;
@@ -36,6 +38,14 @@ class OrderRequestHeader
     #[Serializer\SerializedName('Tax')]
     private ?Tax $tax = null;
 
+    #[Serializer\XmlElement]
+    #[Serializer\SerializedName('Payment')]
+    private ?Payment $payment = null;
+
+    #[Serializer\XmlElement]
+    #[Serializer\SerializedName('PaymentTerm')]
+    private ?PaymentTerm $paymentTerm = null;
+
     #[Serializer\SerializedName('SupplierOrderInfo')]
     private ?SupplierOrderInfo $supplierOrderInfo = null;
 
@@ -168,4 +178,24 @@ public function addBusinessPartner(BusinessPartner $businessPartner): void
     {
         $this->businessPartners[] = $businessPartner;
     }
+
+    public function getPayment(): ?Payment
+    {
+        return $this->payment;
+    }
+
+    public function setPayment(?Payment $payment): void
+    {
+        $this->payment = $payment;
+    }
+
+    public function getPaymentTerm(): ?PaymentTerm
+    {
+        return $this->paymentTerm;
+    }
+
+    public function setPaymentTerm(?PaymentTerm $paymentTerm): void
+    {
+        $this->paymentTerm = $paymentTerm;
+    }
 }
diff --git a/src/CXml/Validation/DtdValidator.php b/src/CXml/Validation/DtdValidator.php
@@ -39,6 +39,9 @@ public function validateAgainstDtd(string $xml): void
         $old->loadXML($xml);
 
         $validateFiles = ['cXML.dtd', 'Fulfill.dtd', 'Quote.dtd'];
+        if (file_exists($this->pathToCxmlDtds . '/Custom.dtd')) {
+            $validateFiles[] = 'Custom.dtd';
+        }
 
         $this->validateAgainstMultipleDtd($validateFiles, $old);
 

diff --git a/tests/CXmlTest/Handling/HandlerTest.php b/tests/CXmlTest/Handling/HandlerTest.php
@@ -35,6 +35,11 @@ public static function getEndpointData(): iterable
             'QuoteMessage',
         ];
 
+        yield [
+            self::loadFixture('order_request.xml'),
+            'OrderRequest',
+        ];
+
         // TODO add more cases
     }
 
@@ -47,7 +52,7 @@ private static function loadFixture(string $filename): ?string
     public function testEndpoint(string $requestCxml, string $expectedHandlerCalled): void
     {
         $serializer = Serializer::create();
-        $messageValidator = new DtdValidator(__DIR__ . '/../../metadata/cxml/dtd/1.2.050/');
+        $messageValidator = new DtdValidator(__DIR__ . '/../../metadata/cxml/dtd/1.2.050');
 
         $credentialRepository = new Registry();
         $credentialRepository->registerCredential(
@@ -90,8 +95,28 @@ public function handle(PayloadInterface $payload, Context $context): ?ResponsePa
             }
         };
 
+        $orderRequestHandler = new class($actualHandlerCalled) implements HandlerInterface {
+            public function __construct(private string &$actualHandlerCalled)
+            {
+            }
+
+            public static function getRequestName(): string
+            {
+                return 'OrderRequest';
+            }
+
+            public function handle(PayloadInterface $payload, Context $context): ?ResponsePayloadInterface
+            {
+                $this->actualHandlerCalled = 'OrderRequest';
+
+                return null;
+            }
+        };
+
+
         $handlerRegistry = new HandlerRegistry();
         $handlerRegistry->register($quoteMessageHandler);
+        $handlerRegistry->register($orderRequestHandler);
 
         $builder = Builder::create();
 

diff --git a/tests/CXmlTest/Handling/fixtures/order_request.xml b/tests/CXmlTest/Handling/fixtures/order_request.xml
@@ -0,0 +1,80 @@
+<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE cXML SYSTEM "http://xml.cxml.org/schemas/cXML/1.2.060/cXML.dtd">
+<cXML payloadID="1737963337.319.1846511.7249@eu-hub" timestamp="2025-01-27T07:35:37+00:00">
+    <Header>
+        <From>
+            <Credential domain="NetworkId">
+                <Identity>AN00000123</Identity>
+            </Credential>
+        </From>
+        <To>
+            <Credential domain="NetworkId">
+                <Identity>AN00000456</Identity>
+            </Credential>
+        </To>
+        <Sender>
+            <Credential domain="NetworkId">
+                <Identity>AN00000123</Identity>
+                <SharedSecret>Secret!123</SharedSecret>
+            </Credential>
+            <UserAgent>Suppliers Super Order Processor</UserAgent>
+        </Sender>
+    </Header>
+    <Request deploymentMode="test">
+        <OrderRequest>
+            <OrderRequestHeader orderID="acme-1-1" orderDate="2025-01-27T07:35:36+00:00" type="new" requestedDeliveryDate="2025-01-28T23:00:00+00:00">
+                <Total>
+                    <Money currency="USD">10.00</Money>
+                </Total>
+                <ShipTo>
+                    <Address>
+                        <Name xml:lang="en">TEST.USA ACME</Name>
+                        <PostalAddress>
+                            <DeliverTo>ACME</DeliverTo>
+                            <DeliverTo>TEST.USA</DeliverTo>
+                            <Street>22 E 4th Ave</Street>
+                            <City>Columbus</City>
+                            <State>OH</State>
+                            <PostalCode>43201-3551</PostalCode>
+                            <Country isoCountryCode="US">United States</Country>
+                            <Extrinsic name="phone">+49121255566</Extrinsic>
+                        </PostalAddress>
+                    </Address>
+                </ShipTo>
+                <BillTo>
+                    <Address>
+                        <Name xml:lang="en">TEST.USA ACME</Name>
+                        <PostalAddress>
+                            <DeliverTo>ACME</DeliverTo>
+                            <DeliverTo>TEST.USA</DeliverTo>
+                            <Street>22 E 4th Ave</Street>
+                            <City>Columbus</City>
+                            <State>OH</State>
+                            <PostalCode>43201-3551</PostalCode>
+                            <Country isoCountryCode="US">United States</Country>
+                        </PostalAddress>
+                    </Address>
+                </BillTo>
+                <Payment>
+                    <PaymentService method="cc" provider="stripe">
+                        <IdReference identifier="ch_..." domain="charge_id"/>
+                        <IdReference identifier="pi_..." domain="intent_id"/>
+                    </PaymentService>
+                </Payment>
+            </OrderRequestHeader>
+            <ItemOut lineNumber="1" quantity="1">
+                <ItemID>
+                    <SupplierPartID>QA-ACME-AUTOTEST</SupplierPartID>
+                    <BuyerPartID>QA-ACME-AUTOTEST</BuyerPartID>
+                </ItemID>
+                <ItemDetail>
+                    <UnitPrice>
+                        <Money currency="USD">10.00</Money>
+                    </UnitPrice>
+                    <Description xml:lang="en">Testing</Description>
+                    <UnitOfMeasure>EA</UnitOfMeasure>
+                    <Classification domain="supplier_part_id">QA-ACME-AUTOTEST</Classification>
+                </ItemDetail>
+            </ItemOut>
+        </OrderRequest>
+    </Request>
+</cXML>
diff --git a/tests/metadata/cxml/dtd/1.2.050/Custom.dtd b/tests/metadata/cxml/dtd/1.2.050/Custom.dtd
@@ -0,0 +1,10 @@
+<!ENTITY % cxml.payment  "( PCard | PaymentService )">
+
+<!ENTITY % elements SYSTEM "./cXML.dtd">
+%elements;
+
+<!ELEMENT PaymentService (IdReference*, Extrinsic*)>
+<!ATTLIST PaymentService
+        method CDATA #REQUIRED
+        provider CDATA #IMPLIED
+        >