coding challenge 1

Author: jschaedl

.env

@@ -0,0 +1,28 @@
+# In all environments, the following files are loaded if they exist,
+# the latter taking precedence over the former:
+#
+#  * .env                contains default values for the environment variables needed by the app
+#  * .env.local          uncommitted file with local overrides
+#  * .env.$APP_ENV       committed environment-specific defaults
+#  * .env.$APP_ENV.local uncommitted environment-specific overrides
+#
+# Real environment variables win over .env files.
+#
+# DO NOT DEFINE PRODUCTION SECRETS IN THIS FILE NOR IN ANY OTHER COMMITTED FILES.
+#
+# Run "composer dump-env prod" to compile .env files for production use (requires symfony/flex >=1.2).
+# https://symfony.com/doc/current/best_practices.html#use-environment-variables-for-infrastructure-configuration
+
+###> symfony/framework-bundle ###
+APP_ENV=dev
+APP_SECRET=3e770e49c1c79c4dc01aef40b134d86f
+###< symfony/framework-bundle ###
+
+###> doctrine/doctrine-bundle ###
+# Format described at https://www.doctrine-project.org/projects/doctrine-dbal/en/latest/reference/configuration.html#connecting-using-a-url
+# IMPORTANT: You MUST configure your server version, either here or in config/packages/doctrine.yaml
+#
+DATABASE_URL=sqlite:///%kernel.project_dir%/var/data.db
+# DATABASE_URL="mysql://db_user:db_password@127.0.0.1:3306/db_name?serverVersion=5.7"
+# DATABASE_URL="postgresql://db_user:db_password@127.0.0.1:5432/db_name?serverVersion=13&charset=utf8"
+###< doctrine/doctrine-bundle ###

.env.test

@@ -0,0 +1,7 @@
+# define your env variables for the test env here
+KERNEL_CLASS='App\Kernel'
+APP_SECRET='$ecretf0rt3st'
+SYMFONY_DEPRECATIONS_HELPER=999999
+PANTHER_APP_ENV=panther
+PANTHER_ERROR_SCREENSHOT_DIR=./var/error-screenshots
+DATABASE_URL=sqlite:///%kernel.project_dir%/var/test.db

.gitignore

@@ -8,3 +8,19 @@
 /var/
 /vendor/
 ###< symfony/framework-bundle ###
+
+###> friendsofphp/php-cs-fixer ###
+/.php-cs-fixer.php
+/.php-cs-fixer.cache
+###< friendsofphp/php-cs-fixer ###
+
+###> symfony/phpunit-bridge ###
+.phpunit
+.phpunit.result.cache
+/phpunit.xml
+###< symfony/phpunit-bridge ###
+
+###> phpunit/phpunit ###
+/phpunit.xml
+.phpunit.result.cache
+###< phpunit/phpunit ###

.php-cs-fixer.dist.php

@@ -0,0 +1,15 @@
+<?php
+
+$finder = (new PhpCsFixer\Finder())
+    ->in(__DIR__)
+    ->exclude('var')
+    ->exclude('vendor')
+;
+
+return (new PhpCsFixer\Config())
+    ->setRules([
+        '@Symfony' => true,
+        'php_unit_method_casing' => false,
+    ])
+    ->setFinder($finder)
+;

CODING-CHALLENGE-1.md

@@ -0,0 +1,15 @@
+# RESTful Webservices in Symfony
+
+## Coding Challenge 1 - Getting started
+
+### Task
+
+- create a controller to list all attendees
+- create a controller to view a single attendee
+- please check out `Workshop/ListController` and `Workshop/ReadController` as an example
+
+### Solution
+
+- use Symfony's `Route` attribute to configure the route of your controllers
+- use HTTP `GET`
+- return a JSON representation

Makefile

