Version 2.7.4

Author: eclipxe13

docs/CHANGELOG.md

@@ -11,6 +11,16 @@
 - Remove `static` methods from `\CfdiUtils\CfdiVersion`, instead create an instance of the class
 - Remove `static` methods from `\CfdiUtils\TimbreFiscalDigital\TfdVersion`, instead create an instance of the class
 - Remove `trigger_error` on `\CfdiUtils\Elements\Cfdi33\Comprobante::getCfdiRelacionados` when called with arguments.
+- Refactor `\CfdiUtils\Certificado\SerialNumber` to be immutable, this change will remove `loadHexadecimal`,
+  `loadDecimal` and `loadAscii`.
+
+## Version 2.7.4 2018-12-12
+
+- Add `CfdiUtils\Certificado\Certificado::getSerialObject` to return **a copy** of the instance
+  of `CfdiUtils\Certificado\SerialNumber` in case is required.
+- Add `CfdiUtils\Certificado\SerialNumber::loadAscii` helper function
+- Improve tests on `SerialNumberTest` to include `loadAscii`
+- Improve tests on `CertificadoTest` to include `getSerialObject`
 
 
 ## Version 2.7.3 2018-12-05

docs/componentes/certificado.md

@@ -62,13 +62,31 @@ var_dump($certificate->getRfc()); // algo como COSC8001137NA
 ```
 
 
+## Números de serie del certificado
+
+En el número de serie requerido en los CFDI se utiliza una representación ASCII y no hexadecimal, sin embargo
+en algunas ocasiones se podría necesitar el número en formato hexadecimal de dos dígitos o la representación decimal.
+
+El objeto `Certificado` contiene internamente un objeto de tipo `SerialNumber` que del que se puede obtener **una copia**
+por el método `getSerialObject(): SerialNumber` y dicho objeto puede devolver el número de serie en tres diferentes formatos:
+
+- `SerialNumber::asAscii()`: `30001000000300023708` el mismo que se devuelve en `Certificado::getSerial()`
+- `SerialNumber::getHexadecimal()`: `3330303031303030303030333030303233373038`
+- `SerialNumber::getDecimal()`: `292233162870206001759766198425879490508935868472`
+
+!!! note ""
+    Se obtiene una copia del objeto y no la misma instancia porque el `SerialNumber` es mutable, a partir de la
+    versión 3 el objeto será inmutable y se podrá obtener el objeto de la propia instancia.
+
+
 ## Acerca de los formatos de archivo
 
 El certificado (el archivo extensión CER) puede ser leído directamente.
 
 La llave privada (el archivo extensión KEY) debe ser convertido a tipo PEM
 para ser correctamente interpretado por esta clase (en realidad por PHP).
 
+
 ## Comandos útiles de openssl
 
 - Obtener información del certificado:

src/CfdiUtils/Certificado/Certificado.php

@@ -12,7 +12,7 @@ class Certificado
     /** @var string */
     private $name;
 
-    /** @var string */
+    /** @var SerialNumber */
     private $serial;
 
     /** @var int */
@@ -76,7 +76,7 @@ public function __construct(string $filename)
         } else {
             throw new \RuntimeException("Cannot get serialNumberHex or serialNumber from certificate file $filename");
         }
-        $this->serial = $serial->asAscii();
+        $this->serial = $serial;
         $this->validFrom = $data['validFrom_time_t'] ?? 0;
         $this->validTo = $data['validTo_time_t'] ?? 0;
         $this->pubkey = $pubKey;
@@ -143,7 +143,12 @@ public function getName(): string
      */
     public function getSerial(): string
     {
-        return $this->serial;
+        return $this->serial->asAscii();
+    }
+
+    public function getSerialObject(): SerialNumber
+    {
+        return clone $this->serial;
     }
 
     /**

src/CfdiUtils/Certificado/SerialNumber.php

@@ -34,6 +34,11 @@ public function loadDecimal(string $decString)
         $this->loadHexadecimal($hexString);
     }
 
+    public function loadAscii(string $input)
+    {
+        $this->loadHexadecimal($this->asciiToHex($input));
+    }
+
     public function getHexadecimal(): string
     {
         return $this->hexString;
@@ -56,6 +61,13 @@ protected function hexToAscii(string $input): string
         }, '');
     }
 
+    protected function asciiToHex(string $input): string
+    {
+        return array_reduce(str_split($input, 1), function (string $carry, string $value): string {
+            return $carry . dechex(ord($value));
+        }, '');
+    }
+
     /**
      * Converts any string of any base to any other base without
      * PHP native method base_convert's double and float limitations.

tests/CfdiUtilsTests/Certificado/CertificadoTest.php

@@ -27,7 +27,7 @@ public function testConstructWithValidExample()
 
         $certificado = new Certificado($cerfile);
 
-        $this->assertEquals($cerfile, $certificado->getFilename());
+        $this->assertSame($cerfile, $certificado->getFilename());
         $certificateName = implode('', [
             '/CN=ACCEM SERVICIOS EMPRESARIALES SC',
             '/name=ACCEM SERVICIOS EMPRESARIALES SC',
@@ -36,13 +36,17 @@ public function testConstructWithValidExample()
             '/serialNumber= / HEGT761003MDFRNN09',
             '/OU=CSD01_AAA010101AAA',
         ]);
-        $this->assertEquals($certificateName, $certificado->getCertificateName());
-        $this->assertEquals('ACCEM SERVICIOS EMPRESARIALES SC', $certificado->getName());
-        $this->assertEquals('AAA010101AAA', $certificado->getRfc());
-        $this->assertEquals('30001000000300023708', $certificado->getSerial());
-        $this->assertEquals(strtotime('2017-05-18T03:54:56+00:00'), $certificado->getValidFrom());
-        $this->assertEquals(strtotime('2021-05-18T03:54:56+00:00'), $certificado->getValidTo());
-        $this->assertEquals($expectedPublicKey, $certificado->getPubkey());
+        $this->assertSame($certificateName, $certificado->getCertificateName());
+        $this->assertSame('ACCEM SERVICIOS EMPRESARIALES SC', $certificado->getName());
+        $this->assertSame('AAA010101AAA', $certificado->getRfc());
+        $this->assertSame('30001000000300023708', $certificado->getSerial());
+        $this->assertSame(
+            '3330303031303030303030333030303233373038',
+            $certificado->getSerialObject()->getHexadecimal()
+        );
+        $this->assertSame(strtotime('2017-05-18T03:54:56+00:00'), $certificado->getValidFrom());
+        $this->assertSame(strtotime('2021-05-18T03:54:56+00:00'), $certificado->getValidTo());
+        $this->assertSame($expectedPublicKey, $certificado->getPubkey());
     }
 
     public function testVerifyWithKnownData()
@@ -171,4 +175,16 @@ public function testCanReadRfcFromCertificateWhenX500UniqueIdentifierOnlyContain
         $certificate = new Certificado($certificateFile);
         $this->assertEquals('SOMG790807J57', $certificate->getRfc());
     }
+
+    public function testGetSerialObjectReturnsACopyOfTheObjectInsteadTheSameObject()
+    {
+        // remove this test on version 3 when the object SerialNumber is immutable
+        $certificateFile = $this->utilAsset('certs/00001000000301246267.cer');
+        $certificate = new Certificado($certificateFile);
+
+        $first = $certificate->getSerialObject();
+        $second = $certificate->getSerialObject();
+        $this->assertEquals($first, $second);
+        $this->assertNotSame($first, $second);
+    }
 }

tests/CfdiUtilsTests/Certificado/SerialNumberTest.php

@@ -12,13 +12,12 @@ public function testAsDecimalAsAscii()
         $expectedDecimal = '292233162870206001759766198425879490508935868472';
         $expectedAscii = '30001000000300023708';
         $serial = new SerialNumber($input);
+        $this->assertSame($input, $serial->getHexadecimal());
         $this->assertSame($expectedDecimal, $serial->asDecimal());
         $this->assertSame($expectedAscii, $serial->asAscii());
     }
 
     /**
-     * This test extends the base class to expose the visibility of serialHexToAscii method.
-     *
      * @param string $input
      * @param string $expected
      * @testWith ["3330303031303030303030333030303233373038", "30001000000300023708"]
@@ -32,8 +31,6 @@ public function testLoadHexadecimal(string $input, string $expected)
     }
 
     /**
-     * This test extends the base class to expose the visibility of serialHexToAscii method.
-     *
      * @param string $input
      * @param string $expected
      * @testWith ["0x3330303031303030303030333030303233373038", "30001000000300023708"]
@@ -45,4 +42,16 @@ public function testLoadDecimal(string $input, string $expected)
         $serial->loadDecimal($input);
         $this->assertSame($expected, $serial->asAscii());
     }
+
+    /**
+     * @param string $input
+     * @param string $expected
+     * @testWith ["30001000000300023708", "3330303031303030303030333030303233373038"]
+     */
+    public function testLoadAscii(string $input, string $expected)
+    {
+        $serial = new SerialNumber('');
+        $serial->loadAscii($input);
+        $this->assertSame($expected, $serial->getHexadecimal());
+    }
 }