richard/tripbuilder
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Some Error handling and acceptance tests

Browse Source
This commit is contained in:
Richard Morgan
2017-05-15 08:56:10 -04:00
parent 42dc785735
commit 2c8c692890
21 changed files with 457 additions and 126 deletions
Download Patch File Download Diff File Expand all files Collapse all files

67
app/Http/Controllers/AirportController.php
View File

@@ -4,7 +4,7 @@ namespace App\Http\Controllers;
use App\Libraries\IotaCodes\Airport;
use App\Libraries\IotaCodes\AirportTransformer;
use App\Libraries\IotaCodes\Client;
use App\Libraries\IotaCodes\Client as IotaClient;
use Illuminate\Http\Request;
use Illuminate\Pagination\LengthAwarePaginator;
use League\Fractal\Manager;
@@ -18,33 +18,27 @@ use League\Fractal\Serializer\JsonApiSerializer;
class AirportController extends Controller
{
/**
* Create a new controller instance.
*
* @return void
*/
public function __construct()
{
//
}
/**
* Fetch list of airports
*
* @api {get} /airports
* @api {get} /airports list airports
* @apiName List Airports
* @apiGroup Airports
* @apiDescription Fetch list of airports
*
* @apiParam (pagination) {number} [page] page number to display
* @apiParam (pagination) {number} [per_page] number of items to display on the page
* @apiParam (query param) {number} [page=1] page number to display
* @apiParam (query param) {number} [per_page=10] number of items to display on the page
*
* @apiParam (autocomplete) {string} [autocomplete] string to try and autocomplete
* @apiParam (query param) {string} [autocomplete] string to try and autocomplete
*
* @apiExample {curl} example
* curl -i http://localhost:8080/airports?page=1&per_page=10&autocomplete=aar
*
* @param \Illuminate\Http\Request $request
* @return \Illuminate\Http\JsonResponse
*/
public function resourceList(Request $request)
{
$client = Client::create();
$client = IotaClient::create();
$collection = $client->listAirports($request->input('autocomplete'));
//add pagination
@@ -64,12 +58,15 @@ class AirportController extends Controller
}
/**
* Get details of an airport by it's code
* @api {get} /airports/:code get airport
* @apiName Get Airport
* @apiGroup Airports
* @apiDescription Get details of an airport by it's code
*
* @api {get} /airports/:code
* @apiName Get Airport from code
* @apiParam (query param) {string} code 3 letter airport code
*
* @apiParam {string} code 3 letter airport code
* @apiExample {curl} example
* curl -i http://localhost:8080/airports/YUL
*
* @param \Illuminate\Http\Request $request
* @param $code
@@ -77,27 +74,15 @@ class AirportController extends Controller
*/
public function getAirport(Request $request, $code)
{
$client = Client::create();
$client = IotaClient::create();
$airport = $client->getAirport($code);
if (is_null($airport)) {
return $this->returnErrorMessage('not a valid airport code', 400);
}
$result = $client->getAirport($code);
$result = new Item($result, new AirportTransformer(), 'airports');
$result = new Item($airport, new AirportTransformer(), 'airports');
return $this->JsonApiResponse($result, 200);
}
/**
* Convert the response to Json
*
* @param \League\Fractal\Resource\Item $resource
* @param $statusCode
* @return \Illuminate\Http\JsonResponse
*/
protected function JsonApiResponse(ResourceInterface $resource, $statusCode)
{
$manager = new Manager();
$manager->setSerializer(new JsonApiSerializer('http://docker.dev:8080'));
return response()->json($manager->createData($resource)->toArray(), $statusCode);
}
}

34
app/Http/Controllers/Controller.php
View File

@@ -3,8 +3,40 @@
namespace App\Http\Controllers;
use Laravel\Lumen\Routing\Controller as BaseController;
use League\Fractal\Manager;
use League\Fractal\Resource\ResourceInterface;
use League\Fractal\Serializer\JsonApiSerializer;
class Controller extends BaseController
{
//
/**
* Convert the response to Json
*
* @param \League\Fractal\Resource\Item $resource
* @param int $statusCode
* @param string $includes
* @return \Illuminate\Http\JsonResponse
*/
protected function JsonApiResponse(ResourceInterface $resource, $statusCode, $includes = '')
{
$manager = new Manager();
$manager->setSerializer(new JsonApiSerializer('http://docker.dev:8080'));
$manager->parseIncludes($includes);
return response()->json($manager->createData($resource)->toArray(), $statusCode);
}
/**
* format an error message
*
* @param string $message
* @param int $statusCode
* @return \Illuminate\Http\JsonResponse
*/
protected function returnErrorMessage($message, $statusCode = 400)
{
return response()->json([
'error_message' => $message
], $statusCode);
}
}

96
app/Http/Controllers/FlightController.php
View File

