removed pagination for GET languages and GET categories (#340)

* removed pagination for GET languages and GET categories

* removed references to pagination in docs

* multiple

removed pagination references, updated total_counts, added assertions
for test_languages and test_categories, changed all "Linux" references
to "Unix/Linux/*nix" in resources.yml

* fixed test failure on test_languages

Author: mike-lloyd03

app/api/routes/categories.py

@@ -1,10 +1,9 @@
-from flask import redirect, request
+from flask import redirect
 
 from app import utils as utils
 from app.api import bp
 from app.api.routes.helpers import failures_counter, latency_summary, logger
 from app.models import Category
-from configs import Config
 
 
 @latency_summary.time()
@@ -23,23 +22,21 @@ def category(id):
 
 def get_categories():
     try:
-        category_paginator = utils.Paginator(Config.CATEGORY_PAGINATOR, request)
-        query = Category.query
+        categories = Category.query.all()
 
-        paginated_categories = category_paginator.paginated_data(query)
-        if not paginated_categories:
+        if not categories:
             return redirect('/404')
         category_list = [
-            category.serialize for category in paginated_categories.items
+            category.serialize for category in categories
         ]
-        pagination_details = category_paginator.pagination_details(paginated_categories)
+        details = {'details': {'total_count': len(categories)}}
     except Exception as e:
         logger.exception(e)
         return utils.standardize_response(status_code=500)
 
     return utils.standardize_response(payload=dict(
         data=category_list,
-        **pagination_details),
+        **details),
         datatype="categories")
 
 

app/api/routes/languages.py

@@ -1,10 +1,9 @@
-from flask import redirect, request
+from flask import redirect
 
 from app import utils as utils
 from app.api import bp
 from app.api.routes.helpers import failures_counter, latency_summary, logger
 from app.models import Language
-from configs import Config
 
 
 @latency_summary.time()
@@ -22,24 +21,22 @@ def language(id):
 
 
 def get_languages():
-    language_paginator = utils.Paginator(Config.LANGUAGE_PAGINATOR, request)
-    query = Language.query
-
     try:
-        paginated_languages = language_paginator.paginated_data(query)
-        if not paginated_languages:
+        languages = Language.query.all()
+
+        if not languages:
             return redirect('/404')
         language_list = [
-            language.serialize for language in paginated_languages.items
+            language.serialize for language in languages
         ]
-        pagination_details = language_paginator.pagination_details(paginated_languages)
+        details = {'details': {'total_count': len(languages)}}
     except Exception as e:
         logger.exception(e)
         return utils.standardize_response(status_code=500)
 
     return utils.standardize_response(payload=dict(
         data=language_list,
-        **pagination_details),
+        **details),
         datatype="languages")
 
 

app/static/openapi.yaml

@@ -167,7 +167,7 @@ paths:
   /categories:
     get:
       summary: List Categories
-      description: Gets a list of all available categories. Note: The `page` attribute in the response of the `/search` endpoint begins with `0`, but the `page` attribute in the response of the `List Categories` endpoint begins with `1`.
+      description: Gets a list of all available categories.
       tags:
         - List Categories
       responses:
@@ -210,24 +210,25 @@ paths:
                       name: 'Docker'
                     - id: 15
                       name: 'Regular Expressions'
-                    - id: 1
+                    - id: 16
                       name: 'Mentorship'
-                    - id: 1
+                    - id: 17
                       name: 'News'
-                    - id: 1
+                    - id: 18
                       name: 'Back End Dev'
-                    - id: 1
+                    - id: 19
                       name: 'Mobile Dev'
-                    - id: 1
+                    - id: 20
                       name: 'Cheat Sheets'
-                  has_next: true
-                  has_prev: false
-                  number_of_pages: 4
-                  page: 1
-                  records_per_page: 20
+                    - id: 21
+                      name: 'Open Source'
+                    - id: 22
+                      name: 'Front End Dev'
+                    - id: 23
+                      name: 'Web Design'
                   status: 'ok'
                   status_code: 200
-                  total_count: 72
+                  total_count: 23
         404:
           $ref: '#/components/responses/NotFound'
   /categories/{id}:
@@ -265,7 +266,7 @@ paths:
   /languages:
     get:
       summary: List Languages
-      description: Gets list of all available language entries. Note: The `page` attribute in the response of the `/search` endpoint begins with `0`, but the `page` attribute in the response of the `List Languages` endpoint begins with `1`.
+      description: Gets list of all available language entries.
       tags:
         - List Languages
       responses:
@@ -318,14 +319,13 @@ paths:
                     name: 'Android'
                   - id: 20
                     name: 'CSS'
-                has_next: true
-                has_prev: false
-                number_of_pages: 4
-                page: 1
-                records_per_page: 20
+                  - id: 21
+                    name: 'jQuery'
+                  - id: 22
+                    name: 'Git'
                 status: 'ok'
                 status_code: 200
-                total_count: 73
+                total_count: 22
         404:
           $ref: '#/components/responses/NotFound'
   /languages/{id}:
@@ -932,21 +932,6 @@ components:
           type: string
         category:
           $ref: '#/components/schemas/Category_data'
-        has_next:
-          type: boolean
-          description: Additional pages
-        has_previous:
-          type: boolean
-          description: Previous pages
-        number_of_pages:
-          type: integer
-          description: Total pages
-        page:
-          type: integer
-          description: Current page
-        records_per_page:
-          type: integer
-          description: Records per page
         status:
           type: string
           description: Status message
