Merge pull request #6 from lsnepomuceno/feature/adds-ibge-info-cep-en…

…tity-php-83-remove-cep-la-provider Feature/adds ibge info cep entity php 83 remove cep la provider
lsnepomuceno · Jan 12, 2024 · c815473 · c815473
2 parents ed17142 + 183be59
commit c815473
Show file tree

Hide file tree

Showing 12 changed files with 24 additions and 146 deletions.
diff --git a/.github/workflows/action_pr_main.yml b/.github/workflows/action_pr_main.yml
@@ -17,7 +17,7 @@ jobs:
       fail-fast: false
       matrix:
         operating-system: [ ubuntu-latest ]
-        php-versions: [ '8.1', '8.2' ]
+        php-versions: [ '8.1', '8.2', '8.3' ]
     env:
       extensions: mbstring, dom, fileinfo, openssl, json, imagick, swoole, sqlite3
       key: cache-v5

diff --git a/composer.json b/composer.json
@@ -16,7 +16,7 @@
         }
     ],
     "require": {
-        "php": "^8.1 || ^8.2",
+        "php": "^8.1 || ^8.2 || ^8.3",
         "ext-json": "*",
         "ext-fileinfo": "*",
         "ext-mbstring": "*",

diff --git a/src/CepProviders/CepLa.php b/src/CepProviders/CepLa.php
diff --git a/src/CepProviders/OpenCep.php b/src/CepProviders/OpenCep.php
@@ -42,7 +42,8 @@ public function get(string $cep): ?CepEntity
                 street      : $data->logradouro,
                 state       : States::get($data->uf),
                 uf          : $data->uf,
-                neighborhood: $data->bairro
+                neighborhood: $data->bairro,
+                ibge        : $data->ibge
             );
         } catch (Exception $e) {
             return null;

diff --git a/src/CepProviders/Postomon.php b/src/CepProviders/Postomon.php
@@ -41,7 +41,8 @@ public function get(string $cep): ?CepEntity
                 street      : $data->logradouro,
                 state       : States::get($data->estado),
                 uf          : $data->estado,
-                neighborhood: $data->bairro
+                neighborhood: $data->bairro,
+                ibge        : $data->cidade_info?->codigo_ibge
             );
         } catch (Exception $e) {
             return null;

diff --git a/src/CepProviders/ViaCep.php b/src/CepProviders/ViaCep.php
@@ -42,7 +42,8 @@ public function get(string $cep): ?CepEntity
                 street      : $data->logradouro,
                 state       : States::get($data->uf),
                 uf          : $data->uf,
-                neighborhood: $data->bairro
+                neighborhood: $data->bairro,
+                ibge        : $data->ibge
             );
         } catch (Exception $e) {
             return null;

diff --git a/src/Entities/CepEntity.php b/src/Entities/CepEntity.php
@@ -14,7 +14,8 @@ public function __construct(
         public string          $uf,
         public string          $neighborhood,
         public string|int|null $number = null,
-        public ?string         $complement = null
+        public ?string         $complement = null,
+        public string|int|null $ibge = null
     )
     {
     }

diff --git a/src/Services/CepService.php b/src/Services/CepService.php
@@ -7,7 +7,6 @@
 use LSNepomuceno\LaravelBrazilianCeps\CepProviders\ApiCep;
 use LSNepomuceno\LaravelBrazilianCeps\CepProviders\BrasilApiV1;
 use LSNepomuceno\LaravelBrazilianCeps\CepProviders\BrasilApiV2;
-use LSNepomuceno\LaravelBrazilianCeps\CepProviders\CepLa;
 use LSNepomuceno\LaravelBrazilianCeps\CepProviders\OpenCep;
 use LSNepomuceno\LaravelBrazilianCeps\CepProviders\Pagarme;
 use LSNepomuceno\LaravelBrazilianCeps\CepProviders\Postomon;
@@ -28,7 +27,6 @@ public function __construct(
             Pagarme::class,
             OpenCep::class,
             ApiCep::class,
-            CepLa::class,
             Postomon::class,
             BrasilApiV1::class,
             BrasilApiV2::class

diff --git a/tests/Feature/ApiCepProviderTest.php b/tests/Feature/ApiCepProviderTest.php
@@ -51,6 +51,12 @@ public function testValidatesIfTheRequestWillBeExecutedSuccessfully()
         $apiCepProvider = new ApiCep();
         $response       = $apiCepProvider->get($cep);
 
+        if (!$response) {
+            $this->markTestSkipped(
+                'APICep provider unavailable.'
+            );
+        }
+
         $requiredFields = DefaultValues::successfullyRequiredFields();
         $optionalFields = DefaultValues::optionalFields();
 

diff --git a/tests/Feature/CepLaProviderTest.php b/tests/Feature/CepLaProviderTest.php
diff --git a/tests/Helpers/DefaultValues.php b/tests/Helpers/DefaultValues.php
@@ -19,7 +19,8 @@ public static function optionalFields(): array
     {
         return [
             'number',
-            'complement'
+            'complement',
+            'ibge'
         ];
     }
 }
diff --git a/tests/Unit/CepEntityTest.php b/tests/Unit/CepEntityTest.php
@@ -17,7 +17,8 @@ public function testValidatesCepEntityStructure()
             uf          : 'uf',
             neighborhood: 'neighborhood',
             number      : 'number',
-            complement  : 'complement'
+            complement  : 'complement',
+            ibge        : 'ibge'
         );
 
         $this->assertIsArray($cepEntity->toArray());
@@ -33,7 +34,8 @@ public function testValidatesCepEntityStructureWithIntegerNumber()
             uf          : 'uf',
             neighborhood: 'neighborhood',
             number      : 1000,
-            complement  : 'complement'
+            complement  : 'complement',
+            ibge        : 'ibge'
         );
 
         $this->assertIsArray($cepEntity->toArray());
@@ -49,7 +51,8 @@ public function testValidatesCepEntityStructureWhenComplementAndNumberAreNull()
             uf          : 'uf',
             neighborhood: 'neighborhood',
             number      : null,
-            complement  : null
+            complement  : null,
+            ibge        : null
         );
 
         $this->assertIsArray($cepEntity->toArray());