@@ -0,0 +1,44 @@
+COMPOSER_CMD=composer
+SYMFONY_CMD=bin/console
+PHP_CS_FIXER_CMD=vendor/bin/php-cs-fixer
+PHPUNIT_CMD=vendor/bin/phpunit
+
+help:
+	@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_\-\.]+:.*?## / {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST)
+
+dev-init:                                                                      ## setup application
+	$(COMPOSER_CMD) install
+	$(SYMFONY_CMD) doctrine:database:drop --force
+	$(SYMFONY_CMD) doctrine:database:create
+	$(SYMFONY_CMD) doctrine:schema:create
+	$(SYMFONY_CMD) hautelook:fixtures:load -n --no-bundles
+
+fixtures:                                                                      ## load fixtures
+	$(SYMFONY_CMD) hautelook:fixtures:load -n -vvv --no-bundles
+
+cache-clear:                                                                   ## clear symfony cache
+	$(SYMFONY_CMD) cache:clear
+
+lint-config:                                                                   ## lint configuration files
+	$(SYMFONY_CMD) lint:yaml config
+
+lint-container:                                                                ## lint container configuration
+	$(SYMFONY_CMD) lint:container
+
+lint: lint-config lint-container                                               ## lint config/templates/container
+
+cs-check:                                                                      ## run cs fixer (dry-run)
+	PHP_CS_FIXER_FUTURE_MODE=1 $(PHP_CS_FIXER_CMD) fix --allow-risky=yes --diff --dry-run
+
+cs-fix:                                                                        ## run cs fixer
+	PHP_CS_FIXER_FUTURE_MODE=1 $(PHP_CS_FIXER_CMD) fix --allow-risky=yes
+
+qa: lint cs-check                                                              ## run qa tools
+
+tests:                                                                         ## run tests
+	$(PHPUNIT_CMD)
+
+tests-update-snapshots:                                                        ## run tests and update snapshots
+	$(PHPUNIT_CMD) -d -update-snapshots
+
+.PHONY: help dev-init fixtures cache-clear lint-config lint-templates lint-container lint cs-check cs-fix qa tests tests-update-snapshots

README.md

@@ -0,0 +1,103 @@
+# RESTful Webservices in Symfony
+
+## [Jan Schädlich](http://janschaedlich.de) | Team Lead PHP Development @ Siemens Mobility Portugal
+
+### Workshop @ SymfonyWorld Online Winter Edition 2021 on 7th of December 2021
+
+> Nowadays RESTful APIs are powering the web and are used in almost every web application.
+> In this workshop you will learn the fundamental principles of REST and how you can implement a RESTful application using Symfony. 
+>
+> We will start with the basics of REST and will cover some more advanced topics like Serialization, Content-Negotiation, Security afterwards.
+> Besides all the theory you can deepen your learnings on every topic while doing the provided coding challenges.
+>
+> In addition to an IDE (or text editor) you need a current version of PHP, Composer and Symfony CLI.
+
+Code written for the "RESTful Webservices in Symfony" workshop @ SymfonyWorld Online Winter Edition 2021.
+
+This is example code that is not production-ready. It is intended for studying and learning purposes.
+
+(c) 2021 Jan Schädlich All rights reserved.
+
+## Installation
+
+    # checkout the project
+    $ git clone git@github.com:jschaedl/RESTful-Webservices-in-Symfony.git
+
+    # initialize dev environment
+    $ make dev-init
+    
+    # start webserver
+    $ symfony serve -d
+
+## Tools
+
+- Symfony Binary: https://symfony.com/download
+- Postman App: https://www.getpostman.com/downloads
+  
+## Coding Challenge
+
+For a 2-day conference, workshops and participants must be recorded.
+Each workshop last one day.
+All workshops have a participation limit of 25 people.
+Each attendee can only take part in one workshop per day.
+
+We are going to build an API that can be used to organize workshops.
+Our API should offer the following basic features:
+
+- List all workshops
+- Read a single workshop
+- Create a workshop
+- Update a workshop
+- Delete a workshop
+- List all attendees
+- Read a single attendee
+- Create an attendee
+- Update an attendee
+- Delete an attendee
+- Add an attendee to a workshop
+- Remove an attendee from a workshop
+- The listing of workshops and attendees should support pagination
+- The API should support JSON and XML
+
+We also want to limit access to our API as follows:
+
+- Listing of all workshops is allowed for everyone
+- Reading a single workshop is only allowed for logged-in users with the `ROLE_USER` role
+- Creating and updating a workshop is only allowed for logged-in users with the `ROLE_USER` role
+- Deleting a workshop is only allowed for logged-in users with the `ROLE_ADMIN` role
+- Listing of all attendees is allowed for everyone
+- Reading a single attendee is only allowed for logged-in users with the `ROLE_USER` role
+- Creating and updating a attendee is only allowed for logged-in users with the `ROLE_USER` role
+- Deleting an attendee is only allowed for logged-in users with the `ROLE_ADMIN` role
+- Adding/removing an attendee to/from a workshop is only allowed for logged-in users with the `ROLE_USER` role
+
+## Endpoints
+
+### Workshop
+
+HTTP Method | Endpoint
+----------- | --------
+ GET        | /workshops
+ POST       | /workshops
+ GET        | /workshops/{workshopId}
+ PUT        | /workshops/{workshopId}
+ DELETE     | /workshops/{workshopId}
+ POST       | /workshops/{workshopId}/attendees/{attendeeId}/add
+ POST       | /workshops/{workshopId}/attendees/{attendeeId}/remove
+
+### Attendee
+
+HTTP Method | Endpoint
+----------- | --------
+ GET        | /attendees
+ POST       | /attendees
+ GET        | /attendees/{attendeeId}
+ PUT        | /attendees/{attendeeId}
+ DELETE     | /attendees/{attendeeId}
+
+## Testing
+
+We will add functional tests using a snapshot testing approach to make sure that our endpoints are working correctly.
+
+    # run the test suite
+    $ make phpunit

