Merge pull request nerdapplabs#6 from aksinha-nerdapplabs/profile_image_added

Profile Picture added on API and Backend

Author: praveen-garg

README.md

@@ -9,6 +9,13 @@ This is an example project, ready to use. This project is using below Symfony Bu
 * [NelmioApiDocBundle](http://symfony.com/doc/current/bundles/NelmioApiDocBundle/index.html)
 * [AsseticBundle](https://github.com/symfony/assetic-bundle)
 
+The salient features of this Project are:
+* This project consists of **API (currently, user management only) for Frontend consumption, via iPhone and Android Mobiles**, and an **administrative web based Backend system**.
+* The APIs and the Backend system are **internationalization enabled**. Project currently supports English, French and Hindi but can be easily extended to include other languages.
+* This project implements FOSRestBundle **API versioing system** via custom header "X-Accept-Version". Currently, the running API version is 1.0.
+* **Backend theming can easily be customized and extended**. Options have been provided to pick desired front-end theme for the Backend. The choices available are - Bootstrap, Materialize and Skeleton. **To change the theme, modify key "fronend_theme" in parameters.yml accordingly.** However, the design is open-ended and you may add your preferred theme easily. Please also note that theming has only been provided for base and nav. Other top level stuff is using bootstrap, you can theme as per your choice using base theme.
+* The Web user management pages are coming directly from FOSUserBundle views. You may override these pages, per your need.
+
 ## Installation Steps:
 
 **Step 0:**
@@ -34,6 +41,12 @@ This is an example project, ready to use. This project is using below Symfony Bu
       - Composer
       - Chrome browser with Postman plugin or separate Postman installation to test the API (though API can also be  tested via "curl" command)
 
+***Note regarding Webserver:***
+
+As this project uses OAuth2 server, for smooth results, Apache webserver is highly recommended. You may want to create a site, say http://auth.dev, for it. Please refere to section **"Configuring Apache"** below for an example implementation.
+
+However, if you wish to use php local dev server, you will need to start two instances of php local dev server at two different ports (say 8000 and 8080) in two separate terminal windows/tabs,  section **"Use this Package"**, and replace oauth urls accordingly in Step 2 below. This is necessary as php local dev server is a simple single threaded web server and oAuth server needs to work on more than one process simultaneously. Using a single local dev server severly hampers this and blocks execution.
+
 **Step 1 - Clone the project:**
 
     Git clone this project from Github to a web folder, say auth, via
@@ -43,19 +56,37 @@ This is an example project, ready to use. This project is using below Symfony Bu
     cd /path/to/auth
     composer install
 
-**Step 2 - Create Database tables**
+**Step 2 - Replace parameter values in parameters.yml**
+
+    database_host: 127.0.0.1
+    database_port: 3306
+    database_name: authOauth
+    database_user: root
+    database_password: root
+    ...
+    ...
+    oauth2_auth_endpoint: 'http://auth.dev/oauth/v2/auth'
+    oauth2_token_endpoint: 'http://auth.dev/oauth/v2/token'
+    frontend_theme: bootstrap
+
+    If you are using php local dev server, assuming you will be using http://127.0.0.1:8000 for browser use, above endpoint will become something like this:
+
+    oauth2_auth_endpoint: 'http://127.0.0.1:8080/oauth/v2/auth'
+    oauth2_token_endpoint: 'http://127.0.0.1:8080/oauth/v2/token'
+
+**Step 3 - Create Database tables**
 
     cd /path/to/auth
     php app/console doctrine:database:create
     php app/console doctrine:schema:create
 
-**Step 3 - Create assets**
+**Step 4 - Create assets**
 
     cd /path/to/auth
     php app/console assets:install
     php app/console assetic:dump
 
-**Step 4 - Create an Admin user**
+**Step 5 - Create an Admin user**
 
     cd /path/to/auth
     php app/console fos:user:create admin [email protected] password
@@ -66,18 +97,99 @@ This is an example project, ready to use. This project is using below Symfony Bu
 
 Now you are ready to use the Package!
 
+## Configure Apache2
+
+Execute below commands which are specific to Apache2 configuration on Ubuntu 16.04. However, for rest of the env, the detail are quite similar.
+
+```
+$ cd /etc/Apache2
+
+$ sudo cp sites-available/000-default.conf sites-available/auth.conf
+
+```
+
+Via an editor, as superuser, copy/paste below section to sites-available/auth.conf:
+
+```
+    <VirtualHost *:80>
+            # The ServerName directive sets the request scheme, hostname and port that
+            # the server uses to identify itself. This is used when creating
+            # redirection URLs. In the context of virtual hosts, the ServerName
+            # specifies what hostname must appear in the request's Host: header to
+            # match this virtual host. For the default virtual host (this file) this
+            # value is not decisive as it is used as a last resort host regardless.
+            # However, you must set it for any further virtual host explicitly.
+            ServerName auth.dev
+
+            ServerAdmin webmaster@localhost
+            DocumentRoot /var/www/html/authOauth/web
+
+            # Available loglevels: trace8, ..., trace1, debug, info, notice, warn,
+            # error, crit, alert, emerg.
+            # It is also possible to configure the loglevel for particular
+            # modules, e.g.
+            #LogLevel info ssl:warn
+
+            ErrorLog ${APACHE_LOG_DIR}/error.log
+            CustomLog ${APACHE_LOG_DIR}/access.log combined
+
+            # For most configuration files from conf-available/, which are
+            # enabled or disabled at a global level, it is possible to
+            # include a line for only one particular virtual host. For example the
+            # following line enables the CGI configuration for this host only
+            # after it has been globally disabled with "a2disconf".
+            #Include conf-available/serve-cgi-bin.conf
+    </VirtualHost>
+
+    # vim: syntax=apache ts=4 sw=4 sts=4 sr noet
+```
+
+Via an editor, as superuser, modify /etc/hosts to include below line:
+
+```
+127.0.0.1 auth.dev
+```
+
+Now enable auth.conf and restart Apache2:
+
+```
+$ sudo a2ensite auth.conf
+
+$ sudo service apache2 restart
+
+$ cd /var/www/html/authOauth
+
+$ sudo setfacl -R -m u:www-data:rX ../authOauth
+
+$ sudo setfacl -R -m u:www-data:rXw app/cache app/logs
+
+$ sudo setfacl -dR -m u:www-data app/cache app/logs
+
+$ sudo chmod -R ogu+rwx app/cache app/logs web
+```
+
 ## Use this Package
 
 1. Test API
 2. Use API via a Mobile Client
 3. Backend Administration
+4. Troubleshooting
+
+If you are using php local dev server, please start the server at two different ports (say 8000 and 8080) in two terminal windows as below:
 
-You will need to start the server before you can use this package:
+In first terminal window,
 
     cd /path/to/auth
-    php app/console server:run
+    php app/console server:run 127.0.0.1:8000
 
-**Note: This project implements FOSRestBundle API versioing system via custom header "X-Accept-Version". Currently, the running API version is 1.0.**  
+In second terminal window,
+
+    cd /path/to/auth
+    php app/console server:run 127.0.0.1:8080
+
+You may also need to configure parameters.yml accordingly. Then in a browser, you may use http://127.0.0.1:8000 to run this package.
+
+Alternatively, if you have successfully configured Apache2, then modify parameters.yml accordingly can start using the package vide say, http://auth.dev.
 
 #### 1. Test API
 
@@ -101,7 +213,16 @@ Separate sample Github repos are available for iPhone and Android Mobile Clients
 
 In a browser, goto the package site by http://127.0.0.1:8000. This is the Backend Administration tool and can be plugged into any User App easily. It is a simple page. The options are self explanatory.
 
-The salient features of the Backend are:
-* The Backend is internationalization enabled. It currently supports English, French and Hindi.
-* Options have been provided to pick desired front-end theme for the Backend. The choices available are - Bootstrap, Materialize and Skeleton. **To change the theme, modify key "fronend_theme" in parameters.yml accordingly.** However, the design is open-ended and you may add your preferred theme easily. Please also note that theming has only been provided for base and nav. Other top level stuff is using bootstrap, you can theme as per your choice using base theme.
-* The Web user management pages are coming directly from FOSUserBundle views. You may override these pages, per your need.
+#### 4. Troubleshooting
+
+Sometimes, you may run into permission issues. You may try below commands, single or in combination:
+
+```
+$ cd /var/www/html/authOauth
+
+$ php app/console cache:clear
+
+$ sudo rm -rf app/cache/* app/logs/*
+
+$ sudo chmod -R ogu+rwx app/cache app/logs web
+```

app/Resources/FOSUserBundle/views/Security/login.html.twig

@@ -0,0 +1,27 @@
+{% trans_default_domain 'FOSUserBundle' %}
+{% extends "FOSUserBundle::layout.html.twig" %}
+
+{% block fos_user_content %}
+    {% if error %}
+        <div>{{ error|trans({}, 'FOSUserBundle') }}</div>
+    {% endif %}
+
+    <form action="{{ path("fos_user_security_check") }}" method="post" class="form-signin">
+        <input type="hidden" name="_csrf_token" value="{{ csrf_token }}" />
+        <div class="login-container">
+            <h1>Login to Your Account</h1><br>
+            <form>
+                <label for="username">{{ 'security.login.username'|trans }}</label>
+                <input type="text" id="username" name="_username" value="{{ last_username }}" required="required" />
+                <label for="password">{{ 'security.login.password'|trans }}</label>
+                <input type="password" id="password" name="_password" required="required" />
+                <input type="checkbox" id="remember_me" name="_remember_me" value="on" />
+                <label for="remember_me">{{ 'security.login.remember_me'|trans }}</label>
+                <input type="submit" class="login login-submit" id="_submit" name="_submit" value="{{ 'security.login.submit'|trans }}" />
+            </form>
+            <div class="login-help">
+                <a href="{{ path('user_new') }}">Register</a> - <a href="{{ path('fos_user_resetting_request') }}">Forgot Password</a>
+            </div>
+        </div>
+    </form>
+{% endblock fos_user_content %}

app/Resources/FOSUserBundle/views/layout.html.twig

@@ -1,7 +1,7 @@
-{% extends 'base.html.twig' %}
+{% extends '::base.html.twig' %}
 {% block main %}
-        <div>
-            {% block fos_user_content %}
-            {% endblock fos_user_content %}
-        </div>
+  <div>
+      {% block fos_user_content %}
+      {% endblock fos_user_content %}
+  </div>
 {% endblock %}

app/Resources/views/nav_bootstrap.html.twig

@@ -27,13 +27,13 @@
             <li class="dropdown">
                 <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">{{ 'action.profile'|trans }}<span class="caret"></span></a>
                 <ul class="dropdown-menu">
-                  <li><a href="{{ path('fos_user_profile_show') }}">{{ 'action.show_profile'|trans }}</a></li>
-                  <li><a href="{{ path('fos_user_profile_edit') }}">{{ 'action.edit_profile'|trans }}</a></li>
+                  <li><a href="{{ path('user_profile_show', {id: app.user.id }) }}">{{ 'action.show_profile'|trans }}</a></li>
+                  <li><a href="{{ path('user_profile_edit', {id: app.user.id }) }}">{{ 'action.edit_profile'|trans }}</a></li>
                 </ul>
             </li>
         {% else %}
             <li><a href="{{ path('fos_user_security_login') }}">{{ 'action.sign_in'|trans }}</a></li>
-            <li><a href="{{ path('fos_user_registration_register') }}">{{ 'action.sign_up'|trans }}</a></li>
+            <li><a href="{{ path('user_new') }}">{{ 'action.sign_up'|trans }}</a></li>
         {% endif %}
         {% if is_granted("ROLE_ADMIN") %}
             <li class="dropdown">

app/Resources/views/nav_materialize.html.twig

@@ -19,13 +19,13 @@
                 <li>
                 <a href="#">{{ 'action.profile'|trans }}<span></span></a>
                  <ul>
-                    <li><a href="{{ path('fos_user_profile_show') }}">{{ 'action.show_profile'|trans }}</a></li>
-                    <li><a href="{{ path('fos_user_profile_edit') }}">{{ 'action.edit_profile'|trans }}</a></li>
+                   <li><a href="{{ path('user_profile_show', {id: app.user.id }) }}">{{ 'action.show_profile'|trans }}</a></li>
+                   <li><a href="{{ path('user_profile_edit', {id: app.user.id }) }}">{{ 'action.edit_profile'|trans }}</a></li>
                   </ul>
                 </li>
                 {% else %}
                     <li><a href="{{ path('fos_user_security_login') }}">{{ 'action.sign_in'|trans }}</a></li>
-                    <li><a href="{{ path('fos_user_registration_register') }}">{{ 'action.sign_up'|trans }}</a></li>
+                    <li><a href="{{ path('user_new') }}">{{ 'action.sign_up'|trans }}</a></li>
                 {% endif %}
                 {% if is_granted("ROLE_ADMIN") %}
                     <li>

app/Resources/views/nav_skeleton.html.twig

@@ -19,13 +19,13 @@
                 <li>
                 <a href="#">{{ 'action.profile'|trans }}<span></span></a>
                  <ul>
-                    <li><a href="{{ path('fos_user_profile_show') }}">{{ 'action.show_profile'|trans }}</a></li>
-                    <li><a href="{{ path('fos_user_profile_edit') }}">{{ 'action.edit_profile'|trans }}</a></li>
+                   <li><a href="{{ path('user_profile_show', {id: app.user.id }) }}">{{ 'action.show_profile'|trans }}</a></li>
+                   <li><a href="{{ path('user_profile_edit', {id: app.user.id }) }}">{{ 'action.edit_profile'|trans }}</a></li>
                   </ul>
                 </li>
                 {% else %}
                     <li><a href="{{ path('fos_user_security_login') }}">{{ 'action.sign_in'|trans }}</a></li>
-                    <li><a href="{{ path('fos_user_registration_register') }}">{{ 'action.sign_up'|trans }}</a></li>
+                    <li><a href="{{ path('user_new') }}">{{ 'action.sign_up'|trans }}</a></li>
                 {% endif %}
                 {% if is_granted("ROLE_ADMIN") %}
                     <li>

app/config/parameters.yml

@@ -5,14 +5,11 @@ parameters:
     database_name: authOauth
     database_user: root
     database_password: root
-    mailer_transport: gmail
+    mailer_transport: null
     mailer_host: 127.0.0.1
     mailer_user: null
     mailer_password: null
     secret: 67bba702e49b21b1f3884de0d61ae7b09039a50f
-    oauth2_client_id: 2_3gxxgr0gs7wgkk08gs8ss8c0ww444k00okkwosskogg8cg4scw
-    oauth2_client_secret: 42y1qygfyim84kc0scsg0w8o48k8g4484ss4s400c80kwkcssc
-    oauth2_redirect_url: 'http://auth.dev/'
     oauth2_auth_endpoint: 'http://auth.dev/oauth/v2/auth'
     oauth2_token_endpoint: 'http://auth.dev/oauth/v2/token'
     frontend_theme: bootstrap

app/config/parameters.yml.dist

@@ -17,10 +17,6 @@ parameters:
 
     # A secret key that's used to generate certain security-related tokens
     secret:            ThisTokenIsNotSoSecretChangeIt
-    oauth2_client_id: 1_2p4qziaf8lkwwswc4ook0o8ccwow0c4co848sogk8w4gg8c4kk
-    oauth2_client_secret: 37wflagv6ickc4o448kg4ccosskok80kwoo4occ8wcsw8c884o
-    oauth2_redirect_url: 'http://127.0.0.1:8000/authorize'
     oauth2_auth_endpoint: 'http://127.0.0.1:8000/oauth/v2/auth'
     oauth2_token_endpoint: 'http://127.0.0.1:8000/oauth/v2/token'
     frontend_theme: bootstrap
-    

app/config/security.yml

@@ -8,6 +8,7 @@ security:
     role_hierarchy:
         ROLE_ADMIN:       [ROLE_USER, ROLE_API, ROLE_EDITOR]
         ROLE_SUPER_ADMIN: ROLE_ADMIN
+        ROLE_API: ROLE_USER
 
     # http://symfony.com/doc/current/security.html#b-configuring-how-users-are-loaded
     providers: