symfony-rest-installer
Automate Symfony Installation Packages for Rest+ support - JWT - JMS - HWIO - FOSRest - FOSUser, (*1)
There are some instructions to get you all setup., (*2)
Bootstrap a Symfony >2.6 <3.0 (currently not working with 3.0) Rest Backend in minutes, instead of hours
What do you get with this module?
- HWIO Auth for Facebook / Google / Twitter auth
- FOS Userbundle for User managament
- JWT tokens for authentication
- FosRest for Rest support + JMS serialization of data
Requirements - Read before install!
- LAMP working - Apache, MySQL and PHP should be working on your setup already
- Install composer globally
- http://symfony.com/doc/current/cookbook/composer.html
- Add to the composer.json of your symfony root dir the following line:
"minimum-stability": "dev",
- Make sure you have openssl installed, this command should work:
openssl genrsa -out /tmp/test -aes256 4096
- Get your facebook app ID and Secret, this is needed to get Facebook Login working
- https://developers.facebook.com/
- If you don't have an App created, follow the steps and it will provide you with those parameters when done
- Get a tool to test the REST API: POSTMAN recomended
;TL;DR
symfony new symrest
cd symrest
Edit your composer.json file and add the line, (*3)
"minimum-stability": "dev",
With composer install this package:, (*4)
composer require "lionix/symfony-rest-installer":"@dev"
Package configuration will requiere SSL keys, generate them:, (*5)
mkdir -p app/var/jwt/
openssl genrsa -out app/var/jwt/private.pem -aes256 4096
openssl rsa -pubout -in app/var/jwt/private.pem -out app/var/jwt/public.pem
Write down SSL SECRET that you use to generate the keys you'll need on next step, (*6)
Tip: Add this line on your .gitignore file to avoid sharing your private keys:, (*7)
/app/var/*, (*8)
Configure the package with the following command, (*9)
php vendor/lionix/symfony-rest-installer/src/configurePackages.php
configurePackages.php will give you additional manual steps to follow, complete them., (*10)
Sync the database with the modules we just added it:, (*11)
-
For a brand new installation, things can be "forced" a little:, (*12)
mysql -uUSER -pPASSWORD -e "create database symrest"
mysql -uUSER -pPASSWORD -e "GRANT ALL ON symrest.* TO user@localhost IDENTIFIED BY password"
php app/console doctrine:schema:update --force
-
When things has been running for a while, we have to sync the database with a more cautious approach:, (*13)
php app/console doctrine:schema:update --dump-sql
That command display changes needed on the database to work with the new modules, something like this:, (*14)
ALTER TABLE fos_user ADD facebook_id VARCHAR(250) DEFAULT NULL, ADD facebook_access_token VARCHAR(250) DEFAULT NULL;
Tip: Just creating the new tables and columns we're good to go., (*15)
Navigate to localhost/symrest/web/register and create a new account., (*16)
With the user/pass from last step, run this test:, (*17)
curl 'http://localhost/web/app_dev.php/api/v1/getToken' -H 'Content-Type: application/json' \
-H 'Accept: */*' -H 'Connection: keep-alive' -H 'DNT: 1' --data-binary \
'{"username":"USER@gmail.com","password":"PASS"}' --compressed
If everything went right the response should be something like this:, (*18)
{"token":"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9.eyJleHAiOjE0Mjg4OTE5ODEsInVzZXJuYW1lIjoibXJiYXJsZXR0YUBnbWFpbC5jb20iLC\
JpYXQiOiIxNDI4ODA1NTgxIn0.bng6c1bSz9k-2EN-aRRBttBSwM2v2KI8tXAOpFcPhsXYkvJdRFJLTec0x_6LKQrW7idQ-Cj4rbO0rSPdH9giDGprav8\
NtbmFtfqhnvDDxBSfJvzEINmn_ckoEuD5tRPklW1o7p2FEX-GlEE8g9b0FpVe_1sUo3MP0H3lsEh23tvAgt_xp8B3fcw89OQrQfpbCyZdRtnsLIutzyLzk\
make2iGdWPcODjPe-jIucpqrKD1hRrJBx6IdssJlDMZ1FEN_irPFGcZttq2NE9wkJJaPAd4y-3H8uc8x75RdI9Dw5LLhzS7n1Tvi-wqvbVTqXWxgJg4_Tm\
xHOr4MBpCnlPJgtmeBnkYnEhICSWKFalHsc11Lycf7-z6thBhMdIgB9wCRugcCVbsy6W5vkM41mjVo1MugSXdlzDqCZD9cqnT6-7cKr6_3M3t_AreLDvVgl\
AKrsApGEVyBl0UFRl7f9ZwO9ICETtV1dOEQ1SoQpuLs0jQaAqScZ6tmnlKBRf84xdTmSG1DW2riyclbUzhLFj9Fr0ujQCSaejP-ldpvsgFPw1YVkLovHhS7\
8q4HE6ZFjO7uv--bRRkB8iyCgGBjj-Vhh82_Pzm3dpWx6Lxqbg46tyqnJpnmk8JSicycrSXXzicmSdn6iWVfNhmMjxPBZPeimYPd7Z-Ckp2TewX6NvIWFg"}
Thats your JWT token that you will use on your app or in POSTMAN to go around., (*19)
If you're running Ubuntu check the details to have a virtualhost setup easily with a symrest.vcap.me pretty name ;), (*20)
Installation
Install symfony First!, (*21)
symfony new YourAppName
cd YourAppName
composer require "lionix/symfony-rest-installer":"@dev"
php vendor/lionix/symfony-rest-installer/src/configurePackages.php
Configuration
-
Setup symfony database (In case you didn't), (*22)
mysql -uUSER -pPASSWORD -e "create database symfony"
mysql -uUSER -pPASSWORD -e "GRANT ALL ON symfony.* TO user@localhost IDENTIFIED BY password"
** Configure this DB parameters in app/config/parameters.yml
* Tell symfony to create the tables needed, (*23)
php app/console doctrine:schema:update --force
Usage
- Surf to the /register URL of YourAppName (e.g. localhost/symrest/web/register if you didn't use virtual hosts)
- Register into your site - remember user and pass
-
Test the registration with CURL or POSTMAN - if you use curl do this on the console:, (*24)
curl 'http://localhost/web/app_dev.php/api/v1/getToken' -H 'Content-Type: application/json' -H 'Accept: */*' -H 'Connection: keep-alive' -H 'DNT: 1' --data-binary \
'{"username":"USER@gmail.com","password":"PASS"}' --compressed
The response should be something like this:, (*25)
{"token":"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9.eyJleHAiOjE0Mjg4OTE5ODEsInVzZXJuYW1lIjoibXJiYXJsZXR0YUBnbWFpbC5jb20iLC\
JpYXQiOiIxNDI4ODA1NTgxIn0.bng6c1bSz9k-2EN-aRRBttBSwM2v2KI8tXAOpFcPhsXYkvJdRFJLTec0x_6LKQrW7idQ-Cj4rbO0rSPdH9giDGprav8\
NtbmFtfqhnvDDxBSfJvzEINmn_ckoEuD5tRPklW1o7p2FEX-GlEE8g9b0FpVe_1sUo3MP0H3lsEh23tvAgt_xp8B3fcw89OQrQfpbCyZdRtnsLIutzyLzk\
make2iGdWPcODjPe-jIucpqrKD1hRrJBx6IdssJlDMZ1FEN_irPFGcZttq2NE9wkJJaPAd4y-3H8uc8x75RdI9Dw5LLhzS7n1Tvi-wqvbVTqXWxgJg4_Tm\
xHOr4MBpCnlPJgtmeBnkYnEhICSWKFalHsc11Lycf7-z6thBhMdIgB9wCRugcCVbsy6W5vkM41mjVo1MugSXdlzDqCZD9cqnT6-7cKr6_3M3t_AreLDvVgl\
AKrsApGEVyBl0UFRl7f9ZwO9ICETtV1dOEQ1SoQpuLs0jQaAqScZ6tmnlKBRf84xdTmSG1DW2riyclbUzhLFj9Fr0ujQCSaejP-ldpvsgFPw1YVkLovHhS7\
8q4HE6ZFjO7uv--bRRkB8iyCgGBjj-Vhh82_Pzm3dpWx6Lxqbg46tyqnJpnmk8JSicycrSXXzicmSdn6iWVfNhmMjxPBZPeimYPd7Z-Ckp2TewX6NvIWFg"}
Thats your JWT token that you will use on your app or in POSTMAN to go around., (*26)
Configuration with Virtual Host for a fancy name
We will use vcap.me or xip.io DNS Service - This service provides DNS trick that will always return 127.0.0.1 for any address (vcap) or whatever IP you put on the domain (xio), (*27)
symrest.127.0.0.1.xip.io
symrest.vcap.me
UBUNTU/LINUX only - You can automatically create the virtualhost using this handy tool made by RoverWire, (*28)
wget -O virtualhost https://raw.githubusercontent.com/mrbarletta/virtualhost/master/virtualhost.sh
chmod +x virtualhost
sudo ./virtualhost create symrest.vcap.me symrest
Included and ready to use calls
- api/v1/users - Gets all the calls
- api/v1/users/1 - Gets a specific user
Notes
- If you want to use this on a non-fresh symfony installation read and strip the parts needed.
- This is a WIP - we use it at our office to train candidates and bootstrap some prototypes.
Known Issues
no matching package found
Add "minimum-stability": "dev" to the composer.json of your symfony root dir., (*29)
Packages that require @dev will not be installed if this is not used, like hwioauthbundle (requires 0.4 for symfony>2.4)., (*30)
Unauthorized
Apache will strip Authorization headers, so be sure to have this lines in your .htaccess or in your hosts file.
Symfony already has this setup, but will require a AllowOverride all setting in your virtualhost /apache conf., (*31)
RewriteEngine On
RewriteCond %{HTTP:Authorization} ^(.*)
RewriteRule .* - [e=HTTP_AUTHORIZATION:%1]
TODO
- Put some facebook pre-made examples
- Use a Symfony command instead of a plain php
- Make the table configurable - now uses fos_user table, it should be user-defined
- Add #failure_handler / success_handler support functions
- Add ping rest api call to the installer
Wallogit.com
