Expose BFF API

app/Election.php

@@ -271,7 +271,7 @@ public function createTotallyOrderedBallot($nBallot) {
             return new CandidateList($candidate);
         }, $totalOrder);
 
-        return new NBallot(1, ...$totalOrder);
+        return new Ballot(...$totalOrder);
     }
 
     public static function ballotToText($nBallot) {

app/Http/Controllers/BffElectionController.php

@@ -0,0 +1,72 @@
+<?php
+
+namespace App\Http\Controllers;
+
+use Illuminate\Routing\Controller as BaseController;
+use Carbon\Carbon;
+use App\Election;
+use App\Elector;
+use Illuminate\Http\Request;
+use Illuminate\Http\Response;
+use Illuminate\Support\Facades\Auth;
+use PivotLibre\Tideman\BffElectionRunner;
+
+class BffElectionController extends BaseController
+{
+    /**
+     * Run a Ranked Pairs election via BFF ballots.
+     *
+     * @SWG\Post(
+     *     tags={"BFF Election Result"},
+     *     path="/open/try",
+     *     summary="Run an election using BFF ballots",
+     *     operationId="calculateResult",
+     *     consumes={"application/x-www-form-urlencoded"},
+     *     produces={"text/plain"},
+     *     @SWG\Parameter(
+     *         name="ballots",
+     *         in="formData",
+     *         description="One or more BFF ballots, one on each line",
+     *         required=true,
+     *         type="string"
+     *     ),
+     *     @SWG\Parameter(
+     *         name="tieBreaker",
+     *         in="formData",
+     *         description="One BFF Ballot for resolving intermediate ties",
+     *         required=true,
+     *         type="string"
+     *     ),
+     *     @SWG\Response(response="200", description="Success", @SWG\Schema(
+     *             type="string",
+     *             description="JSON with a key `result` whose value is a BFF election result"
+     *         )),
+     *     @SWG\Response(response="400", description="Bad Request")
+     * )
+     *
+     * @return \Illuminate\Http\Response
+     */
+    public function calculateResult(Request $request)
+    {
+        if (!$request->has('tieBreaker')) {
+            abort(400, "tieBreaker is a required parameter");
+        } else {
+            $tieBreaker = $request->input('tieBreaker');
+        }
+        if (!$request->has('ballots')) {
+            abort(400, "ballots is a required parameter");
+        } else {
+            $ballots = $request->input('ballots');
+        }
+
+        $runner = new BffElectionRunner();
+        $runner->setTieBreaker($tieBreaker);
+        $result = $runner->run($ballots);
+        return $result;
+    }
+
+    public function form()
+    {
+        return view('bff_form');
+    }
+}

app/Http/Controllers/CandidateController.php

@@ -20,7 +20,7 @@ public function __construct()
      *
      * @SWG\Get(
      *     tags={"Candidates"},
-     *     path="/elections/{electionId}/candidates",
+     *     path="/api/elections/{electionId}/candidates",
      *     summary="View candidates for an election",
      *     operationId="candidateIndex",
      *     @SWG\Parameter(
@@ -51,7 +51,7 @@ public function index(Election $election)
      *
      * @SWG\Get(
      *     tags={"Candidates"},
-     *     path="/elections/{electionId}/candidates/{candidateId}",
+     *     path="/api/elections/{electionId}/candidates/{candidateId}",
      *     summary="Get information about a candidate",
      *     operationId="getCandidateById",
      *     @SWG\Parameter(
@@ -89,7 +89,7 @@ public function show(Election $election, Candidate $candidate)
      *
      * @SWG\Post(
      *     tags={"Candidates"},
-     *     path="/elections/{electionId}/candidates",
+     *     path="/api/elections/{electionId}/candidates",
      *     summary="Add a candidate",
      *     consumes={"application/json"},
      *     produces={"application/json"},
@@ -149,7 +149,7 @@ public function store(Request $request, Election $election)
      *
      * @SWG\Patch(
      *     tags={"Candidates"},
-     *     path="/elections/{electionId}/candidates/{candidateId}",
+     *     path="/api/elections/{electionId}/candidates/{candidateId}",
      *     summary="Update a candidate",
      *     consumes={"application/json"},
      *     produces={"application/json"},
@@ -206,7 +206,7 @@ public function update(Request $request, Election $election, Candidate $candidat
      *
      * @SWG\Delete(
      *     tags={"Candidates"},
-     *     path="/elections/{electionId}/candidates/{candidateId}",
+     *     path="/api/elections/{electionId}/candidates/{candidateId}",
      *     summary="Delete a candidate",
      *     consumes={"application/json"},
      *     produces={"application/json"},

app/Http/Controllers/Controller.php

@@ -1,7 +1,7 @@
 <?php
 /**
  * @SWG\Swagger(
- *     basePath="/api",
+ *     basePath="/",
  *     @SWG\Info(
  *         title="Pivot API",
  *         version="0.1.0"

app/Http/Controllers/ElectionController.php

@@ -16,7 +16,7 @@ class ElectionController extends Controller
     /**
      * @SWG\Get(
      *     tags={"Election"},
-     *     path="/elections",
+     *     path="/api/elections",
      *     operationId="electionIndex",
      *     summary="View all elections",
      *     @SWG\Response(response="200", description="Success", @SWG\Schema(
@@ -87,7 +87,7 @@ public function store(Request $request)
      *
      * * @SWG\Get(
      *     tags={"Election"},
-     *     path="/elections/{electionId}",
+     *     path="/api/elections/{electionId}",
      *     summary="View information about an election",
      *     operationId="getElectionById",
      *     @SWG\Parameter(
@@ -338,4 +338,4 @@ public function batch_candidates_view(Request $request, $election_id)
         $this->authorize('view', $election);
         return $election->candidates;
     }
-}
+}

app/Http/Controllers/ElectorController.php

@@ -17,7 +17,7 @@ class ElectorController extends Controller
      *
      * @SWG\Get(
      *     tags={"Electors"},
-     *     path="/elections/{electionId}/electors",
+     *     path="/api/elections/{electionId}/electors",
      *     summary="View the electorate for an election",
      *     operationId="electorIndex",
      *     @SWG\Parameter(
@@ -69,7 +69,7 @@ public function electors_for_self(Election $election)
      *
      * @SWG\Get(
      *     tags={"Electors"},
-     *     path="/elections/{electionId}/electors/{electorId}",
+     *     path="/api/elections/{electionId}/electors/{electorId}",
      *     summary="Get information about an elector",
      *     operationId="getElectorById",
      *     @SWG\Parameter(

app/Http/Controllers/InviteController.php

@@ -15,7 +15,7 @@ class InviteController extends Controller
      *
      * @SWG\Get(
      *     tags={"Invites"},
-     *     path="/elections/{electionId}/invite",
+     *     path="/api/elections/{electionId}/invite",
      *     summary="View electors who have not accepted their invite yet",
      *     operationId="inviteIndex",
      *     @SWG\Parameter(
@@ -46,7 +46,7 @@ public function index(Election $election)
      *
      * @SWG\Post(
      *     tags={"Invites"},
-     *     path="/elections/{electionId}/invite",
+     *     path="/api/elections/{electionId}/invite",
      *     summary="Send an invite",
      *     operationId="createInvite",
      *     consumes={"application/json"},
@@ -94,7 +94,7 @@ public function store(Request $request, Election $election)
      *
      * @SWG\Post(
      *     tags={"Invites"},
-     *     path="/invite/accept",
+     *     path="/api/invite/accept",
      *     summary="Accept an invite",
      *     consumes={"application/json"},
      *     produces={"application/json"},

app/Http/Controllers/ResultController.php

@@ -14,7 +14,7 @@ class ResultController extends Controller
      *
      * @SWG\Get(
      *     tags={"Election"},
-     *     path="/election/{electionId}/result",
+     *     path="/api/election/{electionId}/result",
      *     summary="View results for an election",
      *     operationId="getElectionResults",
      *     @SWG\Parameter(

composer.json

@@ -19,7 +19,7 @@
         "laravel/framework": "5.4.*",
         "laravel/passport": "^3.0",
         "laravel/tinker": "~1.0",
-        "pivot-libre/tideman": "0.2.0",
+        "pivot-libre/tideman": "0.4.0",
         "aws/aws-sdk-php": "~3.0",
         "guzzlehttp/guzzle": "~6.0"
     },
@@ -60,6 +60,7 @@
     "config": {
         "preferred-install": "dist",
         "sort-packages": true,
-        "optimize-autoloader": true
+        "optimize-autoloader": true,
+        "discard-changes": true
     }
 }