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

Add Points of Interest API

Author: alnacle

README.md

@@ -284,6 +284,19 @@ HotelOffer[] offers = amadeus.shopping.hotelOffers.get(Params
 HotelOffer hotelOffer = amadeus.shopping.hotelOffersByHotel.get(Params.with("hotelId", "BGLONBGB"));
 // Confirm the availability of a specific offer
 HotelOffer offer = amadeus.shopping.hotelOffer("4BA070CE929E135B3268A9F2D0C51E9D4A6CF318BA10485322FA2C7E78C7852E").get();
+
+// Points of Interest
+// What are the popular places in Barcelona (based a geo location and a radius)
+PointOfInterest[] pointsOfInterest = amadeus.referenceData.locations.pointsOfInterest.get(Params
+   .with("latitude", "41.39715")
+   .and("longitude", "2.160873"));
+
+// What are the popular places in Barcelona? (based on a square)
+PointOfInterest[] pointsOfInterest = amadeus.referenceData.locations.pointsOfInterest.bySquare.get(Params
+    .with("norh", "41.397158")
+    .and("west", "2.160873")
+    .and("south", "41.394582")
+    .and("east", "2.177181"));
 ```
 
 ## Development & Contributing

src/main/java/com/amadeus/referenceData/Locations.java

@@ -5,6 +5,7 @@
 import com.amadeus.Response;
 import com.amadeus.exceptions.ResponseException;
 import com.amadeus.referenceData.locations.Airports;
+import com.amadeus.referenceData.locations.PointsOfInterest;
 import com.amadeus.resources.Location;
 import com.amadeus.resources.Resource;
 import com.google.gson.Gson;
@@ -35,18 +36,28 @@ public class Locations {
   /**
    * <p>
    *   A namespaced client for the
-   *   <code>/v2/reference-data/urls/checkin-links</code> endpoints.
+   *   <code>/v2/reference-data/locations/airports</code> endpoints.
    * </p>
    */
   public Airports airports;
 
+  /**
+   * <p>
+   *   A namespaced client for the
+   *   <code>/v2/reference-data/locations/pois</code> endpoints.
+   * </p>
+   */
+  public PointsOfInterest pointsOfInterest;
+
+
   /**
    * Constructor.
    * @hide
    */
   public Locations(Amadeus client) {
     this.client = client;
     this.airports = new Airports(client);
+    this.pointsOfInterest = new PointsOfInterest(client);
   }
 
   /**
@@ -70,7 +81,7 @@ public Location[] get(Params params) throws ResponseException {
 
   /**
    * Convenience method for calling <code>get</code> without any parameters.
-   * @see Airports#get()
+   * @see Locations#get()
    */
   public Location[] get() throws ResponseException {
     return get(null);

src/main/java/com/amadeus/referenceData/locations/PointsOfInterest.java

@@ -0,0 +1,74 @@
+package com.amadeus.referenceData.locations;
+
+import com.amadeus.Amadeus;
+import com.amadeus.Params;
+import com.amadeus.Response;
+import com.amadeus.exceptions.ResponseException;
+import com.amadeus.referenceData.locations.pointsOfInterest.BySquare;
+import com.amadeus.resources.PointOfInterest;
+import com.amadeus.resources.Resource;
+import com.google.gson.Gson;
+
+/**
+ * <p>
+ *   A namespaced client for the
+ *   <code>/v1/reference-data/locations/pois</code> endpoints.
+ * </p>
+ *
+ * <p>
+ *   Access via the Amadeus client object.
+ * </p>
+ *
+ * <pre>
+ * Amadeus amadeus = Amadeus.builder("clientId", "secret").build();
+ * amadeus.referenceData.locations.pointsOfInterest;</pre>
+ */
+public class PointsOfInterest {
+  private Amadeus client;
+
+
+  /**
+   * <p>
+   *   A namespaced client for the
+   *   <code>/v1/reference-data/locations/pois/by-square</code> endpoints.
+   * </p>
+   */
+  public BySquare bySquare;
+
+  /**
+   * Constructor.
+   * @hide
+   */
+  public PointsOfInterest(Amadeus client) {
+    this.client = client;
+    this.bySquare = new BySquare(client);
+  }
+
+
+  /**
+   * <p>
+   *   Returns a list of relevant point of interests near to a given point.
+   * </p>
+   *
+   * <pre>
+   * amadeus.referenceData.locations.pointsOfInterest.get(Params
+   *   .with("longitude", 2.160873)
+   *   .and("latitude", 41.397158));</pre>
+   *
+   * @param params the parameters to send to the API
+   * @return an API response object
+   * @throws ResponseException when an exception occurs
+   */
+  public PointOfInterest[] get(Params params) throws ResponseException {
+    Response response = client.get("/v1/reference-data/locations/pois", params);
+    return (PointOfInterest[]) Resource.fromArray(response, PointOfInterest[].class);
+  }
+
+  /**
+   * Convenience method for calling <code>get</code> without any parameters.
+   * @see PointsOfInterest#get()
+   */
+  public PointOfInterest[] get() throws ResponseException {
+    return get(null);
+  }
+}

src/main/java/com/amadeus/referenceData/locations/pointsOfInterest/BySquare.java

@@ -0,0 +1,65 @@
+package com.amadeus.referenceData.locations.pointsOfInterest;
+
+import com.amadeus.Amadeus;
+import com.amadeus.Params;
+import com.amadeus.Response;
+import com.amadeus.exceptions.ResponseException;
+import com.amadeus.resources.PointOfInterest;
+import com.amadeus.resources.Resource;
+import com.google.gson.Gson;
+
+/**
+ * <p>
+ *   A namespaced client for the
+ *   <code>/v1/reference-data/locations/pois/by-square</code> endpoints.
+ * </p>
+ *
+ * <p>
+ *   Access via the Amadeus client object.
+ * </p>
+ *
+ * <pre>
+ * Amadeus amadeus = Amadeus.builder("clientId", "secret").build();
+ * amadeus.referenceData.locations.pointsOfInterest.bySquare;</pre>
+ */
+public class BySquare {
+  private Amadeus client;
+
+  /**
+   * Constructor.
+   * @hide
+   */
+  public BySquare(Amadeus client) {
+    this.client = client;
+  }
+
+  /**
+   * <p>
+   *   Returns a list of relevant point of interests within a square defined by
+   *   cardinal points.
+   * </p>
+   *
+   * <pre>
+   * amadeus.referenceData.locations.pointsOfInterest.bySquare.get(Params
+   *   .with("north", 41.397158)
+   *   .and("west", 2.160873)
+   *   .and("south", 41.394582)
+   *   .and("east", 2.177181));</pre>
+   *
+   * @param params the parameters to send to the API
+   * @return an API response object
+   * @throws ResponseException when an exception occurs
+   */
+  public PointOfInterest[] get(Params params) throws ResponseException {
+    Response response = client.get("/v1/reference-data/locations/pois/by-square", params);
+    return (PointOfInterest[]) Resource.fromArray(response, PointOfInterest[].class);
+  }
+
+  /**
+   * Convenience method for calling <code>get</code> without any parameters.
+   * @see PointsOfInterest#get()
+   */
+  public PointOfInterest[] get() throws ResponseException {
+    return get(null);
+  }
+}

src/main/java/com/amadeus/resources/PointOfInterest.java

@@ -0,0 +1,33 @@
+package com.amadeus.resources;
+
+import lombok.Getter;
+import lombok.ToString;
+
+/**
+ * An PointOfInterest object as returned by the Locaion API.
+ * @see com.amadeus.referenceData.locations.PointOfInterest#get()
+ */
+@ToString
+public class PointOfInterest extends Resource {
+  protected PointOfInterest() {}
+
+  private @Getter String type;
+  private @Getter String subType;
+  private @Getter String name;
+  private @Getter GeoCode geoCode;
+  private @Getter String category;
+  private @Getter String[] tags;
+
+  /**
+   * An PointOfInterest-related object as returned by the PointOfInterest API.
+   * @see com.amadeus.referenceData.locations.PointOfInterest#get()
+   */
+  @ToString
+  public class GeoCode {
+    protected GeoCode() {}
+
+    private @Getter double latitude;
+    private @Getter double longitude;
+  }
+
+}

src/test/java/com/amadeus/NamespaceTest.java

@@ -5,6 +5,8 @@
 import com.amadeus.referenceData.Location;
 import com.amadeus.referenceData.Locations;
 import com.amadeus.referenceData.locations.Airports;
+import com.amadeus.referenceData.locations.PointsOfInterest;
+import com.amadeus.referenceData.locations.pointsOfInterest.BySquare;
 import com.amadeus.referenceData.urls.CheckinLinks;
 import com.amadeus.shopping.FlightDates;
 import com.amadeus.shopping.FlightDestinations;
@@ -36,6 +38,8 @@ public void testAllNamespacesExist() {
     Amadeus client = Amadeus.builder("id", "secret").build();
     TestCase.assertNotNull(client.referenceData.urls.checkinLinks);
     TestCase.assertNotNull(client.referenceData.locations.airports);
+    TestCase.assertNotNull(client.referenceData.locations.pointsOfInterest);
+    TestCase.assertNotNull(client.referenceData.locations.pointsOfInterest.bySquare);
     TestCase.assertNotNull(client.referenceData.location("123"));
     TestCase.assertNotNull(client.referenceData.airlines);
     TestCase.assertNotNull(client.travel.analytics.airTraffic.traveled);
@@ -104,6 +108,26 @@ public void testGetMethods() throws ResponseException {
     TestCase.assertNotNull(airports.get(params));
     TestCase.assertEquals(airports.get().length, 2);
 
+    // Testing points of interest
+    Mockito.when(client.get("/v1/reference-data/locations/pois", null))
+        .thenReturn(multiResponse);
+    Mockito.when(client.get("/v1/reference-data/locations/pois", params))
+        .thenReturn(multiResponse);
+    PointsOfInterest pois = new PointsOfInterest(client);
+    TestCase.assertNotNull(pois.get());
+    TestCase.assertNotNull(pois.get(params));
+    TestCase.assertEquals(pois.get().length, 2);
+
+    // Testing points of interest by square
+    Mockito.when(client.get("/v1/reference-data/locations/pois/by-square", null))
+        .thenReturn(multiResponse);
+    Mockito.when(client.get("/v1/reference-data/locations/pois/by-square", params))
+        .thenReturn(multiResponse);
+    PointsOfInterest poisSquare = new PointsOfInterest(client);
+    TestCase.assertNotNull(poisSquare.get());
+    TestCase.assertNotNull(poisSquare.get(params));
+    TestCase.assertEquals(poisSquare.get().length, 2);
+
     // Testing fetching a single location
     Mockito.when(client.get("/v1/reference-data/locations/ALHR", null))
         .thenReturn(singleResponse);