itsgoingto.be

Symfony and React magic behind itsgoingto.be

The root of this project contains the Symfony app which provides the API.

The React app can be found in the app folder. During development this is loaded through a route in symfony to provide the Symfony debug toolbar. In production the app is loaded from compiled files from the public folder via the .htaccess

Getting started

You will need to have Docker installed and running, also make sure you have PHP 7.2 or higher and Composer installed.

Clone the repository into a local folder.

Now inside the project folder run

composer install
./scripts/docker-build.sh
docker-compose up

You will now be able to access the app at http://localhost:8000 and storybook at http://localhost:6006. Everytime you make a change to the app or storybook stories the app will automatically rebuild and refresh in the browser.

Running tests

Client

To test the React client, run the folowwing from inside the app folder.

npm run lint to run the js linter. npm run test to run all the unit tests using jest.

API

To test the Symfony API, from the following from inside the root of the project.

vendor/bin/phplint src to run the php linter. vendor/bin/phpunit to run the unit tests. vendor/bin/codecept run to run the API end-to-end functional tests.

API

GET /api/polls - Retrieve Polls

POST /api/polls - Create a Poll

GET /api/polls/:identifier - Retrieve a Poll

DELETE /api/polls/:identifier - Delete a Poll

GET /api/polls/:identifier/responses - Retrieve responses info

POST /api/polls/:identifier/responses - Submit/Change users response

POST /api/login - Login

GET /api/stats - Stats

Retrieve Polls

Only returns polls if the user has ROLE_ADMIN

GET /api/polls

Parameters

Name	Type	Description
page	integer	The page to return. Default: 1
pageSize	integer	The ammount of results to retur per page. Default: 20
sort	string	The field to sort on. Options: id, identifier, question, responsesCount, created. Default: id
sortDirection	string	The direction to sort. Options: asc, desc. Default: asc

Example Response

{
  'count': 20,
  'total': 100,
  'entities':[
    {
      "id": 1,
      "identifier": "v90034d6",
      "question": "Is this a question?",
      "multipleChoice": false,
      "endDate": {
        "date": "2017-05-18 13:45:37.000000",
        "timezone_type": 3,
        "timezone": "Europe/London"
      },
      "ended": false,
      "deleted": false,
      "created": {
        "date": "2017-05-18 13:45:37.000000",
        "timezone_type": 3,
        "timezone": "Europe/London"
      },
      "updated": {
        "date": "2017-05-18 13:45:37.000000",
        "timezone_type": 3,
        "timezone": "Europe/London"
      },
      "answers": [
        {
          "type": "Answer",
          "id": 1
        },
        {
          "type": "Answer",
          "id": 2
        }
      ],
      "responsesCount": 5
    },
    ...
  ]
}

Create a Poll

POST /api/polls

Input

Name	Type	Required	Description
question	string	true	The question text.
answers	array	true	Array of answers for the poll. Each answer should be a string
multipleChoice	boolean	false	Is the poll multiple choice. Default: false
endDate	string	false	The end date for the poll. Format: DateTime::ATOM (e.g. 2017-05-18T15:52:01+00:00). Default: null

Example Response

{
  "id": 1,
  "identifier": "v90034d6",
  "question": "Is this a question?",
  "multipleChoice": false,
  "endDate": {
    "date": "2017-05-18 13:45:37.000000",
    "timezone_type": 3,
    "timezone": "Europe/London"
  },
  "ended": false,
  "deleted": false,
  "created": {
    "date": "2017-05-18 13:45:37.000000",
    "timezone_type": 3,
    "timezone": "Europe/London"
  },
  "updated": {
    "date": "2017-05-18 13:45:37.000000",
    "timezone_type": 3,
    "timezone": "Europe/London"
  },
  "answers": [
    {
      "id": 1,
      "answer": "Answer Text",
      "poll": {
        "type": "Poll",
        "id": 1
      },
      "responsesCount": 0
    },
    {
      "id": 2,
      "answer": "Answer Text",
      "poll": {
        "type": "Poll",
        "id": 1
      },
      "responsesCount": 0
    }
  ],
  "userResponses": [],
  "responsesCount": 0
}

