Merge pull request #134 from drivergroup/opt-paginationv1.8.8

Created directive for optional pagination

2 files changed, 33 insertions, 0 deletions

diff --git a/src/main/scala/xyz/driver/core/rest/package.scala b/src/main/scala/xyz/driver/core/rest/package.scala
index 19752a1..e3c0c40 100644
--- a/src/main/scala/xyz/driver/core/rest/package.scala
+++ b/src/main/scala/xyz/driver/core/rest/package.scala
@@ -219,6 +219,16 @@ object `package` {
   val paginated: Directive1[Pagination] =
     parameters(("pageSize".as[Int] ? 100, "pageNumber".as[Int] ? 1)).as(Pagination)
 
+  private def extractPagination(pageSizeOpt: Option[Int], pageNumberOpt: Option[Int]): Option[Pagination] =
+    (pageSizeOpt, pageNumberOpt) match {
+      case (Some(size), Some(number)) => Option(Pagination(size, number))
+      case (None, None)               => Option.empty[Pagination]
+      case (_, _)                     => throw new IllegalArgumentException("Pagination's parameters are incorrect")
+    }
+
+  val optionalPagination: Directive1[Option[Pagination]] =
+    parameters(("pageSize".as[Int].?, "pageNumber".as[Int].?)).as(extractPagination)
+
   def paginationQuery(pagination: Pagination) =
     Seq("pageNumber" -> pagination.pageNumber.toString, "pageSize" -> pagination.pageSize.toString)
 }
diff --git a/src/test/scala/xyz/driver/core/rest/RestTest.scala b/src/test/scala/xyz/driver/core/rest/RestTest.scala
index d36e04d..68fe419 100644
--- a/src/test/scala/xyz/driver/core/rest/RestTest.scala
+++ b/src/test/scala/xyz/driver/core/rest/RestTest.scala
@@ -47,4 +47,27 @@ class RestTest extends WordSpec with Matchers with ScalatestRouteTest with Direc
       }
     }
   }
+
+  "optional paginated directive" should {
+    val route: Route = rest.optionalPagination { paginated =>
+      complete(StatusCodes.OK -> paginated.map(p => s"${p.pageNumber},${p.pageSize}").getOrElse("no pagination"))
+    }
+    "accept a pagination" in {
+      Get("/?pageNumber=2&pageSize=42") ~> route ~> check {
+        assert(status == StatusCodes.OK)
+        assert(entityAs[String] == "2,42")
+      }
+    }
+    "without pagination" in {
+      Get("/") ~> route ~> check {
+        assert(status == StatusCodes.OK)
+        assert(entityAs[String] == "no pagination")
+      }
+    }
+    "reject an invalid pagination" in {
+      Get("/?pageNumber=1") ~> route ~> check {
+        assert(rejection.isInstanceOf[ValidationRejection])
+      }
+    }
+  }
 }