From 3ada40f20bdc2a8892e8aed5675afd72f90aca5e Mon Sep 17 00:00:00 2001 From: Bradlee Speice Date: Tue, 25 Mar 2014 23:06:55 -0400 Subject: [PATCH 1/5] Add initial commit for Scavenger Hunt Server --- UNCCScavenger-Server/.gitignore | 4 ++++ UNCCScavenger-Server/README.txt | 1 + 2 files changed, 5 insertions(+) create mode 100644 UNCCScavenger-Server/.gitignore create mode 100644 UNCCScavenger-Server/README.txt diff --git a/UNCCScavenger-Server/.gitignore b/UNCCScavenger-Server/.gitignore new file mode 100644 index 0000000..f1b53d7 --- /dev/null +++ b/UNCCScavenger-Server/.gitignore @@ -0,0 +1,4 @@ +bin/ +include/ +lib/ +local/ diff --git a/UNCCScavenger-Server/README.txt b/UNCCScavenger-Server/README.txt new file mode 100644 index 0000000..fda5f86 --- /dev/null +++ b/UNCCScavenger-Server/README.txt @@ -0,0 +1 @@ +Server API implementation for UNCC Scavenger Hunt From e8c22e86f234e1bba8bca05ac5795b9da61a0753 Mon Sep 17 00:00:00 2001 From: Bradlee Speice Date: Tue, 25 Mar 2014 23:15:39 -0400 Subject: [PATCH 2/5] Add initial Django project for UNCCScavenger_Server --- .../UNCCScavenger_Server/__init__.py | 0 .../UNCCScavenger_Server/settings.py | 155 ++++++++++++++++++ .../UNCCScavenger_Server/urls.py | 17 ++ .../UNCCScavenger_Server/wsgi.py | 28 ++++ .../UNCCScavenger_Server/manage.py | 10 ++ 5 files changed, 210 insertions(+) create mode 100644 UNCCScavenger-Server/UNCCScavenger_Server/UNCCScavenger_Server/__init__.py create mode 100644 UNCCScavenger-Server/UNCCScavenger_Server/UNCCScavenger_Server/settings.py create mode 100644 UNCCScavenger-Server/UNCCScavenger_Server/UNCCScavenger_Server/urls.py create mode 100644 UNCCScavenger-Server/UNCCScavenger_Server/UNCCScavenger_Server/wsgi.py create mode 100644 UNCCScavenger-Server/UNCCScavenger_Server/manage.py diff --git a/UNCCScavenger-Server/UNCCScavenger_Server/UNCCScavenger_Server/__init__.py b/UNCCScavenger-Server/UNCCScavenger_Server/UNCCScavenger_Server/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/UNCCScavenger-Server/UNCCScavenger_Server/UNCCScavenger_Server/settings.py b/UNCCScavenger-Server/UNCCScavenger_Server/UNCCScavenger_Server/settings.py new file mode 100644 index 0000000..cd49d61 --- /dev/null +++ b/UNCCScavenger-Server/UNCCScavenger_Server/UNCCScavenger_Server/settings.py @@ -0,0 +1,155 @@ +# Django settings for UNCCScavenger_Server project. + +DEBUG = True +TEMPLATE_DEBUG = DEBUG + +ADMINS = ( + # ('Your Name', 'your_email@example.com'), +) + +MANAGERS = ADMINS + +DATABASES = { + 'default': { + 'ENGINE': 'django.db.backends.', # Add 'postgresql_psycopg2', 'mysql', 'sqlite3' or 'oracle'. + 'NAME': '', # Or path to database file if using sqlite3. + 'USER': '', # Not used with sqlite3. + 'PASSWORD': '', # Not used with sqlite3. + 'HOST': '', # Set to empty string for localhost. Not used with sqlite3. + 'PORT': '', # Set to empty string for default. Not used with sqlite3. + } +} + +# Hosts/domain names that are valid for this site; required if DEBUG is False +# See https://docs.djangoproject.com/en/1.4/ref/settings/#allowed-hosts +ALLOWED_HOSTS = [] + +# Local time zone for this installation. Choices can be found here: +# http://en.wikipedia.org/wiki/List_of_tz_zones_by_name +# although not all choices may be available on all operating systems. +# In a Windows environment this must be set to your system time zone. +TIME_ZONE = 'America/Chicago' + +# Language code for this installation. All choices can be found here: +# http://www.i18nguy.com/unicode/language-identifiers.html +LANGUAGE_CODE = 'en-us' + +SITE_ID = 1 + +# If you set this to False, Django will make some optimizations so as not +# to load the internationalization machinery. +USE_I18N = True + +# If you set this to False, Django will not format dates, numbers and +# calendars according to the current locale. +USE_L10N = True + +# If you set this to False, Django will not use timezone-aware datetimes. +USE_TZ = True + +# Absolute filesystem path to the directory that will hold user-uploaded files. +# Example: "/home/media/media.lawrence.com/media/" +MEDIA_ROOT = '' + +# URL that handles the media served from MEDIA_ROOT. Make sure to use a +# trailing slash. +# Examples: "http://media.lawrence.com/media/", "http://example.com/media/" +MEDIA_URL = '' + +# Absolute path to the directory static files should be collected to. +# Don't put anything in this directory yourself; store your static files +# in apps' "static/" subdirectories and in STATICFILES_DIRS. +# Example: "/home/media/media.lawrence.com/static/" +STATIC_ROOT = '' + +# URL prefix for static files. +# Example: "http://media.lawrence.com/static/" +STATIC_URL = '/static/' + +# Additional locations of static files +STATICFILES_DIRS = ( + # Put strings here, like "/home/html/static" or "C:/www/django/static". + # Always use forward slashes, even on Windows. + # Don't forget to use absolute paths, not relative paths. +) + +# List of finder classes that know how to find static files in +# various locations. +STATICFILES_FINDERS = ( + 'django.contrib.staticfiles.finders.FileSystemFinder', + 'django.contrib.staticfiles.finders.AppDirectoriesFinder', +# 'django.contrib.staticfiles.finders.DefaultStorageFinder', +) + +# Make this unique, and don't share it with anybody. +SECRET_KEY = 'yafkof5)-n4umlwhtln@vj4-a-%0uo=k_eqf$jx-k+hx03&zn*' + +# List of callables that know how to import templates from various sources. +TEMPLATE_LOADERS = ( + 'django.template.loaders.filesystem.Loader', + 'django.template.loaders.app_directories.Loader', +# 'django.template.loaders.eggs.Loader', +) + +MIDDLEWARE_CLASSES = ( + 'django.middleware.common.CommonMiddleware', + 'django.contrib.sessions.middleware.SessionMiddleware', + 'django.middleware.csrf.CsrfViewMiddleware', + 'django.contrib.auth.middleware.AuthenticationMiddleware', + 'django.contrib.messages.middleware.MessageMiddleware', + # Uncomment the next line for simple clickjacking protection: + # 'django.middleware.clickjacking.XFrameOptionsMiddleware', +) + +ROOT_URLCONF = 'UNCCScavenger_Server.urls' + +# Python dotted path to the WSGI application used by Django's runserver. +WSGI_APPLICATION = 'UNCCScavenger_Server.wsgi.application' + +TEMPLATE_DIRS = ( + # Put strings here, like "/home/html/django_templates" or "C:/www/django/templates". + # Always use forward slashes, even on Windows. + # Don't forget to use absolute paths, not relative paths. +) + +INSTALLED_APPS = ( + 'django.contrib.auth', + 'django.contrib.contenttypes', + 'django.contrib.sessions', + 'django.contrib.sites', + 'django.contrib.messages', + 'django.contrib.staticfiles', + # Uncomment the next line to enable the admin: + # 'django.contrib.admin', + # Uncomment the next line to enable admin documentation: + # 'django.contrib.admindocs', +) + +# A sample logging configuration. The only tangible logging +# performed by this configuration is to send an email to +# the site admins on every HTTP 500 error when DEBUG=False. +# See http://docs.djangoproject.com/en/dev/topics/logging for +# more details on how to customize your logging configuration. +LOGGING = { + 'version': 1, + 'disable_existing_loggers': False, + 'filters': { + 'require_debug_false': { + '()': 'django.utils.log.RequireDebugFalse' + } + }, + 'handlers': { + 'mail_admins': { + 'level': 'ERROR', + 'filters': ['require_debug_false'], + 'class': 'django.utils.log.AdminEmailHandler' + } + }, + 'loggers': { + 'django.request': { + 'handlers': ['mail_admins'], + 'level': 'ERROR', + 'propagate': True, + }, + } +} diff --git a/UNCCScavenger-Server/UNCCScavenger_Server/UNCCScavenger_Server/urls.py b/UNCCScavenger-Server/UNCCScavenger_Server/UNCCScavenger_Server/urls.py new file mode 100644 index 0000000..33054ae --- /dev/null +++ b/UNCCScavenger-Server/UNCCScavenger_Server/UNCCScavenger_Server/urls.py @@ -0,0 +1,17 @@ +from django.conf.urls import patterns, include, url + +# Uncomment the next two lines to enable the admin: +# from django.contrib import admin +# admin.autodiscover() + +urlpatterns = patterns('', + # Examples: + # url(r'^$', 'UNCCScavenger_Server.views.home', name='home'), + # url(r'^UNCCScavenger_Server/', include('UNCCScavenger_Server.foo.urls')), + + # Uncomment the admin/doc line below to enable admin documentation: + # url(r'^admin/doc/', include('django.contrib.admindocs.urls')), + + # Uncomment the next line to enable the admin: + # url(r'^admin/', include(admin.site.urls)), +) diff --git a/UNCCScavenger-Server/UNCCScavenger_Server/UNCCScavenger_Server/wsgi.py b/UNCCScavenger-Server/UNCCScavenger_Server/UNCCScavenger_Server/wsgi.py new file mode 100644 index 0000000..02851d9 --- /dev/null +++ b/UNCCScavenger-Server/UNCCScavenger_Server/UNCCScavenger_Server/wsgi.py @@ -0,0 +1,28 @@ +""" +WSGI config for UNCCScavenger_Server project. + +This module contains the WSGI application used by Django's development server +and any production WSGI deployments. It should expose a module-level variable +named ``application``. Django's ``runserver`` and ``runfcgi`` commands discover +this application via the ``WSGI_APPLICATION`` setting. + +Usually you will have the standard Django WSGI application here, but it also +might make sense to replace the whole Django WSGI application with a custom one +that later delegates to the Django one. For example, you could introduce WSGI +middleware here, or combine a Django application with an application of another +framework. + +""" +import os + +os.environ.setdefault("DJANGO_SETTINGS_MODULE", "UNCCScavenger_Server.settings") + +# This application object is used by any WSGI server configured to use this +# file. This includes Django's development server, if the WSGI_APPLICATION +# setting points here. +from django.core.wsgi import get_wsgi_application +application = get_wsgi_application() + +# Apply WSGI middleware here. +# from helloworld.wsgi import HelloWorldApplication +# application = HelloWorldApplication(application) diff --git a/UNCCScavenger-Server/UNCCScavenger_Server/manage.py b/UNCCScavenger-Server/UNCCScavenger_Server/manage.py new file mode 100644 index 0000000..07b3023 --- /dev/null +++ b/UNCCScavenger-Server/UNCCScavenger_Server/manage.py @@ -0,0 +1,10 @@ +#!/usr/bin/env python +import os +import sys + +if __name__ == "__main__": + os.environ.setdefault("DJANGO_SETTINGS_MODULE", "UNCCScavenger_Server.settings") + + from django.core.management import execute_from_command_line + + execute_from_command_line(sys.argv) From e26bf2419e83f3e542da92ccca2c83a962661c1b Mon Sep 17 00:00:00 2001 From: Bradlee Speice Date: Wed, 26 Mar 2014 23:26:57 -0400 Subject: [PATCH 3/5] Add initial scavenger app, and basic models file --- .../UNCCScavenger_Server/scavenger/__init__.py | 0 .../UNCCScavenger_Server/scavenger/models.py | 9 +++++++++ .../UNCCScavenger_Server/scavenger/tests.py | 16 ++++++++++++++++ .../UNCCScavenger_Server/scavenger/views.py | 1 + 4 files changed, 26 insertions(+) create mode 100644 UNCCScavenger-Server/UNCCScavenger_Server/scavenger/__init__.py create mode 100644 UNCCScavenger-Server/UNCCScavenger_Server/scavenger/models.py create mode 100644 UNCCScavenger-Server/UNCCScavenger_Server/scavenger/tests.py create mode 100644 UNCCScavenger-Server/UNCCScavenger_Server/scavenger/views.py diff --git a/UNCCScavenger-Server/UNCCScavenger_Server/scavenger/__init__.py b/UNCCScavenger-Server/UNCCScavenger_Server/scavenger/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/UNCCScavenger-Server/UNCCScavenger_Server/scavenger/models.py b/UNCCScavenger-Server/UNCCScavenger_Server/scavenger/models.py new file mode 100644 index 0000000..caa9dd9 --- /dev/null +++ b/UNCCScavenger-Server/UNCCScavenger_Server/scavenger/models.py @@ -0,0 +1,9 @@ +from django.db import models + +class Location(models.Model): + + key = models.CharField(max_length=32) + name = models.CharField(max_length=32) + riddle = models.CharField(max_length=512) + location = models.CharField(max_length=16) + result = models.TextField() diff --git a/UNCCScavenger-Server/UNCCScavenger_Server/scavenger/tests.py b/UNCCScavenger-Server/UNCCScavenger_Server/scavenger/tests.py new file mode 100644 index 0000000..501deb7 --- /dev/null +++ b/UNCCScavenger-Server/UNCCScavenger_Server/scavenger/tests.py @@ -0,0 +1,16 @@ +""" +This file demonstrates writing tests using the unittest module. These will pass +when you run "manage.py test". + +Replace this with more appropriate tests for your application. +""" + +from django.test import TestCase + + +class SimpleTest(TestCase): + def test_basic_addition(self): + """ + Tests that 1 + 1 always equals 2. + """ + self.assertEqual(1 + 1, 2) diff --git a/UNCCScavenger-Server/UNCCScavenger_Server/scavenger/views.py b/UNCCScavenger-Server/UNCCScavenger_Server/scavenger/views.py new file mode 100644 index 0000000..60f00ef --- /dev/null +++ b/UNCCScavenger-Server/UNCCScavenger_Server/scavenger/views.py @@ -0,0 +1 @@ +# Create your views here. From 09512c03d47416f5b0aa5aaa704f3a132f7cfb0a Mon Sep 17 00:00:00 2001 From: Bradlee Speice Date: Fri, 28 Mar 2014 18:31:06 -0400 Subject: [PATCH 4/5] Add initial (completely untested) server API --- .../UNCCScavenger_Server/scavenger/forms.py | 26 +++++++++++++++++++ .../scavenger/serializers.py | 13 ++++++++++ .../UNCCScavenger_Server/scavenger/views.py | 26 +++++++++++++++++++ 3 files changed, 65 insertions(+) create mode 100644 UNCCScavenger-Server/UNCCScavenger_Server/scavenger/forms.py create mode 100644 UNCCScavenger-Server/UNCCScavenger_Server/scavenger/serializers.py diff --git a/UNCCScavenger-Server/UNCCScavenger_Server/scavenger/forms.py b/UNCCScavenger-Server/UNCCScavenger_Server/scavenger/forms.py new file mode 100644 index 0000000..5099352 --- /dev/null +++ b/UNCCScavenger-Server/UNCCScavenger_Server/scavenger/forms.py @@ -0,0 +1,26 @@ +from scavenger.models import Location + +from django import forms +from django.core.exceptions import ObjectDoesNotExist + +class LocationValidator(forms.ModelForm): + ''' + Validate that the user actually found a location + ''' + + def is_valid(self): + valid = super(LocationValidator, self).is_valid() + if not valid: + return valid + + # Make sure the key and ID submitted match + try: + self._instance = Location.objects.get(id=self.cleaned_data['id'], + key=self.cleaned_data['key']) + return True + except ObjectDoesNotExist, e: + return False + + class Meta: + model = Location + fields = ('id', 'key') diff --git a/UNCCScavenger-Server/UNCCScavenger_Server/scavenger/serializers.py b/UNCCScavenger-Server/UNCCScavenger_Server/scavenger/serializers.py new file mode 100644 index 0000000..6f509af --- /dev/null +++ b/UNCCScavenger-Server/UNCCScavenger_Server/scavenger/serializers.py @@ -0,0 +1,13 @@ +from rest_framework.serializers import ModelSerializer + +from models import Location + +class LocationListSerializer(ModelSerializer): + class Meta: + model = Location + fields = ('id', 'name', 'riddle', 'location') + +class LocationResultSerializer(ModelSerializer): + class Meta: + model = Location + fields = ('id', 'name', 'result') diff --git a/UNCCScavenger-Server/UNCCScavenger_Server/scavenger/views.py b/UNCCScavenger-Server/UNCCScavenger_Server/scavenger/views.py index 60f00ef..d035430 100644 --- a/UNCCScavenger-Server/UNCCScavenger_Server/scavenger/views.py +++ b/UNCCScavenger-Server/UNCCScavenger_Server/scavenger/views.py @@ -1 +1,27 @@ # Create your views here. +from scavenger.models import Location +from scavenger.serializers import LocationListSerializer +from scavenger.forms import LocationValidator +from rest_framework.views import APIView +from rest_framework.response import Response + +class LocationList(APIView): + ''' + List all locations available for the scavenger hunt. + ''' + def get(self, request, format=None): + locations = Location.objects.all() + locations_serializer = LocationListSerializer(locations, many=True) + return Response(serializer.data) + +class LocationResult(APIView): + ''' + Show the result for a specific location + ''' + def get(self, request, format=None): + l_form = LocationValidator(data=request.data) + if l_form.is_valid(): + location = l_form._instance + return Response(location.result) + else: + return Response("You found the wrong code!", status=400) From b1a5298b91a6ce12dc98c680b44c464e8756c622 Mon Sep 17 00:00:00 2001 From: Bradlee Speice Date: Fri, 28 Mar 2014 18:32:07 -0400 Subject: [PATCH 5/5] Ignore *.pyc --- .gitignore | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index e3ed630..2da351d 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ *.class -.metadata/* \ No newline at end of file +.metadata/* +*.pyc