Merge pull request #295 from Seluj78/feature/138-search

Author: Seluj78

PyMatcha.postman_collection.json

@@ -227,6 +227,7 @@ def check_if_token_is_revoked(decrypted_token):
 from PyMatcha.routes.api.messages import messages_bp
 from PyMatcha.routes.api.recommendations import recommendations_bp
 from PyMatcha.routes.api.profile.images import images_bp
+from PyMatcha.routes.api.search import search_bp
 
 logging.debug("Registering Flask blueprints")
 application.register_blueprint(user_bp)
@@ -243,6 +244,7 @@ def check_if_token_is_revoked(decrypted_token):
 application.register_blueprint(messages_bp)
 application.register_blueprint(recommendations_bp)
 application.register_blueprint(images_bp)
+application.register_blueprint(search_bp)
 
 if application.debug:
     logging.debug("Registering debug route")

backend/PyMatcha/__init__.py

@@ -0,0 +1,79 @@
+import datetime
+
+from flask import Blueprint
+from flask import request
+from flask_jwt_extended import current_user
+from flask_jwt_extended import jwt_required
+from PyMatcha.utils.decorators import validate_params
+from PyMatcha.utils.errors import BadRequestError
+from PyMatcha.utils.match_score import _get_common_tags
+from PyMatcha.utils.match_score import _get_distance
+from PyMatcha.utils.match_score import _get_gender_query
+from PyMatcha.utils.success import SuccessOutput
+
+search_bp = Blueprint("search", __name__)
+
+REQUIRED_PARAMS_SEARCH = {
+    "min_age": int,
+    "max_age": int,
+    "min_score": int,
+    "max_score": int,
+    "tags": list,
+    "max_distance": int,
+}
+
+
+@search_bp.route("/search", methods=["POST"])
+@validate_params(REQUIRED_PARAMS_SEARCH, allow_empty=True)
+@jwt_required
+def search():
+    data = request.get_json()
+    min_age = int(data["min_age"])
+    max_age = int(data["max_age"])
+    min_score = int(data["min_score"])
+    max_score = int(data["max_score"])
+    max_distance = int(data["max_distance"])
+    tags = data["tags"]
+
+    today = datetime.datetime.utcnow()
+
+    query = _get_gender_query(current_user.orientation, current_user.gender)
+    returned_list = []
+    for user in query:
+        user_age = (
+            today.year - user.birthdate.year - ((today.month, today.day) < (user.birthdate.month, user.birthdate.day))
+        )
+
+        if max_age != -1:
+            if user_age >= max_age:
+                continue
+        if min_age != -1:
+            if user_age <= min_age:
+                continue
+
+        if max_score != -1:
+            if user.heat_score >= max_score:
+                continue
+        if min_score != -1:
+            if user.heat_score <= min_score:
+                continue
+
+        distance = _get_distance(current_user.geohash, user.geohash)
+        if distance:
+            if distance >= max_distance:
+                if max_distance != -1:
+                    continue
+        else:
+            if max_distance != -1:
+                raise BadRequestError("user needs to sets his location first")
+
+        user_tags = [t.name for t in user.get_tags()]
+        common_tags = _get_common_tags(tags, user_tags)
+        if not common_tags:
+            if tags:
+                continue
+
+        user_dict = user.to_dict()
+        user_dict.update({"distance": distance, "common_tags": common_tags})
+        returned_list.append(user_dict)
+    return SuccessOutput("search_results", returned_list)

backend/PyMatcha/routes/api/search.py

@@ -8,7 +8,7 @@
 from werkzeug.exceptions import BadRequest
 
 
-def validate_params(required: dict, optional: Optional[dict] = None):
+def validate_params(required: dict, optional: Optional[dict] = None, allow_empty=False):
     if optional is None:
         optional = {}
 
@@ -43,12 +43,13 @@ def wrapper(*args, **kwargs):
                         "You are only allowed to specify the fields {}" ".".format(required.keys()),
                     )
 
-            for key, value in data.items():
-                if not value:
-                    if required[key] == int or required[key] == bool:
-                        pass
-                    else:
-                        raise BadRequestError(f"The item {key} cannot be None or empty.")
+            if not allow_empty:
+                for key, value in data.items():
+                    if not value:
+                        if required[key] == int or required[key] == bool:
+                            pass
+                        else:
+                            raise BadRequestError(f"The item {key} cannot be None or empty.")
 
             wrong_types = [r for r in required.keys() if not isinstance(data[r], required[r])]
             wrong_types += [r for r in optional.keys() if r in data and not isinstance(data[r], optional[r])]

backend/PyMatcha/utils/decorators.py

@@ -45,7 +45,7 @@ def populate_users(amount=150, drop_user_table=False):
         date_lastseen = gen_datetime(min_year=2017, max_year=datetime.datetime.now().year)
         username = user.get_username()
 
