add main

Author: wasin-waeosri

.dockerignore

@@ -0,0 +1,11 @@
+.env
+images/
+__pycache__/
+.vscode/
+video/
+rdp_controller/__pycache__/
+sample_jsons/
+tests/__pycache__/
+README.md
+.git/
+.gitignore

.env.test

@@ -0,0 +1,10 @@
+# RDP Core Credentials
+RDP_USERNAME=testuser1
+RDP_PASSWORD=testpassword1
+RDP_CLIENTID=testclientid1
+
+# RDP Core Endpoints
+RDP_BASE_URL=https://api.refinitiv.com
+RDP_AUTH_URL=/auth/oauth2/v1/token
+RDP_ESG_URL=/data/environmental-social-governance/v2/views/scores-full
+RDP_SEARCH_EXPLORE_URL=/discovery/search/v1/explore

.gitignore

@@ -0,0 +1,7 @@
+video/
+.env
+sample_jsons/
+tests/__pycache__/
+rdp_controller/__pycache__/
+__pycache__/
+tree.txt

.vscode/settings.json

@@ -0,0 +1,11 @@
+{
+    "python.testing.unittestArgs": [
+        "-v",
+        "-s",
+        ".",
+        "-p",
+        "test*.py"
+    ],
+    "python.testing.pytestEnabled": false,
+    "python.testing.unittestEnabled": true
+}

Dockerfile

@@ -0,0 +1,28 @@
+#Build stage, using slim based-image because alpine cannot use Pandas and Matplotlib
+FROM python:3.9.13-slim-buster AS builder
+
+#Copy requirements.txt
+COPY requirements.txt .
+
+# install dependencies to the local user directory (eg. /root/.local)
+RUN pip install --user -r requirements.txt
+
+# Run stage, using slim based-image because alpine cannot use Pandas and Matplotlib
+FROM python:3.9.13-slim-buster 
+WORKDIR /app
+
+# Update PATH environment variable + set Python buffer to make Docker print every message instantly.
+ENV PATH=/root/.local:$PATH \
+    USERNAME=DOCKER_CONTAINER \
+    PYTHONUNBUFFERED=1
+
+# copy only the dependencies installation from the 1st stage image
+COPY --from=builder /root/.local /root/.local
+# Copy env.test, module and tests folder.
+COPY app.py .env.test ./
+ADD rdp_controller /app/rdp_controller
+ADD tests /app/tests
+WORKDIR /app/tests
+
+#Run Python
+ENTRYPOINT [ "python", "-m", "unittest", "discover" ]

LICENSE.md

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (C) 2019-2022 Refinitiv. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,90 @@
+#|-----------------------------------------------------------------------------
+#|            This source code is provided under the MIT license             --
+#|  and is provided AS IS with no warranty or guarantee of fit for purpose.  --
+#|                See the project's LICENSE.md for details.                  --
+#|           Copyright Refinitiv 2022.       All rights reserved.            --
+#|-----------------------------------------------------------------------------
+
+"""
+Example Code Disclaimer:
+ALL EXAMPLE CODE IS PROVIDED ON AN “AS IS” AND “AS AVAILABLE” BASIS FOR ILLUSTRATIVE PURPOSES ONLY. REFINITIV MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND, EXPRESS OR IMPLIED, AS TO THE OPERATION OF THE EXAMPLE CODE, OR THE INFORMATION, CONTENT, OR MATERIALS USED IN CONNECTION WITH THE EXAMPLE CODE. YOU EXPRESSLY AGREE THAT YOUR USE OF THE EXAMPLE CODE IS AT YOUR SOLE RISK.
+"""
+
+import sys
+import os
+import pandas as pd
+import numpy as np
+from dotenv import load_dotenv
+
+load_dotenv()  # take environment variables from .env.
+
+from rdp_controller import rdp_http_controller
+
+def convert_pandas(json_data):
+    if not json_data:
+        raise TypeError('Received invalid (None or Empty) JSON data')
+
+    try:
+        headers=json_data['headers'] 
+        #Get column headers/titles using lambda
+        titles=map(lambda header:header['title'], headers)
+            
+        dataArray=np.array(json_data['data'])
+        df = pd.DataFrame(data=dataArray,columns=titles)
+
+        return df
+    except Exception as exp:
+        print(f'Error converting JSON to Dataframe exception: {str(exp)}') 
+        raise TypeError('Error converting JSON to Dataframe')
+
+
+if __name__ == '__main__':
+    username = os.getenv('RDP_USERNAME')
+    password = os.getenv('RDP_PASSWORD')
+    client_id = os.getenv('RDP_CLIENTID')
+
+    rdp_controller = rdp_http_controller.RDPHTTPController()
+
+    base_URL = os.getenv('RDP_BASE_URL')
+    auth_endpoint = base_URL + os.getenv('RDP_AUTH_URL')
+    esg_endpoint = base_URL + os.getenv('RDP_ESG_URL')
+    search_endpoint = base_URL + os.getenv('RDP_SEARCH_EXPLORE_URL')
+
+    access_token = None
+    refresh_token = None
+    expires_in = 0
+    universe = 'LSEG.L'
+
+    try:
+        access_token, refresh_token, expires_in = rdp_controller.rdp_authentication(auth_endpoint, username, password, client_id)
+        if not access_token:
+            print('Cannot login to RDP, exiting application')
+            sys.exit(1)
+        
+        esg_data = None
+        esg_data = rdp_controller.rdp_getESG(esg_endpoint, access_token, universe)
+        if not esg_data:
+            print(f'No ESG data for {universe}, exiting application')
+        
+        esg_df = convert_pandas(esg_data)
+        esg_df = pd.DataFrame(esg_df,columns=['Instrument','Period End Date','ESG Score','ESG Combined Score','ESG Controversies Score'])
+        print(esg_df.head())
+
+        company_data = None
+        search_payload = {
+            'View': 'Entities',
+            'Filter': f'RIC eq \'{universe}\'',
+            'Select': 'IssuerCommonName,DocumentTitle,RCSExchangeCountryLeaf,IssueISIN,ExchangeName,ExchangeCode,SearchAllCategoryv3,RCSTRBC2012Leaf'
+        }
+        company_data = rdp_controller.rdp_getSearchExplore(search_endpoint, access_token, search_payload)
+        if not company_data:
+            print(f'No Meta data for {universe}, exiting application')
+        print(f'RIC: {universe} Metadata:')
+        print('\tIssuerCommonName: {}'.format(company_data['Hits'][0]['IssuerCommonName']))
+        print('\tRCSExchangeCountryLeaf: {}'.format(company_data['Hits'][0]['RCSExchangeCountryLeaf']))
+        print('\tISIN: {}'.format(company_data['Hits'][0]['IssueISIN']))
+        print('\tExchange Name: {}'.format(company_data['Hits'][0]['ExchangeName']))
+        print('\tRCSTRBC2012Leaf: {}'.format(company_data['Hits'][0]['RCSTRBC2012Leaf']))
+    except Exception as exp:
+        print(f'Caught exception: {str(exp)}')
+

