feat(api): add Alliance contact endpoint (#76)

Add Alliance contact endpoint

Author: Dusty-Meg

src/Http/Controllers/Api/v2/AllianceController.php

@@ -0,0 +1,103 @@
+<?php
+
+/*
+ * This file is part of SeAT
+ *
+ * Copyright (C) 2015 to 2022 Leon Jacobs
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+namespace Seat\Api\Http\Controllers\Api\v2;
+
+use Seat\Api\Http\Resources\ContactResource;
+use Seat\Api\Http\Traits\Filterable;
+use Seat\Eveapi\Models\Contacts\AllianceContact;
+
+/**
+ * Class AllianceController.
+ *
+ * @package Seat\Api\Http\Controllers\Api\v2
+ */
+class AllianceController extends ApiController
+{
+    use Filterable;
+
+    /**
+     * @OA\Get(
+     *      path="/v2/alliance/contacts/{alliance_id}",
+     *      tags={"Contacts"},
+     *      summary="Get a list of contacts for a alliance",
+     *      description="Returns a list of contacts",
+     *      security={
+     *          {"ApiKeyAuth": {}}
+     *      },
+     *      @OA\Parameter(
+     *          name="alliance_id",
+     *          description="Alliance id",
+     *          required=true,
+     *          @OA\Schema(
+     *              type="integer"
+     *          ),
+     *          in="path"
+     *      ),
+     *      @OA\Parameter(
+     *          in="query",
+     *          name="$filter",
+     *          description="Query filter following OData format",
+     *          @OA\Schema(
+     *              type="string"
+     *          )
+     *      ),
+     *      @OA\Response(response=200, description="Successful operation",
+     *          @OA\JsonContent(
+     *              type="object",
+     *              @OA\Property(
+     *                  type="array",
+     *                  property="data",
+     *                  @OA\Items(ref="#/components/schemas/AllianceContact")
+     *              ),
+     *              @OA\Property(
+     *                  property="links",
+     *                  ref="#/components/schemas/ResourcePaginatedLinks"
+     *              ),
+     *              @OA\Property(
+     *                  property="meta",
+     *                  ref="#/components/schemas/ResourcePaginatedMetadata"
+     *              )
+     *          )
+     *      ),
+     *      @OA\Response(response=400, description="Bad request"),
+     *      @OA\Response(response=401, description="Unauthorized"),
+     *     )
+     *
+     * @param  int  $alliance_id
+     * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection
+     */
+    public function getContacts(int $alliance_id)
+    {
+        request()->validate([
+            '$filter' => 'string',
+        ]);
+
+        $query = AllianceContact::with('labels')
+            ->where('alliance_id', $alliance_id)
+            ->where(function ($sub_query) {
+                $this->applyFilters(request(), $sub_query);
+            });
+
+        return ContactResource::collection($query->paginate()->appends(request()->except('page')));
+    }
+}

src/Http/routes.php

@@ -135,6 +135,11 @@
                 Route::get('/wallet-journal/{corporation_id}')->uses('CorporationController@getWalletJournal');
                 Route::get('/wallet-transactions/{corporation_id}')->uses('CorporationController@getWalletTransactions');
             });
+
+            Route::group(['prefix' => 'alliance'], function () {
+
+                Route::get('/contacts/{alliance_id}')->uses('AllianceController@getContacts');
+            });
         });
 
     });