From 91a5eb535d60f80392d7df8230b2af44530dce1e Mon Sep 17 00:00:00 2001
From: Nabeel Shahzad <nshahzad@gmail.com>
Date: Tue, 20 Aug 2019 08:48:45 -0400
Subject: [PATCH] Add abstract class for route finding mechanism

---
 app/Contracts/RouteFinder.php | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 app/Contracts/RouteFinder.php

diff --git a/app/Contracts/RouteFinder.php b/app/Contracts/RouteFinder.php
new file mode 100644
index 00000000..8c79a425
--- /dev/null
+++ b/app/Contracts/RouteFinder.php
@@ -0,0 +1,24 @@
+<?php
+
+namespace App\Contracts;
+
+/**
+ * Abstract class for finding a route from a departure airport to an arrival airport
+ * Can allow for multiple, configurable methods for finding a route, whether it reaches
+ * out to a REST API or implement some sort of internal logic to look through a file
+ * or whatever the logic might be.
+ *
+ * Just one public-facing method needs to be implemented
+ */
+abstract class RouteFinder
+{
+    /**
+     * Find a route from the departure ICAO to the arrival ICAO
+     *
+     * @param $dptIcao
+     * @param $arrIcao
+     *
+     * @return string
+     */
+    abstract public function findRoute($dptIcao, $arrIcao): string;
+}