Merge pull request #20 from alnacle/feature/points-of-interest

Add Points of Interest API

Author: alnacle

README.md

@@ -275,6 +275,21 @@ amadeus.shopping.hotelOffersByHotel.get({
 })
 // Confirm the availability of a specific offer id 
 amadeus.shopping.hotelOffer('XXX').get()
+
+// Points of Interest
+// What are the popular places in Barcelona (based a geo location and a radius)
+amadeus.referenceData.locations.pointsOfInterest.get({
+    latitude : 41.397158,
+    longitude : 2.160873
+})
+ 
+// What are the popular places in Barcelona? (based on a square)
+amadeus.referenceData.locations.pointsOfInterest.bySquare.get({
+    north: 41.397158,
+    west: 2.160873,
+    south: 41.394582,
+    east: 2.177181
+})
 ```
 
 ## Development & Contributing

spec/amadeus/namespaces.test.js

@@ -22,6 +22,8 @@ describe('Namespaces', () => {
       expect(amadeus.referenceData.location).toBeDefined();
       expect(amadeus.referenceData.locations).toBeDefined();
       expect(amadeus.referenceData.locations.airports).toBeDefined();
+      expect(amadeus.referenceData.locations.pointsOfInterest).toBeDefined();
+      expect(amadeus.referenceData.locations.pointsOfInterest.bySquare).toBeDefined();
       expect(amadeus.referenceData.airlines).toBeDefined();
 
       expect(amadeus.travel).toBeDefined();
@@ -49,6 +51,8 @@ describe('Namespaces', () => {
       expect(amadeus.referenceData.location('ALHR').get).toBeDefined();
       expect(amadeus.referenceData.locations.get).toBeDefined();
       expect(amadeus.referenceData.locations.airports.get).toBeDefined();
+      expect(amadeus.referenceData.locations.pointsOfInterest.get).toBeDefined();
+      expect(amadeus.referenceData.locations.pointsOfInterest.bySquare.get).toBeDefined();
       expect(amadeus.referenceData.airlines.get).toBeDefined();
 
       expect(amadeus.travel.analytics.airTraffic.searched.get).toBeDefined();
@@ -94,6 +98,20 @@ describe('Namespaces', () => {
         .toHaveBeenCalledWith('/v1/reference-data/locations/airports', {});
     });
 
+    it('.amadeus.referenceData.locations.pointsOfInterest.get', () => {
+      amadeus.client.get = jest.fn();
+      amadeus.referenceData.locations.pointsOfInterest.get();
+      expect(amadeus.client.get)
+        .toHaveBeenCalledWith('/v1/reference-data/locations/pois', {});
+    });
+
+    it('.amadeus.referenceData.locations.pointsOfInterest.bySquare.get', () => {
+      amadeus.client.get = jest.fn();
+      amadeus.referenceData.locations.pointsOfInterest.bySquare.get();
+      expect(amadeus.client.get)
+        .toHaveBeenCalledWith('/v1/reference-data/locations/pois/by-square', {});
+    });
+
     it('.amadeus.referenceData.airlines.get', () => {
       amadeus.client.get = jest.fn();
       amadeus.referenceData.airlines.get();

src/amadeus/namespaces/reference_data/locations.js

@@ -1,4 +1,5 @@
 import Airports from './locations/airports';
+import PointsOfInterest from './locations/pois';
 
 /**
  * A namespaced client for the
@@ -18,6 +19,7 @@ class Locations {
   constructor(client) {
     this.client = client;
     this.airports = new Airports(client);
+    this.pointsOfInterest = new PointsOfInterest(client);
   }
 
   /**

src/amadeus/namespaces/reference_data/locations/points_of_interest/by-square.js

@@ -0,0 +1,45 @@
+/**
+ * A namespaced client for the
+ * `/v1/reference-data/locations/pois/by-square` endpoints
+ *
+ * Access via the {@link Amadeus} object
+ *
+ * ```js
+ * let amadeus = new Amadeus();
+ * amadeus.referenceData.locations.pointsOfInterest.bySquare;
+ * ```
+ *
+ * @param {Client} client
+ */
+class bySquare {
+  constructor(client) {
+    this.client = client;
+  }
+
+  /**
+   * Returns a list of relevant points of interest for a given area.
+   *
+   * @param {Object} params
+   * @param {Double} params.north latitude north of bounding box - required
+   * @param {Double} params.west  longitude west of bounding box - required
+   * @param {Double} params.south latitude south of bounding box - required
+   * @param {Double} params.east  longitude east of bounding box - required
+   * @return {Promise.<Response,ResponseError>} a Promise
+   *
+   * Find relevant points of interest within an area in Barcelona
+   *
+   * ```js
+   * amadeus.referenceData.locations.pointsOfInterest.bySquare.get({
+   *   north: 41.397158,
+   *   west: 2.160873,
+   *   south: 41.394582,
+   *   east: 2.177181
+   * });
+   * ```
+   */
+  get(params = {}) {
+    return this.client.get('/v1/reference-data/locations/pois/by-square', params);
+  }
+}
+
+export default bySquare;

src/amadeus/namespaces/reference_data/locations/pois.js

@@ -0,0 +1,47 @@
+import BySquare from './points_of_interest/by-square';
+
+/**
+ * A namespaced client for the
+ * `/v1/reference-data/locations/pois` endpoints
+ *
+ * Access via the {@link Amadeus} object
+ *
+ * ```js
+ * let amadeus = new Amadeus();
+ * amadeus.referenceData.locations.pointsOfInterest;
+ * ```
+ *
+ * @param {Client} client
+ */
+class pointsOfInterest {
+  constructor(client) {
+    this.client = client;
+    this.bySquare = new BySquare(client);
+  }
+
+  /**
+   * Returns a list of relevant points of interest near to a given point.
+   *
+   * @param {Object} params
+   * @param {Double} params.latitude latitude location to be at the center of
+   *   the search circle - required
+   * @param {Double} params.longitude longitude location to be at the center of
+   *   the search circle - required
+   * @param {Double} params.radius radius of the search in Kilometer - optional
+   * @return {Promise.<Response,ResponseError>} a Promise
+   *
+   * Find relevant points of interest close to Barcelona
+   *
+   * ```js
+   * amadeus.referenceData.locations.pointsOfInterest.get({
+   *   longitude: 2.160873,
+   *   latitude: 41.397158
+   * });
+   * ```
+   */
+  get(params = {}) {
+    return this.client.get('/v1/reference-data/locations/pois', params);
+  }
+}
+
+export default pointsOfInterest;