@@ -974,23 +959,8 @@ components:
         apiVersion:
           type: string
           description: API version
-        language:
+        languages:
           $ref: '#/components/schemas/Language_data'
-        has_next:
-          type: boolean
-          description: Additional pages
-        has_previous:
-          type: boolean
-          description: Previous pages
-        number_of_pages:
-          type: integer
-          description: Total pages
-        page:
-          type: integer
-          description: Current page
-        records_per_page:
-          type: integer
-          description: Records per page
         status:
           type: string
           description: Status message

app/utils.py

@@ -50,7 +50,7 @@ def paginated_data(self, query):
 
     def pagination_details(self, paginated_data):
         return {
-            "pagination_details": {
+            "details": {
                 "page": paginated_data.page,
                 "number_of_pages": paginated_data.pages,
                 "records_per_page": paginated_data.per_page,
@@ -101,7 +101,7 @@ def standardize_response(
     """
     data = payload.get("data")
     errors = payload.get("errors")
-    pagination_details = payload.get("pagination_details")
+    details = payload.get("details")
     resp = dict(
         apiVersion=version,
         status="ok",
@@ -129,8 +129,8 @@ def standardize_response(
     else:
         resp[datatype] = data
 
-        if pagination_details:
-            resp.update(pagination_details)
+        if details:
+            resp.update(details)
 
     return jsonify(resp), resp["status_code"], {'Content-Type': 'application/json'}
 

resources.yml

@@ -1260,35 +1260,35 @@
 - name: Linux Journey
   url: https://linuxjourney.com/
   category: Open Source
-  languages: ["Linux"]
+  languages: ["Unix/Linux/*nix"]
   paid: false
   notes:
 
 - name: Linux from Scratch
   url: http://linuxfromscratch.org/
   category: Open Source
-  languages: ["Linux"]
+  languages: ["Unix/Linux/*nix"]
   paid: false
   notes:
 
 - name: System Administration Guide from Red Hat
   url: https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/4/html/Introduction_To_System_Administration/index.html
   category: Open Source
-  languages: ["Linux"]
+  languages: ["Unix/Linux/*nix"]
   paid: false
   notes:
 
 - name: Linux Tutorials
   url: https://www.linux.com/tutorials
   category: Open Source
-  languages: ["Linux"]
+  languages: ["Unix/Linux/*nix"]
   paid: false
   notes:
 
 - name: Linux Survival
   url: http://linuxsurvival.com/
   category: Open Source
-  languages: ["Linux"]
+  languages: ["Unix/Linux/*nix"]
   paid: false
   notes:
 

tests/conftest.py

@@ -184,6 +184,24 @@ def fake_key_query_error(mocker):
     mocker.patch('app.models.Key.query', new=None)
 
 
+@pytest.fixture(scope='function')
+def fake_category_query_error(mocker):
+    """
+    Mocks an exception being raised during a query to test error handling
+    """
+
+    mocker.patch('app.models.Category.query', new=None)
+
+
+@pytest.fixture(scope='function')
+def fake_language_query_error(mocker):
+    """
+    Mocks an exception being raised during a query to test error handling
+    """
+
+    mocker.patch('app.models.Language.query', new=None)
+
+
 @pytest.fixture(scope='function')
 def fake_algolia_save(mocker):
     """

tests/unit/test_routes/test_categories.py

@@ -10,16 +10,8 @@ def test_categories(module_client, module_db):
         assert (isinstance(category.get('id'), int))
         assert (isinstance(category.get('name'), str))
         assert (category.get('name'))
-    assert (response.json['number_of_pages'] is not None)
-
-
-def test_categories_page_out_of_bounds(module_client, module_db):
-    client = module_client
-    too_far = 99999999
-    response = client.get(
-        f"api/v1/categories?page_size=100&page={too_far}", follow_redirects=True)
-
-    assert_correct_response(response, 404)
+    assert (response.json['total_count'] is not None)
+    assert (len(response.json['categories']) == response.json['total_count'])
 
 
 def test_get_single_category(module_client, module_db):

tests/unit/test_routes/test_languages.py

@@ -9,15 +9,8 @@ def test_languages(module_client, module_db):
         assert (isinstance(language.get('id'), int))
         assert (isinstance(language.get('name'), str))
         assert (language.get('name'))
-    assert (response.json['number_of_pages'] is not None)
-
-
-def test_languages_page_out_of_bounds(module_client, module_db):
-    client = module_client
-    too_far = 99999999
-    response = client.get(
-        f"api/v1/languages?page_size=100&page={too_far}", follow_redirects=True)
-    assert_correct_response(response, 404)
+    assert (response.json['total_count'] is not None)
+    assert (len(response.json['languages']) == response.json['total_count'])
 
 
 def test_get_single_language(module_client, module_db):

tests/unit/test_routes/test_utils.py

@@ -5,7 +5,11 @@
 
 
 def test_internal_server_error_handler(
-        module_client, module_db, fake_paginated_data_error):
+        module_client,
+        module_db,
+        fake_language_query_error,
+        fake_category_query_error,
+        fake_paginated_data_error):
     client = module_client
 
     response = client.get('api/v1/resources')