Replace DRF with connexion

`connexion` is a framework that automagically handles HTTP requests
based on OpenAPI Specification. The routes and the documentation are
autogenerated. Models are being validated against the specification.

* Remove all django files
* Update requirements
* Create function to generate and configure a connexion app
* Implement a way to manage the settings similar to what was done for
  DRF
* Fix the unit tests
* Fix integration tests
* Update the docker image
* Fix the wheel package
* Update and clean up Makefile
* Update the GitHub PR template

Fixes request-yo-racks#60

.coveragerc

@@ -1,19 +1,12 @@
 [run]
 omit =
  *__init__.py
- api/apps/api/models.py
- api/apps/api/serializers.py
- api/apps/api/tests/*
- api/apps/api/urls.py
- api/apps/api/views.py
  api/celery/celery.py
  api/celery/celery_settings.py
- api/celery/tests/*
+ api/connexion_*
+ api/controller/*
  api/settings/*
- api/static.py
- api/urls.py
  api/wsgi.py
 
-
 [report]
 fail_under = 90.0

.github/PULL_REQUEST_TEMPLATE.md

@@ -20,14 +20,13 @@ Add a screenshot if applicable.
 -->
 
 
+<!--
 Motivation and Context
-----------------------
-<!-- Why is this change required? What problem does it solve? -->
+Why is this change required? What problem does it solve? -->
 
 
-How Has This Been Tested?
--------------------------
 <!--
+How Has This Been Tested?
 Add any information that could help the reviewer to validate the PR.
 Please describe in detail how you tested your changes, include details
 of your testing environment, and the tests you ran to see how your

Dockerfile

@@ -4,7 +4,7 @@ MAINTAINER Rémy Greinhofer <remy.greinhofer@requestyoracks.org>
 # Update the package list.
 RUN apt-get update \
  && DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends \
-  git \
+ git \
  && apt-get clean \
  && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
 
@@ -15,7 +15,8 @@ WORKDIR /usr/src/app
 COPY . .
 
 # Build the packages.
-RUN python setup.py bdist_wheel
+RUN rm -fr dist \
+ && python setup.py bdist_wheel
 
 ###
 # Create the release image.

Makefile

@@ -31,10 +31,6 @@ else
  RUN_CMD = $(LOCAL_RUN_CMD)
 endif
 
-# Docker run Django parameters.
-DJANGO_MANAGE_CMD = python manage.py
-RUN_DJANGO_MANAGE_CMD = $(RUN_CMD) $(DJANGO_MANAGE_CMD)
-
 default: setup
 
 help: # Display help
@@ -81,24 +77,6 @@ clean-minikube: ## Remove all the Kubernetes objects associated to this project
 clean-repo: ## Remove unwanted files in project (!DESTRUCTIVE!)
  @cd $(TOPDIR) && git clean -ffdx && git reset --hard
 
-.PHONY: django-migrate
-django-migrate: ## Run the Django migrations
- @bash tools/kubernetes-django-manage.sh migrate
-
-.PHONY: django-make-migrations
-django-make-migrations: ## Prepare the Django migrations
- @bash tools/kubernetes-django-manage.sh makemigrations
-
-.PHONY: django-shell
-django-shell: ## Run the Django Shell
- @bash tools/kubernetes-django-manage.sh shell
-
-.PHONY: django-superuser
-django-superuser: ## Create the Django super user
- @bash tools/kubernetes-django-manage.sh createsuperuser \
- --username admin\
- --email admin@requestyoracks.com
-
 .PHONY: deploy-minikube-api
 deploy-minikube-api: ## Deploy the API on Minikube
  cd charts \
@@ -159,10 +137,10 @@ local-celery-worker: ## Start a local celery worker
  && eval $$(tools/kubernetes-local-env-vars.sh) \
  && $(LOCAL_RUN_CMD) docker/docker-entrypoint.sh celery worker
 
-.PHONY: local-django-api
-local-django-api: ## Run Django locally
+.PHONY: local-api
+local-api: ## Run connexion locally
  source $(HOME)/.config/ryr/ryr-env.sh \
- && export DJANGO_SETTINGS_MODULE=api.settings.local \
+ && export CONNEXION_SETTINGS_MODULE=api.settings.local \
  && export RYR_API_API_OPTS="--reload --timeout 1800" \
  && export RYR_LOG_LEVEL=info \
  && eval $$(tools/kubernetes-local-env-vars.sh) \
@@ -176,7 +154,7 @@ venv: venv/bin/activate ## Setup local venv
 venv/bin/activate: requirements.txt
  test -d venv || python3 -m venv venv || virtualenv --no-setuptools --no-wheel -p python3 venv
  . venv/bin/activate \
- && pip install --upgrade pip \
+ && pip install --upgrade pip setuptools \
  && pip install -U -r requirements.txt \
  && pip install -r requirements-dev.txt \
  && pip install -e .

api/celery/tasks.py

@@ -4,8 +4,8 @@
 from celery import chord
 from celery.utils.log import get_task_logger
 
-from api.apps.api.collectors.base import BusinessInfo
-from api.apps.api.collectors.generic import CollectorClient
+from api.collectors.base import BusinessInfo
+from api.collectors.generic import CollectorClient
 from api.celery.worker import app
 
 logger = get_task_logger(__name__)
@@ -41,8 +41,11 @@ def collect_place_details_from_yelp(name, address):
  client.search_places(address, terms=name, limit=1)
  place_summary = client.retrieve_search_summary(0)
 
+ if not place_summary:
+ raise ValueError('Yelp did not return any result.')
+
  # Extract the place_id.
- details = client.get_place_details(place_summary.id)
+ details = client.get_place_details(place_summary.place_id)
  return details
 
 

api/apps/api/collectors/base.py → api/collectors/base.py

@@ -87,7 +87,7 @@ def from_json(cls, json_obj):
 class PlaceSearchSummary:
  """Define Place Search Summary information."""
 
- id: str = ''
+ place_id: str = ''
  name: str = ''
  address: str = ''
 

api/apps/api/collectors/generic.py → api/collectors/generic.py

@@ -1,7 +1,7 @@
 """Defines a generic client for the collectors."""
 
-from api.apps.api.collectors.google import GoogleCollector
-from api.apps.api.collectors.yelp import YelpCollector
+from api.collectors.google import GoogleCollector
+from api.collectors.yelp import YelpCollector
 
 
 class CollectorClient:
@@ -106,7 +106,7 @@ def lookup_place(self, place_id=None, name=None, address=None):
  limit=1,
  )
  search_summary = self.retrieve_search_summary(0)
- lookup_id = search_summary.id
+ lookup_id = search_summary.place_id
  else:
  lookup_id = place_id
  place_details = self.get_place_details(lookup_id)

api/apps/api/collectors/google.py → api/collectors/google.py

@@ -2,9 +2,9 @@
 
 import googlemaps
 
-from api.apps.api.collectors.base import AbstractClientCollector
-from api.apps.api.collectors.base import BusinessInfo
-from api.apps.api.collectors.base import PlaceSearchSummary
+from api.collectors.base import AbstractClientCollector
+from api.collectors.base import BusinessInfo
+from api.collectors.base import PlaceSearchSummary
 
 
 class GoogleCollector(AbstractClientCollector):
@@ -94,7 +94,7 @@ def retrieve_search_summary(self, index=0):
  search_summary = PlaceSearchSummary()
  business = self.search_results.get('results')[index]
 
- search_summary.id = business.get('place_id', '')
+ search_summary.place_id = business.get('place_id', '')
  search_summary.name = business.get('name', '')
  search_summary.address = business.get('vicinity', '')
 

api/apps/api/collectors/yelp.py → api/collectors/yelp.py

@@ -3,9 +3,9 @@
 
 import requests
 
-from api.apps.api.collectors.base import AbstractRestCollector
-from api.apps.api.collectors.base import BusinessInfo
-from api.apps.api.collectors.base import PlaceSearchSummary
+from api.collectors.base import AbstractRestCollector
+from api.collectors.base import BusinessInfo
+from api.collectors.base import PlaceSearchSummary
 
 
 class YelpCollector(AbstractRestCollector):
@@ -114,7 +114,7 @@ def retrieve_search_summary(self, index=0):
  search_summary = PlaceSearchSummary()
  business = self.search_results.get('businesses')[index]
 
- search_summary.id = business.get('id', '')
+ search_summary.place_id = business.get('id', '')
  search_summary.name = business.get('name', '')
  search_summary.address = ' '.join(business.get('location', {}).get('display_address', ''))
 

api/connexion_server.py

@@ -0,0 +1,12 @@
+"""
+Define the REST API server.
+
+This was done to help transitionning to `connexion` and may be deleted at some point in the future.
+To launch the server locally, use the `make local-api` command instead.
+"""
+
+from api.connexion_utils import create_connexion_app
+
+if __name__ == '__main__':
+ app = create_connexion_app()
+ app.run()