def test_override_default_limit_from_request_header():
graph = create_object_graph(name="example", testing=True)
with graph.flask.test_request_context(headers={"X-Request-Limit": "2"}):
page = OffsetLimitPage.from_dict(dict(foo="bar"))
assert_that(page.offset, is_(equal_to(0)))
assert_that(page.limit, is_(equal_to(2)))
assert_that(page.kwargs, has_entry("foo", "bar"))
def test_override_default_limit_from_request_header():
graph = create_object_graph(name="example", testing=True)
with graph.flask.test_request_context(headers={"X-Request-Limit": "2"}):
page = OffsetLimitPage.from_dict(dict(foo="bar"))
assert_that(page.offset, is_(equal_to(0)))
assert_that(page.limit, is_(equal_to(2)))
assert_that(page.kwargs, has_entry("foo", "bar"))
def test_offset_limit_page_from_query_string():
graph = create_object_graph(name="example", testing=True)
with graph.flask.test_request_context(query_string="offset=1&foo=bar"):
page = OffsetLimitPage.from_query_string(OffsetLimitPageSchema())
assert_that(page.offset, is_(equal_to(1)))
assert_that(page.limit, is_(equal_to(20)))
# schema filters out extra arguments
assert_that(page.to_dict(), is_not(has_entry("foo", "bar")))
def test_offset_limit_page_from_query_string():
graph = create_object_graph(name="example", testing=True)
with graph.flask.test_request_context(query_string="offset=1&foo=bar"):
page = OffsetLimitPage.from_query_string(OffsetLimitPageSchema())
assert_that(page.offset, is_(equal_to(1)))
assert_that(page.limit, is_(equal_to(20)))
# schema filters out extra arguments
assert_that(page.to_dict(), is_not(has_entry("foo", "bar")))
def test_offset_limit_page_to_paginated_list():
graph = create_object_graph(name="example", testing=True)
ns = Namespace("foo")
@graph.flask.route("/", methods=["GET"], endpoint="foo.search.v1")
def search():
pass
with graph.flask.test_request_context():
page = OffsetLimitPage(
offset=10,
limit=10,
foo="bar",
)
result = [], 0
paginated_list, headers = page.to_paginated_list(
result, _ns=ns, _operation=Operation.Search)
schema_cls = page.make_paginated_list_schema_class(ns, Schema())
data = schema_cls().dump(paginated_list).data
assert_that(
data,
is_(
equal_to(
dict(
offset=10,
limit=10,
count=0,
items=[],
_links=dict(
self=dict(
href=
"http://localhost/?offset=10&limit=10&foo=bar",
),
prev=dict(
href=
"http://localhost/?offset=0&limit=10&foo=bar",
),
),
))))
def discover():
# accept pagination limit from request
page = OffsetLimitPage.from_query_string(page_schema)
page.offset = 0
response_data = dict(_links=Links({
"self":
Link.for_(Operation.Discover, ns, qs=page.to_items()),
"search": [
link for link in iter_links(
self.find_matching_endpoints(ns), page)
],
}).to_dict())
return make_response(response_data)
def test_offset_limit_page_to_paginated_list():
graph = create_object_graph(name="example", testing=True)
ns = Namespace("foo")
@graph.flask.route("/", methods=["GET"], endpoint="foo.search.v1")
def search():
pass
with graph.flask.test_request_context():
page = OffsetLimitPage(
offset=10,
limit=10,
foo="bar",
)
result = [], 0
paginated_list, headers = page.to_paginated_list(result, _ns=ns, _operation=Operation.Search)
schema_cls = page.make_paginated_list_schema_class(ns, Schema())
data = schema_cls().dump(paginated_list).data
assert_that(
data,
is_(equal_to(dict(
offset=10,
limit=10,
count=0,
items=[],
_links=dict(
self=dict(
href="http://localhost/?offset=10&limit=10&foo=bar",
),
prev=dict(
href="http://localhost/?offset=0&limit=10&foo=bar",
),
),
))))
def test_offset_limit_page_to_from_dict():
page = OffsetLimitPage.from_dict(dict(offset=10, limit=10, foo="bar"))
assert_that(page.offset, is_(equal_to(10)))
assert_that(page.limit, is_(equal_to(10)))
assert_that(page.to_dict(),
is_(equal_to(dict(offset=10, limit=10, foo="bar"))))
def test_default_values_for_offset_limit_page():
page = OffsetLimitPage(foo="bar")
assert_that(page.offset, is_(equal_to(0)))
assert_that(page.limit, is_(equal_to(20)))
assert_that(page.kwargs, has_entry("foo", "bar"))
def test_offset_limit_page_from_query_string():
graph = create_object_graph(name="example", testing=True)
with graph.flask.test_request_context(query_string="offset=1"):
page = OffsetLimitPage.from_query_string(OffsetLimitPageSchema())
assert_that(page.offset, is_(equal_to(1)))
assert_that(page.limit, is_(equal_to(20)))
def test_offset_limit_page_to_from_dict():
page = OffsetLimitPage.from_dict(dict(offset=10, limit=10, foo="bar"))
assert_that(page.offset, is_(equal_to(10)))
assert_that(page.limit, is_(equal_to(10)))
assert_that(page.to_dict(), is_(equal_to(dict(offset=10, limit=10, foo="bar"))))