Merge pull request #35 from skyflowapi/fix-contentType

add content-type default header

Author: yennamsanthosh-skyflow

.github/workflows/ci.yml

@@ -38,4 +38,4 @@ jobs:
         pip install requests pyjwt datetime aiohttp cryptography python-dotenv coverage
         coverage run --source skyflow -m unittest discover
     - name: coverage
-      run: coverage report
+      run: coverage report -m

CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.3.0] - 2021-02-24
+
+### Added
+- Request ID in error logs and error responses for API Errors
+- Caching to accessToken token 
+- `isValid` method for validating Service Account bearer token
+
 ## [1.2.1] - 2022-01-18
 
 ### Fixed

README.md

@@ -32,13 +32,24 @@ The `generateBearerToken(filepath)` function takes the credentials file path for
 
 
 ```python
-from skyflow.ServiceAccount import generateBearerToken
+from skyflow.Errors import SkyflowError
+from skyflow.ServiceAccount import generateBearerToken, isValid
+
+# cache token for reuse
+bearerToken = ''
+tokenType = ''
+def tokenProvider():
+    if not isValid(bearerToken):
+        bearerToken, tokenType = generateBearerToken('<YOUR_CREDENTIALS_FILE_PATH>')
+    return bearerToken, tokenType
 
-filepath =  '<YOUR_CREDENTIALS_FILE_PATH>'
-accessToken, tokenType = generateBearerToken(filepath) # or generateBearerTokenFromCreds(credentials)
+try:
+    accessToken, tokenType = tokenProvider()
+    print("Access Token:", accessToken)
+    print("Type of token:", tokenType)
+except SkyflowError as e:
+    print(e)
 
-print("Access Token:", accessToken)
-print("Type of token:", tokenType)
 ```
 
 
@@ -49,12 +60,17 @@ To use this module, the skyflow client must first be initialized as follows.
 
 ```python
 from skyflow.Vault import Client, Configuration
-from skyflow.ServiceAccount import generateBearerToken
+from skyflow.ServiceAccount import generateBearerToken, isValid
+
+# cache for reuse
+bearerToken = ''
 
-#User defined function to provide access token to the vault apis
+# User defined function to provide access token to the vault apis
 def tokenProvider():    
-    token, _ = generateBearerToken('<YOUR_CREDENTIALS_FILE_PATH>')
-    return token
+    if isValid(bearerToken):
+        return bearerToken
+    bearerToken, _ = generateBearerToken('<YOUR_CREDENTIALS_FILE_PATH>')
+    return bearerToken 
 
 #Initializing a Skyflow Client instance with a SkyflowConfiguration object
 config = Configuration('<YOUR_VAULT_ID>', '<YOUR_VAULT_URL>', tokenProvider)
@@ -293,9 +309,12 @@ An example of invokeConnection:
 ```python
 from skyflow.Vault import ConnectionConfig, Configuration, RequestMethod
 
+bearerToken = '' 
 def tokenProvider():
-    token, _ = generateBearerToken('<YOUR_CREDENTIALS_FILE_PATH>')
-    return token
+    if isValid(bearerToken):
+        return bearerToken
+    bearerToken, _ = generateBearerToken('<YOUR_CREDENTIALS_FILE_PATH>')
+    return bearerToken
 
 try:
     config = Configuration('<YOUR_VAULT_ID>', '<YOUR_VAULT_URL>', tokenProvider)

samples/InsertSample.py

@@ -1,11 +1,13 @@
 from skyflow.Errors import SkyflowError
-from skyflow.ServiceAccount import generateBearerToken
+from skyflow.ServiceAccount import generateBearerToken, isValid
 from skyflow.Vault import Client, InsertOptions, Configuration
 
-
+# cache token for reuse
+bearerToken = ''
 def tokenProvider():
-    token, _ = generateBearerToken('<YOUR_CREDENTIALS_FILE_PATH>')
-    return token
+    if not isValid(bearerToken):
+        bearerToken, _ = generateBearerToken('<YOUR_CREDENTIALS_FILE_PATH>')
+    return bearerToken
 
 try:
     config = Configuration('<YOUR_VAULT_ID>', '<YOUR_VAULT_URL>', tokenProvider)

samples/SATokenSample.py

@@ -1,9 +1,16 @@
 from skyflow.Errors import SkyflowError
-from skyflow.ServiceAccount import generateBearerToken
+from skyflow.ServiceAccount import generateBearerToken, isValid
 
+# cache token for reuse
+bearerToken = ''
+tokenType = ''
+def tokenProvider():
+    if not isValid(bearerToken):
+        bearerToken, tokenType = generateBearerToken('<YOUR_CREDENTIALS_FILE_PATH>')
+    return bearerToken, tokenType
 
 try:
