def test_post_method():
client = Client()
req = client._build_post_request("foo", {"key": "value"},
auth={"user", "pw"})
assert req.url == "http://localhost:5000/foo"
assert req.json["key"] == "value"
assert req.auth == set(["user", "pw"])
req = client._build_post_request("foo", {"key": "value"})
assert req.url == "http://localhost:5000/foo"
assert req.json["key"] == "value"
assert not req.auth
def test_patch_method():
client = Client()
req = client._build_patch_request(
"foo",
{
client.settings.id_field: "id",
client.settings.etag: "etag",
"key": "value"
},
auth={"user", "pw"},
)
assert req.url == "http://localhost:5000/foo/id"
assert req.json["key"] == "value"
assert req.headers["If-Match"] == "etag"
assert req.auth == set(["user", "pw"])
req = client._build_patch_request("foo", {"key": "value"},
unique_id="foo_id",
etag="foo_etag")
assert req.url == "http://localhost:5000/foo/foo_id"
assert req.json["key"] == "value"
assert req.headers["If-Match"] == "foo_etag"
assert not req.auth
with pytest.raises(ValueError, message="ETag is required"):
client._build_put_request("foo", {"key": "value"}, unique_id="id")
with pytest.raises(ValueError, message="Unique id is required"):
client._build_patch_request("foo", {"key": "value"})
def test_get_method():
client = Client()
req = client._build_get_request("foo")
assert req.url == "http://localhost:5000/foo"
req = client._build_get_request("foo",
etag="etag",
unique_id="id",
auth=("user", "pw"))
assert req.url == "http://localhost:5000/foo/id"
assert req.headers["If-None-Match"] == "etag"
assert req.auth == tuple(["user", "pw"])
req = client._build_get_request("foo",
payload={
client.settings.id_field: "id",
client.settings.etag: "etag"
})
assert req.url == "http://localhost:5000/foo/id"
assert req.headers["If-None-Match"] == "etag"
req = client._build_get_request(
"foo",
payload={
client.settings.id_field: "id",
client.settings.etag: "etag"
},
etag="this_wins",
)
assert req.url == "http://localhost:5000/foo/id"
assert req.headers["If-None-Match"] == "this_wins"
with pytest.raises(ValueError, message="ETag is required"):
req = client._build_get_request("foo", payload={"key": "value"})
client.settings.if_match = False
req = client._build_get_request("foo")
assert req.url == "http://localhost:5000/foo"
assert "If-None-Match" not in req.headers
assert not req.auth
req = client._build_get_request("foo",
payload={
client.settings.id_field: "id",
client.settings.etag: "etag"
})
assert "If-None-Match" not in req.headers
def test_resolve_if_none_match_header():
client = Client()
with pytest.raises(ValueError, message="ETag is required"):
assert client._resolve_if_none_match_header()
assert client._resolve_if_none_match_header(None)
assert client._resolve_if_none_match_header(None, None)
headers = client._resolve_if_none_match_header(
{client.settings.etag: "hash"})
assert headers["If-None-Match"] == "hash"
headers = client._resolve_if_none_match_header(etag="etag")
assert headers["If-None-Match"] == "etag"
headers = client._resolve_if_none_match_header(
{client.settings.etag: "hash"}, "etag")
assert headers["If-None-Match"] == "etag"
client.settings.if_match = False
assert client._resolve_if_none_match_header() is None
assert client._resolve_if_none_match_header(None) is None
assert client._resolve_if_none_match_header(None, None) is None
assert client._resolve_if_none_match_header({client.settings.etag: "hash"
}) is None
assert client._resolve_if_none_match_header(etag="hash") is None
assert (client._resolve_if_none_match_header(
{client.settings.etag: "hash"}, "etag") is None)
def test_client_session_is_set_at_startup():
client = Client()
assert client.session is not None
def test_validate():
client = Client()
client.settings = None
with pytest.raises(ValueError, message="Settings are required"):
client.get("foo")
client.post("foo", {})
client.patch("foo", {})
client.put("foo", {})
client.delete("foo", "etag", "id")
def test_resolve_url():
client = Client()
assert client._resolve_url("endpoint") == "http://localhost:5000/endpoint"
client.settings.base_url = "//myapi"
assert client._resolve_url("endpoint") == "//myapi/endpoint"
client.settings.base_url = "https://myapi"
assert client._resolve_url("endpoint") == "https://myapi/endpoint"
assert (client._resolve_url("endpoint",
unique_id="id") == "https://myapi/endpoint/id")
# unique_id takes precedence over the payload
assert (client._resolve_url("endpoint",
{client.settings.id_field: "payload_id"},
"id") == "https://myapi/endpoint/id")
assert client._resolve_url(None) == "https://myapi"
assert (client._resolve_url(
"contacts",
{client.settings.id_field: "id"}) == "https://myapi/contacts/id")
assert client._resolve_url("contacts",
{"key": "value"}) == "https://myapi/contacts"
client.settings.base_url = None
assert client._resolve_url(None) is None
# urlib.parse.urljoin ignores non-absolute urls as base
client.settings.base_url = "myapi"
assert client._resolve_url("endpoint") == "endpoint"
def test_delete_method():
client = Client()
req = client._build_delete_request("foo",
None,
"id",
"etag",
auth={"user", "pw"})
assert req.url == "http://localhost:5000/foo/id"
assert req.headers["If-Match"] == "etag"
assert req.auth == set(["user", "pw"])
req = client._build_delete_request("foo", {client.settings.etag: "etag"},
"id",
auth={"user", "pw"})
assert req.url == "http://localhost:5000/foo/id"
assert req.headers["If-Match"] == "etag"
assert req.auth == set(["user", "pw"])
req = client._build_delete_request(
"foo",
{
client.settings.etag: "etag",
client.settings.id_field: "id"
},
auth={"user", "pw"},
)
assert req.url == "http://localhost:5000/foo/id"
assert req.headers["If-Match"] == "etag"
assert req.auth == set(["user", "pw"])
with pytest.raises(ValueError, message="ETag is required"):
client._build_delete_request("foo", None, None)
client._build_delete_request("foo", None, "id")
client._build_delete_request("foo", {"key": "value"}, "id")
with pytest.raises(ValueError, message="Unique id is required"):
client._build_delete_request("foo", None, None, "etag")
client._build_delete_request("foo", {client.settings.etag: "etag"})
def test_client_default_settings_can_be_overridden_at_startup():
settings = Settings()
settings.base_url = "mybase"
client = Client(settings)
assert client.settings.base_url == "mybase"
def test_client_default_settings_are_set_at_startup():
client = Client()
assert isinstance(client.settings, Settings)
assert client.settings.base_url == "http://localhost:5000"