Update challenge

Author: bartek

README.md

@@ -1,17 +1,21 @@
-# API Team Challenge
+# Python Data Challenge
 
-Thank you for your interest in joining G Adventures, and specifically being part
-of the API Team! We're really excited to see what you can do.
+Thank you for your interest in joining G Adventures. This challenge will allow
+us to further evaluate where you may potentially fit from a technical
+perspective. We're really excited to see what you can do.
 
 ## Submission
 
 * Fork this project on Github. You will need to create an account if you don't already have one.
-* Complete the project as described within your fork.
+* Complete the project as described, within your fork.
 * Push all of your changes to your fork on github and submit a pull request.
 * We will be notified of your pull request (or feel free to email us as well), and we'll review!
 
 If you don't wish to publicize your work on this challenge, you may simply send
-the completed project in an archived file to [[email protected]](mailto:[email protected])
+the completed project in an archived file to [[email protected]](mailto:[email protected])
+
+We recommend using *Python 3* for all work you produce, but we're also happy if
+you use *Go*, or *Javascript*
 
 ## Project
 
@@ -20,32 +24,77 @@ get familiar with documentation, please take your time. In the end, we don't
 want you to feel rushed, but we also don't want you spending too much time on
 this.
 
-For this project, we want you to use the [Django REST Framework](http://www.django-rest-framework.org/) library to construct an API that displays a list of Trips.
+For this project, you'll build a script which consumes data from a local API
+(provided). Your script will transform this data in various ways (described
+below), and be output as a CSV.
+
+### Local API
+
+Provided within this project is a local API, which uses [Django REST Framework](http://www.django-rest-framework.org/)
+to provide a simple, standards-compliant API. Below, within the `Getting
+Started` section, you'll find instructions on how to run the API server.
+
+Once running, your only task for the server, is to load data into the API. We've provided a
+`departures.json` file, which you should load into the server using [Django Data
+Migrations](https://docs.djangoproject.com/en/2.0/topics/migrations/#data-migrations).
+You will need to make a new *empty* migration as per the documentation, and
+write the code to read the file and [insert it into the Departure
+Model](https://docs.djangoproject.com/en/2.0/ref/models/instances/#creating-objects).
+
+After this data is loaded, you should be able to view it all at
+`http://localhost:8000/departures`, assuming you're running the local API
+server.
+
+### Data Collection Script
+
+Your primary task within this project is to build a script which consumes data
+from your local API. Within this API, you have a `/departures` URL, which is a
+multi-page listing of trips, operating on various dates.
+
+The script will be expected to query for `/departures`, and iterate over every
+page, collecting all `departures` referenced from the API.
 
-A Trip model has been supplied for you within the project. It has a `name`,
-`start_date`, and `finish_date`. If you wish to extend this model, feel free to
-do so. The model has no data, you'll want to understand how to interact with
-[Django Models](https://docs.djangoproject.com/en/1.9/topics/db/models/) to
-create some data. Feel free to include a script of creating such data in your
-submission.
+To iterate over a page, the script simply needs to follow the `next` links,
+which look like so in the API response:
 
-Your API will provide this Trip data in a RESTful manner, ideally responding in
-JSON (Built-in to Django REST Framework)
+```
+{
+    "count": 100,
+    "next": "http://localhost:8000/departures/?limit=50&offset=50",
+    "previous": null,
+    "results": [`
+        ...
+    ]
 
-Once you have constructed the API to display these trips, you'll create a page
-that displays the list of Trips, as per the response of the API.
+```
 
-Stylistically, how you display these trips is up to you. Data-wise, as long as the data is coming from the API view you've built, we
-are agnostic as to what technology you use to query that view. Generally, it'd be in Javascript using an _AJAX_ call, or you can do something else. Feel like displaying it on an Android application instead? That's fine, as long as you built the API for it :)
+Once the script has collected all `departures`, from all pages, it will need to
+filter down the data to only include the following:
+
+1. Filter down so that your local data only contains `departures` with a `start_date` after `June 1st, 2018`
+
+2. Additionally, filter down to only `departures` of `category = Adventurous`
+
+At this point, your script should have a subset of the data fetched from the
+API. You will now want to write this information into a CSV. For the output,
+ensure the following:
+
+
+1. Every attribute within `departures` is given its own column, and there's a
+   header within the CSV with the attribute names, title-case.
+2. Every remaining `departures` instance is written to a row.
+
+The CSV should be written to the root folder of your project, with whatever file
+name you believe is relevant.
 
 ... And that's it! Feel free to try new technologies, as long you're within the
 scope of the challenge requirements, we're happy.
 
 ## Goal
 
 We'd like to get a sense of how you work, specifically within areas that are
-unexplored territory, and if you are able to fulfill the requirements scoped
-for a project.
+unexplored territory, and if you are able to fulfill all the requirements scoped
+for a task.
 
 We're looking for code that is well structured, documented, and testable.
 
@@ -73,22 +122,17 @@ Once installed, you can run the Django project like so:
 
     python manage.py runserver
 
-You should now be able to visit your project at `http://127.0.0.1:8000/trips`
-
-We've included a basic Django project and a `Trip` model with some fields.
-You'll want to focus on understanding how to integrate Django REST Framework
-into an existing Django project. Their documentation is great!
+You should now be able to visit your project at `http://127.0.0.1:8000/departures`
 
-We have also supplied a blank template, which lives in
-`trips/templates/trips/index.html`. This is the template you see when you visit
-`/trips` within your project.
+We've included a basic Django project and a `Departure` model with some fields,
+which you will consume.
 
 Otherwise, the rest is up to you!
 
 ## Stuck?
 
 If you get stuck -- Please don't hesitate to email
-[bartekc@gadventures.com](mailto:bartekc@gadventures.com). We are looking for
+[recruiting_tech@gadventures.com](mailto:recruiting_tech@gadventures.com). We are looking for
 candidates who are not afraid to ask questions, and explore new ideas. Asking
 questions will not hurt your chances.
 

apichallenge/settings.py

@@ -1,13 +1,13 @@
 """
 Django settings for apichallenge project.
 
-Generated by 'django-admin startproject' using Django 1.9.2.
+Generated by 'django-admin startproject' using Django 2.0.2.
 
 For more information on this file, see
-https://docs.djangoproject.com/en/1.9/topics/settings/
+https://docs.djangoproject.com/en/2.0/topics/settings/
 
 For the full list of settings and their values, see
-https://docs.djangoproject.com/en/1.9/ref/settings/
+https://docs.djangoproject.com/en/2.0/ref/settings/
 """
 
 import os
@@ -17,10 +17,10 @@
 
 
 # Quick-start development settings - unsuitable for production
-# See https://docs.djangoproject.com/en/1.9/howto/deployment/checklist/
+# See https://docs.djangoproject.com/en/2.0/howto/deployment/checklist/
 
 # SECURITY WARNING: keep the secret key used in production secret!
-SECRET_KEY = 'd(_v6s%d0zcb6#u1y9@u4)pvo@3hsc49cupfyd)3%gmziq95k$'
+SECRET_KEY = '!daaozar3!$-e$z+=w3d2afsol(b(g!&z^(*$gn2=hj8sw9q25'
 
 # SECURITY WARNING: don't run with debug turned on in production!
 DEBUG = True
@@ -37,16 +37,21 @@
     'django.contrib.sessions',
     'django.contrib.messages',
     'django.contrib.staticfiles',
-    'trips',
+    'rest_framework',
+    'departures',
 ]
 
-MIDDLEWARE_CLASSES = [
+REST_FRAMEWORK = {
+    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.LimitOffsetPagination',
+    'PAGE_SIZE': 50
+}
+
+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.auth.middleware.SessionAuthenticationMiddleware',
     'django.contrib.messages.middleware.MessageMiddleware',
     'django.middleware.clickjacking.XFrameOptionsMiddleware',
 ]
@@ -73,7 +78,7 @@
 
 
 # Database
-# https://docs.djangoproject.com/en/1.9/ref/settings/#databases
+# https://docs.djangoproject.com/en/2.0/ref/settings/#databases
 
 DATABASES = {
     'default': {
@@ -84,7 +89,7 @@
 
 
 # Password validation
-# https://docs.djangoproject.com/en/1.9/ref/settings/#auth-password-validators
+# https://docs.djangoproject.com/en/2.0/ref/settings/#auth-password-validators
 
 AUTH_PASSWORD_VALIDATORS = [
     {
@@ -103,7 +108,7 @@
 
 
 # Internationalization
-# https://docs.djangoproject.com/en/1.9/topics/i18n/
+# https://docs.djangoproject.com/en/2.0/topics/i18n/
 
 LANGUAGE_CODE = 'en-us'
 
@@ -117,6 +122,6 @@
 
 
 # Static files (CSS, JavaScript, Images)
-# https://docs.djangoproject.com/en/1.9/howto/static-files/
+# https://docs.djangoproject.com/en/2.0/howto/static-files/
 
 STATIC_URL = '/static/'

apichallenge/urls.py

@@ -1,22 +1,22 @@
 """apichallenge URL Configuration
 
 The `urlpatterns` list routes URLs to views. For more information please see:
-    https://docs.djangoproject.com/en/1.9/topics/http/urls/
+    https://docs.djangoproject.com/en/2.0/topics/http/urls/
 Examples:
 Function views
     1. Add an import:  from my_app import views
-    2. Add a URL to urlpatterns:  url(r'^$', views.home, name='home')
+    2. Add a URL to urlpatterns:  path('', views.home, name='home')
 Class-based views
     1. Add an import:  from other_app.views import Home
-    2. Add a URL to urlpatterns:  url(r'^$', Home.as_view(), name='home')
+    2. Add a URL to urlpatterns:  path('', Home.as_view(), name='home')
 Including another URLconf
-    1. Import the include() function: from django.conf.urls import url, include
-    2. Add a URL to urlpatterns:  url(r'^blog/', include('blog.urls'))
+    1. Import the include() function: from django.urls import include, path
+    2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
 """
-from django.conf.urls import url, include
 from django.contrib import admin
+from django.urls import path, include
 
 urlpatterns = [
-    url(r'^admin/', admin.site.urls),
-    url(r'^trips/', include('trips.urls')),
+    path('admin/', admin.site.urls),
+    path('departures/', include('departures.urls')),
 ]

apichallenge/wsgi.py

@@ -4,7 +4,7 @@
 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.9/howto/deployment/wsgi/
+https://docs.djangoproject.com/en/2.0/howto/deployment/wsgi/
 """
 
 import os

db.sqlite3

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class DeparturesConfig(AppConfig):
+    name = 'departures'

departures.json

@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
-# Generated by Django 1.9.2 on 2016-02-03 03:57
-from __future__ import unicode_literals
+# Generated by Django 2.0.2 on 2018-02-12 02:23
 
 from django.db import migrations, models
 
@@ -14,12 +12,13 @@ class Migration(migrations.Migration):
 
     operations = [
         migrations.CreateModel(
-            name='Trip',
+            name='Departure',
             fields=[
                 ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
                 ('name', models.CharField(max_length=55)),
                 ('start_date', models.DateField()),
                 ('finish_date', models.DateField()),
+                ('category', models.CharField(choices=[('Adventurous', 'Adventurous'), ('Classic', 'Classic'), ('Marine', 'Marine')], max_length=25)),
             ],
         ),
     ]

trips/__init__.py departures/__init__.py

@@ -0,0 +1,17 @@
+from __future__ import unicode_literals
+
+from django.db import models
+
+
+class Departure(models.Model):
+    name = models.CharField(max_length=55)
+    start_date = models.DateField()
+    finish_date = models.DateField()
+    category = models.CharField(
+        max_length=25,
+        choices=(
+            ('Adventurous', 'Adventurous'),
+            ('Classic', 'Classic'),
+            ('Marine', 'Marine'),
+        )
+    )

trips/admin.py departures/admin.py

@@ -0,0 +1,7 @@
+from django.conf.urls import url
+
+from .views import DepartureView
+
+urlpatterns = [
+    url('^', DepartureView.as_view())
+]

departures/apps.py

@@ -0,0 +1,13 @@
+from rest_framework import generics
+from rest_framework import serializers
+
+from .models import Departure
+
+class DepartureSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = Departure
+        fields = ('name', 'start_date', 'finish_date', 'category')
+
+class DepartureView(generics.ListAPIView):
+    queryset = Departure.objects.all()
+    serializer_class = DepartureSerializer

trips/migrations/0001_initial.py departures/migrations/0001_initial.py

@@ -4,7 +4,12 @@
 
 if __name__ == "__main__":
     os.environ.setdefault("DJANGO_SETTINGS_MODULE", "apichallenge.settings")
-
-    from django.core.management import execute_from_command_line
-
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        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?"
+        ) from exc
     execute_from_command_line(sys.argv)

trips/migrations/__init__.py departures/migrations/__init__.py

@@ -1,2 +1,2 @@
-Django==1.9.2
-djangorestframework==3.3.2
+Django==2.0.2
+djangorestframework==3.7.7