add route and swagger doc

.github/workflows/run_back_test.yml

@@ -17,3 +17,5 @@ jobs:
           custom-title: Coverage report for backend
           github-token: ${{ secrets.PR_TOCKEN}}
           annotations: none #disable annotation
+        env:
+          OPEN_TRIP_MAPS_KEY: ${{ secrets.OPEN_TRIP_MAPS_KEY}}

Express/barAndCafe/Dockerfile

@@ -47,7 +47,8 @@ WORKDIR /home/node
 EXPOSE 3000
 
 # Add Healthcheck
-HEALTHCHECK --interval=10s --timeout=10s --start-period=5s --retries=3 CMD wget --no-verbose --tries=1 --spider http://localhost:3000 || exit 1
+# FIXME: remttre check avec un port
+# HEALTHCHECK --interval=10s --timeout=10s --start-period=5s --retries=3 CMD wget --no-verbose --tries=1 --spider http://localhost:3000 || exit 1
 
 # copy from build image
 COPY --chown=node:node --from=BUILD_IMAGE /home/node/node_modules ./node_modules

Express/barAndCafe/jest.config.js

@@ -1,5 +1,6 @@
 /** @type {import('ts-jest').JestConfigWithTsJest} */
 module.exports = {
+  testTimeout: 10000,
   preset: 'ts-jest',
   testEnvironment: 'node',
   collectCoverage: true,

Express/barAndCafe/jsdoc.json

@@ -6,10 +6,15 @@
         "allowUnknownTags": true
     },
     "plugins": [
-        "node_modules/better-docs/typescript"
+        "node_modules/better-docs/typescript",
+        "plugins/markdown",
+        "jsdoc-mermaid"
     ],
     "source": {
         "include": ["./src"],
         "includePattern": "\\.(jsx|js|ts|tsx)$"
+    },
+    "templates": {
+        "search": true
     }
 }

Express/barAndCafe/package.json

@@ -5,12 +5,15 @@
     "start": "node dist/src/server.js",
     "predev": "npm run build",
     "dev": "npx tsc -w & nodemon dist/src/server.js",
+    "predocs": "npm run build",
     "docs": "jsdoc -c jsdoc.json",
-    "test": "jest"
+    "pretest": "npm run build",
+    "test": "ts-node -O '{\"module\":\"commonjs\"}' node_modules/jest/bin/jest.js"
   },
   "dependencies": {
     "@types/express": "^4.17.21",
     "@types/node": "^20.12.7",
+    "axios": "^1.6.8",
     "dotenv": "^16.4.5",
     "express": "^4.19.2",
     "rimraf": "^5.0.5",
@@ -19,16 +22,20 @@
   },
   "devDependencies": {
     "@types/jest": "^29.5.12",
+    "@types/rewire": "^2.5.30",
     "@types/supertest": "^6.0.2",
     "babel-cli": "^6.26.0",
     "babel-preset-env": "^1.7.0",
     "better-docs": "^2.7.3",
     "jest": "^29.7.0",
     "jsdoc": "^4.0.3",
+    "jsdoc-mermaid": "^1.0.0",
     "nodemon": "^3.1.0",
+    "rewire": "^7.0.0",
     "superagent": "^9.0.2",
     "supertest": "^7.0.0",
     "ts-jest": "^29.1.2",
+    "ts-node": "^10.9.2",
     "typedoc": "^0.25.13",
     "typescript": "^5.4.5"
   }

Express/barAndCafe/src/app.ts

@@ -1,3 +1,4 @@
+import { getCity, getRadius, getPoiId } from "./openTripMaps"
 import express from "express"
 /**
  * Initialize Express application instance.
@@ -22,6 +23,7 @@ function getWelcome(req: express.Request, res: express.Response) {
  * @openapi
  * /welcome:
  *   get:
+ *     summary: retun just hello
  *     description: Welcome to swagger-jsdoc!
  *     responses:
  *       200:
@@ -29,4 +31,88 @@ function getWelcome(req: express.Request, res: express.Response) {
  */
 app.get("/welcome", getWelcome)
 