Retrieve a Poll

Only returns a non deleted poll unless the user has ROLE_ADMIN

GET /api/polls/:identifier

Example Response

{
  "id": 1,
  "identifier": "v90034d6",
  "question": "Is this a question?",
  "multipleChoice": false,
  "endDate": {
    "date": "2017-05-18 13:45:37.000000",
    "timezone_type": 3,
    "timezone": "Europe/London"
  },
  "ended": false,
  "deleted": false,
  "created": {
    "date": "2017-05-18 13:45:37.000000",
    "timezone_type": 3,
    "timezone": "Europe/London"
  },
  "updated": {
    "date": "2017-05-18 13:45:37.000000",
    "timezone_type": 3,
    "timezone": "Europe/London"
  },
  "answers": [
    {
      "id": 1,
      "answer": "Answer Text",
      "poll": {
        "type": "Poll",
        "id": 1
      },
      "responsesCount": 2
    },
    {
      "id": 2,
      "answer": "Answer Text",
      "poll": {
        "type": "Poll",
        "id": 1
      },
      "responsesCount": 3
    }
  ],
  "userResponses" : [
    2
  ],
  "responsesCount": 5
}

Delete a Poll

Sets the deleted flag to true. Can only be accessed by ROLE_ADMIN

DELETE /api/polls/:identifier

Example Response

{
  "id": 1,
  "identifier": "v90034d6",
  "question": "Is this a question?",
  "multipleChoice": false,
  "endDate": {
    "date": "2017-05-18 13:45:37.000000",
    "timezone_type": 3,
    "timezone": "Europe/London"
  },
  "ended": false,
  "deleted": true,
  "created": {
    "date": "2017-05-18 13:45:37.000000",
    "timezone_type": 3,
    "timezone": "Europe/London"
  },
  "updated": {
    "date": "2017-05-18 13:45:37.000000",
    "timezone_type": 3,
    "timezone": "Europe/London"
  },
  "answers": [
    {
      "type": "Answer",
      "id": 1
    },
    {
      "type": "Answer",
      "id": 2
    }
  ],
  "responsesCount": 5
}

Retrieve responses info

Only returns non deleted poll's responses unless the user has ROLE_ADMIN

GET /api/polls/:identifier/responses

Example Response

{
  "userResponses" : [
    2
  ],
  "responsesCount": 5,
  "answers": [
    {
      "id": 1,
      "responsesCount": 2
    },
    {
      "id": 2,
      "responsesCount": 3
    }
  ]
}

Submit/Change a user response

POST /api/polls/:identifier/responses

Input

Name	Type	Required	Description
answers	array	true	Array of answer ids the user has selected. If the poll is not multiple choice only the first will be used.

Example Response

{
  "userResponses": [
    2
  ],
  "responsesCount": 6,
  "responses" : [
    1
  ],
  "answers": [
    {
      "id": 1,
      "responsesCount": 3
    },
    {
      "id": 2,
      "responsesCount": 3
    }
  ]
}

Login

POST /api/login

Input

Name	Type	Required	Description
username	string	true	The username of the user to login.
password	string	true	The plaintext password of the user to login. Must match the users password or will return a 400 error.

Example Response

{
  "id": 1,
  "username": "admin",
  "created": {
    "date": "2017-11-26 00:26:00",
    "timezone_type": 3,
    "timezone": "Europe/London"
  },
  "updated": {
    "date": "2017-11-26 00:26:00",
    "timezone_type": 3,
    "timezone": "Europe\/London"
  },
  "token": "eyJhbGciOiJSUzI1NiJ9.eyJ1c2VybmFtZSI6ImFkbWlu..." (Valid User Authentication Token)
}

Retrieve Stats

Only returns stats if the user has ROLE_ADMIN

GET /api/stats

Example Response

{
  'polls': 156,
  'responses': 549
}

Copyright

Copyright (c) 2018 James Grant

License

ItsGoingToBe 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 3 of the License, or
(at your option) any later version.

ItsGoingToBe 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 ItsGoingToBe.  If not, see <http://www.gnu.org/licenses/>.