API: Seat Maps

.github/workflows/examples.yml

@@ -47,3 +47,6 @@ jobs:
 
       - name: Run book with extra baggage example
         run: php ./examples/book-with-extra-baggage.php
+
+      - name: Run book with seat example
+        run: php ./examples/book-with-seat.php

examples/book-with-seat.php

@@ -0,0 +1,116 @@
+<?php
+
+declare(strict_types=1);
+
+require_once __DIR__ . '/../vendor/autoload.php';
+
+use Duffel\Client;
+
+echo "Duffel Flights API - book with seat example\n";
+$start = time();
+
+$client = new Client;
+$client->setAccessToken(getenv('DUFFEL_ACCESS_TOKEN'));
+
+$departureDate = (new DateTime)->add(new DateInterval("P10D"))->format('Y-m-d');
+
+$offerRequest = $client->offerRequests()->create(
+  "economy", 
+  array(
+    array("type" => "adult")
+  ),
+  array(
+    array(
+      "origin" => "LHR",
+      "destination" => "STN", 
+      "departure_date" => $departureDate
+    )
+  )
+);
+
+echo sprintf("Created offer request: %s\n", $offerRequest["id"]);
+
+$offers = $client->offers()->all($offerRequest["id"]);
+
+echo sprintf("Got %s offers\n", count($offers));
+
+$selectedOffer = $offers[0];
+
+echo sprintf("Selected offer %s to book\n", $selectedOffer["id"]);
+
+$pricedOffer = $client->offers()->show($selectedOffer["id"]);
+
+echo sprintf("The final price for offer %s is %s (%s)\n", $pricedOffer["id"],
+  $pricedOffer["total_amount"],
+  $pricedOffer["total_currency"]
+);
+
+$seatMaps = $client->seatMaps()->all($pricedOffer["id"]);
+$availableSeats = [];
+foreach($seatMaps as $seatMap) {
+  foreach($seatMap["cabins"] as $cabin) {
+    foreach($cabin["rows"] as $row) {
+      foreach($row["sections"] as $section) {
+        foreach($section["elements"] as $element) {
+          if ($element["type"] == "seat" && count($element["available_services"]) > 0) {
+            $availableSeats[] = $element;
+          }
+        }
+      }
+    }
+  }
+}
+
+$availableSeat = array_shift($availableSeats);
+$availableSeatService = array_shift($availableSeat["available_services"]);
+
+echo sprintf("Adding seat %s costing %s (%s)\n", $availableSeat["designator"],
+  $availableSeatService["total_amount"],
+  $availableSeatService["total_currency"],
+);
+
+$totalAmount = round(($pricedOffer["total_amount"] + $availableSeatService["total_amount"]), 2);
+
+echo sprintf("Total amount is %s\n", $totalAmount);
+
+$order = $client->orders()->create(array(
+  "selected_offers" => array($pricedOffer["id"]),
+  "services" => array(
+    array(
+      "id" => $availableSeatService["id"],
+      "quantity" => 1,
+    )
+  ),
+  "payments" => array(
+    array(
+      "type" => "balance",
+      "amount" => $totalAmount,
+      "currency" => $pricedOffer["total_currency"]
+    )
+  ),
+  "passengers" => array(
+    array(
+      "id" => $pricedOffer["passengers"][0]["id"],
+      "title" => "mr",
+      "gender" => "m",
+      "given_name" => "Zepp",
+      "family_name" => "Lin",
+      "born_on" => "1990-01-26",
+      "phone_number" => "+441234567890",
+      "email" => "z.e.l@zeppelin.aero",
+    )
+  )
+));
+
+echo sprintf("Created order %s with booking reference %s\n", $order["id"], $order["booking_reference"]);
+
+$orderCancellation = $client->orderCancellations()->create($order["id"]);
+
+echo sprintf("Requested refund quote for order %s – %s (%s) is available\n", $order["id"], $orderCancellation["refund_amount"], $orderCancellation["refund_currency"]);
+
+$client->orderCancellations()->confirm($orderCancellation["id"]);
+
+echo sprintf("Confirmed refund quote for order %s\n", $order["id"]);
+
+$finish = time();
+echo sprintf("Finished in %d seconds.\n", ($finish - $start));

src/Duffel/Api/SeatMaps.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Duffel\Api;
+
+class SeatMaps extends AbstractApi {
+  public function all(string $offerId) {
+    return $this->get('/air/seat_maps?offer_id='.self::encodePath($offerId));
+  }
+}

src/Duffel/Client.php

@@ -11,6 +11,7 @@
 use Duffel\Api\Offers;
 use Duffel\Api\OrderCancellations;
 use Duffel\Api\Orders;
+use Duffel\Api\SeatMaps;
 use Duffel\Exception\InvalidAccessTokenException;
 use Duffel\HttpClient\Builder;
 use Http\Client\Common\HttpMethodsClientInterface;
@@ -73,6 +74,10 @@ public function orders(): Orders {
     return new Orders($this);
   }
 
+  public function seatMaps(): SeatMaps {
+    return new SeatMaps($this);
+  }
+
   public function getAccessToken() {
     return $this->accessToken;
   }

tests/Duffel/Api/SeatMapsTest.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Duffel\Tests\Api;
+
+use Duffel\Api\SeatMaps;
+use Duffel\Client;
+use Http\Client\Common\HttpMethodsClientInterface;
+use PHPUnit\Framework\TestCase;
+
+class SeatMapsTest extends TestCase {
+  private $mock;
+  private $stub;
+
+  public function setUp(): void {
+    $this->mock = $this->createMock(HttpMethodsClientInterface::class);
+    $this->stub = $this->createStub(Client::class);
+    $this->stub->method('getHttpClient')
+               ->willReturn($this->mock);
+  }
+
+  public function testAllCallsGetWithExpectedUri(): void {
+    $this->mock->expects($this->once())
+               ->method('get')
+               ->with(
+                 $this->equalTo('/air/seat_maps?offer_id=some-offer-id'),
+                 $this->equalTo([]),
+               );
+
+    $actual = new SeatMaps($this->stub);
+    $actual->all('some-offer-id');
+  }
+}

tests/Duffel/ClientTest.php

@@ -11,6 +11,7 @@
 use Duffel\Api\Offers;
 use Duffel\Api\OrderCancellations;
 use Duffel\Api\Orders;
+use Duffel\Api\SeatMaps;
 use Duffel\Client;
 use Duffel\Exception\InvalidAccessTokenException;
 use Duffel\HttpClient\Builder;
@@ -67,6 +68,10 @@ public function testOrdersUsesApiClass(): void {
     $this->assertInstanceOf(Orders::class, $this->subject->orders());
   }
 
+  public function testSeatMapsUsesApiClass(): void {
+    $this->assertInstanceOf(SeatMaps::class, $this->subject->seatMaps());
+  }
+
   public function testSetAccessTokenChangesValue(): void {
     $this->subject->setAccessToken('some-token');