Renamed all references of paid to true (#379)

Co-authored-by: Aaron Suarez <aaron-suarez@users.noreply.github.com>

Makefile

@@ -60,7 +60,7 @@ run: build
 run_windows: build
 	@cmd /c (IF NOT "$(shell ${DOCKER} ps -q -f name=resources-api)" == "" ${DOCKER_COMPOSE} down)
 	${DOCKER_COMPOSE} run -p 5000:5000 ${RESOURCES_CONTAINER} ${FLASK} run -h 0.0.0.0
-	
+
 
 .PHONY: bg
 bg:

app/api/routes/resource_creation.py

@@ -44,13 +44,13 @@ def create_resources(json, db):
         # Create each Resource in the database one by one
         for resource in json:
             langs, categ = get_attributes(resource)
-            paid_bool = ensure_bool(resource.get('paid'))
+            free_bool = ensure_bool(resource.get('free'))
             new_resource = Resource(
                 name=resource.get('name'),
                 url=resource.get('url'),
                 category=categ,
                 languages=langs,
-                paid=paid_bool,
+                free=free_bool,
                 notes=resource.get('notes'))
 
             try:

app/api/routes/resource_modification.py

@@ -57,10 +57,10 @@ def update_resource(id, json, db):
         if json.get('url'):
             resource.url = json.get('url')
             index_object['url'] = json.get('url')
-        if 'paid' in json:
-            paid = ensure_bool(json.get('paid'))
-            resource.paid = paid
-            index_object['paid'] = paid
+        if 'free' in json:
+            free = ensure_bool(json.get('free'))
+            resource.free = free
+            index_object['free'] = free
         if 'notes' in json:
             resource.notes = json.get('notes')
             index_object['notes'] = json.get('notes')

app/api/routes/resource_retrieval.py

@@ -40,7 +40,7 @@ def get_resources():
     languages = request.args.getlist('languages')
     category = request.args.get('category')
     updated_after = request.args.get('updated_after')
-    paid = request.args.get('paid')
+    free = request.args.get('free')
 
     q = Resource.query
 
@@ -81,13 +81,13 @@ def get_resources():
             )
         )
 
-    # Filter on paid
-    if isinstance(paid, str) and paid.lower() in ['true', 'false']:
-        paidAsBool = paid.lower() == 'true'
-        q = q.filter(Resource.paid == paidAsBool)
+    # Filter on free
+    if isinstance(free, str) and free.lower() in ['true', 'false']:
+        freeAsBool = free.lower() == 'true'
+        q = q.filter(Resource.free == freeAsBool)
 
     # Order by "getting started" category
-    if not languages and not category and paid is None:
+    if not languages and not category and free is None:
         show_first = Category.query.filter(Category.name == "Getting Started").first()
         clause = (
             f" CASE resource.category_id"

app/api/routes/search.py

@@ -20,19 +20,19 @@ def search_results():
     page_size = request.args.get('page_size', Config.RESOURCE_PAGINATOR.per_page, int)
 
     # Fetch the filter params from the url, if they were provided.
-    paid = request.args.get('paid')
+    free = request.args.get('free')
     category = request.args.get('category')
     languages = request.args.getlist('languages')
     filters = []
 
-    # Filter on paid
-    if paid:
-        paid = paid.lower()
+    # Filter on free
+    if free:
+        free = free.lower()
         # algolia filters boolean attributes with either 0 or 1
-        if paid == 'true':
-            filters.append('paid=1')
-        elif paid == 'false':
-            filters.append('paid=0')
+        if free == 'true':
+            filters.append('free=1')
+        elif free == 'false':
+            filters.append('free=0')
 
     # Filter on category
     if category:

app/cli.py

@@ -110,7 +110,7 @@ def create_resource(resource, db):  # pragma: no cover
         url=resource['url'],
         category=resource['category'],
         languages=resource['languages'],
-        paid=resource.get('paid'),
+        free=resource.get('free'),
         notes=resource.get('notes', ''),
         upvotes=resource.get('upvotes', 0),
         downvotes=resource.get('downvotes', 0),
@@ -126,7 +126,7 @@ def update_resource(resource, existing_resource):   # pragma: no cover
     existing_resource.name = resource['name']
     existing_resource.url = resource['url']
     existing_resource.category = resource['category']
-    existing_resource.paid = resource.get('paid')
+    existing_resource.free = resource.get('free')
     existing_resource.notes = resource.get('notes', '')
     existing_resource.languages = resource['languages']
 

app/models.py

@@ -29,7 +29,7 @@ class Resource(TimestampMixin, db.Model):
                             nullable=False)
     category = db.relationship('Category')
     languages = db.relationship('Language', secondary=language_identifier)