@@ -7,7 +7,9 @@ use App\Libraries\Trips\Models\Flights;
use App\Libraries\Trips\Models\Trips;
use App\Libraries\Trips\TripTransformer;
use Illuminate\Http\Request;
use Illuminate\Pagination\LengthAwarePaginator;
use League\Fractal\Manager;
use League\Fractal\Pagination\IlluminatePaginatorAdapter;
use League\Fractal\Resource\Collection;
use League\Fractal\Resource\Item;
use League\Fractal\Resource\ResourceInterface;
@@ -16,62 +18,90 @@ use League\Fractal\Serializer\JsonApiSerializer;
class FlightController extends Controller
{
/**
* Create a new controller instance.
* @api {get} /flights list flights
* @apiName List Flights
* @apiGroup Flights
* @apiDescription List all defined flights
*
* @return void
* @apiParam (query params) {number} [page=1] page to fetch
* @apiParam (query param) {number} [per_page=10] number of results to fetch per page
*
* @apiExample {curl} example
* curl -i http://localhost:8080/flights?page=1&per_page=10
*
* @param \Illuminate\Http\Request $request
* @return \Illuminate\Http\JsonResponse
*/
public function __construct()
{
//
}
public function listFlights(Request $request)
{
$flightCollection = Flights::all();
//TODO: add pagination
//add pagination
$per_page = $request->input('per_page', 10);
$page = $request->input('page', 1);
$paginator = new LengthAwarePaginator(
$flightCollection->forPage($page, $per_page),
$flightCollection->count(),
$per_page,
$page
);
$result = (new Collection($paginator, new TripTransformer(), 'trips'))
->setPaginator(new IlluminatePaginatorAdapter($paginator));
$result = new Collection($flightCollection, new FlightTransform(), 'flights');
return $this->JsonApiResponse($result, 200);
}
/**
* @api {get} /flights/:id get flight
* @apiName Get Flight
* @apiGroup Flights
* @apiDescription get details of a specific flight
*
* @apiParam (url) {number} id the id of the flight to fetch
*
* @apiExample {curl} example
* curl -i http://localhost:8080/flights/1
*
* @param \Illuminate\Http\Request $request
* @param $id
* @return \Illuminate\Http\JsonResponse
*/
public function getFlight(Request $request, $id)
{
$flight = Flights::find($id);
$result = new Item($flight, new FlightTransform(), 'flights');
return $this->JsonApiResponse($result, 200);
}
public function removeFlight(Request $request, $id)
{
/** @var \App\Libraries\Trips\Models\Flights $flight */
$flight = Flights::find($id);
$deleted = $flight->delete();
// $result = new Item($flight, [
// 'id' => $id,
// 'message' => 'flight removed'
// ], 'message');
if (! $flight) {
return $this->returnErrorMessage("flight id $id not found", 400);
}
$result = new Item($flight, new FlightTransform(), 'flights');
return $this->JsonApiResponse($result, 200);
}
/**
* Convert the response to Json
* @api {delete} /flights/:id delete a flight
* @apiName Delete a Flight
* @apiGroup Flights
* @apiDescription delete a flight and remove it from any trips
*
* @param \League\Fractal\Resource\Item $resource
* @param $statusCode
* @apiParam (url) {number} id the id of the flight to fetch
*
* @param \Illuminate\Http\Request $request
* @param $id
* @return \Illuminate\Http\JsonResponse
*/
protected function JsonApiResponse(ResourceInterface $resource, $statusCode)
public function removeFlight(Request $request, $id)
{
$manager = new Manager();
$manager->setSerializer(new JsonApiSerializer('http://docker.dev:8080'));
$manager->parseIncludes('flights');
/** @var \App\Libraries\Trips\Models\Flights $flight */
$flight = Flights::find($id);
$deleted = $flight->delete();
$result = new Item($flight, new FlightTransform(), 'flights');
return response()->json($manager->createData($resource)->toArray(), $statusCode);
return $this->JsonApiResponse($result, 200);
}
}

83
app/Http/Controllers/TripController.php
View File