+/**
+ * @openapi
+ * /otm/city:
+ *  get:
+ *      summary: return the drinks in a city
+ *      description: return the drinks in a defined perimeter in a city
+ *      parameters:
+ *        - name: name
+ *          in: query
+ *          required: true
+ *          description: the name of the city
+ *          schema:
+ *              type: string
+ *      responses:
+ *          200:
+ *              description: Return a list of bars and coffee in city in geoJSON format
+ *          400:
+ *              description: Missing Argument Error
+ *          401:
+ *              description: Missing OTM tocken
+ */
+app.get("/otm/city", getCity)
+
+
+/**
+ * @openapi
+ * /otm/radius:
+ *  get:
+ *      summary: return the drinks in a radius
+ *      description: return the drinks in a defined radius
+ *      parameters:
+ *        - name: lon
+ *          in: query
+ *          required: true
+ *          description: longitude of the center of the radius
+ *          schema:
+ *              type: number
+ *              minimum: -180
+ *              maximum: 180
+ *        - name: lat
+ *          in: query
+ *          required: true
+ *          description: latitude of the center of the radius
+ *          schema:
+ *              type: number
+ *              minimum: -90
+ *              maximum: 90
+ *        - name: radius
+ *          in: query
+ *          description: size of the radius
+ *      responses:
+ *          200:
+ *              description: Return a list of bars and coffee in city in geoJSON format
+ *          400:
+ *              description: Missing Argument Error
+ *          401:
+ *              description: Missing OTM tocken
+ */
+app.get("/otm/radius", getRadius)
+
+
+/**
+ * @openapi
+ * /otm/poidetaill:
+ *  get:
+ *      summary: detail of a POI
+ *      description: detail of a POI link name, kind, rate,...
+ *      parameters:
+ *        - name: id
+ *          in: query
+ *          required: true
+ *          description: Unique identifier of the object in OpenTripMap
+ *          schema:
+ *              type: string
+ *      responses:
+ *          200:
+ *              description: Return a list of bars and coffee in city in geoJSON format
+ *          400:
+ *              description: Missing Argument Error
+ *          401:
+ *              description: Missing OTM tocken
+ */
+app.get("/otm/poidetaill", getPoiId)
+
 export default app

Express/barAndCafe/src/openTripMaps.ts

