Merge pull request #13 from getyoti/Removing-Old-Buttons

[SDK-165]: Removed login button helper functions from Example project, tidied up READMEs

Author: echarrod

README.md

@@ -91,19 +91,17 @@ import "yoti_python_sdk"
 
 After creating your application on the [Yoti Dashboard](https://www.yoti.com/dashboard/), you need to download the `.PEM` key and save it *outside* the repo (keep it private).
 
-The following variables are then required for the SDK to work:
+The variables required for the SDK to work are found in the tabs on your Yoti application's settings page ([Yoti Dashboard](https://www.yoti.com/dashboard/)). These are:
 
-* `YOTI_CLIENT_SDK_ID` - is the SDK identifier generated by Yoti Dashboard in the Key tab when you create your app. Note this is not your Application Identifier which is needed by your client-side code
-* `YOTI_KEY_FILE_PATH` - is the path to the application pem file. It can be downloaded only once from the Keys tab in your Yoti Dashboard. (e.g. /home/user/.ssh/access-security.pem)
+* **`YOTI_APPLICATION_ID`** - This is used to configure the [Yoti Login Button](https://www.yoti.com/developers/documentation/#2-front-end-integration).
+* **`YOTI_CLIENT_SDK_ID`** - This is the SDK identifier generated by Yoti Dashboard in the Key tab when you create your app. Note this is not your Application Identifier which is needed by your client-side code.
+* **`YOTI_KEY_FILE_PATH`** - This is the path to the application .pem file, we recommend keeping your .pem file outside of your repository. It can be downloaded only once from the Keys tab in your Yoti Dashboard. (e.g. /home/user/.ssh/access-security.pem).
 
-Please do not open the pem file as this might corrupt the key and you will need to create a new application.
+**Please do not open the pem file** as this might corrupt the key and you will need to create a new application.
 
-The following env variables are additionally used to configure your backend:
-* `YOTI_APPLICATION_ID` - found on the Integrations settings page, used to configure the [Yoti Login Button](https://www.yoti.com/developers/#login-button-setup).
+One way to configure these environment variables is to use an .env file. There are `.env.example` files supplied in the [Django](/examples/yoti_example_django/yoti_example/.env.example) and [Flask](/examples/yoti_example_flask/.env.example) example projects, which you can rename to `.env` and enter your settings into this file.
 
-Keeping your settings and access keys outside your repository is highly recommended.
-
-### Example
+### Example Initialisation
 
 ```python
 from yoti_python_sdk import Client

examples/yoti_example_django/yoti_example/templates/index.html

@@ -11,17 +11,13 @@
     <!-- Your website content -->
 
     <!-- This span will create the Yoti button -->
-    <span
-        data-yoti-application-id="{{ app_id }}"
-        data-size="small"
-    >
+    <span data-yoti-application-id="{{app_id}}">
         Log in with Yoti
     </span>
 
-    <!-- This script snippet will also be required in your HTML body during the early pilot period -->
+    <!-- This script snippet will also be required in your HTML body -->
     <script>
-        _ybg.config.service = 'https://www.yoti.com/connect/';
-        _ybg.init();
+        _ybg.init()
     </script>
 </body>
 </html>

examples/yoti_example_django/yoti_example/views.py

@@ -1,8 +1,7 @@
 from binascii import a2b_base64
+from os.path import join, dirname
 
 from django.views.generic import TemplateView
-
-from os.path import join, dirname
 from dotenv import load_dotenv
 
 dotenv_path = join(dirname(__file__), '.env')

examples/yoti_example_flask/templates/index.html

@@ -11,17 +11,13 @@
     <!-- Your website content -->
 
     <!-- This span will create the Yoti button -->
-    <span
-        data-yoti-application-id="{{ app_id }}"
-        data-size="small"
-    >
+    <span data-yoti-application-id="{{app_id}}">
         Log in with Yoti
     </span>
 
-    <!-- This script snippet will also be required in your HTML body during the early pilot period -->
+    <!-- This script snippet will also be required in your HTML body -->
     <script>
-        _ybg.config.service = 'https://www.yoti.com/connect/';
-        _ybg.init();
+        _ybg.init()
     </script>
 </body>
 </html>

plugins/django_yoti/README.md

@@ -17,13 +17,12 @@ INSTALLED_APPS = [
 ]
 ```
 
-* Django Yoti plugin provides the following template context vars:
+* Django Yoti plugin provides the following template context var:
     - `yoti_application_id`
-    - `yoti_login_button_*`
 
 * If you're using a Django template backend that supports context processors
 like default DTL (Django Template Language) and want to use context tags
-inside your template (e.g. `{{ yoti_login_button_*}}`), then you should
+inside your template (e.g. `{{yoti_application_id}}`), then you should
 include `django_yoti`'s context processors into your templates
 configuration like this:
 ```python
@@ -51,9 +50,17 @@ def some_view(request):
     return render(request, 'index.html', yoti_context)
 ```
 
-* And then use the following settings to configure the plugin:
+The variables required for the SDK to work are found in the tabs on your Yoti application's settings page ([Yoti Dashboard](https://www.yoti.com/dashboard/)). These are:
 
+* **`YOTI_APPLICATION_ID`** - This is used to configure the [Yoti Login Button](https://www.yoti.com/developers/documentation/#2-front-end-integration).
+* **`YOTI_CLIENT_SDK_ID`** - This is the SDK identifier generated by Yoti Dashboard in the Key tab when you create your app. Note this is not your Application Identifier which is needed by your client-side code.
+* **`YOTI_KEY_FILE_PATH`** - This is the path to the application .pem file, we recommend keeping your .pem file outside of your repository. It can be downloaded only once from the Keys tab in your Yoti Dashboard. (e.g. /home/user/.ssh/access-security.pem).
 
+**Please do not open the pem file** as this might corrupt the key and you will need to create a new application.
+
+One way to configure these environment variables is to use an .env file. There are `.env.example` files supplied in the [Django](/examples/yoti_example_django/yoti_example/.env.example) and [Flask](/examples/yoti_example_flask/.env.example) example projects, which you can rename to `.env` and enter your settings into this file.
+
+Alternatively you could define these settings in the `settings.py` file like this:
 ```python
 # your_django_project/settings.py
 
@@ -66,21 +73,6 @@ YOTI = {
     ...
 }
 ```
-* **`YOTI_APPLICATION_ID`** - **required**, *can be also set by env variable with the same name*<br>
-Your Yoti application's ID, found under the `INTEGRATIONS` tab of your
-Yoti application's settings page ([Yoti Dashboard](https://www.yoti.com/dashboard/)).<br>
-It is used to configure the [Yoti Login Button](https://www.yoti.com/developers/#login-button-setup).<br>
-Example: `ca84f68b-1b48-458b-96bf-963868edc8b6`
-
-* **`YOTI_CLIENT_SDK_ID`** - **required**, *can be also set by env variable with the same name*<br>
-Your Yoti application's SDK ID, found under the `INTEGRATIONS` tab of your
-Yoti application's settings page ([Yoti Dashboard](https://www.yoti.com/dashboard/)).<br>
-Example: `39aef70a-89d6-4644-a687-b3e891613da6`
-
-* **`YOTI_KEY_FILE_PATH`** - **required**, *can be also set by env variable with the same name*<br>
-The full path to your private key downloaded from your Yoti application's
-settings page under the `KEYS` tab ([Yoti Dashboard](https://www.yoti.com/dashboard/)).<br>
-Example: `/home/user/.ssh/access-security.pem`
 
 ### Endpoints configuration ###
 
@@ -106,7 +98,6 @@ YOTI = {
     ...
     'YOTI_LOGIN_VIEW': '...',
     'YOTI_REDIRECT_TO': '...',
-    'YOTI_LOGIN_BUTTON_LABEL': '...',
 }
 ```
 * **`YOTI_LOGIN_VIEW`**<br>
@@ -159,13 +150,12 @@ Your Yoti application's callback URL should point to `your_site.com/yoti/auth`.
 ## Using plugin ##
 
 1. First you need to add a login button to some of your view's templates.
-- You can do it by using one of the predefined login buttons:
-```
-{{ yoti_login_button_sm }}
-{{ yoti_login_button_md }}
-{{ yoti_login_button_lg }}
+- You can do it by using the predefined login button:
+```HTML
+<span data-yoti-application-id="{{app_id}}">
+    Log in with Yoti
+</span>
 ```
-- or with a default one `{{ yoti_login_button }}`<br>
 
 By clicking this button, user will be redirected to the Yoti Authentication page.
 

plugins/django_yoti/django_yoti/context_processors.py

@@ -1,20 +1,8 @@
-from .login_button import get_login_button_html
 from .settings import YOTI_APPLICATION_ID
 
 
 def yoti_context(request=None):
-    context = login_button_context()
-    context.update(application_context())
-    return context
-
-
-def login_button_context():
-    return {
-        'yoti_login_button': get_login_button_html,
-        'yoti_login_button_sm': get_login_button_html('small'),
-        'yoti_login_button_md': get_login_button_html('medium'),
-        'yoti_login_button_lg': get_login_button_html('large')
-    }
+    return application_context()
 
 
 def application_context():

plugins/django_yoti/django_yoti/login_button.py

@@ -20,14 +20,11 @@ def _get_parameter(name, required=True):
 
 YOTI_REDIRECT_TO = GLOBAL_YOTI_SETTINGS.get('YOTI_REDIRECT_TO', 'yoti_profile')
 YOTI_LOGIN_VIEW = GLOBAL_YOTI_SETTINGS.get('YOTI_LOGIN_VIEW', 'yoti_login')
-YOTI_LOGIN_BUTTON_LABEL = GLOBAL_YOTI_SETTINGS.get('YOTI_LOGIN_BUTTON_LABEL',
-                                                   'Log in with Yoti')
 
 __all__ = [
     'YOTI_APPLICATION_ID',
     'YOTI_CLIENT_SDK_ID',
     'YOTI_KEY_FILE_PATH',
     'YOTI_REDIRECT_TO',
     'YOTI_LOGIN_VIEW',
-    'YOTI_LOGIN_BUTTON_LABEL',
 ]

plugins/django_yoti/django_yoti/settings.py

@@ -11,12 +11,13 @@
     <!-- Your website content -->
 
     <!-- This span will create the Yoti button -->
-    <div>Button: {{ yoti_login_button }}</div>
+    <span data-yoti-application-id="{{app_id}}">
+        Log in with Yoti
+    </span>
 
-    <!-- This script snippet will also be required in your HTML body during the early pilot period -->
+    <!-- This script snippet will also be required in your HTML body -->
     <script>
-        _ybg.config.service = 'https://www.yoti.com/connect/';
-        _ybg.init();
+        _ybg.init()
     </script>
 </body>
 </html>