|
| 1 | +# -*- coding: utf-8 -*- |
| 2 | +from __future__ import unicode_literals |
| 3 | + |
| 4 | +import json |
| 5 | + |
| 6 | +import yoti_python_sdk |
| 7 | +from yoti_python_sdk.docs.endpoint import Endpoint |
| 8 | +from yoti_python_sdk.docs.session.retrieve.create_session_result import ( |
| 9 | + CreateSessionResult, |
| 10 | +) |
| 11 | +from yoti_python_sdk.docs.session.retrieve.get_session_result import GetSessionResult |
| 12 | +from yoti_python_sdk.docs.session.retrieve.media_value import MediaValue |
| 13 | +from yoti_python_sdk.http import MediaRequestHandler |
| 14 | +from yoti_python_sdk.http import SignedRequest |
| 15 | +from yoti_python_sdk.utils import YotiEncoder |
| 16 | +from .exception import DocScanException |
| 17 | + |
| 18 | + |
| 19 | +class DocScanClient(object): |
| 20 | + """ |
| 21 | + Client used for communication with the Yoti Doc Scan service where any |
| 22 | + signed request is required |
| 23 | + """ |
| 24 | + |
| 25 | + def __init__(self, sdk_id, key, api_url=None): |
| 26 | + self.__sdk_id = sdk_id |
| 27 | + self.__key = key |
| 28 | + if api_url is not None: |
| 29 | + self.__api_url = api_url |
| 30 | + else: |
| 31 | + self.__api_url = yoti_python_sdk.DOCS_API_URL |
| 32 | + |
| 33 | + def create_session(self, session_spec): |
| 34 | + """ |
| 35 | + Creates a Doc Scan session using the supplied session specification |
| 36 | +
|
| 37 | + :param session_spec: the session specification |
| 38 | + :type session_spec: SessionSpec |
| 39 | + :return: the create session result |
| 40 | + :rtype: CreateSessionResult |
| 41 | + :raises DocScanException: if there was an error creating the session |
| 42 | + """ |
| 43 | + payload = json.dumps(session_spec, cls=YotiEncoder).encode("utf-8") |
| 44 | + |
| 45 | + request = ( |
| 46 | + SignedRequest.builder() |
| 47 | + .with_post() |
| 48 | + .with_pem_file(self.__key) |
| 49 | + .with_base_url(self.__api_url) |
| 50 | + .with_endpoint(Endpoint.create_docs_session_path()) |
| 51 | + .with_param("sdkId", self.__sdk_id) |
| 52 | + .with_payload(payload) |
| 53 | + .with_header("Content-Type", "application/json") |
| 54 | + .build() |
| 55 | + ) |
| 56 | + response = request.execute() |
| 57 | + |
| 58 | + if response.status_code != 201: |
| 59 | + raise DocScanException("Failed to create session", response) |
| 60 | + |
| 61 | + data = json.loads(response.text) |
| 62 | + return CreateSessionResult(data) |
| 63 | + |
| 64 | + def get_session(self, session_id): |
| 65 | + """ |
| 66 | + Retrieves the state of a previously created Yoti Doc Scan session |
| 67 | +
|
| 68 | + :param session_id: the session ID |
| 69 | + :type session_id: str |
| 70 | + :return: the session state |
| 71 | + :rtype: GetSessionResult |
| 72 | + :raises DocScanException: if there was an error retrieving the session |
| 73 | + """ |
| 74 | + request = ( |
| 75 | + SignedRequest.builder() |
| 76 | + .with_get() |
| 77 | + .with_pem_file(self.__key) |
| 78 | + .with_base_url(self.__api_url) |
| 79 | + .with_endpoint(Endpoint.retrieve_docs_session_path(session_id)) |
| 80 | + .with_param("sdkId", self.__sdk_id) |
| 81 | + .build() |
| 82 | + ) |
| 83 | + response = request.execute() |
| 84 | + |
| 85 | + if response.status_code != 200: |
| 86 | + raise DocScanException("Failed to retrieve session", response) |
| 87 | + |
| 88 | + data = json.loads(response.text) |
| 89 | + return GetSessionResult(data) |
| 90 | + |
| 91 | + def delete_session(self, session_id): |
| 92 | + """ |
| 93 | + Deletes a previously created Yoti Doc Scan session and |
| 94 | + all of its related resources |
| 95 | +
|
| 96 | + :param session_id: the session id to delete |
| 97 | + :type session_id: str |
| 98 | + :rtype: None |
| 99 | + :raises DocScanException: if there was an error deleting the session |
| 100 | + """ |
| 101 | + request = ( |
| 102 | + SignedRequest.builder() |
| 103 | + .with_http_method("DELETE") |
| 104 | + .with_pem_file(self.__key) |
| 105 | + .with_base_url(self.__api_url) |
| 106 | + .with_endpoint(Endpoint.delete_docs_session_path(session_id)) |
| 107 | + .with_param("sdkId", self.__sdk_id) |
| 108 | + .build() |
| 109 | + ) |
| 110 | + response = request.execute() |
| 111 | + |
| 112 | + if response.status_code < 200 or response.status_code >= 300: |
| 113 | + raise DocScanException("Failed to delete session", response) |
| 114 | + |
| 115 | + def get_media_content(self, session_id, media_id): |
| 116 | + """ |
| 117 | + Retrieves media related to a Yoti Doc Scan session |
| 118 | + based on the supplied media ID |
| 119 | +
|
| 120 | + :param session_id: the session ID |
| 121 | + :type session_id: str |
| 122 | + :param media_id: the media ID |
| 123 | + :type media_id: str |
| 124 | + :return: the media |
| 125 | + :rtype: MediaValue |
| 126 | + :raises DocScanException: if there was an error retrieving the media content |
| 127 | + """ |
| 128 | + request = ( |
| 129 | + SignedRequest.builder() |
| 130 | + .with_request_handler(MediaRequestHandler) |
| 131 | + .with_get() |
| 132 | + .with_pem_file(self.__key) |
| 133 | + .with_base_url(self.__api_url) |
| 134 | + .with_endpoint(Endpoint.get_media_content_path(session_id, media_id)) |
| 135 | + .with_param("sdkId", self.__sdk_id) |
| 136 | + .build() |
| 137 | + ) |
| 138 | + response = request.execute() |
| 139 | + |
| 140 | + if response.status_code != 200: |
| 141 | + raise DocScanException("Failed to retrieve media content", response) |
| 142 | + |
| 143 | + media_mime_type = response.headers["Content-Type"] |
| 144 | + media_content = response.content |
| 145 | + return MediaValue(media_mime_type, media_content) |
| 146 | + |
| 147 | + def delete_media_content(self, session_id, media_id): |
| 148 | + """ |
| 149 | + Deletes media related to a Yoti Doc Scan session |
| 150 | + based on the supplied media ID |
| 151 | +
|
| 152 | + :param session_id: the session ID |
| 153 | + :type session_id: str |
| 154 | + :param media_id: the media ID |
| 155 | + :type media_id: str |
| 156 | + :rtype: None |
| 157 | + :raises DocScanException: if there was an error deleting the media content |
| 158 | + """ |
| 159 | + request = ( |
| 160 | + SignedRequest.builder() |
| 161 | + .with_http_method("DELETE") |
| 162 | + .with_pem_file(self.__key) |
| 163 | + .with_base_url(self.__api_url) |
| 164 | + .with_endpoint(Endpoint.delete_media_path(session_id, media_id)) |
| 165 | + .with_param("sdkId", self.__sdk_id) |
| 166 | + .build() |
| 167 | + ) |
| 168 | + |
| 169 | + response = request.execute() |
| 170 | + if response.status_code < 200 or response.status_code >= 300: |
| 171 | + raise DocScanException("Failed to delete media content", response) |
0 commit comments