-    paid = db.Column(db.Boolean, nullable=False, default=False)
+    free = db.Column(db.Boolean, nullable=False, default=True)
     notes = db.Column(db.String)
     upvotes = db.Column(db.INTEGER, default=0)
     downvotes = db.Column(db.INTEGER, default=0)
@@ -54,7 +54,7 @@ def serialize(self):
             'url': self.url,
             'category': self.category.name,
             'languages': self.serialize_languages,
-            'paid': self.paid,
+            'free': self.free,
             'notes': self.notes,
             'upvotes': self.upvotes,
             'downvotes': self.downvotes,
@@ -84,7 +84,7 @@ def __eq__(self, other):
                 for attribute in [
                     "name",
                     "url",
-                    "paid",
+                    "free",
                     "notes",
                     "category",
                     "languages",

app/static/openapi.yaml

@@ -116,9 +116,9 @@ paths:
             type: string
           required: true
         - in: query
-          name: paid
+          name: free
           required: false
-          description: Whether the resource is paid or not. To search for *free* resources, make a `GET` request to `/search?paid=false`.
+          description: Whether the resource is free or not. To search for *free* resources, make a `GET` request to `/search?free=true`.
           schema:
             type: boolean
         - in: query
@@ -152,7 +152,7 @@ paths:
                     last_updated: '2019-05-25 18:52:15'
                     name: 'C Tutorial'
                     notes: 'Learn C with our popular C tutorial, which will take you from the very basics of C all the way through sophisticated topics like binary trees and data structures.'
-                    paid: false
+                    free: true
                     times_clicked: 0
                     upvotes: 0
                     url: 'https://www.cprogramming.com/tutorial/c-tutorial.html'
@@ -394,7 +394,7 @@ paths:
                   last_updated: '2019-06-15 17:55:32'
                   name: 'Free Tech Books'
                   notes: 'Focuses on general computer science concepts rather than a specific language'
-                  paid: false
+                  free: true
                   times_clicked: 0
                   upvotes: 0
                   url: 'http://www.freetechbooks.com/'
@@ -443,7 +443,7 @@ paths:
                   last_updated: '2019-07-22 16:05:53'
                   name: 'Updated Book Title'
                   notes: null
-                  paid: false
+                  free: true
                   times_clicked: 3
                   upvotes: 1
                   url: 'http://www.test.com'
@@ -506,7 +506,7 @@ paths:
                     last_updated: '2019-07-26 13:47:52'
                     name: 'Thinking Forth'
                     notes: null
-                    paid: false
+                    free: true
                     times_clicked: 2
                     upvotes: 0
                     url: 'http://thinking-forth.sourceforge.net/'
@@ -550,7 +550,7 @@ paths:
                   last_updated: '2020-03-12 23:17:52'
                   name: 'Teach Your Kids to Code'
                   notes: null
-                  paid: true
+                  free: false
                   times_clicked: 0
                   upvotes: 1
                   url: 'http://teachyourkidstocode.com/'
@@ -594,7 +594,7 @@ paths:
                   last_updated: '2020-03-12 23:17:52'
                   name: 'Teach Your Kids to Code'
                   notes: null
-                  paid: true
+                  free: false
                   times_clicked: 0
                   upvotes: 0
                   url: 'http://teachyourkidstocode.com/'
@@ -611,9 +611,9 @@ paths:
         - List Resources
       parameters:
         - in: query
-          name: paid
+          name: free
           required: false
-          description: Whether the resource is paid or not. To search for *free* resources, make a `GET` request to `/resources?paid=false`.
+          description: Whether the resource is free or not. To search for *free* resources, make a `GET` request to `/resources?free=true`.
           schema:
             type: boolean
         - in: query
@@ -654,7 +654,7 @@ paths:
                     last_updated: '2019-07-22 17:39:50'
                     name: 'Some, but not ALL of the knowledge'
                     notes: null
-                    paid: false
+                    free: true
                     times_clicked: 3
                     upvotes: 1
                     url: 'http://www.test.com'
@@ -685,7 +685,7 @@ paths:
 
     post:
       summary: Create Resources
-      description: Creates new learning resources. The structure of the request is a list of resource objects. The required properties for each new resource are `category`, `name`, `paid`, and `url`.
+      description: Creates new learning resources. The structure of the request is a list of resource objects. The required properties for each new resource are `category`, `name`, `free`, and `url`.
       tags:
         - Create Resources
       requestBody:
@@ -696,7 +696,7 @@ paths:
             example:
               - category: 'Tutorial'
                 name: 'CSS Tutorial'
-                paid: false
+                free: true
                 url: 'https://www.w3schools.com/css/'
         required: true
       responses:
@@ -718,7 +718,7 @@ paths:
                     last_updated: '2019-07-22 16:05:53'
                     name: 'CSS Tutorial'
                     notes: null
-                    paid: false
+                    free: true
                     times_clicked: 3
                     upvotes: 1
                     url: 'https://www.w3schools.com/css/'
@@ -744,11 +744,11 @@ paths:
                           - url
                         resource: 'https://resources.operationcode.org/api/v1/2137'
                       missing-params:
-                          message: 'The following params were missing: name, category, paid.'
+                          message: 'The following params were missing: name, category, free.'
                           params:
                             - name
                             - category
-                            - paid
+                            - free
                   status: 'Unprocessable Entity'
                   status_code: 422
       security:
@@ -984,7 +984,7 @@ components:
     CreateResourcesRequest:
       allOf:
         - $ref: '#/components/schemas/ResourcesRequest'
-        # - required: [category, name, paid, url]
+        # - required: [category, name, free, url]
 
     ResourcesRequest:
       type: array
@@ -1005,9 +1005,9 @@ components:
           notes:
             type: string
             description: Resource notes
-          paid:
+          free:
             type: boolean
-            description: True or false for whether resource is paid
+            description: True or false for whether resource is free
           url:
             type: string
             description: Resource url
@@ -1028,9 +1028,9 @@ components:
         notes:
           type: string
           description: Resource notes
-        paid:
+        free:
           type: boolean
-          description: True or false for whether resource is paid
+          description: True or false for whether resource is free
         url:
           type: string
           description: Resource url
@@ -1066,9 +1066,9 @@ components:
         notes:
           type: string
           description: Resource notes
-        paid:
+        free:
           type: boolean
-          description: True or false for whether resource is paid
+          description: True or false for whether resource is free
         upvotes:
           type: integer
           description: Positive ratings

app/utils.py

@@ -67,7 +67,7 @@ def format_resource_search(hit):
         'url': hit['url'],
         'category': hit['category'],
         'languages': hit['languages'],
-        'paid': hit['paid'],
+        'free': hit['free'],
         'notes': hit['notes'],
         'upvotes': hit['upvotes'],
         'downvotes': hit['downvotes'],

migrations/versions/fc34137ad3ba_.py

@@ -0,0 +1,29 @@
+"""Rename paid column to free
+
+Revision ID: fc34137ad3ba
+Revises: 205742d3b3f5
+Create Date: 2020-09-30 22:35:20.007768
+
+"""
+from alembic import op
+import sqlalchemy as sa
+import sqlalchemy_utils
+
+
+# revision identifiers, used by Alembic.
+revision = 'fc34137ad3ba'
+down_revision = '205742d3b3f5'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.alter_column('resource', 'paid', new_column_name='free', existing_type=sa.Boolean, nullable=False)
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.alter_column('resource', 'free', new_column_name='paid', existing_type=sa.Boolean, nullable=True)
+    # ### end Alembic commands ###