@@ -2,12 +2,14 @@
namespace App\Http\Controllers;
use App\Libraries\IotaCodes\Client as IotaClient;
use App\Libraries\Trips\Models\Flights;
use App\Libraries\Trips\Models\Trips;
use App\Libraries\Trips\TripTransformer;
use Illuminate\Http\Request;
use Illuminate\Pagination\LengthAwarePaginator;
use League\Fractal\Manager;
use League\Fractal\Pagination\IlluminatePaginatorAdapter;
use League\Fractal\Resource\Collection;
use League\Fractal\Resource\Item;
use League\Fractal\Resource\ResourceInterface;
@@ -24,7 +26,22 @@ class TripController extends Controller
{
//
}
/**
* @api {get} /trips list trips
* @apiName list trips
* @apiGroup Trips
* @apiDescription This api returns a paginated list of trips found
*
* @apiParam (query params) {number} [page=1] page to fetch
* @apiParam (query param) {number} [per_page=10] number of results to fetch per page
*
* @apiExample {curl} example
* curl -i http://localhost:8080/trips?page=1&per_page=10
*
* @param \Illuminate\Http\Request $request
* @return \Illuminate\Http\JsonResponse
*/
public function listTrips(Request $request)
{
$tripsCollection = Trips::all();
@@ -41,10 +58,25 @@ class TripController extends Controller
$result = (new Collection($paginator, new TripTransformer(), 'trips'))
->setPaginator(new IlluminatePaginatorAdapter($paginator));
return $this->JsonApiResponse($result, 200);
}
/**
* @api {get} /trips/:id get trip
* @apiName get trip
* @apiGroup Trips
* @apiDescription Fetch details of a specific trip
*
* @apiParam (url) {number} id the id of the trip to fetch
*
* @apiExample {curl} example
* curl -i http://localhost:8080/trips/1
*
* @param \Illuminate\Http\Request $request
* @param $id
* @return \Illuminate\Http\JsonResponse
*/
public function getTrip(Request $request, $id)
{
$trip = Trips::find($id);
@@ -58,14 +90,36 @@ class TripController extends Controller
return $this->JsonApiResponse($result, 200, 'flights');
}
/**
* @api {post} /trips/:id/flights add flight
* @apiName add flight
* @apiGroup Trips
* @apiDescription send a destination to this endpoint to add a flight to the trip
*
* @apiParam (form data) {string} destination the destination of the new flight
* @apiParam (url) {number} id the id of the trip to fetch
*
* @apiExample {curl} example
* curl -i http://localhost:8080/trips/1/flights
*
* @param \Illuminate\Http\Request $request
* @param $id
* @return \Illuminate\Http\JsonResponse
*/
public function addFlight(Request $request, $id)
{
$trip = Trips::find($id);
$destination = $request->input('destination');
if (! $destination) {
return $this->returnErrorMessage('destination not set', 400);
}
$client = IotaClient::create();
$airport = $client->getAirport($destination);
if (is_null($airport)) {
return $this->returnErrorMessage('destination not a valid airport code', 400);
}
$flight = new Flights(['destination' => $destination]);
$flight->save();
@@ -74,27 +128,4 @@ class TripController extends Controller
$result = new Item($trip, new TripTransformer(), 'trips');
return $this->JsonApiResponse($result, 201, 'flights');
}
/**
* Convert the response to Json
*
* @param \League\Fractal\Resource\Item $resource
* @param $statusCode
* @return \Illuminate\Http\JsonResponse
*/
protected function JsonApiResponse(ResourceInterface $resource, $statusCode, $includes = '')
{
$manager = new Manager();
$manager->setSerializer(new JsonApiSerializer('http://docker.dev:8080'));
$manager->parseIncludes($includes);
return response()->json($manager->createData($resource)->toArray(), $statusCode);
}
protected function returnErrorMessage($message, $statusCode = 400)
{
return response()->json([
'error_message' => $message
], $statusCode);
}
}

8
app/Libraries/IotaCodes/Client.php
View File

@@ -63,11 +63,15 @@ class Client
return $result;
}
/**
* @param $code
* @return Collection
*/
public function getAirport($code)
{
$uri = '/api/v6/airports';
$cacheKey = 'airport.'.$code;
$cacheMinutes = 60;
$cacheMinutes = 1;
$response = app('cache')->get($cacheKey, function () use ($cacheKey, $cacheMinutes, $uri, $code) {
try {
@@ -81,7 +85,7 @@ class Client
]);
} catch (\Exception $e) {
//todo handle error
return new Collection();
}
$result = $response->getBody()->getContents();

22
app/Libraries/Trips/FlightTransform.php
View File

@@ -7,6 +7,15 @@ use League\Fractal\TransformerAbstract;
class FlightTransform extends TransformerAbstract
{
/**
* List of resources possible to include
*
* @var array
*/
protected $availableIncludes = [
'trips'
];
/**
* Turn this item object into a generic array
*
@@ -17,10 +26,23 @@ class FlightTransform extends TransformerAbstract
return [
'id' => $flight->id,
'name' => $flight->destination,
'trips' => $flight->trips()->get(),
'links' => [
'rel' => 'self',
'uri' => '/flights/'.$flight->id,
]
];
}
/**
* Include Trips
*
* @return \League\Fractal\Resource\ResourceAbstract
*/
public function includeTrips(Flights $flight)
{
$flights = $flight->trips()->get();
return $this->collection($flights, new TripTransformer());
}
}

11
app/Libraries/Trips/Models/Trips.php
View File

@@ -16,4 +16,15 @@ class Trips extends Model
{
return $this->belongsToMany(Flights::class, 'trip_flights');
}
/**
* @return array
*/
public function toArray()
{
return [
'id' => $this->id,
'name' => $this->name,
];
}
}

2
app/Libraries/Trips/TripTransformer.php
View File

@@ -36,7 +36,7 @@ class TripTransformer extends TransformerAbstract
}
/**
* Include Author
* Include Flights
*
* @return \League\Fractal\Resource\ResourceAbstract
*/