diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..ccca24a --- /dev/null +++ b/.dockerignore @@ -0,0 +1,2 @@ +.git +*.pyc \ No newline at end of file diff --git a/.gitignore b/.gitignore index 740bb18..c4342be 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ - +*.pyc .vagrant - +*.log +*.idea/ \ No newline at end of file diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..b0c81b8 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,11 @@ +FROM alpine:3.6 + +RUN apk add --update py3-pip python3 postgresql postgresql-dev zlib-dev libjpeg-turbo-dev gcc python3-dev musl-dev make \ + && pip3 install --upgrade pip +RUN if [[ ! -e /usr/bin/python ]]; then ln -sf /usr/bin/python3 /usr/bin/python; fi + +WORKDIR /srv/python-code-test +ADD requirements.in /srv/python-code-test/ +RUN pip3 install -r requirements.in +ADD test_requirements.txt /srv/python-code-test/ +RUN pip3 install -r test_requirements.txt diff --git a/README.md b/README.md new file mode 100644 index 0000000..a524173 --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ +# Shiptrader + +A platform on which users can buy and sell Starships. +Technical information about the Starships on sale from the [Starship +API](https://swapi.co/documentation#starships). + +## Getting started + +* Install [Docker](https://docs.docker.com/compose/install/#install-compose) +* Run the following shell commands: + +``` +> docker-compose up + +# You can run `manage.py` commands using the `./manapy` wrapper. +# To load data into DB from external SWAPI resource: +> ./manapy load_ships +# Running tests: +> docker-compose run --rm code-test pytest +``` + +## Endpoints + +* `/swagger-docs` to browse with Swagger-UI. +* `/api/v1/starship` to browse Starships (GET). +* `/api/v1/listing` to browse, create and edit Listings for Starship sales (GET, POST, PATCH). + +## Functionality + +* A potential buyer can browse all Starships +* A potential buyer can browse all the listings for a given `starship_class` (filtered to Listings where `is_active is True`). +* A potential buyer can sort listings by price or time of listing +* To list a Starship as for sale, the user should supply the listing name, Starship name and list price. +* A seller can deactivate and reactivate their listing (PATCH request with listing ID and a value for `is_active` field). diff --git a/Vagrantfile b/Vagrantfile index 9f95721..6fab5ed 100644 --- a/Vagrantfile +++ b/Vagrantfile @@ -5,25 +5,14 @@ VAGRANTFILE_API_VERSION = "2" Vagrant.configure(VAGRANTFILE_API_VERSION) do |config| - config.vm.box = "ubuntu/trusty64" - - # local box - config.vm.define :local, primary: true do |local| - local.vm.box_url = "https://vagrantcloud.com/ubuntu/trusty64" - local.vm.hostname = "local" + config.vm.box = "ubuntu/xenial64" # Django runserver networking - local.vm.network "forwarded_port", guest: 8888, host: 8888 - local.vm.network "forwarded_port", guest: 80, host: 8989 - local.vm.network "forwarded_port", guest: 4000, host: 4000 + config.vm.network "forwarded_port", guest: 8008, host: 8008 - local.vm.provision "shell", - path:"./scripts/server-setup.sh", args: ["dev", "vagrant"] + config.vm.provision "shell", path:"./scripts/setup-server.sh" - # VirtualBox Provider config - local.vm.provider "virtualbox" do |vb| - vb.customize ["modifyvm", :id, "--memory", "512"] + config.vm.provider :virtualbox do |vb, override| + vb.memory = 512 end - end - end diff --git a/config/dev.sh b/config/dev.sh deleted file mode 100644 index 1e55fbc..0000000 --- a/config/dev.sh +++ /dev/null @@ -1,6 +0,0 @@ -#!/bin/bash -# Dev environment-specific settings - -DB_NAME="lecodetest" -DB_USER="devuser" -DB_PASS="devpass" diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..0513217 --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,18 @@ +version: "3" +services: + code-test: + build: + context: . + command: "scripts/runserver" + volumes: + - .:/srv/python-code-test + ports: + - "8008:8008" + links: + - postgresql + postgresql: + image: postgres:9.6 + environment: + POSTGRES_USER: postgres + POSTGRES_PASSWORD: postgres + POSTGRES_DB: postgres diff --git a/fabfile.py b/fabfile.py deleted file mode 100644 index 18a53bb..0000000 --- a/fabfile.py +++ /dev/null @@ -1,18 +0,0 @@ -from fabric.api import local - - -def run_manage(command): - local('/home/vagrant/.virtualenvs/le-code-test/bin/python /vagrant/testsite/manage.py %s' % command) - - -def web(): - run_manage('runserver 0.0.0.0:8888') - -def migrate(): - run_manage('migrate') - -def make_migrations(): - run_manage('makemigrations') - -def requirements(): - local('/home/vagrant/.virtualenvs/le-code-test/bin/pip install -r requirements.txt ') \ No newline at end of file diff --git a/manage.py b/manage.py new file mode 100755 index 0000000..b99c032 --- /dev/null +++ b/manage.py @@ -0,0 +1,22 @@ +#!/usr/bin/env python +import os +import sys + +if __name__ == "__main__": + os.environ.setdefault("DJANGO_SETTINGS_MODULE", "testsite.settings") + try: + from django.core.management import execute_from_command_line + except ImportError: + # The above import may fail for some other reason. Ensure that the + # issue is really that Django is missing to avoid masking other + # exceptions on Python 2. + try: + import django + except ImportError: + raise ImportError( + "Couldn't import Django. Are you sure it's installed and " + "available on your PYTHONPATH environment variable? Did you " + "forget to activate a virtual environment?" + ) + raise + execute_from_command_line(sys.argv) diff --git a/manapy b/manapy new file mode 100755 index 0000000..b667b52 --- /dev/null +++ b/manapy @@ -0,0 +1,3 @@ +#!/bin/bash + +docker-compose run --rm code-test ./manage.py $* diff --git a/pytest.ini b/pytest.ini new file mode 100644 index 0000000..9e87dfc --- /dev/null +++ b/pytest.ini @@ -0,0 +1,2 @@ +[pytest] +DJANGO_SETTINGS_MODULE = testsite.settings diff --git a/requirements.in b/requirements.in new file mode 100644 index 0000000..fce5432 --- /dev/null +++ b/requirements.in @@ -0,0 +1,5 @@ +django>=1.11,<2.0 +Pillow>=3.4.1,<3.5 +psycopg2>=2.6.2,<2.7 +django-rest-swagger>=2 +django-filter==2.1.0 diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index 88e7096..0000000 --- a/requirements.txt +++ /dev/null @@ -1,7 +0,0 @@ -Django==1.7.2 -ecdsa==0.11 -Fabric==1.10.1 -paramiko==1.15.2 -Pillow==2.7.0 -psycopg2==2.5.4 -pycrypto==2.6.1 diff --git a/scripts/runserver b/scripts/runserver new file mode 100755 index 0000000..e53be2b --- /dev/null +++ b/scripts/runserver @@ -0,0 +1,10 @@ +#!/bin/sh + +until PGPASSWORD=postgres psql --host postgresql --username postgres -c '\l' > /dev/null; do + echo "Postgres is unavailable - sleeping" + sleep 1 +done + +export PYTHONUNBUFFERED=0 +./manage.py migrate +./manage.py runserver 0.0.0.0:8008 diff --git a/scripts/server-setup-user.sh b/scripts/server-setup-user.sh deleted file mode 100755 index b1e5862..0000000 --- a/scripts/server-setup-user.sh +++ /dev/null @@ -1,40 +0,0 @@ -#!/bin/bash -# VirtualEnv and Django setup -# -# This is a distinct file as it's meant to be run as the primary user we SSH in as - -# Grab the environment var, default to 'dev' -ENV=${1-dev} -# ... and pick up related vars -source /vagrant/config/$ENV.sh - -# Grab the user var, default to 'vagrant' -USER=${2-vagrant} - -echo -e "\033[0;34m > Running main-user setup script, with the following parameters:\033[0m" -echo -e "\033[0;34m > Environment: $ENV\033[0m" -echo -e "\033[0;34m > Main User: $USER\033[0m" - -# Set up virtualenv directory for the user if required -if [ ! -d /home/$USER/.virtualenvs ]; then - echo -e "\033[0;31m > Creating .virtualenvs folder" - mkdir /home/$USER/.virtualenvs -fi - -# write all the profile stuff for the user if required -grep -q WORKON /home/$USER/.bashrc -if [ $? -ne 0 ]; then - echo -e "\033[0;31m > Updating profile file\033[0m" - echo "export WORKON_HOME=~/.virtualenvs" >> /home/$USER/.bashrc - echo "source /usr/local/bin/virtualenvwrapper.sh" >> /home/$USER/.bashrc - echo "export PIP_VIRTUALENV_BASE=~/.virtualenvs" >> /home/$USER/.bashrc - echo "workon le-code-test" >> /home/$USER/.bashrc - echo "cd /vagrant/" >> /home/$USER/.bashrc -fi - -echo -e "\033[0;34m > Setting up virtualenv\033[0m" -export WORKON_HOME=/home/$USER/.virtualenvs -source /usr/local/bin/virtualenvwrapper.sh -export PIP_VIRTUALENV_BASE=/home/$USER/.virtualenvs -mkvirtualenv le-code-test -workon le-code-test diff --git a/scripts/server-setup.sh b/scripts/server-setup.sh deleted file mode 100755 index 64bb430..0000000 --- a/scripts/server-setup.sh +++ /dev/null @@ -1,49 +0,0 @@ -#!/bin/bash -# Server Setup -# -# Script to install all the requirements for the server-side part of the Infinity Health project - -# Note that we may want to tighten it up a little for production - e.g. better DB user privs. - -# Grab the environment var, default to 'dev' -ENV=${1-dev} -# ... and pick up related vars -source /vagrant/config/$ENV.sh - -# Grab the user var, default to 'vagrant' -USER=${2-vagrant} - -echo -e "\033[0;34m > Provisioning Vagrant server, with the following parameters:\033[0m" -echo -e "\033[0;34m > Environment: $ENV\033[0m" -echo -e "\033[0;34m > Main User: $USER\033[0m" - -# Housekeeping -apt-get update -apt-get install -y git vim - -# Python environment and tools -apt-get install -y python-setuptools python2.7 build-essential python-dev libncurses5-dev fabric -easy_install pip -pip install virtualenv virtualenvwrapper - -# Postgres DB setup -apt-get install -y postgresql-9.3 postgresql-client-9.3 postgresql-server-dev-9.3 -echo -e "\033[0;34m > Setting up DB. If it already exists this will generate warnings, but no harm will be done.\033[0m" -sudo -u postgres psql -c "CREATE DATABASE $DB_NAME ENCODING='UTF8' TEMPLATE=template0;" -sudo -u postgres psql -c "CREATE USER $DB_USER WITH PASSWORD '$DB_PASS';" -sudo -u postgres psql -c "GRANT ALL PRIVILEGES ON DATABASE $DB_NAME TO $DB_USER;" -if [ $ENV == 'dev' -o $ENV == 'test' ] - then - sudo -u postgres psql -c "ALTER USER $DB_USER CREATEDB;" -fi - -echo -e "\033[0;34m > Installing all the image support libs for pillow.\033[0m" -sudo apt-get install -y libjpeg62-dev zlib1g-dev libfreetype6-dev liblcms1-dev - -# do the rest as the user we'll be logging in as through SSH -chmod +x /vagrant/scripts/server-setup-user.sh -sudo -u $USER /vagrant/scripts/server-setup-user.sh $ENV $USER - -# install requirements -echo -e "\033[0;34m > Installing the pip requirements.\033[0m" -sudo -H -u vagrant /home/vagrant/.virtualenvs/le-code-test/bin/pip install -r /vagrant/requirements.txt diff --git a/scripts/setup-server-user.sh b/scripts/setup-server-user.sh new file mode 100755 index 0000000..3215a14 --- /dev/null +++ b/scripts/setup-server-user.sh @@ -0,0 +1,33 @@ +#!/bin/bash +# VirtualEnv and Django setup + +USER=ubuntu + +# Set up virtualenv directory for the user if required +if [ ! -d /home/$USER/.virtualenvs ]; then + mkdir /home/$USER/.virtualenvs +fi + +# write all the profile stuff for the user if required +grep -q virtualenvs /home/$USER/.bashrc +if [ $? -ne 0 ]; then + echo -e "\033[0;31m > Updating profile file\033[0m" + echo "source ~/.virtualenvs/code-test/bin/activate" >> /home/$USER/.bashrc + echo "cd /vagrant/" >> /home/$USER/.bashrc +fi + +echo -e "\033[0;34m > Setting up virtualenv\033[0m" +export WORKON_HOME=/home/$USER/.virtualenvs +export PIP_VIRTUALENV_BASE=/home/$USER/.virtualenvs +python3 -m venv $PIP_VIRTUALENV_BASE/code-test +source $PIP_VIRTUALENV_BASE/code-test/bin/activate + +# install requirements +echo -e "\033[0;34m > Installing the pip requirements.\033[0m" +$PIP_VIRTUALENV_BASE/code-test/bin/pip install -U pip +$PIP_VIRTUALENV_BASE/code-test/bin/pip install wheel==0.29.0 +$PIP_VIRTUALENV_BASE/code-test/bin/pip install -r /vagrant/requirements.in + +# setup db state +cd /vagrant +./manage.py migrate diff --git a/scripts/setup-server.sh b/scripts/setup-server.sh new file mode 100755 index 0000000..c9cbdc9 --- /dev/null +++ b/scripts/setup-server.sh @@ -0,0 +1,15 @@ +#!/bin/bash +USER=ubuntu + +apt-get update +apt-get install -y git vim build-essential python3.5-dev python3-venv \ + libncurses5-dev fabric postgresql-9.5 postgresql-server-dev-9.5 \ + libjpeg62-dev zlib1g-dev libfreetype6-dev + +sudo -u postgres psql -c "CREATE DATABASE postgres ENCODING='UTF8' TEMPLATE=template0;" +sudo -u postgres psql -c "CREATE USER ubuntu;" +sudo -u postgres psql -c "GRANT ALL PRIVILEGES ON DATABASE postgres TO ubuntu;" +sudo -u postgres psql -c "ALTER USER ubuntu CREATEDB;" + +chmod +x /vagrant/scripts/setup-server-user.sh +sudo -H -u $USER /vagrant/scripts/setup-server-user.sh diff --git a/testsite/items/__init__.py b/shiptrader/__init__.py similarity index 100% rename from testsite/items/__init__.py rename to shiptrader/__init__.py diff --git a/shiptrader/admin.py b/shiptrader/admin.py new file mode 100644 index 0000000..8c38f3f --- /dev/null +++ b/shiptrader/admin.py @@ -0,0 +1,3 @@ +from django.contrib import admin + +# Register your models here. diff --git a/shiptrader/conftest.py b/shiptrader/conftest.py new file mode 100644 index 0000000..5a2e19d --- /dev/null +++ b/shiptrader/conftest.py @@ -0,0 +1,26 @@ +import pytest +from pytest_factoryboy import register +from rest_framework.test import APIClient + +from .tests.factories import StarshipFactory, ListingFactory + + +register(StarshipFactory) +register(ListingFactory) + + +@pytest.fixture +def api_client(db): + """ + API client fixture for testing endpoints. + :param db: Fixture to enable DB access. + :return: Instance of APIClient. + """ + return APIClient() + + +@pytest.fixture +def test_data(starship_factory, listing_factory): + ships = starship_factory.create_batch(size=5) + active_listings = [listing_factory.create(ship_type=ship) for ship in ships] + listing_factory.create(is_active=False) diff --git a/shiptrader/management/commands/load_ships.py b/shiptrader/management/commands/load_ships.py new file mode 100644 index 0000000..bba9c9a --- /dev/null +++ b/shiptrader/management/commands/load_ships.py @@ -0,0 +1,51 @@ +from itertools import chain + +import requests +from requests.exceptions import HTTPError +from django.core.management.base import BaseCommand + +from shiptrader.serializers import StarshipSerializer +from shiptrader.models import Starship +from testsite.settings import STARSHIP_URI + + +class Command(BaseCommand): + help = 'Import data from the remote Starship API and creates models as needed.' + + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + self.session = requests.Session() + + def handle(self, *args, **options): + self.stdout.write('Connecting to Starship API...') + ship_data = list(chain.from_iterable(self.get_data())) + self.stdout.write(f'Retrieved {len(ship_data)} ships.') + + self.stdout.write('Creating Starship instances') + ships = StarshipSerializer(data=ship_data, many=True) + if ships.is_valid(): + ships.save() + self.stdout.write(f'DB record count: {Starship.objects.count()}') + else: + self.stderr.write(f'Problem validating ship data: {ships.errors}') + + def get_data(self): + """ + Generator to retrieve all results from a paginated JSON source. + :yield: List of results from current page. + """ + try: + this_page = self.session.get(STARSHIP_URI) + this_page.raise_for_status() + except HTTPError as http_error: + self.stderr.write(f'Problem accessing ship data: {http_error}') + raise + else: + this_page = this_page.json() + yield this_page['results'] + + while this_page['next']: + next_page = this_page['next'] + self.stdout.write(next_page) + this_page = self.session.get(next_page).json() + yield this_page['results'] diff --git a/shiptrader/migrations/0001_initial.py b/shiptrader/migrations/0001_initial.py new file mode 100644 index 0000000..5a3bfc5 --- /dev/null +++ b/shiptrader/migrations/0001_initial.py @@ -0,0 +1,43 @@ +# -*- coding: utf-8 -*- +# Generated by Django 1.11.9 on 2018-01-16 13:15 +from __future__ import unicode_literals + +from django.db import migrations, models +import django.db.models.deletion + + +class Migration(migrations.Migration): + + initial = True + + dependencies = [ + ] + + operations = [ + migrations.CreateModel( + name='Listing', + fields=[ + ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), + ('name', models.CharField(max_length=255)), + ('price', models.IntegerField()), + ], + ), + migrations.CreateModel( + name='Starship', + fields=[ + ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), + ('starship_class', models.CharField(max_length=255)), + ('manufacturer', models.CharField(max_length=255)), + ('length', models.FloatField()), + ('hyperdrive_rating', models.FloatField()), + ('cargo_capacity', models.BigIntegerField()), + ('crew', models.IntegerField()), + ('passengers', models.IntegerField()), + ], + ), + migrations.AddField( + model_name='listing', + name='ship_type', + field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='listings', to='shiptrader.Starship'), + ), + ] diff --git a/shiptrader/migrations/0002_auto_20190508_1807.py b/shiptrader/migrations/0002_auto_20190508_1807.py new file mode 100644 index 0000000..145c276 --- /dev/null +++ b/shiptrader/migrations/0002_auto_20190508_1807.py @@ -0,0 +1,27 @@ +# -*- coding: utf-8 -*- +# Generated by Django 1.11.20 on 2019-05-08 18:07 +from __future__ import unicode_literals + +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('shiptrader', '0001_initial'), + ] + + operations = [ + migrations.AddField( + model_name='starship', + name='model', + field=models.CharField(default='', max_length=255), + preserve_default=False, + ), + migrations.AddField( + model_name='starship', + name='name', + field=models.CharField(default='', max_length=255), + preserve_default=False, + ), + ] diff --git a/shiptrader/migrations/0003_auto_20190510_0239.py b/shiptrader/migrations/0003_auto_20190510_0239.py new file mode 100644 index 0000000..2d35f4f --- /dev/null +++ b/shiptrader/migrations/0003_auto_20190510_0239.py @@ -0,0 +1,30 @@ +# -*- coding: utf-8 -*- +# Generated by Django 1.11.20 on 2019-05-10 02:39 +from __future__ import unicode_literals + +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('shiptrader', '0002_auto_20190508_1807'), + ] + + operations = [ + migrations.AddField( + model_name='listing', + name='is_active', + field=models.BooleanField(default=True), + ), + migrations.AddField( + model_name='listing', + name='modified', + field=models.DateTimeField(auto_now=True), + ), + migrations.AlterField( + model_name='starship', + name='cargo_capacity', + field=models.BigIntegerField(default=0), + ), + ] diff --git a/testsite/items/migrations/__init__.py b/shiptrader/migrations/__init__.py similarity index 100% rename from testsite/items/migrations/__init__.py rename to shiptrader/migrations/__init__.py diff --git a/shiptrader/models.py b/shiptrader/models.py new file mode 100644 index 0000000..392dc39 --- /dev/null +++ b/shiptrader/models.py @@ -0,0 +1,30 @@ +from django.db import models + + +class Starship(models.Model): + name = models.CharField(max_length=255) + model = models.CharField(max_length=255) + starship_class = models.CharField(max_length=255) + manufacturer = models.CharField(max_length=255) + + length = models.FloatField() + hyperdrive_rating = models.FloatField() + cargo_capacity = models.BigIntegerField(default=0) + + crew = models.IntegerField() + passengers = models.IntegerField() + + def __str__(self): + return f'{self.name} made by {self.manufacturer}' + + +class Listing(models.Model): + modified = models.DateTimeField(auto_now=True) + name = models.CharField(max_length=255) + ship_type = models.ForeignKey(Starship, related_name='listings') + price = models.IntegerField() + is_active = models.BooleanField(default=True) + + def __str__(self): + return f'Listing for {self.ship_type} at price {self.price}' + diff --git a/shiptrader/serializers.py b/shiptrader/serializers.py new file mode 100644 index 0000000..1fd69a8 --- /dev/null +++ b/shiptrader/serializers.py @@ -0,0 +1,62 @@ +from rest_framework import serializers + +from .models import Starship, Listing + + +class StarshipSerializer(serializers.ModelSerializer): + class Meta: + model = Starship + fields = [ + 'name', + 'model', + 'starship_class', + 'manufacturer', + 'length', + 'hyperdrive_rating', + 'cargo_capacity', + 'crew', + 'passengers', + ] + + def to_internal_value(self, data): + """ + Handle esoteric SWAPI values if necessary, for object creation. + :param data: Dict of unvalidated input. + :return: Modified validated_data dict. + """ + for field, value in data.items(): + if str(value).lower() in ('unknown', 'n/a'): + data[field] = '0' + elif isinstance(value, str): + # Problematic thousands separator with numeric fields. + data[field] = value.replace(',', '') + + return super().to_internal_value(data) + + def create(self, validated_data): + """Create instance as normal, but prevent duplication. + """ + if not Starship.objects.filter( + name=validated_data['name'], + manufacturer=validated_data['manufacturer'] + ).exists(): + return super().create(validated_data) + + +class ListingSerializer(serializers.ModelSerializer): + class Meta: + model = Listing + fields = ('id', 'name', 'ship_name', 'ship_type', 'price', 'is_active', ) + read_only_fields = ('ship_type', ) + + ship_name = serializers.CharField(write_only=True) + + def create(self, validated_data): + """ + Create a Listing if data is valid. + ship_name is not a Listing field, but is used for Starship query. + """ + ship_name = validated_data.pop('ship_name') + ship = Starship.objects.get(name=ship_name) + validated_data['ship_type'] = ship + return super().create(validated_data) diff --git a/testsite/stream/__init__.py b/shiptrader/tests/__init__.py similarity index 100% rename from testsite/stream/__init__.py rename to shiptrader/tests/__init__.py diff --git a/shiptrader/tests/factories.py b/shiptrader/tests/factories.py new file mode 100644 index 0000000..2403f6e --- /dev/null +++ b/shiptrader/tests/factories.py @@ -0,0 +1,32 @@ +import factory +from faker import Factory as FakerFactory + + +faker = FakerFactory.create() + + +class StarshipFactory(factory.django.DjangoModelFactory): + """Model factory for Starships. + """ + class Meta: + model = 'shiptrader.Starship' + + name = factory.Sequence(lambda n: f'Ship {n}') + model = factory.Sequence(lambda n: f'Model {n}') + starship_class = 'Test Class' + manufacturer = 'Acme Corp' + length = 5000.0 + hyperdrive_rating = 1.5 + crew = 5 + passengers = 50 + + +class ListingFactory(factory.django.DjangoModelFactory): + """Model factory for Listings. + """ + class Meta: + model = 'shiptrader.Listing' + + name = factory.Sequence(lambda n: f'Listing {n}') + price = 10000 + ship_type = factory.SubFactory(StarshipFactory) diff --git a/shiptrader/tests/test_api.py b/shiptrader/tests/test_api.py new file mode 100644 index 0000000..e3f5a94 --- /dev/null +++ b/shiptrader/tests/test_api.py @@ -0,0 +1,120 @@ +from django.urls import reverse +from rest_framework import status + +from shiptrader.models import Starship, Listing + + +def test_get_starships(api_client, test_data): + response = api_client.get(reverse('starship-list')) + + assert response.status_code == status.HTTP_200_OK + assert len(response.data) == 6 + + +def test_get_listings(api_client, test_data): + """All active Listings should be shown. + """ + response = api_client.get(reverse('listing-list')) + + assert response.status_code == status.HTTP_200_OK + assert len(response.data) == 5 + + +def test_get_listing_detail(api_client, test_data): + listing = Listing.objects.first() + response = api_client.get(reverse('listing-detail', args=[listing.id])) + + assert response.status_code == status.HTTP_200_OK + + +def test_get_listings_by_starship_class( + api_client, test_data, starship_factory, listing_factory): + """Django-Filter backend should filter by related starship_class field. + """ + new_ship = starship_factory(starship_class='Another Class') + listing_factory(ship_type=new_ship) + response = api_client.get( + reverse('listing-list'), {'ship_type__starship_class': 'Another Class'}) + + assert response.status_code == status.HTTP_200_OK + assert len(response.data) == 1 + + +def test_get_listings_ordered_by_price(api_client, test_data, listing_factory): + listing_factory(price=100) + response = api_client.get(reverse('listing-list'), {'ordering': 'price'}) + + assert response.status_code == status.HTTP_200_OK + listings = response.data + assert len(listings) == 6 + assert listings[0]['price'] == 100 + + +def test_get_listings_ordered_by_price_descending(api_client, test_data, listing_factory): + listing_factory(price=100) + response = api_client.get(reverse('listing-list'), {'ordering': '-price'}) + + assert response.status_code == status.HTTP_200_OK + listings = response.data + assert len(listings) == 6 + assert listings[5]['price'] == 100 + + +def test_get_listings_ordered_by_modified(api_client, test_data, listing_factory): + listing = listing_factory(name='New listing') + response = api_client.get(reverse('listing-list'), {'ordering': 'modified'}) + + assert response.status_code == status.HTTP_200_OK + listings = response.data + assert len(listings) == 6 + assert listings[5]['name'] == listing.name + + +def test_get_listings_ordered_by_modified_descending(api_client, test_data, listing_factory): + listing = listing_factory(name='New listing') + response = api_client.get(reverse('listing-list'), {'ordering': '-modified'}) + + assert response.status_code == status.HTTP_200_OK + listings = response.data + assert len(listings) == 6 + assert listings[0]['name'] == listing.name + + +def test_create_listing(api_client, test_data): + ship = Starship.objects.first() + response = api_client.post( + reverse('listing-list'), + { + 'name': 'New listing', + 'ship_name': ship.name, + 'price': 666, + }, + format='json' + ) + + assert response.status_code == status.HTTP_201_CREATED + assert response.data['name'] == 'New listing' + assert response.data['ship_type'] == ship.id + assert response.data['price'] == 666 + + +def test_put_listing_deactivate(api_client, test_data): + listing = Listing.objects.filter(is_active=True).first() + response = api_client.patch( + reverse('listing-detail', args=[listing.id]), {'is_active': False}) + + assert response.status_code == status.HTTP_200_OK + assert not response.data['is_active'] + listing = Listing.objects.get(id=listing.id) + assert not listing.is_active + + +def test_put_listing_activate(api_client, test_data): + listing = Listing.objects.filter(is_active=False).first() + response = api_client.patch( + reverse('listing-detail', args=[listing.id]), {'is_active': True}) + + assert response.status_code == status.HTTP_200_OK + assert response.data['is_active'] + listing = Listing.objects.get(id=listing.id) + assert listing.is_active diff --git a/shiptrader/views.py b/shiptrader/views.py new file mode 100644 index 0000000..ce535e3 --- /dev/null +++ b/shiptrader/views.py @@ -0,0 +1,47 @@ +from rest_framework import viewsets, mixins +from rest_framework.filters import OrderingFilter +from django_filters.rest_framework import DjangoFilterBackend + +from shiptrader.models import Starship, Listing +from shiptrader.serializers import StarshipSerializer, ListingSerializer + + +class StarshipViewSet(viewsets.ReadOnlyModelViewSet): + """Viewset for browsing Starships. + """ + serializer_class = StarshipSerializer + queryset = Starship.objects.all() + + +class ListingViewSet( + mixins.CreateModelMixin, + mixins.ListModelMixin, + mixins.RetrieveModelMixin, + mixins.UpdateModelMixin, + viewsets.GenericViewSet): + """ + Viewset for Listings. + Allows the following: + - Browse all Listings. + - Retrieve a Listing by ID. + - Creation of new Listing. + - Filtering of Listings by starship_class param. + - Ordering on the `price` and `modified` fields. + - Partial update of specific Listing by PUT request with ID. + """ + serializer_class = ListingSerializer + queryset = Listing.objects.all() + filter_backends = (DjangoFilterBackend, OrderingFilter, ) + filterset_fields = ('ship_type__starship_class', ) + ordering_fields = ('price', 'modified', ) + + def get_queryset(self): + """ + Filter queryset by is_active field on list action, but not others. + Allows PATCH request to retrieve a Listing where is_active is False. + :return: Queryset. + """ + queryset = super().get_queryset() + if self.action == 'list': + queryset = queryset.filter(is_active=True) + return queryset diff --git a/test_requirements.txt b/test_requirements.txt new file mode 100644 index 0000000..0a69ade --- /dev/null +++ b/test_requirements.txt @@ -0,0 +1,2 @@ +pytest-django==3.4.8 +pytest-factoryboy==2.0.2 diff --git a/testsite/stream/migrations/__init__.py b/testsite/__init__.py similarity index 100% rename from testsite/stream/migrations/__init__.py rename to testsite/__init__.py diff --git a/testsite/items/admin.py b/testsite/items/admin.py deleted file mode 100644 index debc267..0000000 --- a/testsite/items/admin.py +++ /dev/null @@ -1,6 +0,0 @@ -from django.contrib import admin - -from models import PhotoItem, TweetItem - -admin.site.register(PhotoItem) -admin.site.register(TweetItem) diff --git a/testsite/items/migrations/0001_initial.py b/testsite/items/migrations/0001_initial.py deleted file mode 100644 index 9392339..0000000 --- a/testsite/items/migrations/0001_initial.py +++ /dev/null @@ -1,41 +0,0 @@ -# -*- coding: utf-8 -*- -from __future__ import unicode_literals - -from django.db import models, migrations -from django.conf import settings - - -class Migration(migrations.Migration): - - dependencies = [ - migrations.swappable_dependency(settings.AUTH_USER_MODEL), - ] - - operations = [ - migrations.CreateModel( - name='PhotoItem', - fields=[ - ('id', models.AutoField(verbose_name='ID', serialize=False, auto_created=True, primary_key=True)), - ('created_at', models.DateTimeField()), - ('image', models.ImageField(upload_to=b'')), - ('user', models.ForeignKey(to=settings.AUTH_USER_MODEL)), - ], - options={ - 'abstract': False, - }, - bases=(models.Model,), - ), - migrations.CreateModel( - name='TweetItem', - fields=[ - ('id', models.AutoField(verbose_name='ID', serialize=False, auto_created=True, primary_key=True)), - ('created_at', models.DateTimeField()), - ('text', models.CharField(max_length=150)), - ('user', models.ForeignKey(to=settings.AUTH_USER_MODEL)), - ], - options={ - 'abstract': False, - }, - bases=(models.Model,), - ), - ] diff --git a/testsite/items/models.py b/testsite/items/models.py deleted file mode 100644 index 7d7ebe0..0000000 --- a/testsite/items/models.py +++ /dev/null @@ -1,18 +0,0 @@ -from django.db import models -from django.contrib.auth.models import User - - -class ItemAbstract(models.Model): - user = models.ForeignKey(User) - created_at = models.DateTimeField() - - class Meta: - abstract = True - - -class PhotoItem(ItemAbstract): - image = models.ImageField() - - -class TweetItem(ItemAbstract): - text = models.CharField(max_length=150) diff --git a/testsite/items/tests.py b/testsite/items/tests.py deleted file mode 100644 index 7ce503c..0000000 --- a/testsite/items/tests.py +++ /dev/null @@ -1,3 +0,0 @@ -from django.test import TestCase - -# Create your tests here. diff --git a/testsite/items/views.py b/testsite/items/views.py deleted file mode 100644 index 91ea44a..0000000 --- a/testsite/items/views.py +++ /dev/null @@ -1,3 +0,0 @@ -from django.shortcuts import render - -# Create your views here. diff --git a/testsite/manage.py b/testsite/manage.py deleted file mode 100755 index 4671d39..0000000 --- a/testsite/manage.py +++ /dev/null @@ -1,10 +0,0 @@ -#!/usr/bin/env python -import os -import sys - -if __name__ == "__main__": - os.environ.setdefault("DJANGO_SETTINGS_MODULE", "testsite.settings") - - from django.core.management import execute_from_command_line - - execute_from_command_line(sys.argv) diff --git a/testsite/settings.py b/testsite/settings.py new file mode 100644 index 0000000..b5d6c5e --- /dev/null +++ b/testsite/settings.py @@ -0,0 +1,139 @@ +""" +Django settings for testsite project. + +Generated by 'django-admin startproject' using Django 1.11.8. + +For more information on this file, see +https://docs.djangoproject.com/en/1.11/topics/settings/ + +For the full list of settings and their values, see +https://docs.djangoproject.com/en/1.11/ref/settings/ +""" + +import os + +DOCKER = os.getenv('USER') != 'ubuntu' + +# Build paths inside the project like this: os.path.join(BASE_DIR, ...) +BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) + + +# Quick-start development settings - unsuitable for production +# See https://docs.djangoproject.com/en/1.11/howto/deployment/checklist/ + +# SECURITY WARNING: keep the secret key used in production secret! +SECRET_KEY = 'a-z$8$66fyjy01^328r$5nmj=bzz2a8m%^-kf403!(ohrg5k_b' + +# SECURITY WARNING: don't run with debug turned on in production! +DEBUG = True + +ALLOWED_HOSTS = [] + + +# Application definition + +INSTALLED_APPS = [ + 'django.contrib.admin', + 'django.contrib.auth', + 'django.contrib.contenttypes', + 'django.contrib.sessions', + 'django.contrib.messages', + 'django.contrib.staticfiles', + 'rest_framework_swagger', + 'shiptrader', +] + +MIDDLEWARE = [ + 'django.middleware.security.SecurityMiddleware', + 'django.contrib.sessions.middleware.SessionMiddleware', + 'django.middleware.common.CommonMiddleware', + 'django.middleware.csrf.CsrfViewMiddleware', + 'django.contrib.auth.middleware.AuthenticationMiddleware', + 'django.contrib.messages.middleware.MessageMiddleware', + 'django.middleware.clickjacking.XFrameOptionsMiddleware', +] + +ROOT_URLCONF = 'testsite.urls' + +TEMPLATES = [ + { + 'BACKEND': 'django.template.backends.django.DjangoTemplates', + 'DIRS': [], + 'APP_DIRS': True, + 'OPTIONS': { + 'context_processors': [ + 'django.template.context_processors.debug', + 'django.template.context_processors.request', + 'django.contrib.auth.context_processors.auth', + 'django.contrib.messages.context_processors.messages', + ], + }, + }, +] + +WSGI_APPLICATION = 'testsite.wsgi.application' + + +# Database +# https://docs.djangoproject.com/en/1.11/ref/settings/#databases + +DATABASES = { + 'default': { + 'ENGINE': 'django.db.backends.postgresql_psycopg2', + 'NAME': 'postgres', + } +} + +if DOCKER: + DATABASES['default']['NAME'] = 'postgres' + DATABASES['default']['HOST'] = 'postgresql' + DATABASES['default']['USER'] = 'postgres' + DATABASES['default']['PASSWORD'] = 'postgres' + + +# Password validation +# https://docs.djangoproject.com/en/1.11/ref/settings/#auth-password-validators + +AUTH_PASSWORD_VALIDATORS = [ + { + 'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator', + }, + { + 'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator', + }, + { + 'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator', + }, + { + 'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator', + }, +] + + +# Internationalization +# https://docs.djangoproject.com/en/1.11/topics/i18n/ + +LANGUAGE_CODE = 'en-us' + +TIME_ZONE = 'UTC' + +USE_I18N = True + +USE_L10N = True + +USE_TZ = True + + +# Static files (CSS, JavaScript, Images) +# https://docs.djangoproject.com/en/1.11/howto/static-files/ + +STATIC_URL = '/static/' + +REST_FRAMEWORK = { + 'DEFAULT_FILTER_BACKENDS': ( + 'django_filters.rest_framework.DjangoFilterBackend', + ) +} + +# Remote SWAPI URI +STARSHIP_URI = 'https://swapi.co/api/starships/' diff --git a/testsite/stream/admin.py b/testsite/stream/admin.py deleted file mode 100644 index 54a2562..0000000 --- a/testsite/stream/admin.py +++ /dev/null @@ -1,5 +0,0 @@ -from django.contrib import admin - -from models import Stream - -admin.site.register(Stream) diff --git a/testsite/stream/migrations/0001_initial.py b/testsite/stream/migrations/0001_initial.py deleted file mode 100644 index 30d7667..0000000 --- a/testsite/stream/migrations/0001_initial.py +++ /dev/null @@ -1,26 +0,0 @@ -# -*- coding: utf-8 -*- -from __future__ import unicode_literals - -from django.db import models, migrations -from django.conf import settings - - -class Migration(migrations.Migration): - - dependencies = [ - migrations.swappable_dependency(settings.AUTH_USER_MODEL), - ] - - operations = [ - migrations.CreateModel( - name='Stream', - fields=[ - ('id', models.AutoField(verbose_name='ID', serialize=False, auto_created=True, primary_key=True)), - ('created_at', models.DateTimeField()), - ('user', models.ForeignKey(to=settings.AUTH_USER_MODEL)), - ], - options={ - }, - bases=(models.Model,), - ), - ] diff --git a/testsite/stream/models.py b/testsite/stream/models.py deleted file mode 100644 index e10fd24..0000000 --- a/testsite/stream/models.py +++ /dev/null @@ -1,7 +0,0 @@ -from django.db import models -from django.contrib.auth.models import User - - -class Stream(models.Model): - user = models.ForeignKey(User) - created_at = models.DateTimeField() \ No newline at end of file diff --git a/testsite/stream/tests.py b/testsite/stream/tests.py deleted file mode 100644 index 7ce503c..0000000 --- a/testsite/stream/tests.py +++ /dev/null @@ -1,3 +0,0 @@ -from django.test import TestCase - -# Create your tests here. diff --git a/testsite/stream/views.py b/testsite/stream/views.py deleted file mode 100644 index 91ea44a..0000000 --- a/testsite/stream/views.py +++ /dev/null @@ -1,3 +0,0 @@ -from django.shortcuts import render - -# Create your views here. diff --git a/testsite/testsite/__init__.py b/testsite/testsite/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/testsite/testsite/settings.py b/testsite/testsite/settings.py deleted file mode 100644 index 2821860..0000000 --- a/testsite/testsite/settings.py +++ /dev/null @@ -1,86 +0,0 @@ -""" -Django settings for testsite project. - -For more information on this file, see -https://docs.djangoproject.com/en/1.7/topics/settings/ - -For the full list of settings and their values, see -https://docs.djangoproject.com/en/1.7/ref/settings/ -""" - -# Build paths inside the project like this: os.path.join(BASE_DIR, ...) -import os -BASE_DIR = os.path.dirname(os.path.dirname(__file__)) - - -# Quick-start development settings - unsuitable for production -# See https://docs.djangoproject.com/en/1.7/howto/deployment/checklist/ - -# SECURITY WARNING: keep the secret key used in production secret! -SECRET_KEY = '!4oojc^tmd%+*c_^(n)7^p^6-0f8td(_o&(2bj*e7demr&jtvy' - -# SECURITY WARNING: don't run with debug turned on in production! -DEBUG = True - -TEMPLATE_DEBUG = True - -ALLOWED_HOSTS = [] - -INSTALLED_APPS = ( - 'django.contrib.admin', - 'django.contrib.auth', - 'django.contrib.contenttypes', - 'django.contrib.sessions', - 'django.contrib.messages', - 'django.contrib.staticfiles', - 'stream', - 'items', -) - -MIDDLEWARE_CLASSES = ( - 'django.contrib.sessions.middleware.SessionMiddleware', - 'django.middleware.common.CommonMiddleware', - 'django.middleware.csrf.CsrfViewMiddleware', - 'django.contrib.auth.middleware.AuthenticationMiddleware', - 'django.contrib.auth.middleware.SessionAuthenticationMiddleware', - 'django.contrib.messages.middleware.MessageMiddleware', - 'django.middleware.clickjacking.XFrameOptionsMiddleware', -) - -ROOT_URLCONF = 'testsite.urls' - -WSGI_APPLICATION = 'testsite.wsgi.application' - - -# Database -# https://docs.djangoproject.com/en/1.7/ref/settings/#databases - -DATABASES = { - 'default': { - 'ENGINE': 'django.db.backends.postgresql_psycopg2', - 'NAME': 'lecodetest', - 'USER': 'devuser', - 'PASSWORD': 'devpass', - 'HOST': '127.0.0.1', - 'PORT': '', - } -} - -# Internationalization -# https://docs.djangoproject.com/en/1.7/topics/i18n/ - -LANGUAGE_CODE = 'en-us' - -TIME_ZONE = 'UTC' - -USE_I18N = True - -USE_L10N = True - -USE_TZ = True - - -# Static files (CSS, JavaScript, Images) -# https://docs.djangoproject.com/en/1.7/howto/static-files/ - -STATIC_URL = '/static/' diff --git a/testsite/testsite/urls.py b/testsite/testsite/urls.py deleted file mode 100644 index bcd73c7..0000000 --- a/testsite/testsite/urls.py +++ /dev/null @@ -1,10 +0,0 @@ -from django.conf.urls import patterns, include, url -from django.contrib import admin - -urlpatterns = patterns('', - # Examples: - # url(r'^$', 'testsite.views.home', name='home'), - # url(r'^blog/', include('blog.urls')), - - url(r'^admin/', include(admin.site.urls)), -) diff --git a/testsite/urls.py b/testsite/urls.py new file mode 100644 index 0000000..98ca63d --- /dev/null +++ b/testsite/urls.py @@ -0,0 +1,22 @@ +"""testsite URL Configuration +""" +from django.conf.urls import url, include +from django.contrib import admin + +from rest_framework_swagger.views import get_swagger_view +from rest_framework.routers import DefaultRouter + +from shiptrader.views import StarshipViewSet, ListingViewSet + + +router = DefaultRouter() +router.register(r'starship', StarshipViewSet, basename='starship') +router.register(r'listing', ListingViewSet, basename='listing') + +schema_view = get_swagger_view(title='Starship API') + +urlpatterns = [ + url(r'^admin/', admin.site.urls), + url(r'^swagger-docs/', schema_view), + url(r'^api/v1/', include(router.urls)) +] diff --git a/testsite/testsite/wsgi.py b/testsite/wsgi.py similarity index 83% rename from testsite/testsite/wsgi.py rename to testsite/wsgi.py index 2091485..a65c11b 100644 --- a/testsite/testsite/wsgi.py +++ b/testsite/wsgi.py @@ -4,11 +4,13 @@ It exposes the WSGI callable as a module-level variable named ``application``. For more information on this file, see -https://docs.djangoproject.com/en/1.7/howto/deployment/wsgi/ +https://docs.djangoproject.com/en/1.11/howto/deployment/wsgi/ """ import os -os.environ.setdefault("DJANGO_SETTINGS_MODULE", "testsite.settings") from django.core.wsgi import get_wsgi_application + +os.environ.setdefault("DJANGO_SETTINGS_MODULE", "testsite.settings") + application = get_wsgi_application()