@@ -0,0 +1,139 @@
+import axios from 'axios';
+import express from "express"
+import * as dotenv from "dotenv";
+
+dotenv.config({path: '../../.env'})
+const key = process.env.OPEN_TRIP_MAPS_KEY
+
+/**
+ * make GET request to the OTM for radius search.
+ * @param {string} lon Longitude of radius center point
+ * @param {string} lat Latitude du point central du rayon
+ * @param {string} radius search radius size in meters
+ * @returns {FeatureCollection} a list of POIs with their type, id, etc. (cf: [opentripmap](https://dev.opentripmap.org/docs#))
+ */
+async function callRadius(lon: string, lat: string, radius = '1000') {
+    const optionsDrink = {
+        method: 'GET',
+        url: 'https://api.opentripmap.com/0.1/en/places/radius',
+        params: {
+            radius: radius,
+            lon: lon,
+            lat: lat,
+            apikey: key,
+            kinds: 'bars,cafes,pubs,biergartens'
+        },
+        headers: {'Content-Type': 'application/json'}
+    }
+
+    try {
+        const { data } = await axios.request(optionsDrink);
+        return data
+    } catch (error) {
+        console.error(error);
+    }
+}
+
+/**
+ * make GET request to the OTM for city info.
+ * @param {string} name Name of a city
+ * @returns {Geoname} info of a search city their name, country, lat, lon, etc. (cf: [opentripmap](https://dev.opentripmap.org/docs#))
+ */
+async function callCity(name:string) {
+    const optionsCity = {
+        method: 'GET',
+        url: 'https://api.opentripmap.com/0.1/en/places/geoname',
+        params: {
+            name: name,
+            apikey: key
+        },
+        headers: {'Content-Type': 'application/json'}
+    };
+    
+    try {
+        const { data } = await axios.request(optionsCity);
+        return data
+    } catch (error) {
+        console.error(error);
+    }
+}
+
+/**
+ * make GET request to the OTM for city info.
+ * @param {string} name Name of a city
+ * @returns {Geoname} info of a search city their name, country, lat, lon, etc. (cf: [opentripmap](https://dev.opentripmap.org/docs#))
+ */
+async function callId(id:string) {
+    const optionsId = {
+        method: 'GET',
+        url: 'https://api.opentripmap.com/0.1/en/places/xid/' + id,
+        params: {
+            apikey: key
+        },
+        headers: {'Content-Type': 'application/json'}
+    };
+
+    try {
+        const { data } = await axios.request(optionsId);
+        return data
+    } catch (error) {
+        console.error(error);
+    }
+}
+
+/**
+ * Handle GET request for city search route ('/otm/city').
+ * @param {express.Request} req - HTTP Request object.
+ * @param {express.Response} res - HTTP Response object.
+ */
+export async function getCity(req: express.Request, res: express.Response) {
+    const cityName = req.query["name"]
+    let radius = req.query["radius"]
+
+    if(!cityName){
+        res.status(400).send("Missing Argument name")
+        return
+    }
+    if(!radius){
+        radius = "1000"
+    }
+    const cityPose = await callCity(cityName as string)
+    res.send( await callRadius(cityPose.lon,cityPose.lat, radius as string))
+}
+
+/**
+ * Handle GET request for radius search route ('/otm/radius').
+ * @param {express.Request} req - HTTP Request object.
+ * @param {express.Response} res - HTTP Response object.
+ */
+export async function getRadius(req:express.Request, res: express.Response) {
+    const lon = req.query["lon"] as string
+    const lat = req.query["lat"] as string
+    let radius = req.query["radius"]
+    if(!lon || !lat){
+        res.status(400).send("Missing Argument name")
+        return
+    }
+    if(!radius){
+        radius = "1000"
+    }
+
+    res.send( await callRadius(lon,lat,radius as string))
+}
+
+/**
+ * Handle GET request for radius search route ('/otm/radius').
+ * @param {express.Request} req - HTTP Request object.
+ * @param {express.Response} res - HTTP Response object.
+ */
+export async function getPoiId(req: express.Request, res: express.Response){
+    const id = req.query["id"] as string
+    if(!id){
+        res.status(400).send("Missing Argument name")
+        return
+    }
+    res.send( await callId( id as string))
+}
+
+//TODO: fair une route ou l'on donne l'id un établicement pour avoir des détailles
+//TODO: fair une route ou l'on donne 2 coordonée

Express/barAndCafe/src/swaggerDef.ts

@@ -16,6 +16,9 @@ const options = {
 			{
 				url: "http://localhost:"+port.toString(),
 			},
+			{
+				url: "https://drink-tweb.cb85.fr"
+			}
 		],
 	},
 	apis: ['./src/*.ts'],

Express/barAndCafe/test/app.test.ts

