Skip to content

bug(*): fix Boolean query params #128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 14, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cellengine/utils/api_client/APIClient.py
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ def _get_id_by_name(self, name, resource_type, experiment_id):
raise RuntimeError(str(e).format(name))

def _lookup_by_name(self, path, query, name):
params = f'query=eq({query},"{name}")&limit=2'
params = {"query": f'eq({query},"{name}")', "limit": 2}
return self._get(f"{self.base_url}/{path}", params=params)

def _handle_response(self, response):
Expand Down
13 changes: 9 additions & 4 deletions cellengine/utils/api_client/BaseAPIClient.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,11 @@
from cellengine.utils.singleton import AbstractSingleton


def prepare_params(params: Dict) -> Dict:
"""Converts Booleans to lower-case strings. (Requests yields upper-case.)"""
return {k: str(v).lower() if type(v) == bool else v for k, v in params.items()}


class BaseAPIClient(metaclass=AbstractSingleton):
@property
@abstractmethod
Expand Down Expand Up @@ -67,7 +72,7 @@ def _get(self, url, params: Dict = None, headers: Dict = None, raw=False) -> Any
response = self.requests_session.get(
url,
headers=self._make_headers(headers),
params=params if params else {},
params=prepare_params(params if params else {}),
)
except Exception as error:
raise error
Expand All @@ -87,7 +92,7 @@ def _post(
url,
json=json,
headers=self._make_headers(headers),
params=params if params else {},
params=prepare_params(params if params else {}),
files=files,
data=data,
)
Expand All @@ -106,7 +111,7 @@ def _patch(
url,
json=json,
headers=self._make_headers(headers),
params=params if params else {},
params=prepare_params(params if params else {}),
files=files,
)
return self._parse_response(response, raw=raw)
Expand All @@ -115,7 +120,7 @@ def _delete(self, url, params: dict = None, headers: dict = None):
response = self.requests_session.delete(
url,
headers=self._make_headers(headers),
params=params if params else {},
params=prepare_params(params if params else {}),
)
try:
if response.ok:
Expand Down
6 changes: 5 additions & 1 deletion tests/unit/resources/test_plots.py
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,11 @@ def test_should_get_plot_for_each_query_parameter(
item = ("color", "%23ff0000")

assert item[0] in responses.calls[i].request.url
assert str(item[1]) in responses.calls[i].request.url
assert (
str(item[1]).lower()
if type(item[1]) is bool
else str(item[1]) in responses.calls[i].request.url
)
plot_tester(plot)
i += 1

Expand Down
3 changes: 2 additions & 1 deletion tests/unit/utils/test_lru_cache.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,8 @@ def test_lru_cache_paths(ENDPOINT_BASE, client, experiments):
client.get_experiment(name="test_experiment")
assert (
responses.calls[0].request.url
== ENDPOINT_BASE + "/experiments?query=eq(name,%22test_experiment%22)&limit=2"
== ENDPOINT_BASE
+ "/experiments?query=eq%28name%2C%22test_experiment%22%29&limit=2"
)

responses.add(responses.GET, ENDPOINT_BASE + "/experiments", json=experiments[0])
Expand Down