[v0.0.2.1] add score filtering feature

CHANGES.md

@@ -47,3 +47,7 @@
 ## v0.0.2.0
 > Added `reviews` feature
 - `reviews` feature released with dirty codes.
+
+## v0.0.2.1
+> Added `filter_score_with` parameter to `reviews` feature
+- New feature `reviews filtering with score` released. 

google_play_scraper/constants/url.py

@@ -31,21 +31,22 @@ def build(self, lang, country):
             return self.URL_FORMAT.format(lang=lang, country=country)
 
     class _ReviewPayload(URLFormat):
-        PAYLOAD_FORMAT_FOR_FIRST_PAGE = "f.req=%5B%5B%5B%22UsvDTd%22%2C%22%5Bnull%2Cnull%2C%5B2%2C{sort}%2C%5B{count}%2Cnull%2Cnull%5D%2Cnull%2C%5B%5D%5D%2C%5B%5C%22{app_id}%5C%22%2C7%5D%5D%22%2Cnull%2C%22generic%22%5D%5D%5D"
-        PAYLOAD_FORMAT_FOR_PAGINATED_PAGE = "f.req=%5B%5B%5B%22UsvDTd%22%2C%22%5Bnull%2Cnull%2C%5B2%2C{sort}%2C%5B{count}%2Cnull%2C%5C%22{pagination_token}%5C%22%5D%2Cnull%2C%5B%5D%5D%2C%5B%5C%22{app_id}%5C%22%2C7%5D%5D%22%2Cnull%2C%22generic%22%5D%5D%5D"
+        PAYLOAD_FORMAT_FOR_FIRST_PAGE = "f.req=%5B%5B%5B%22UsvDTd%22%2C%22%5Bnull%2Cnull%2C%5B2%2C{sort}%2C%5B{count}%2Cnull%2Cnull%5D%2Cnull%2C%5Bnull%2C{score}%5D%5D%2C%5B%5C%22{app_id}%5C%22%2C7%5D%5D%22%2Cnull%2C%22generic%22%5D%5D%5D"
+        PAYLOAD_FORMAT_FOR_PAGINATED_PAGE = "f.req=%5B%5B%5B%22UsvDTd%22%2C%22%5Bnull%2Cnull%2C%5B2%2C{sort}%2C%5B{count}%2Cnull%2C%5C%22{pagination_token}%5C%22%5D%2Cnull%2C%5Bnull%2C{score}%5D%5D%2C%5B%5C%22{app_id}%5C%22%2C7%5D%5D%22%2Cnull%2C%22generic%22%5D%5D%5D"
 
-        def build(self, app_id, sort, count, pagination_token):
-            # type: (str, Sort, int, str) -> bytes
+        def build(self, app_id, sort, count, filter_score_with, pagination_token):
+            # type: (str, Sort, int, int, str) -> bytes
             if pagination_token is not None:
                 result = self.PAYLOAD_FORMAT_FOR_PAGINATED_PAGE.format(
                     app_id=app_id,
                     sort=sort,
                     count=count,
+                    score=filter_score_with,
                     pagination_token=pagination_token,
                 )
             else:
                 result = self.PAYLOAD_FORMAT_FOR_FIRST_PAGE.format(
-                    app_id=app_id, sort=sort, count=count
+                    app_id=app_id, sort=sort, score=filter_score_with, count=count
                 )
 
             return result.encode()

google_play_scraper/features/reviews.py

@@ -1,4 +1,5 @@
 import json
+from typing import Optional
 
 from google_play_scraper import Sort
 from google_play_scraper.constants.element import ElementSpecs
@@ -7,10 +8,16 @@
 from google_play_scraper.utils.request import post
 
 
-def _fetch_review_items(url, app_id, sort, count, pagination_token):
+def _fetch_review_items(url, app_id, sort, count, filter_score_with, pagination_token):
     dom = post(
         url,
-        Formats.ReviewPayload.build(app_id, sort, count, pagination_token),
+        Formats.ReviewPayload.build(
+            app_id,
+            sort,
+            count,
+            "null" if filter_score_with is None else filter_score_with,
+            pagination_token,
+        ),
         {"content-type": "application/x-www-form-urlencoded"},
     )
 
@@ -19,9 +26,10 @@ def _fetch_review_items(url, app_id, sort, count, pagination_token):
     return json.loads(match[0][2])[0], json.loads(match[0][2])[-1][-1]
 
 
-def reviews(app_id, lang="en", country="us", sort=Sort.NEWEST, count=100):
-    # type: (str, str, str, Sort, int) -> list
-    # TODO filtering with rating
+def reviews(
+    app_id, lang="en", country="us", sort=Sort.NEWEST, count=100, filter_score_with=None
+):
+    # type: (str, str, str, Sort, int, Optional[int]) -> list
     # TODO filtering with device model
     # TODO reply data
     # TODO refactoring
@@ -39,7 +47,7 @@ def reviews(app_id, lang="en", country="us", sort=Sort.NEWEST, count=100):
 
     while True:
         review_items, pagination_token = _fetch_review_items(
-            url, app_id, sort, _count, pagination_token
+            url, app_id, sort, _count, filter_score_with, pagination_token
         )
 
         for review in review_items:

tests/e2e_tests/test_reviews.py

@@ -59,3 +59,14 @@ def test_e2e_scenario_3(self):
 
         for r in result:
             self.assertEqual(5, r["score"])
+
+    def test_e2e_scenario_4(self):
+        for score in {1, 2, 3, 4, 5}:
+            result = reviews(
+                "com.mojang.minecraftpe",
+                sort=Sort.NEWEST,
+                count=300,
+                filter_score_with=score,
+            )
+
+            self.assertEqual(score * 300, sum([r["score"] for r in result]))