diff --git a/README.md b/README.md index 5674c20..34eec83 100644 --- a/README.md +++ b/README.md @@ -83,19 +83,6 @@ assessment: dict = api.register_new_signup('installation-id', account_id=account ``` -#### Getting a Signup - -This method allows you to query the latest assessment for a given signup event, returning a `dict`, -containing the risk assessment and supporting evidence: - -```python3 -from incognia.api import IncogniaAPI - -api = IncogniaAPI('client-id', 'client-secret') - -assessment: dict = api.get_signup_assessment('signup-id') -``` - #### Registering Feedback This method registers a feedback event for the given identifiers (optional arguments) related to a @@ -204,11 +191,6 @@ assessment: dict = api.register_login('installation-id', policy_id='policy_id') ``` -## Evidences - -Every assessment response includes supporting evidence in a dict. You can find all available -evidences [here](https://docs.incognia.com/apis/understanding-assessment-evidence). - ## Error Handling Every method call can throw `IncogniaHTTPError` and `IncogniaError`. @@ -272,13 +254,6 @@ Incognia is a location identity platform for mobile apps that enables: - Frictionless authentication - Real-time transaction verification -## Create a Free Incognia Account - -1. Go to [Incognia](https://www.incognia.com/) and click on "Sign Up For Free" -2. Create an Account -3. You're ready to integrate [Incognia SDK](https://docs.incognia.com/sdk/getting-started) and - use [Incognia APIs](https://dash.incognia.com/api-reference) - ## License [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) diff --git a/incognia/api.py b/incognia/api.py index 79a4f4d..3974bb2 100644 --- a/incognia/api.py +++ b/incognia/api.py @@ -48,17 +48,6 @@ def register_new_signup(self, except IncogniaHTTPError as e: raise IncogniaHTTPError(e) from None - def get_signup_assessment(self, signup_id: str) -> dict: - if not signup_id: - raise IncogniaError('signup_id is required.') - - try: - headers = self.__get_authorization_header() - return self.__request.get(f'{Endpoints.SIGNUPS}/{signup_id}', headers=headers) - - except IncogniaHTTPError as e: - raise IncogniaHTTPError(e) from None - def register_feedback(self, event: str, timestamp: dt.datetime, diff --git a/incognia/base_request.py b/incognia/base_request.py index 31f88bf..2ab6bb8 100644 --- a/incognia/base_request.py +++ b/incognia/base_request.py @@ -48,15 +48,3 @@ def post(self, url: Union[str, bytes], headers: Any = None, data: Any = None, except requests.HTTPError as e: raise IncogniaHTTPError(e) from None - - def get(self, url: Union[str, bytes], headers: Any = None, data: Any = None) -> Optional[dict]: - headers = headers or {} - headers.update(USER_AGENT_HEADER) - - try: - response = requests.get(url=url, headers=headers, data=data, timeout=self.__timeout) - response.raise_for_status() - return json.loads(response.content.decode('utf-8')) or None - - except requests.HTTPError as e: - raise IncogniaHTTPError(e) from None diff --git a/tests/test_api.py b/tests/test_api.py index fc92957..42e5ab0 100644 --- a/tests/test_api.py +++ b/tests/test_api.py @@ -179,46 +179,6 @@ def test_register_new_signup_when_installation_id_is_empty_should_raise_an_Incog mock_token_manager_get.assert_not_called() mock_base_request_post.assert_not_called() - @patch.object(BaseRequest, 'get') - @patch.object(TokenManager, 'get', return_value=TOKEN_VALUES) - def test_get_signup_assessment_when_signup_id_is_valid_should_return_a_valid_dict( - self, mock_token_manager_get: Mock, mock_base_request_get: Mock): - mock_base_request_get.configure_mock(return_value=self.JSON_RESPONSE) - - api = IncogniaAPI(self.CLIENT_ID, self.CLIENT_SECRET) - request_response = api.get_signup_assessment(signup_id=self.SIGNUP_ID) - - mock_token_manager_get.assert_called() - mock_base_request_get.assert_called_with(f'{Endpoints.SIGNUPS}/{self.SIGNUP_ID}', - headers=self.AUTH_HEADER) - - self.assertEqual(request_response, self.JSON_RESPONSE) - - @patch.object(BaseRequest, 'get') - @patch.object(TokenManager, 'get', return_value=TOKEN_VALUES) - def test_get_signup_assessment_when_signup_id_invalid_should_raise_an_IncogniaHTTPError( - self, mock_token_manager_get: Mock, mock_base_request_get: Mock): - mock_base_request_get.configure_mock(side_effect=IncogniaHTTPError) - - api = IncogniaAPI(self.CLIENT_ID, self.CLIENT_SECRET) - - self.assertRaises(IncogniaHTTPError, api.get_signup_assessment, self.SIGNUP_ID) - - mock_token_manager_get.assert_called() - mock_base_request_get.assert_called_with(f'{Endpoints.SIGNUPS}/{self.SIGNUP_ID}', - headers=self.AUTH_HEADER) - - @patch.object(BaseRequest, 'get') - @patch.object(TokenManager, 'get', return_value=TOKEN_VALUES) - def test_get_signup_assessment_when_signup_id_is_empty_should_raise_an_IncogniaError( - self, mock_token_manager_get: Mock, mock_base_request_get: Mock): - api = IncogniaAPI(self.CLIENT_ID, self.CLIENT_SECRET) - - self.assertRaises(IncogniaError, api.get_signup_assessment, '') - - mock_token_manager_get.assert_not_called() - mock_base_request_get.assert_not_called() - @patch.object(BaseRequest, 'post') @patch.object(TokenManager, 'get', return_value=TOKEN_VALUES) def test_register_feedback_when_required_fields_are_valid_should_work( diff --git a/tests/test_base_request.py b/tests/test_base_request.py index e42b458..d80e9de 100644 --- a/tests/test_base_request.py +++ b/tests/test_base_request.py @@ -52,36 +52,3 @@ def get_mocked_response() -> requests.Response: mock_requests_post.assert_called_with(url=self.URL, headers=USER_AGENT_HEADER, data=None, params=None, timeout=base_request.timeout(), auth=None) - - @patch('requests.get') - def test_get_when_parameters_are_valid_should_return_a_valid_dict(self, - mock_requests_get: Mock): - def get_mocked_response() -> requests.Response: - response = requests.Response() - response._content, response.status_code = encode( - self.JSON_RESPONSE), self.OK_STATUS_CODE - return response - - mock_requests_get.configure_mock(return_value=get_mocked_response()) - - base_request = BaseRequest() - result = base_request.get(url=self.URL) - mock_requests_get.assert_called_with(url=self.URL, headers=USER_AGENT_HEADER, data=None, - timeout=base_request.timeout()) - self.assertEqual(result, self.JSON_RESPONSE) - - @patch('requests.get') - def test_get_when_parameters_are_invalid_should_raise_an_IncogniaHTTPError( - self, mock_requests_get: Mock): - def get_mocked_response() -> requests.Response: - response = requests.Response() - response._content, response.status_code = encode( - self.JSON_RESPONSE), self.CLIENT_ERROR_CODE - return response - - mock_requests_get.configure_mock(return_value=get_mocked_response()) - - base_request = BaseRequest() - self.assertRaises(IncogniaHTTPError, base_request.get, url=self.URL) - mock_requests_get.assert_called_with(url=self.URL, headers=USER_AGENT_HEADER, data=None, - timeout=base_request.timeout())