-        birthdate = datetime.datetime.strptime(user.get_dob(), "%Y-%m-%dT%H:%M:%S.%fZ").date()
+        birthdate = gen_datetime(min_year=1985, max_year=datetime.datetime.now().year - 18).date()
         try:
             User.create(
                 first_name=user.get_first_name(),
@@ -58,7 +58,7 @@ def populate_users(amount=150, drop_user_table=False):
                 orientation=orientation,
                 birthdate=birthdate,
                 geohash=geohash,
-                heat_score=0,
+                heat_score=random.randint(0, 150),
                 is_online=random.choice([True, False]),
                 date_joined=date_joined,
                 date_lastseen=date_lastseen,

backend/PyMatcha/utils/populate_database.py

@@ -48,6 +48,8 @@ def update_heat_scores():
         score -= reports_received * REPORTS_MULTIPLIER
         score += views * VIEW_MULTIPLIER
         score += ceil(messages / MESSAGES_DIVIDER)
+        if score < 0:
+            score = 0
         user.heat_score = score
         user.save()
         return f"Updated heat score for user {user.id}: {user.heat_score}."

backend/PyMatcha/utils/tasks.py

@@ -20,6 +20,7 @@ tags:
   - name: Messages
     description: Send and receive messages
   - name: Recommendations
+  - name: Search
   - name: User
     description: Get user info
   - name: Debug
@@ -1204,6 +1205,36 @@ paths:
                   message:
                     type: string
                     example: Image successfully deleted.
+  /search:
+    post:
+      summary: Search users
+      operationId: searchUsers
+      security:
+        - bearerAuth: [ ]
+      tags:
+        - Search
+      responses:
+        "400":
+          $ref: '#/components/responses/BadRequest'
+        "200":
+          description: Returns a list of users based on the search
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    description: If the request is a success
+                    example: true
+                  code:
+                    type: integer
+                    description: The status code
+                    example: 200
+                  search_results:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/SearchResult'
 
 
 servers:
@@ -1894,4 +1925,106 @@ components:
         is_primary:
           type: boolean
           description: Is this image the profile picture of the user
-          example: true
+          example: true
+    SearchResult:
+      type: object
+      properties:
+        common_tags:
+          type: array
+          example: [ "friends", "drinks", "sun" ]
+        distance:
+          type: integer
+          example: 50
+          description: The distance between two users
+        id:
+          type: integer
+          example: 1
+        first_name:
+          type: string
+          example: Foo
+        last_name:
+          type: string
+          example: Bar
+        username:
+          type: string
+          example: FooBar
+        email:
+          type: string
+          example: foo@example.org
+        bio:
+          type: string
+          example: Lorem Ipsum is the single greatest threat. We are not - we are not keeping up with other websites. Lorem Ipsum best not make any more threats to your website. It will be met with fire and fury like the world has never seen. Does everybody know that pig named Lorem Ipsum? An ‘extremely credible source’ has called my office and told me that Barack Obama’s placeholder text is a fraud.
+        birthdate:
+          type: date
+          example: Mon, 06 Apr 1998 00:00:00 GMT
+        gender:
+          type: string
+          enum: [ "male", "female", "other" ]
+          example: male
+        orientation:
+          type: string
+          enum: [ "heterosexual", "homosexual", "bisexual", "other" ]
+          example: heterosexual
+        geohash:
+          type: string
+          example: u09whv25xgzn
+        heat_score:
+          type: integer
+          example: 123
+        confirmed_on:
+          type: date
+          example: Wed, 16 Sep 2020 15:20:02 GMT
+        date_joined:
+          type: date
+          example: Wed, 16 Sep 2020 15:18:02 GMT
+        date_lastseen:
+          type: date
+          example: Wed, 19 Sep 2020 19:24:02 GMT
+        is_confirmed:
+          type: boolean
+          example: true
+        is_online:
+          type: boolean
+          example: true
+        is_profile_completed:
+          type: boolean
+          example: true
+        age:
+          type: int
+          example: 22
+        likes:
+          type: object
+          properties:
+            sent:
+              type: array
+              items:
+                $ref: '#/components/schemas/Like'
+              uniqueItems: true
+            received:
+              type: array
+              items:
+                $ref: '#/components/schemas/Like'
+              uniqueItems: true
+        reports:
+          type: object
+          properties:
+            sent:
+              type: array
+              items:
+                $ref: '#/components/schemas/Report'
+              uniqueItems: true
+            received:
+              type: array
+              items:
+                $ref: '#/components/schemas/Report'
+              uniqueItems: true
+        tags:
+          type: array
+          items:
+            $ref: '#/components/schemas/Tag'
+          uniqueItems: true
+        images:
+          type: array
+          items:
+            $ref: '#/components/schemas/Image'
+          uniqueItems: true