Merge pull request #23 from maick05/development

Development

CHANGELOG.MD

@@ -32,3 +32,15 @@ All notable changes to this project will be documented in this file.
 - Route Neighborhoods By State
 - Route Seed Neighborhoods By State
 - logSeed Collection
+
+## [0.0.5] - 2022-06-27
+
+### Added
+
+- Route Cities By State
+- Route Cities By Country
+- Route States By Country
+- Route Countries
+- Swagger Openapi automation
+- Optmize Neighborhoods by State
+- Sort Collections result

README.md

@@ -20,7 +20,10 @@
 
 API to get Places by Local Names.
 
-- Only Neighborhoods for now
+- Neighborhoods
+- Cities
+- States
+- Countries
 
 ## Installation
 
@@ -81,8 +84,16 @@ After run the server, make a get in browser, postman or similar
 http://localhost:3000/neighborhoods/city/brazil/sc/orleans
 ## Neighborhoods By State example
 http://localhost:3000/neighborhoods/city/brazil/sc
+## Cities By State example
+http://localhost:3000/cities/brazil/sc
+## Cities By Country example
+http://localhost:3000/cities/brazil
+## States By Country example
+http://localhost:3000/states/brazil
+## Countries example
+http://localhost:3000/countries/
 ```
 
-[Swagger](https://app.swaggerhub.com/apis/dev-seeder/Places/1.0.0)
+[Swagger](https://app.swaggerhub.com/apis/dev-seeder/Places/)
 
-At the moment, it's working only for Brazilians cities and states.
+At the moment, it's working only for Brazilians places.

config/yaml/values.yaml

@@ -7,3 +7,5 @@ database:
     connection: 'mongodb+srv://dev-seeder-root:hpYpxyjrKExNQviu@devseeder.v6xtv.mongodb.net/places?retryWrites=true&w=majority&ssl=true&wtimeoutMS=0'
 api:
   port: 3000
+doc:
+  version: 0.0.5

package.json

@@ -30,6 +30,7 @@
     "@nestjs/core": "^8.0.0",
     "@nestjs/mongoose": "^9.1.0",
     "@nestjs/platform-express": "^8.0.0",
+    "@nestjs/swagger": "^5.2.1",
     "chai": "^4.3.6",
     "cheerio": "^1.0.0-rc.10",
     "class-transformer": "^0.5.1",
@@ -45,7 +46,8 @@
     "rimraf": "^3.0.2",
     "rxjs": "^7.2.0",
     "sinon": "^14.0.0",
-    "superagent": "^7.1.3"
+    "superagent": "^7.1.3",
+    "swagger-ui-express": "^4.4.0"
   },
   "devDependencies": {
     "@nestjs/cli": "^8.0.0",

src/app.module.ts

@@ -4,9 +4,12 @@ import { APP_INTERCEPTOR } from '@nestjs/core';
 import { MongooseModule } from '@nestjs/mongoose';
 import { FiltersModule } from './core/error-handling/filters.module';
 import { TransformResponseInterceptor } from './core/http/transform-response.interceptor';
+import { CitiesModule } from './microservice/adapter/cities.module';
+import { CountriesModule } from './microservice/adapter/countries.module';
 import { ExtensionsModule } from './microservice/adapter/helper/extensions/exensions.module';
 import { CustomPuppeteerModule } from './microservice/adapter/helper/modules/custom-puppeteer.module';
 import { NeighborhoodsModule } from './microservice/adapter/neighborhoods.module';
+import { StatesModule } from './microservice/adapter/states.module';
 
 @Module({
   imports: [
@@ -23,7 +26,10 @@ import { NeighborhoodsModule } from './microservice/adapter/neighborhoods.module
         uri: config.get<string>('database.mongodb.connection')
       })
     }),
-    NeighborhoodsModule
+    NeighborhoodsModule,
+    CitiesModule,
+    StatesModule,
+    CountriesModule
   ],
   controllers: [],
   providers: [

src/main.ts

@@ -3,6 +3,8 @@ import { ConfigService } from '@nestjs/config';
 import { NestFactory } from '@nestjs/core';
 import { useContainer } from 'class-validator';
 import { AppModule } from './app.module';
+import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';
+import * as fs from 'fs';
 
 async function bootstrap() {
   const app = await NestFactory.create(AppModule);
@@ -12,7 +14,19 @@ async function bootstrap() {
     })
   );
   useContainer(app.select(AppModule), { fallbackOnErrors: true });
+
   const configService = app.get<ConfigService>(ConfigService);
+
+  const docApi = new DocumentBuilder()
+    .setTitle('Places')
+    .setDescription('Places API')
+    .setVersion(configService.get<string>('doc.version'))
+    .build();
+
+  const document = SwaggerModule.createDocument(app, docApi);
+  fs.writeFileSync('./swagger-spec.json', JSON.stringify(document));
+  SwaggerModule.setup('api', app, document);
+
   return await app.listen(configService.get<string>('api.port'));
 }
 

src/microservice/adapter/cities.module.ts

@@ -0,0 +1,33 @@
+import { Module } from '@nestjs/common';
+import { ConfigModule } from '@nestjs/config';
+import configuration from '../../config/configuration';
+import { MongooseModule } from '@nestjs/mongoose';
+import { City, CitySchema } from '../domain/schemas/city.schema';
+import { ValidateCityByNameOrAliasService } from '../domain/service/cities/validate-city-by-name-or-alias.service';
+import { CitiesMongoose } from './repository/cities/cities-mongoose.repository';
+import { ValidateInputParamsService } from '../domain/service/validate/validate-input-params.service';
+import { GetCitiesByStateService } from '../domain/service/cities/get/get-cities-by-state.service';
+import { CitiesController } from './controller/cities.controller';
+import { GetCitiesByCountryService } from '../domain/service/cities/get/get-cities-by-country.service';
+import { StatesModule } from './states.module';
+
+@Module({
+  imports: [
+    ConfigModule.forRoot({
+      isGlobal: true,
+      load: [configuration]
+    }),
+    MongooseModule.forFeature([{ name: City.name, schema: CitySchema }]),
+    StatesModule
+  ],
+  controllers: [CitiesController],
+  providers: [
+    CitiesMongoose,
+    ValidateCityByNameOrAliasService,
+    ValidateInputParamsService,
+    GetCitiesByStateService,
+    GetCitiesByCountryService
+  ],
+  exports: [CitiesMongoose, ValidateInputParamsService, GetCitiesByStateService]
+})
+export class CitiesModule {}

src/microservice/adapter/controller/cities.controller.ts

@@ -0,0 +1,78 @@
+import { Controller, Get, HttpStatus, Param } from '@nestjs/common';
+import { NestResponse } from '../../../core/http/nest-response';
+import { AbstractController } from '../../domain/controller/abstract-controller';
+import { GetCitiesByStateService } from '../../domain/service/cities/get/get-cities-by-state.service';
+import { SearchCitiesDTO } from '../../domain/model/search/cities/search-cities-dto.model';
+import { GetCitiesByCountryService } from '../../domain/service/cities/get/get-cities-by-country.service';
+import {
+  ApiOkResponse,
+  ApiOperation,
+  ApiParam,
+  ApiTags
+} from '@nestjs/swagger';
+import { CityResponse } from '../../domain/model/cities/city-response.model';
+import { CitiesByCountry } from '../../domain/model/cities/cities-by-country.model';
+
+@ApiTags('cities')
+@Controller('cities')
+export class CitiesController extends AbstractController {
+  constructor(
+    private readonly getCitiesByStateService: GetCitiesByStateService,
+    private readonly getCitiesByCountryService: GetCitiesByCountryService
+  ) {
+    super();
+  }
+
+  @ApiOperation({
+    description: 'Get Cities By State Reference'
+  })
+  @ApiOkResponse({
+    description: 'Cities found.',
+    isArray: true,
+    type: CityResponse
+  })
+  @ApiParam({
+    name: 'country',
+    required: true,
+    description: 'The Country name of the city',
+    type: String
+  })
+  @ApiParam({
+    name: 'state',
+    required: true,
+    description: 'The State name of the city',
+    type: String
+  })
+  @Get('/state/:country/:state')
+  async getCitiesByState(
+    @Param() params: SearchCitiesDTO
+  ): Promise<NestResponse> {
+    return this.buildResponse(
+      HttpStatus.OK,
+      await this.getCitiesByStateService.getCitiesByState(params)
+    );
+  }
+
+  @ApiOperation({
+    description: 'Get Cities By Country Reference'
+  })
+  @ApiOkResponse({
+    description: 'Cities found.',
+    type: CitiesByCountry
+  })
+  @ApiParam({
+    name: 'country',
+    required: true,
+    description: 'The Country name of the city',
+    type: String
+  })
+  @Get('/country/:country')
+  async getCitiesByCountry(
+    @Param('country') country: string
+  ): Promise<NestResponse> {
+    return this.buildResponse(
+      HttpStatus.OK,
+      await this.getCitiesByCountryService.getCitiesByCountry(country)
+    );
+  }
+}