bin/phpunit

@@ -0,0 +1,13 @@
+#!/usr/bin/env php
+<?php
+
+if (!file_exists(dirname(__DIR__).'/vendor/symfony/phpunit-bridge/bin/simple-phpunit.php')) {
+    echo "Unable to find the `simple-phpunit.php` script in `vendor/symfony/phpunit-bridge/bin/`.\n";
+    exit(1);
+}
+
+if (false === getenv('SYMFONY_PHPUNIT_DIR')) {
+    putenv('SYMFONY_PHPUNIT_DIR='.__DIR__.'/.phpunit');
+}
+
+require dirname(__DIR__).'/vendor/symfony/phpunit-bridge/bin/simple-phpunit.php';

composer.json

@@ -4,17 +4,34 @@
     "minimum-stability": "dev",
     "prefer-stable": true,
     "require": {
-        "php": ">=7.2.5",
+        "php": ">=8",
         "ext-ctype": "*",
         "ext-iconv": "*",
+        "composer/package-versions-deprecated": "1.11.99.4",
+        "doctrine/doctrine-bundle": "^2.5",
+        "doctrine/doctrine-migrations-bundle": "^3.2",
+        "doctrine/orm": "^2.10",
+        "ramsey/uuid": "^4.2",
+        "ramsey/uuid-doctrine": "^1.8",
+        "sensio/framework-extra-bundle": "^6.2",
         "symfony/console": "5.4.*",
+        "symfony/deprecation-contracts": "^2.1|^3",
         "symfony/dotenv": "5.4.*",
         "symfony/flex": "^1.17",
         "symfony/framework-bundle": "5.4.*",
+        "symfony/proxy-manager-bridge": "5.4.*",
         "symfony/runtime": "5.4.*",
-        "symfony/yaml": "5.4.*"
+        "symfony/yaml": "5.4.*",
+        "webmozart/assert": "^1.10"
     },
     "require-dev": {
+        "friendsofphp/php-cs-fixer": "^3.3",
+        "hautelook/alice-bundle": "^2.9",
+        "phpunit/phpunit": "^9.5",
+        "spatie/phpunit-snapshot-assertions": "^4.2",
+        "symfony/browser-kit": "5.4.*",
+        "symfony/css-selector": "5.4.*",
+        "symfony/phpunit-bridge": "^5.2"
     },
     "config": {
         "optimize-autoloader": true,