Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions MeAjudaAi.sln
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@


Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio Version 18
VisualStudioVersion = 18.0.11205.157
Expand Down Expand Up @@ -109,19 +109,19 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Location", "Location", "{8B
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Tests", "Tests", "{A297266A-1ECB-AE19-8D6F-3A458F9AD28F}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MeAjudaAi.Modules.Location.Tests", "src\Modules\Location\Tests\MeAjudaAi.Modules.Location.Tests.csproj", "{D0E46405-E34A-4905-BF34-9DF22036512E}"
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MeAjudaAi.Modules.Locations.Tests", "src\Modules\Locations\Tests\MeAjudaAi.Modules.Locations.Tests.csproj", "{D0E46405-E34A-4905-BF34-9DF22036512E}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Application", "Application", "{10AEE144-453E-4C4D-B928-DBD6A8C72108}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MeAjudaAi.Modules.Location.Application", "src\Modules\Location\Application\MeAjudaAi.Modules.Location.Application.csproj", "{B98C73C8-F57C-747F-B86E-3A0429BFBE12}"
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MeAjudaAi.Modules.Locations.Application", "src\Modules\Locations\Application\MeAjudaAi.Modules.Locations.Application.csproj", "{B98C73C8-F57C-747F-B86E-3A0429BFBE12}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Domain", "Domain", "{A7277AF8-7D65-4CE2-B6B0-2A0DB786780A}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MeAjudaAi.Modules.Location.Domain", "src\Modules\Location\Domain\MeAjudaAi.Modules.Location.Domain.csproj", "{72B40E16-5D54-DCE4-A235-AA9F7CF99665}"
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MeAjudaAi.Modules.Locations.Domain", "src\Modules\Locations\Domain\MeAjudaAi.Modules.Locations.Domain.csproj", "{72B40E16-5D54-DCE4-A235-AA9F7CF99665}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Infrastructure", "Infrastructure", "{E4E48F48-72CF-41A4-AA66-9423D81C7970}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MeAjudaAi.Modules.Location.Infrastructure", "src\Modules\Location\Infrastructure\MeAjudaAi.Modules.Location.Infrastructure.csproj", "{1E72996A-6FD1-9E16-5188-42DDCFF6518C}"
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MeAjudaAi.Modules.Locations.Infrastructure", "src\Modules\Locations\Infrastructure\MeAjudaAi.Modules.Locations.Infrastructure.csproj", "{1E72996A-6FD1-9E16-5188-42DDCFF6518C}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Search", "Search", "{6FF68FBA-C4AF-48EC-AFE2-E320F2195C79}"
EndProject
Expand Down
18 changes: 9 additions & 9 deletions docs/modules/location.md → docs/modules/locations.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# 🗺️ Módulo Location - Geolocalização e CEP
# 🗺️ Módulo Locations - Geolocalização e CEP

> **✅ Status**: Módulo **implementado e funcional** (Novembro 2025)

## 🎯 Visão Geral

O módulo **Location** é responsável por abstrair funcionalidades de **geolocalização** e **lookup de CEP brasileiro**, fornecendo uma API unificada e resiliente para outros módulos consumirem dados de localização.
O módulo **Locations** é responsável por abstrair funcionalidades de **geolocalização** e **lookup de CEP brasileiro**, fornecendo uma API unificada e resiliente para outros módulos consumirem dados de localização.

### **Responsabilidades**
- ✅ **Lookup de CEP** com fallback automático entre APIs brasileiras
Expand All @@ -16,7 +16,7 @@ O módulo **Location** é responsável por abstrair funcionalidades de **geoloca

## 🏗️ Arquitetura Implementada

### **Bounded Context: Location**
### **Bounded Context: Locations**
- **Sem schema próprio** (stateless module)
- **Padrão**: Service Layer + Value Objects
- **Integrações**: ViaCEP, BrasilAPI, OpenCEP
Expand Down Expand Up @@ -227,7 +227,7 @@ public sealed class LocationsModuleApi : ILocationModuleApi
{
private static class ModuleMetadata
{
public const string Name = "Location";
public const string Name = "Locations";
public const string Version = "1.0";
}

Expand Down Expand Up @@ -317,23 +317,23 @@ services.AddHttpClient<IViaCepClient, ViaCepClient>()
## 📊 Estrutura de Pastas

```plaintext
src/Modules/Location/
src/Modules/Locations/
├── API/
│ └── MeAjudaAi.Modules.Location.API.csproj
│ └── MeAjudaAi.Modules.Locations.API.csproj
├── Application/
│ ├── ModuleApi/
│ │ └── LocationsModuleApi.cs
│ ├── Services/
│ │ ├── ICepLookupService.cs
│ │ ├── CepLookupService.cs
│ │ └── IGeocodingService.cs
│ └── MeAjudaAi.Modules.Location.Application.csproj
│ └── MeAjudaAi.Modules.Locations.Application.csproj
├── Domain/
│ ├── ValueObjects/
│ │ ├── Cep.cs
│ │ ├── Coordinates.cs
│ │ └── Address.cs
│ └── MeAjudaAi.Modules.Location.Domain.csproj
│ └── MeAjudaAi.Modules.Locations.Domain.csproj
├── Infrastructure/
│ ├── ExternalServices/
│ │ ├── ViaCEP/
Expand All @@ -346,7 +346,7 @@ src/Modules/Location/
│ │ ├── IOpenCepClient.cs
│ │ └── OpenCepClient.cs
│ ├── Extensions.cs
│ └── MeAjudaAi.Modules.Location.Infrastructure.csproj
│ └── MeAjudaAi.Modules.Locations.Infrastructure.csproj
└── Tests/
└── Unit/
└── Domain/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<ProjectReference Include="..\..\Aspire\MeAjudaAi.ServiceDefaults\MeAjudaAi.ServiceDefaults.csproj" />
<ProjectReference Include="..\..\Modules\Catalogs\API\MeAjudaAi.Modules.Catalogs.API.csproj" />
<ProjectReference Include="..\..\Modules\Documents\API\MeAjudaAi.Modules.Documents.API.csproj" />
<ProjectReference Include="..\..\Modules\Location\Infrastructure\MeAjudaAi.Modules.Location.Infrastructure.csproj" />
<ProjectReference Include="..\..\Modules\Locations\Infrastructure\MeAjudaAi.Modules.Locations.Infrastructure.csproj" />
<ProjectReference Include="..\..\Modules\Providers\API\MeAjudaAi.Modules.Providers.API.csproj" />
<ProjectReference Include="..\..\Modules\Search\API\MeAjudaAi.Modules.Search.API.csproj" />
<ProjectReference Include="..\..\Modules\Users\API\MeAjudaAi.Modules.Users.API.csproj" />
Expand Down
2 changes: 1 addition & 1 deletion src/Bootstrapper/MeAjudaAi.ApiService/Program.cs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
using MeAjudaAi.ApiService.Extensions;
using MeAjudaAi.Modules.Catalogs.API;
using MeAjudaAi.Modules.Documents.API;
using MeAjudaAi.Modules.Location.Infrastructure;
using MeAjudaAi.Modules.Locations.Infrastructure;
using MeAjudaAi.Modules.Providers.API;
using MeAjudaAi.Modules.Search.API;
using MeAjudaAi.Modules.Users.API;
Expand Down
2 changes: 1 addition & 1 deletion src/Bootstrapper/MeAjudaAi.ApiService/appsettings.json
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@
"RetryAttempts": 3,
"AutomaticRetryDelaySeconds": 60
},
"Location": {
"Locations": {
"ExternalApis": {
"ViaCep": {
"BaseUrl": "https://viacep.com.br/"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<Project Sdk="Microsoft.NET.Sdk">
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFramework>net9.0</TargetFramework>
<RootNamespace>MeAjudaAi.Modules.Location.Application</RootNamespace>
<RootNamespace>MeAjudaAi.Modules.Locations.Application</RootNamespace>
</PropertyGroup>

<ItemGroup>
<ProjectReference Include="..\..\..\Shared\MeAjudaAi.Shared.csproj" />
<ProjectReference Include="..\Domain\MeAjudaAi.Modules.Location.Domain.csproj" />
<ProjectReference Include="..\Domain\MeAjudaAi.Modules.Locations.Domain.csproj" />
</ItemGroup>

</Project>
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
using MeAjudaAi.Modules.Location.Application.Services;
using MeAjudaAi.Modules.Location.Domain.ValueObjects;
using MeAjudaAi.Modules.Locations.Application.Services;
using MeAjudaAi.Modules.Locations.Domain.ValueObjects;
using MeAjudaAi.Shared.Contracts.Modules;
using MeAjudaAi.Shared.Contracts.Modules.Location;
using MeAjudaAi.Shared.Contracts.Modules.Location.DTOs;
using MeAjudaAi.Shared.Functional;
using Microsoft.Extensions.Logging;

namespace MeAjudaAi.Modules.Location.Application.ModuleApi;
namespace MeAjudaAi.Modules.Locations.Application.ModuleApi;

/// <summary>
/// Implementação da API pública do módulo Location para outros módulos.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
using MeAjudaAi.Modules.Location.Domain.ValueObjects;
using MeAjudaAi.Modules.Locations.Domain.ValueObjects;

namespace MeAjudaAi.Modules.Location.Application.Services;
namespace MeAjudaAi.Modules.Locations.Application.Services;

/// <summary>
/// Serviço de consulta de CEP com fallback automático entre provedores.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
using MeAjudaAi.Shared.Geolocation;

namespace MeAjudaAi.Modules.Location.Application.Services;
namespace MeAjudaAi.Modules.Locations.Application.Services;

/// <summary>
/// Serviço de geocoding para converter endereços em coordenadas.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
namespace MeAjudaAi.Modules.Location.Domain.Enums;
namespace MeAjudaAi.Modules.Locations.Domain.Enums;

/// <summary>
/// Provedores de consulta de CEP disponíveis.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<Project Sdk="Microsoft.NET.Sdk">
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFramework>net9.0</TargetFramework>
<RootNamespace>MeAjudaAi.Modules.Location.Domain</RootNamespace>
<RootNamespace>MeAjudaAi.Modules.Locations.Domain</RootNamespace>
</PropertyGroup>

<ItemGroup>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
using MeAjudaAi.Shared.Domain;
using MeAjudaAi.Shared.Geolocation;

namespace MeAjudaAi.Modules.Location.Domain.ValueObjects;
namespace MeAjudaAi.Modules.Locations.Domain.ValueObjects;

/// <summary>
/// Representa um endereço brasileiro completo.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
using System.Text.RegularExpressions;
using MeAjudaAi.Shared.Domain;

namespace MeAjudaAi.Modules.Location.Domain.ValueObjects;
namespace MeAjudaAi.Modules.Locations.Domain.ValueObjects;

/// <summary>
/// Representa um Código de Endereçamento Postal (CEP) brasileiro.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
using MeAjudaAi.Modules.Location.Application.ModuleApi;
using MeAjudaAi.Modules.Location.Application.Services;
using MeAjudaAi.Modules.Location.Infrastructure.ExternalApis.Clients;
using MeAjudaAi.Modules.Location.Infrastructure.Services;
using MeAjudaAi.Modules.Locations.Application.ModuleApi;
using MeAjudaAi.Modules.Locations.Application.Services;
using MeAjudaAi.Modules.Locations.Infrastructure.ExternalApis.Clients;
using MeAjudaAi.Modules.Locations.Infrastructure.Services;
using MeAjudaAi.Shared.Contracts.Modules.Location;
using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;

namespace MeAjudaAi.Modules.Location.Infrastructure;
namespace MeAjudaAi.Modules.Locations.Infrastructure;

/// <summary>
/// Métodos de extensão para registrar serviços do módulo Location.
Expand All @@ -23,30 +23,30 @@ public static IServiceCollection AddLocationModule(this IServiceCollection servi
// ServiceDefaults já configura resiliência (retry, circuit breaker, timeout)
services.AddHttpClient<ViaCepClient>(client =>
{
var baseUrl = configuration["Location:ExternalApis:ViaCep:BaseUrl"] ?? "https://viacep.com.br/";
var baseUrl = configuration["Locations:ExternalApis:ViaCep:BaseUrl"] ?? "https://viacep.com.br/";
client.BaseAddress = new Uri(baseUrl);
});

services.AddHttpClient<BrasilApiCepClient>(client =>
{
var baseUrl = configuration["Location:ExternalApis:BrasilApi:BaseUrl"] ?? "https://brasilapi.com.br/";
var baseUrl = configuration["Locations:ExternalApis:BrasilApi:BaseUrl"] ?? "https://brasilapi.com.br/";
client.BaseAddress = new Uri(baseUrl);
});

services.AddHttpClient<OpenCepClient>(client =>
{
var baseUrl = configuration["Location:ExternalApis:OpenCep:BaseUrl"] ?? "https://opencep.com/";
var baseUrl = configuration["Locations:ExternalApis:OpenCep:BaseUrl"] ?? "https://opencep.com/";
client.BaseAddress = new Uri(baseUrl);
});

// Registrar HTTP client para Nominatim (geocoding)
services.AddHttpClient<NominatimClient>(client =>
{
var baseUrl = configuration["Location:ExternalApis:Nominatim:BaseUrl"] ?? "https://nominatim.openstreetmap.org/";
var baseUrl = configuration["Locations:ExternalApis:Nominatim:BaseUrl"] ?? "https://nominatim.openstreetmap.org/";
client.BaseAddress = new Uri(baseUrl);

// Configurar User-Agent conforme política de uso do Nominatim
var userAgent = configuration["Location:ExternalApis:Nominatim:UserAgent"]
var userAgent = configuration["Locations:ExternalApis:Nominatim:UserAgent"]
?? "MeAjudaAi/1.0 (https://github.com/frigini/MeAjudaAi)";
client.DefaultRequestHeaders.Add("User-Agent", userAgent);
});
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
using System.Text.Json;
using MeAjudaAi.Modules.Location.Domain.ValueObjects;
using MeAjudaAi.Modules.Location.Infrastructure.ExternalApis.Responses;
using MeAjudaAi.Modules.Locations.Domain.ValueObjects;
using MeAjudaAi.Modules.Locations.Infrastructure.ExternalApis.Responses;
using MeAjudaAi.Shared.Serialization;
using Microsoft.Extensions.Logging;

namespace MeAjudaAi.Modules.Location.Infrastructure.ExternalApis.Clients;
namespace MeAjudaAi.Modules.Locations.Infrastructure.ExternalApis.Clients;

/// <summary>
/// Cliente HTTP para a API BrasilAPI.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
using System.Text.Json;
using System.Web;
using MeAjudaAi.Modules.Location.Infrastructure.ExternalApis.Responses;
using MeAjudaAi.Modules.Locations.Infrastructure.ExternalApis.Responses;
using MeAjudaAi.Shared.Geolocation;
using MeAjudaAi.Shared.Serialization;
using MeAjudaAi.Shared.Time;
using Microsoft.Extensions.Logging;

namespace MeAjudaAi.Modules.Location.Infrastructure.ExternalApis.Clients;
namespace MeAjudaAi.Modules.Locations.Infrastructure.ExternalApis.Clients;

/// <summary>
/// Cliente HTTP para a API Nominatim (OpenStreetMap).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
using System.Text.Json;
using MeAjudaAi.Modules.Location.Domain.ValueObjects;
using MeAjudaAi.Modules.Location.Infrastructure.ExternalApis.Responses;
using MeAjudaAi.Modules.Locations.Domain.ValueObjects;
using MeAjudaAi.Modules.Locations.Infrastructure.ExternalApis.Responses;
using MeAjudaAi.Shared.Serialization;
using Microsoft.Extensions.Logging;

namespace MeAjudaAi.Modules.Location.Infrastructure.ExternalApis.Clients;
namespace MeAjudaAi.Modules.Locations.Infrastructure.ExternalApis.Clients;

/// <summary>
/// Cliente HTTP para a API OpenCEP.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
using System.Text.Json;
using MeAjudaAi.Modules.Location.Domain.ValueObjects;
using MeAjudaAi.Modules.Location.Infrastructure.ExternalApis.Responses;
using MeAjudaAi.Modules.Locations.Domain.ValueObjects;
using MeAjudaAi.Modules.Locations.Infrastructure.ExternalApis.Responses;
using MeAjudaAi.Shared.Serialization;
using Microsoft.Extensions.Logging;

namespace MeAjudaAi.Modules.Location.Infrastructure.ExternalApis.Clients;
namespace MeAjudaAi.Modules.Locations.Infrastructure.ExternalApis.Clients;

/// <summary>
/// Cliente HTTP para a API ViaCEP.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
namespace MeAjudaAi.Modules.Location.Infrastructure.ExternalApis.Responses;
namespace MeAjudaAi.Modules.Locations.Infrastructure.ExternalApis.Responses;

/// <summary>
/// Resposta da API BrasilAPI.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
namespace MeAjudaAi.Modules.Location.Infrastructure.ExternalApis.Responses;
namespace MeAjudaAi.Modules.Locations.Infrastructure.ExternalApis.Responses;

/// <summary>
/// Resposta da API Nominatim (OpenStreetMap).
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
namespace MeAjudaAi.Modules.Location.Infrastructure.ExternalApis.Responses;
namespace MeAjudaAi.Modules.Locations.Infrastructure.ExternalApis.Responses;

/// <summary>
/// Resposta da API OpenCEP.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
namespace MeAjudaAi.Modules.Location.Infrastructure.ExternalApis.Responses;
namespace MeAjudaAi.Modules.Locations.Infrastructure.ExternalApis.Responses;

/// <summary>
/// Resposta da API ViaCEP.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
<Project Sdk="Microsoft.NET.Sdk">
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFramework>net9.0</TargetFramework>
<RootNamespace>MeAjudaAi.Modules.Location.Infrastructure</RootNamespace>
<RootNamespace>MeAjudaAi.Modules.Locations.Infrastructure</RootNamespace>
</PropertyGroup>

<ItemGroup>
<ProjectReference Include="..\..\..\Shared\MeAjudaAi.Shared.csproj" />
<ProjectReference Include="..\Domain\MeAjudaAi.Modules.Location.Domain.csproj" />
<ProjectReference Include="..\Application\MeAjudaAi.Modules.Location.Application.csproj" />
<ProjectReference Include="..\Domain\MeAjudaAi.Modules.Locations.Domain.csproj" />
<ProjectReference Include="..\Application\MeAjudaAi.Modules.Locations.Application.csproj" />
</ItemGroup>

</Project>
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
using MeAjudaAi.Modules.Location.Application.Services;
using MeAjudaAi.Modules.Location.Domain.Enums;
using MeAjudaAi.Modules.Location.Domain.ValueObjects;
using MeAjudaAi.Modules.Location.Infrastructure.ExternalApis.Clients;
using MeAjudaAi.Modules.Locations.Application.Services;
using MeAjudaAi.Modules.Locations.Domain.Enums;
using MeAjudaAi.Modules.Locations.Domain.ValueObjects;
using MeAjudaAi.Modules.Locations.Infrastructure.ExternalApis.Clients;
using MeAjudaAi.Shared.Caching;
using Microsoft.Extensions.Caching.Hybrid;
using Microsoft.Extensions.Logging;

namespace MeAjudaAi.Modules.Location.Infrastructure.Services;
namespace MeAjudaAi.Modules.Locations.Infrastructure.Services;

/// <summary>
/// Implementação do serviço de consulta de CEP com fallback chain e caching.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
using MeAjudaAi.Modules.Location.Application.Services;
using MeAjudaAi.Modules.Location.Infrastructure.ExternalApis.Clients;
using MeAjudaAi.Modules.Locations.Application.Services;
using MeAjudaAi.Modules.Locations.Infrastructure.ExternalApis.Clients;
using MeAjudaAi.Shared.Caching;
using MeAjudaAi.Shared.Geolocation;
using Microsoft.Extensions.Caching.Hybrid;
using Microsoft.Extensions.Logging;

namespace MeAjudaAi.Modules.Location.Infrastructure.Services;
namespace MeAjudaAi.Modules.Locations.Infrastructure.Services;

/// <summary>
/// Implementação do serviço de geocoding usando Nominatim (OpenStreetMap).
Expand Down
Loading