def test_request_right_resources(self, mocked_response):
paths_resources = [
(MopinionClient.RESOURCE_ACCOUNT, None, None),
(MopinionClient.RESOURCE_DEPLOYMENTS, None, None),
(MopinionClient.RESOURCE_DEPLOYMENTS, "string_id", None),
(MopinionClient.RESOURCE_REPORTS, None, None),
(MopinionClient.RESOURCE_REPORTS, 1, None),
(MopinionClient.RESOURCE_DATASETS, None, None),
(
MopinionClient.RESOURCE_DATASETS,
1,
MopinionClient.SUBRESOURCE_FIELDS,
),
(
MopinionClient.RESOURCE_DATASETS,
1,
MopinionClient.SUBRESOURCE_FEEDBACK,
),
]
for resources in paths_resources:
mocked_response.return_value = MockedResponse({"token": "token"})
client = MopinionClient(self.public_key, self.private_key)
client.resource(
resource_name=resources[0],
resource_id=resources[1],
sub_resource_name=resources[2],
)
def test_api_request_default_args(self, mocked_response):
mocked_response.side_effect = [
MockedResponse({"token": "my-token"}),
MockedResponse({"_meta": {"code": 200}}),
]
client = MopinionClient(self.public_key, self.private_key)
response = client.request("/account")
self.assertEqual(response.json()["_meta"]["code"], 200)
self.assertEqual(2, mocked_response.call_count)
mocked_response.assert_has_calls(
[
call(
method="GET",
url="https://api.mopinion.com/token",
headers={
"Authorization": "Basic UFVCTElDX0tFWTpQUklWQVRFX0tFWQ=="
},
),
call(
method="GET",
url="https://api.mopinion.com/account",
headers={
"X-Auth-Token": b"UFVCTElDX0tFWTpiMWIzY2Q0YWI2NGJmYjJhN"
b"mRhMDM2NDgyN2UwOGQyNmE1NjI0YzlhNzNjMG"
b"RjOWIwNTQ5ZmQ3NDQxNDAxMGNj",
"verbosity": "normal",
"Accept": "application/json",
},
),
]
)
def test_request_raise(self, mocked_response):
mocked_response.side_effect = [
MockedResponse({"token": "token"}),
MockedResponse({}, raise_error=True),
]
client = MopinionClient(self.public_key, self.private_key)
with self.assertRaises(RequestException) as cm:
client.request("/account")
self.assertIsInstance(cm.exception, RequestException)
def test_api_request_2(self, mocked_response):
mocked_response.side_effect = [
MockedResponse({"token": "token"}),
MockedResponse({"_meta": {"code": 200}}),
]
client = MopinionClient(self.public_key, self.private_key)
response = client.request(
endpoint="/reports",
query_params={"key": "value"},
content_negotiation=client.CONTENT_YAML,
)
self.assertEqual(response.json()["_meta"]["code"], 200)
self.assertEqual(2, mocked_response.call_count)
def test_get_token(self, mocked_response):
endpoint = EndPoint(path="/account")
mocked_response.return_value = MockedResponse({"token": "token"})
client = MopinionClient(self.public_key, self.private_key)
xtoken = client.get_token(endpoint=endpoint, body={"key": "value"})
self.assertEqual(
xtoken,
b"UFVCTElDX0tFWTplMzJkYTE0M2MzMWNjMGE0NWU1MGIwOGMwOWVmMDRjMWVhZmYwZTU5MTExOGMzMjViOGQxMzc1OGY3NDQ3ODZl",
)
self.assertIsInstance(xtoken, bytes)
xtoken = client.get_token(endpoint=endpoint, body=None)
self.assertEqual(
xtoken,
b"UFVCTElDX0tFWTo0ZWVkZGYzNzljNDIyNDU3ZmVhOThmYzc0NGNkYTkwMGVhYmM3NmViNjM4ZjU1OTRkNGJmYmJiMGIwMWYzM2Nh",
)
def test_api_request_availability(self, mocked_response):
mocked_response.side_effect = [
MockedResponse({"token": "token"}),
MockedResponse(
{"code": 200, "response": "pong", "version": "1.18.14"}
),
MockedResponse(
{"code": 200, "response": "pong", "version": "1.18.14"}
),
]
client = MopinionClient(self.public_key, self.private_key)
is_available = client.is_available()
self.assertTrue(is_available)
json_response = client.is_available(verbose=True)
self.assertEqual(json_response["code"], 200)
def test_get_signature_token_raise(self, mocked_response):
mocked_response.return_value = MockedResponse(
{"token": "my-token"}, raise_error=True
)
with self.assertRaises(RequestException) as cm:
MopinionClient(self.public_key, self.private_key)
self.assertIsInstance(cm.exception, RequestException)
def test_constructor(self, mocked_response):
mocked_response.return_value = MockedResponse({"token": "token"})
client = MopinionClient(self.public_key, self.private_key)
self.assertIsInstance(client.session, Session)
self.assertEqual(client.credentials.public_key, self.public_key)
self.assertEqual(len(client.session.adapters), 3)
self.assertEqual(client.signature_token, "token")
def test_api_resource_request_calls(self, mocked_response):
mocked_response.side_effect = [
MockedResponse({"token": "token"}, 200, raise_error=False),
MockedResponse({"_meta": {"message": "Hello World"}}, 200, False),
]
client = MopinionClient(self.public_key, self.private_key)
result = client.resource(
resource_name=client.RESOURCE_REPORTS,
resource_id=1,
sub_resource_name=client.SUBRESOURCE_FEEDBACK,
version="2.0.0",
verbosity=client.VERBOSITY_FULL,
query_params={"key": "value"},
iterator=False,
)
self.assertEqual(result.json()["_meta"]["message"], "Hello World")
self.assertEqual(2, mocked_response.call_count)
def test_api_request(self, mocked_response):
mocked_response.side_effect = [
MockedResponse({"token": "token"}),
MockedResponse({"_meta": {"code": 200}}),
]
client = MopinionClient(self.public_key, self.private_key)
response = client.request(
endpoint="/reports",
version="2.0.0",
verbosity=client.VERBOSITY_FULL,
query_params={"key": "value"},
body={"key": "value"},
)
self.assertEqual(response.json()["_meta"]["code"], 200)
self.assertEqual(2, mocked_response.call_count)
mocked_response.assert_has_calls(
[
call(
method="GET",
url="https://api.mopinion.com/token",
headers={
"Authorization": "Basic UFVCTElDX0tFWTpQUklWQVRFX0tFWQ=="
},
),
call(
method="GET",
url="https://api.mopinion.com/reports",
headers={
"X-Auth-Token": b"UFVCTElDX0tFWTpjNDVmMGQ0ZGI3MTE2MjZ"
b"mYTRkYTk5ZDgzMGI2NzQ2NzRkZWZlNmVkNDY"
b"3N2U5ZTMxN2FiYzU0OTYxYTJhNjVh",
"version": "2.0.0",
"verbosity": "full",
"Accept": "application/json",
},
json={"key": "value"},
params={"key": "value"},
),
]
)
def test_api_resource_request_generator(self, mocked_response):
mocked_response.side_effect = [
MockedResponse({"token": "token"}, raise_error=False),
MockedResponse({"_meta": {"has_more": True, "next": "/account"}}),
MockedResponse({"_meta": {"has_more": False}}),
]
client = MopinionClient(self.public_key, self.private_key)
generator = client.resource(
resource_name=client.RESOURCE_REPORTS,
resource_id=1,
sub_resource_name=client.SUBRESOURCE_FEEDBACK,
version="2.0.0",
verbosity=client.VERBOSITY_FULL,
query_params={"key": "value"},
iterator=True,
)
self.assertIsInstance(generator, types.GeneratorType)
self.assertEqual(1, mocked_response.call_count)
next(generator)
self.assertEqual(2, mocked_response.call_count)
next(generator)
self.assertEqual(3, mocked_response.call_count)
def test_request_right_paths(self, mocked_response):
paths = [
"/ping",
"/token",
"/account",
"/deployments",
"/deployments/string",
"/deployments/my_string",
"/deployments/76pg3seur7occo1hogv88eltdtmxoxxl81vj",
"/reports",
"/reports/1",
"/reports/19475758",
"/datasets",
"/datasets/1/fields",
"/datasets/123/feedback",
"/datasets/119475758/feedback",
"/datasets/119475758/feedback",
]
for path in paths:
mocked_response.return_value = MockedResponse({"token": "token"})
client = MopinionClient(self.public_key, self.private_key)
client.request(endpoint=path)
def test_request_wrong_resources(self, mocked_response):
client = MopinionClient(self.public_key, self.private_key)
weird_path_resources = [
(MopinionClient.SUBRESOURCE_FIELDS, None, None),
(MopinionClient.SUBRESOURCE_FEEDBACK, None, None),
(
MopinionClient.RESOURCE_DATASETS,
1,
MopinionClient.RESOURCE_DEPLOYMENTS,
),
(
MopinionClient.RESOURCE_DATASETS,
1,
MopinionClient.RESOURCE_REPORTS,
),
]
for weird_path in weird_path_resources:
with self.assertRaises(ValueError):
client.resource(
resource_name=weird_path[0],
resource_id=weird_path[1],
sub_resource_name=weird_path[2],
)
def test_request_wrong_paths(self, mocked_response):
client = MopinionClient(self.public_key, self.private_key)
weird_paths = [
"",
"/",
"/pings", # must be singular
"/tokens", # must be singular
"/accounts", # must be singular
"/deployment", # must be plural
"/deployment/string", # must be plural
"/dataset", # must be plural
"/report", # must be plural
"/dataset/1/field", # must be plural
"/datasets/1/file", # must be field
"/datasets/string/field", # must be integer
"/reports/string_id", #
"/dataset/1/feedback/1", # must be plural
"/datasets/string/feedback/string_id", # must be integer
"/datasets/1/feedbacks/string_id", # feedback is singular
]
for weird_path in weird_paths:
with self.assertRaises(ValueError):
client.request(endpoint=weird_path)
def test_get_signature_token(self, mocked_response):
mocked_response.return_value = MockedResponse({"token": "my-token"})
client = MopinionClient(self.public_key, self.private_key)
self.assertEqual(client.credentials.public_key, self.public_key)
token = client._get_signature_token(client.credentials)
self.assertEqual(token, "my-token")