Adding support for Safe Places API

Adding support for Safe Places API

Author: akshitsingla

README.md

@@ -425,6 +425,21 @@ amadeus.airport.predictions.onTime.get({
     airportCode: 'JFK',
     date: '2020-08-01'
 })
+
+// How safe is Barcelona? (based a geo location and a radius)
+amadeus.safety.safetyRatedLocations.get({
+  latitude: 41.397158,
+  longitude: 2.160873
+})
+// How safe is Barcelona? (based on a square)
+amadeus.safety.safetyRatedLocations.bySquare.get({
+  north: 41.397158,
+  west: 2.160873,
+  south: 41.394582,
+  east: 2.177181
+})
+// What is the safety information of a location based on it's Id?
+amadeus.safety.safetyRatedLocation('Q930400801').get()
 ```
 
 ## Development & Contributing

spec/amadeus/namespaces.test.js

@@ -68,6 +68,11 @@ describe('Namespaces', () => {
       expect(amadeus.airport).toBeDefined();
       expect(amadeus.airport.predictions).toBeDefined();
       expect(amadeus.airport.predictions.onTime).toBeDefined();
+
+      expect(amadeus.safety).toBeDefined();
+      expect(amadeus.safety.safetyRatedLocations).toBeDefined();
+      expect(amadeus.safety.safetyRatedLocations.bySquare).toBeDefined();
+      expect(amadeus.safety.safetyRatedLocation).toBeDefined();
     });
 
     it('should define all expected .get methods', () => {
@@ -103,6 +108,10 @@ describe('Namespaces', () => {
 
       expect(amadeus.media.files.generatedPhotos.get).toBeDefined();
       expect(amadeus.airport.predictions.onTime.get).toBeDefined();
+
+      expect(amadeus.safety.safetyRatedLocations.get).toBeDefined();
+      expect(amadeus.safety.safetyRatedLocations.bySquare.get).toBeDefined();
+      expect(amadeus.safety.safetyRatedLocation('XXX').get).toBeDefined();
     });
 
     it('should define all expected .post methods', () => {
@@ -356,5 +365,26 @@ describe('Namespaces', () => {
       expect(amadeus.client.get)
         .toHaveBeenCalledWith('/v1/airport/predictions/on-time', {});
     });
+
+    it('.amadeus.safety.safetyRatedLocations.get', () => {
+      amadeus.client.get = jest.fn();
+      amadeus.safety.safetyRatedLocations.get();
+      expect(amadeus.client.get)
+        .toHaveBeenCalledWith('/v1/safety/safety-rated-locations', {});
+    });
+
+    it('.amadeus.safety.safetyRatedLocations.bySquare.get', () => {
+      amadeus.client.get = jest.fn();
+      amadeus.safety.safetyRatedLocations.bySquare.get();
+      expect(amadeus.client.get)
+        .toHaveBeenCalledWith('/v1/safety/safety-rated-locations/by-square', {});
+    });
+
+    it('.amadeus.safety.safetyRatedLocation().get', () => {
+      amadeus.client.get = jest.fn();
+      amadeus.safety.safetyRatedLocation('XXX').get();
+      expect(amadeus.client.get)
+        .toHaveBeenCalledWith('/v1/safety/safety-rated-locations/XXX');
+    });
   });
 });

src/amadeus.js

@@ -8,6 +8,7 @@ import Travel        from './amadeus/namespaces/travel';
 import EReputation   from './amadeus/namespaces/e_reputation';
 import Media         from './amadeus/namespaces/media';
 import Airport       from './amadeus/namespaces/airport';
+import Safety       from './amadeus/namespaces/safety';
 
 /**
  * The Amadeus client library for accessing the travel APIs.
@@ -67,6 +68,7 @@ class Amadeus {
     this.media          = new Media(this.client);
     this.airport        = new Airport(this.client);
     this.pagination     = new Pagination(this.client);
+    this.safety         = new Safety(this.client);
   }
 
   /**

src/amadeus/namespaces/safety.js

@@ -0,0 +1,29 @@
+import SafetyRatedLocations from './safety/safety_rated_locations';
+import SafetyRatedLocation from './safety/safety_rated_location';
+
+/**
+ * A namespaced client for the
+ * `/v1/safety` endpoints
+ *
+ * Access via the {@link Amadeus} object
+ *
+ * ```js
+ * let amadeus = new Amadeus();
+ * amadeus.safety;
+ * ```
+ *
+ * @param {Client} client
+ * @property {SafetyRatedLocations} safetyRatedLocations
+ */
+class Safety {
+  constructor(client) {
+    this.client = client;
+    this.safetyRatedLocations = new SafetyRatedLocations(client);
+  }
+
+  safetyRatedLocation(locationId) {
+    return new SafetyRatedLocation(this.client, locationId);
+  }
+}
+
+export default Safety;

src/amadeus/namespaces/safety/safety_rated_location.js

@@ -0,0 +1,33 @@
+/**
+ * A namespaced client for the
+ * `/v1/safety/safety-rated-locations` endpoints
+ *
+ * Access via the {@link Amadeus} object
+ *
+ * ```js
+ * let amadeus = new Amadeus();
+ * amadeus.safety.safetyRatedLocation;
+ * ```
+ *
+ * @param {Client} client
+ */
+class SafetyRatedLocation {
+  constructor(client, locationId) {
+    this.client = client;
+    this.locationId = locationId;
+  }
+
+  /**
+   * Retieve safety information of a location by its Id.
+   *
+   * What is the safety information of a location with Id Q930400801?
+   * ```js
+   * amadeus.safety.safetyRatedLocation('Q930400801').get();
+   * ```
+   */
+  get() {
+    return this.client.get(`/v1/safety/safety-rated-locations/${this.locationId}`);
+  }
+}
+
+export default SafetyRatedLocation;

src/amadeus/namespaces/safety/safety_rated_locations.js

@@ -0,0 +1,47 @@
+import BySquare from './safety_rated_locations/by_square';
+
+/**
+ * A namespaced client for the
+ * `/v1/safety/safety-rated-locations` endpoints
+ *
+ * Access via the {@link Amadeus} object
+ *
+ * ```js
+ * let amadeus = new Amadeus();
+ * amadeus.safety.safetyRatedLocations;
+ * ```
+ *
+ * @param {Client} client
+ */
+class SafetyRatedLocations {
+  constructor(client) {
+    this.client = client;
+    this.bySquare = new BySquare(client);
+  }
+
+  /**
+   * /safety/safety-rated-locations
+   *
+   * @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
+   *
+   * How safe is Barcelona? (based a geo location and a radius)
+   *
+   * ```js
+   * amadeus.safety.safetyRatedLocations.get({
+   *   longitude: 2.160873,
+   *   latitude: 41.397158
+   * });
+   * ```
+   */
+  get(params = {}) {
+    return this.client.get('/v1/safety/safety-rated-locations', params);
+  }
+}
+
+export default SafetyRatedLocations;

src/amadeus/namespaces/safety/safety_rated_locations/by_square.js

@@ -0,0 +1,45 @@
+/**
+ * A namespaced client for the
+ * `/v1/safety/safety-rated-locations/by-square` endpoints
+ *
+ * Access via the {@link Amadeus} object
+ *
+ * ```js
+ * let amadeus = new Amadeus();
+ * amadeus.safety.safetyRatedLocations.bySquare;
+ * ```
+ *
+ * @param {Client} client
+ */
+class bySquare {
+  constructor(client) {
+    this.client = client;
+  }
+
+  /**
+   * Returns the safety rating of 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
+   *
+   * How safe is Barcelona? (based on a square)
+   *
+   * ```js
+   * amadeus.safety.safetyRatedLocations.bySquare.get({
+   *   north: 41.397158,
+   *   west: 2.160873,
+   *   south: 41.394582,
+   *   east: 2.177181
+   * });
+   * ```
+   */
+  get(params = {}) {
+    return this.client.get('/v1/safety/safety-rated-locations/by-square', params);
+  }
+}
+
+export default bySquare;