@@ -10,17 +10,7 @@ let serveur : Server<typeof IncomingMessage, typeof ServerResponse>
 
 describe("Test the welcome path", () => {
 
-    beforeEach(() => {
+    test("It should response the 200 code for GET method", done => {
-        serveur = app.listen(port, () =>{
-            console.log(`serveur running in ${port}`)
-        })
-    })
-    
-    afterEach((done) => {
-        serveur.close(done)
-    })
-
-    test("It should response the GET method", done => {
         request(app)
         .get("/welcome")
         .then(response => {
@@ -29,7 +19,7 @@ describe("Test the welcome path", () => {
         });
     });
 
-    test("It should response the GET method", done => {
+    test("It should response the GET method with content", done => {
         const out = {hello:"world"};
         request(app)
         .get("/welcome")

Express/barAndCafe/test/openTripMaps.test.ts

@@ -0,0 +1,169 @@
+import request from "supertest";
+import app from "../src/app";
+import { Server, IncomingMessage, ServerResponse } from "http";
+import * as dotenv from "dotenv";
+
+dotenv.config({path: '../../.env'})
+const port = parseInt(process.env.BAR_PORT || '3000')
+
+let serveur : Server<typeof IncomingMessage, typeof ServerResponse>
+
+describe("Test the otm city path", () => {
+
+    test("It should response the 200 code for GET method", done => {
+        request(app)
+        .get("/otm/city")
+        .query({'name':'La roche sur yon'})
+        .then(response => {
+            expect(response.statusCode).toBe(200);
+            done();
+        });
+    });
+
+    test("It should response the GET method with content", done => {
+        const out = {
+            "type": "FeatureCollection",
+            "features": [{
+                "type": "Feature",
+                "id": "562635",
+                "geometry": {
+                    "type": "Point",
+                    "coordinates": [
+                        -1.4344594,
+                        46.6686478
+                    ]
+                },
+                "properties": {
+                    "xid": "N4032296324",
+                    "name": "Le 27 point carré",
+                    "dist": 236.40360026,
+                    "rate": 1,
+                    "osm": "node/4032296324",
+                    "kinds": "foods,bars,tourist_facilities"
+                }
+            }]
+        }
+
+        request(app)
+        .get("/otm/city")
+        .query({'name':'La roche sur yon', "radius": 240})
+        .then(response => {
+            console.log(response.text)
+            expect(response.text).toEqual(JSON.stringify(out))
+            done();
+        });
+    });
+
+    test("It should response the 400 code for GET method", done => {
+        request(app)
+        .get("/otm/city")
+        .then(response => {
+            console.log(response.text)
+            expect(response.statusCode).toBe(400);
+            done();
+        });
+    });
+
+    test("It should response the 200 code for GET method", done => {
+        request(app)
+        .get("/otm/radius")
+        .query({'lon':'-1.4344594', 'lat' : '46.6686478', 'radius': '10'})
+        .then(response => {
+            expect(response.statusCode).toBe(200);
+            done();
+        });
+    });
+
+    //TODO faire les test pour les cas d'erreur
+
+    test("Get bar in radius from API", done  => {
+        const out = {
+            "type": "FeatureCollection",
+            "features": [{
+                "type": "Feature",
+                "id": "562635",
+                "geometry": {
+                    "type": "Point",
+                    "coordinates": [
+                        -1.4344594,
+                        46.6686478
+                    ]
+                },
+                "properties": {
+                    "xid": "N4032296324",
+                    "name": "Le 27 point carré",
+                    "dist": 0.17652159,
+                    "rate": 1,
+                    "osm": "node/4032296324",
+                    "kinds": "foods,bars,tourist_facilities"
+                }
+            }]
+        }
+        request(app)
+        .get("/otm/radius")
+        .query({'lon':'-1.4344594', 'lat' : '46.6686478', 'radius': '10'})
+        .then(response => {
+            expect(response.text).toEqual(JSON.stringify(out));
+            done();
+        });
+    })
+
+    test("It should response the 200 code for GET method", done => {
+        request(app)
+        .get("/otm/poidetaill")
+        .query({'id':'562635'})
+        .then(response => {
+            expect(response.statusCode).toBe(200);
+            done();
+        });
+    });
+
+    test("Get bar in radius from API", done  => {
+    const out = {
+        "xid": "N4032296324",
+        "name": "Le 27 point carré",
+        "address": {
+          "road": "Rue Raymond Poincaré",
+          "town": "La Roche-sur-Yon",
+          "state": "Pays de la Loire",
+          "county": "La Roche-sur-Yon",
+          "suburb": "Zola",
+          "country": "France",
+          "postcode": "85000",
+          "country_code": "fr",
+          "house_number": "27",
+          "neighbourhood": "Cité des Forges"
+        },
+        "rate": "1",
+        "osm": "node/4032296324",
+        "kinds": "foods,bars,tourist_facilities",
+        "sources": {
+          "geometry": "osm",
+          "attributes": [
+            "osm"
+          ]
+        },
+        "otm": "https://opentripmap.com/en/card/N4032296324",
+        "point": {
+          "lon": -1.4344594478607178,
+          "lat": 46.66864776611328
+        }
+      }
+        request(app)
+        .get("/otm/poidetaill")
+        .query({'id':'562635'})
+        .then(response => {
+            expect(response.text).toEqual(JSON.stringify(out));
+            done();
+        });
+    })
+
+    test("It should response the 200 code for GET method", done => {
+        request(app)
+        .get("/otm/poidetaill")
+        .then(response => {
+            expect(response.statusCode).toBe(400);
+            done();
+        });
+    });
+});

bruno/OpenData datatourisme/environments/dev.bru

@@ -1,3 +1,7 @@
+vars {
+  TRIPMAP_URL: https://api.opentripmap.com/0.1
+}
 vars:secret [
-  app_key
+  app_key,
+  OTM_KEY
 ]

bruno/OpenData datatourisme/express Drink OTM.bru

@@ -1,7 +1,7 @@
 meta {
-  name: express test
+  name: express Drink OTM
   type: http
-  seq: 3
+  seq: 4
 }
 
 get {

bruno/OpenData datatourisme/get return format.bru

@@ -0,0 +1,11 @@
+meta {
+  name: get return format
+  type: http
+  seq: 11
+}
+
+get {
+  url: https://dev.opentripmap.org/openapi.en.json
+  body: none
+  auth: none
+}

bruno/OpenData datatourisme/otm_drink.bru

@@ -0,0 +1,19 @@
+meta {
+  name: otm_drink
+  type: http
+  seq: 6
+}
+
+get {
+  url: {{TRIPMAP_URL}}/en/places/radius?radius=10&lon=-1.4344594&lat=46.6686478&apikey={{OTM_KEY}}&kinds=bars,cafes,pubs,biergartens
+  body: none
+  auth: none
+}
+
+query {
+  radius: 10
+  lon: -1.4344594
+  lat: 46.6686478
+  apikey: {{OTM_KEY}}
+  kinds: bars,cafes,pubs,biergartens
+}

bruno/OpenData datatourisme/otm_drink_id.bru

@@ -0,0 +1,15 @@
+meta {
+  name: otm_drink_id
+  type: http
+  seq: 7
+}
+
+get {
+  url: https://api.opentripmap.com/0.1/en/places/xid/562635?apikey={{OTM_KEY}}
+  body: none
+  auth: none
+}
+
+query {
+  apikey: {{OTM_KEY}}
+}

bruno/OpenData datatourisme/otm_ex_city.bru

@@ -0,0 +1,16 @@
+meta {
+  name: otm_ex_city
+  type: http
+  seq: 8
+}
+
+get {
+  url: http://localhost:3001/otm/city?name=La roche sur yon&radius=300
+  body: none
+  auth: none
+}
+
+query {
+  name: La roche sur yon
+  radius: 300
+}

bruno/OpenData datatourisme/otm_ex_drink_id.bru

@@ -0,0 +1,15 @@
+meta {
+  name: otm_ex_drink_id
+  type: http
+  seq: 10
+}
+
+get {
+  url: https://api.opentripmap.com/0.1/en/places/xid/562635?apikey={{OTM_KEY}}
+  body: none
+  auth: none
+}
+
+query {
+  apikey: {{OTM_KEY}}
+}

bruno/OpenData datatourisme/otm_ex_radius.bru

@@ -0,0 +1,16 @@
+meta {
+  name: otm_ex_radius
+  type: http
+  seq: 9
+}
+
+get {
+  url: http://localhost:3001/otm/city?name=La roche sur yon&radius=300
+  body: none
+  auth: none
+}
+
+query {
+  name: La roche sur yon
+  radius: 300
+}

bruno/OpenData datatourisme/otm_location.bru

@@ -0,0 +1,16 @@
+meta {
+  name: otm_location
+  type: http
+  seq: 5
+}
+
+get {
+  url: {{TRIPMAP_URL}}/en/places/geoname?name=Paris&apikey={{OTM_KEY}}
+  body: none
+  auth: none
+}
+
+query {
+  name: Paris
+  apikey: {{OTM_KEY}}
+}

bruno/OpenData datatourisme/test graphQL.bru

@@ -0,0 +1,22 @@
+meta {
+  name: test graphQL
+  type: graphql
+  seq: 3
+}
+
+post {
+  url: https://datatour-tweb.cb85.fr
+  body: graphql
+  auth: none
+}
+
+body:graphql {
+  {
+    poi {
+      total
+      results {
+  			_uri
+      }
+    }
+  }
+}