app.py

@@ -0,0 +1,98 @@
+import requests
+import json
+
+class RDPHTTPController():
+
+    # Constructor Method
+    def __init__(self):
+        self.scope = 'trapi'
+        self.client_secret = ''
+        pass
+    
+    # Send HTTP Post request to get Access Token (Password Grant and Refresh Grant) from RDP Auth Service
+    def rdp_authentication(self, auth_url, username, password, client_id, old_refresh_token = None):
+        """
+        Send Authentication to RDP Auth service
+        """
+
+        if not auth_url or not username or not password or not client_id:
+            raise TypeError('Received invalid (None or Empty) arguments')
+
+        access_token = None
+        refresh_token = None
+        expires_in = 0
+        if old_refresh_token is None: # For the Password Grant scenario
+            payload=f'username={username}&password={password}&grant_type=password&scope={self.scope}&takeExclusiveSignOnControl=true&client_id={client_id}'
+        else:  # For the Refresh Token scenario
+            payload=f'username={username}&refresh_token={old_refresh_token}&grant_type=refresh_token&client_id={client_id}'
+
+        # Send HTTP Request
+        try:
+            response = requests.post(auth_url, 
+                headers = {'Content-Type':'application/x-www-form-urlencoded'}, 
+                data = payload, 
+                auth = (client_id, self.client_secret)
+                )
+        except Exception as exp:
+            print(f'Caught exception: {exp}')
+    
+
+        if response.status_code == 200:  # HTTP Status 'OK'
+            print('Authentication success')
+            access_token = response.json()['access_token']
+            refresh_token = response.json()['refresh_token']
+            expires_in = int(response.json()['expires_in'])
+        if response.status_code != 200:
+            print(f'RDP authentication failure: {response.status_code} {response.reason}')
+            print(f'Text: {response.text}')
+            raise requests.exceptions.HTTPError(f'RDP authentication failure: {response.status_code} - {response.text} ', response = response )
+        
+        return access_token, refresh_token, expires_in
+    
+    def rdp_getESG(self, esg_url, access_token, universe):
+
+        if not esg_url or not access_token or not universe:
+            raise TypeError('Received invalid (None or Empty) arguments')
+
+        payload = {'universe': universe}
+        # Request data for ESG Score Full Service
+        try:
+            response = requests.get(esg_url, headers={'Authorization': f'Bearer {access_token}'}, params = payload)
+        except Exception as exp:
+            print(f'Caught exception: {exp}')
+
+        if response.status_code == 200:  # HTTP Status 'OK'
+            print('Receive ESG Data from RDP APIs')
+            #print(response.json())
+        else:
+            print(f'RDP APIs: ESG data request failure: {response.status_code} {response.reason}')
+            print(f'Text: {response.text}')
+            raise requests.exceptions.HTTPError(f'ESG data request failure: {response.status_code} - {response.text} ', response = response )
+
+        return response.json()
+
+    def rdp_getSearchExplore(self, search_url, access_token, payload):
+
+        if not search_url or not access_token or not payload:
+            raise TypeError('Received invalid (None or Empty) arguments')
+
+        headers = {
+            'Accept': 'application/json',
+            'Authorization': f'Bearer {access_token}'
+        }
+
+        try:
+            response = requests.post(search_url, headers = headers, data = json.dumps(payload))
+        except Exception as exp:
+            print(f'Caught exception: {exp}')
+        
+        if response.status_code == 200:  # HTTP Status 'OK'
+            print('Receive Search Explore Data from RDP APIs')
+            #print(response.json())
+        else:
+            print(f'RDP APIs: Search Explore request failure: {response.status_code} {response.reason}')
+            print(f'Text: {response.text}')
+            raise requests.exceptions.HTTPError(f'Search Explore request failure: {response.status_code} - {response.text} ', response = response )
+
+        return response.json()
+