-    accessToken, tokenType = generateBearerToken('<YOUR_CREDENTIALS_FILE_PATH>')
+    accessToken, tokenType = tokenProvider()
     print("Access Token:", accessToken)
     print("Type of token:", tokenType)
 except SkyflowError as e:

samples/detokenizeSample.py

@@ -1,11 +1,13 @@
 from skyflow.Errors import SkyflowError
-from skyflow.ServiceAccount import generateBearerToken
+from skyflow.ServiceAccount import generateBearerToken, isValid
 from skyflow.Vault import Client, Configuration
 
-
+# cache token for reuse
+bearerToken = ''
 def tokenProvider():
-    token, _ = generateBearerToken('<YOUR_CREDENTIALS_FILE_PATH>')
-    return token
+    if not isValid(bearerToken):
+        bearerToken, _ = generateBearerToken('<YOUR_CREDENTIALS_FILE_PATH>')
+    return bearerToken
 
 try:
     config = Configuration('<YOUR_VAULT_ID>', '<YOUR_VAULT_URL>', tokenProvider)

samples/generateBearerTokenFromCredsSample.py

@@ -1,7 +1,7 @@
 import json
 
 from skyflow.Errors import SkyflowError
-from skyflow.ServiceAccount import generateBearerTokenFromCreds
+from skyflow.ServiceAccount import generateBearerTokenFromCreds, isValid
 
 '''
     This sample demonstrates the usage of generateBearerTokenFromCreds
@@ -10,8 +10,11 @@
     - Use generateBearerTokenFromCreds(jsonString) to get the Bearer Token
 '''
 
+# cache token for reuse
+bearerToken = ''
+tokenType = ''
+def tokenProvider():
 
-try:
     # As an example
     credentials = {
         "clientID": "<YOUR_clientID>",
@@ -21,7 +24,13 @@
         "privateKey": "<YOUR_PEM_privateKey>"
     }
     jsonString = json.dumps(credentials)
-    accessToken, tokenType = generateBearerTokenFromCreds(credentials=jsonString)
+    if not isValid(bearerToken):
+        bearerToken, tokenType = generateBearerTokenFromCreds(credentials=jsonString)
+
+    return bearerToken
+
+try:
+    accessToken, tokenType = tokenProvider()
     print("Access Token:", accessToken)
     print("Type of token:", tokenType)
 except SkyflowError as e:

samples/getByIDSample.py

@@ -1,11 +1,14 @@
 from skyflow.Errors import SkyflowError
-from skyflow.ServiceAccount import generateBearerToken
+from skyflow.ServiceAccount import generateBearerToken, isValid
 from skyflow.Vault import Client, Configuration, RedactionType
 
 
+# cache token for reuse
+bearerToken = ''
 def tokenProvider():
-    token, _ = generateBearerToken('<YOUR_CREDENTIALS_FILE_PATH>')
-    return token
+    if not isValid(bearerToken):
+        bearerToken, _ = generateBearerToken('<YOUR_CREDENTIALS_FILE_PATH>')
+    return bearerToken
 
 try:
     config = Configuration('<YOUR_VAULT_ID>', '<YOUR_VAULT_URL>', tokenProvider)

samples/invokeConnectionSample.py

@@ -1,15 +1,18 @@
 from skyflow.Errors import SkyflowError
-from skyflow.ServiceAccount import generateBearerToken
+from skyflow.ServiceAccount import generateBearerToken, isValid
 from skyflow.Vault import Client, Configuration, RequestMethod, ConnectionConfig
 
 '''
 This sample is for generating CVV using Skyflow Connection with a third party integration such as VISA
 '''
 
-
+# cache token for reuse
+bearerToken = ''
 def tokenProvider():
-    token, _ = generateBearerToken('<YOUR_CREDENTIALS_FILE_PATH>')
-    return token
+    if not isValid(bearerToken):
+        bearerToken, _ = generateBearerToken('<YOUR_CREDENTIALS_FILE_PATH>')
+    return bearerToken
+
 
 try:
     config = Configuration('<YOUR_VAULT_ID>', '<YOUR_VAULT_URL>', tokenProvider)

skyflow/Errors/_skyflowErrors.py

@@ -20,6 +20,7 @@ class SkyflowErrorMessages(Enum):
     JWT_INVALID_FORMAT = "Private key is not in correct format"
     MISSING_ACCESS_TOKEN = "accessToken not present in response"
     MISSING_TOKEN_TYPE = "tokenType not present in response"
+    JWT_DECODE_ERROR = "Invalid access token"
 
     # vault
     RECORDS_KEY_ERROR = "Records key is missing from payload"