Merge lp:~victor-oc/ubuntu-api-website/trunk into lp:ubuntu-api-website

[Victor Choueiri]

Created the models for distro/language/support apps.

Created views for distro and ditrorelease.

Added distro_data.json with some initial distro models that can be loaded [included instructions in DEVELOPMENT]

[lp:~victor-oc/ubuntu-api-website/trunk]

85. By Michael Hall on 2012-09-22

Add juju charm, use juju deploy --repository=./charms/ local:precise/ubuntu-api-website

[John Vrbanac (john.vrbanac)]

Victor,
I checked out a fresh version of your branch and followed the modified instructions. When I attempted to use the site it gives me the following trace:

http://paste.ubuntu.com/1264963/

review: Needs Fixing

[lp:~victor-oc/ubuntu-api-website/trunk]

86. By John Vrbanac on 2012-10-07

Adding docbook to html xsl transform on the class view

87. By John Vrbanac on 2012-10-07

Forgot to remove pdb import on last commit

[Victor Choueiri (victor-oc)]

Thanks John,

I've just added a simple implementation for the view/template that will sort this [was just returning None earlier] - The call shouldn't be failing anymore, although the page will be empty since none of the PlatformItem objects have actually been created.

[John Vrbanac (john.vrbanac)]

Victor,
I finally got around to checking out your changes last night. Thanks for fixing that stacktrace! Quick question, with this change, how does a person access the actual api references now? I didn't see the links under a given distro version.

Thanks for your contribution!

[Victor Choueiri (victor-oc)]

John,

Thanks for spending time on this.

Unfortunately there was no way to access the full listing: following the wireframes over at https://wiki.ubuntu.com/DeveloperNetwork there is no page which contains all api namespace listings. To resolve this now I've added an include in urls.py to point to the api views via /all [http://localhost:8000/all] - Once the rest of the site is completed this shouldn't be required any more.

As for providing links under the distros, that would be what is documented as the Release Page [https://wiki.ubuntu.com/DeveloperNetwork#Release_Page] . The problem here is I don't know the PlatformSection info needed to group PlatformItems. If this information is available somewhere I wouldn't mind doing the data-entry required to generate loadable db data. In fact if the data required is available I could continue developing the views/templates for the rest of the pages, unfortunately without knowing the details I find myself blocked.

Just to clarify: this merge request tries to cover the following Work_Items laid out at https://wiki.ubuntu.com/DeveloperNetwork#Work_Items :
Distro model
DistroRelease model
PlatformSection model
PlatformItem model
ProgrammingLang model
LanguageNamespace model
RelatedQuestion model
RelatedTutorial model
RelatedSnipped model
RelatedImage model
Index view
Distro view

[John Vrbanac (john.vrbanac)]

Victor,
Awesome! Yeah, my major concern was preventing access to those api views until everything is hooked up. I'm assuming that we'll eventually need a way of binding specific GIRs to a given Ubuntu release, but until then then the /all link should work fine.

Regarding the PlatformSection info:
Considering that the GIR files don't give us the information we need to create the PlatformSection information on-the-fly, I'm guessing that we'll just have to manually map the namespaces to a given PlatformSection and then anything that isn't mapped gets put into a generic "Other" section.

Thanks again for your hard work! I'll go ahead and merge this over my lunch break today.

review: Approve

[lp:~victor-oc/ubuntu-api-website/trunk]

88. By John Vrbanac on 2012-10-19

Accepting Victor's merge request.

[Michael Hall (mhall119)]

I've added an initial list of PlatformSections for Ubuntu that can be used to pre-populate the database: https://wiki.ubuntu.com/DeveloperNetwork#Release_Page (below the mockup image)

=== modified file 'DEVELOPMENT'
--- DEVELOPMENT	2012-10-07 04:53:33 +0000
+++ DEVELOPMENT	2012-10-19 13:46:19 +0000
@@ -32,11 +32,15 @@
 
 	python manage.py import-girs 
 
-6. Run the Django test server
+6. Load the initial distro data
+
+	python manage.py loaddata distro_data.json 
+
+7. Run the Django test server
 
 	python manage.py runserver
 
-7. View the site
+8. View the site
 
 	Open your browser to http://localhost:8000/api/
 

=== modified file 'distro/models.py'
--- distro/models.py	2012-09-20 02:08:20 +0000
+++ distro/models.py	2012-10-19 13:46:19 +0000
@@ -1,3 +1,25 @@
 from django.db import models
 
-# Create your models here.
+CF_MAX_LENGTH = 500
+
+class Distro(models.Model):
+	name = models.CharField(max_length=CF_MAX_LENGTH)
+	website = models.URLField(max_length=CF_MAX_LENGTH)
+	description = models.TextField(blank=True)
+
+class DistroRelease(models.Model):
+	distro = models.ForeignKey(Distro)
+	version = models.CharField(max_length=CF_MAX_LENGTH)
+	codename = models.CharField(max_length=CF_MAX_LENGTH)
+	release_date = models.DateField()
+	expiration_date = models.DateField()
+
+class PlatformSection(models.Model):
+	section_name = models.CharField(max_length=CF_MAX_LENGTH)
+	section_description = models.TextField(blank=True)
+
+class PlatformItem(models.Model):
+	distro_release = models.ForeignKey(DistroRelease)
+	library_release = models.ForeignKey('api.Namespace')
+	section = models.ForeignKey(PlatformSection)
+	packages = models.TextField(blank=True)

=== added file 'distro/urls.py'
--- distro/urls.py	1970-01-01 00:00:00 +0000
+++ distro/urls.py	2012-10-19 13:46:19 +0000
@@ -0,0 +1,8 @@
+# vim: tabstop=4 noexpandtab shiftwidth=4 softtabstop=4
+from django.conf.urls.defaults import patterns, include, url
+
+urlpatterns = patterns('',
+	url("^$", "distro.views.index"),
+	url("^(?P<distro_name>[\w]+)/$", "distro.views.distroview"),
+	url("^(?P<distro_name>[\w]+)/(?P<release_version>[\w\\.]+)$", "distro.views.releaseview")
+	)

=== modified file 'distro/views.py'
--- distro/views.py	2012-09-20 02:08:20 +0000
+++ distro/views.py	2012-10-19 13:46:19 +0000
@@ -1,1 +1,29 @@
-# Create your views here.
+import datetime
+import distro.models as models
+from django.shortcuts import render_to_response, get_object_or_404
+from django.template import Context
+
+def index(request):
+	distros = models.Distro.objects.all()
+	ctx = Context({'distros': distros})
+	return render_to_response ('index.html', ctx)
+
+def distroview(request, distro_name):
+	distro = get_object_or_404(models.Distro, name=distro_name)
+	releases = models.DistroRelease.objects.filter(distro=distro, expiration_date__gt=datetime.date.today()).order_by('-release_date')
+	ctx = Context({
+		'distro': distro, 
+		'releases': releases 
+	})
+	return render_to_response ('distro.html', ctx)
+
+def releaseview(request, distro_name, release_version):
+	distro_release = get_object_or_404(models.DistroRelease, distro__name=distro_name, version=release_version)
+	platform_items = models.PlatformItem.objects.filter(distro_release=distro_release)
+
+	ctx = Context({
+		'distro': distro_release.distro,
+		'release': distro_release,
+		'platform_items': platform_items	
+	})
+	return render_to_response ('release.html', ctx)

=== added file 'distro_data.json'
--- distro_data.json	1970-01-01 00:00:00 +0000
+++ distro_data.json	2012-10-19 13:46:19 +0000
@@ -0,0 +1,161 @@
+[
+    {
+        "pk": 1,
+        "model": "distro.distro",
+        "fields": {
+            "website": "http://www.ubuntu.com",
+            "name": "Ubuntu",
+            "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque nec nisl id metus tempor imperdiet. Integer hendrerit purus eget risus feugiat auctor. Aenean eget mi tincidunt velit ornare gravida et sed urna. Nulla facilisi. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Aliquam aliquam nibh eget massa tincidunt porttitor. Aenean et ornare turpis."
+        }
+    },
+    {
+        "pk": 2,
+        "model": "distro.distro",
+        "fields": {
+            "website": "http://www.edubuntu.org",
+            "name": "Edubuntu",
+            "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque nec nisl id metus tempor imperdiet. Integer hendrerit purus eget risus feugiat auctor. Aenean eget mi tincidunt velit ornare gravida et sed urna. Nulla facilisi. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Aliquam aliquam nibh eget massa tincidunt porttitor. Aenean et ornare turpis."
+        }
+    },
+    {
+        "pk": 3,
+        "model": "distro.distro",
+        "fields": {
+            "website": "http://www.kubuntu.org",
+            "name": "Kubuntu",
+            "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque nec nisl id metus tempor imperdiet. Integer hendrerit purus eget risus feugiat auctor. Aenean eget mi tincidunt velit ornare gravida et sed urna. Nulla facilisi. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Aliquam aliquam nibh eget massa tincidunt porttitor. Aenean et ornare turpis."
+        }
+    },
+    {
+        "pk": 1,
+        "model": "distro.distrorelease",
+        "fields": {
+            "expiration_date": "2017-04-26",
+            "codename": "Precise Pengolin",
+            "version": "12.04",
+            "release_date": "2012-04-26",
+            "distro": 1
+        }
+    },
+    {
+        "pk": 2,
+        "model": "distro.distrorelease",
+        "fields": {
+            "expiration_date": "2013-04-01",
+            "codename": "Oneiric Ocelot",
+            "version": "11.10",
+            "release_date": "2011-10-13",
+            "distro": 1
+        }
+    },
+    {
+        "pk": 3,
+        "model": "distro.distrorelease",
+        "fields": {
+            "expiration_date": "2012-10-01",
+            "codename": "Natty Narwhal",
+            "version": "11.04",
+            "release_date": "2011-04-28",
+            "distro": 1
+        }
+    },
+    {
+        "pk": 4,
+        "model": "distro.distrorelease",
+        "fields": {
+            "expiration_date": "2012-04-10",
+            "codename": "Maverick Meerkat",
+            "version": "10.10",
+            "release_date": "2010-10-10",
+            "distro": 1
+        }
+    },
+    {
+        "pk": 5,
+        "model": "distro.distrorelease",
+        "fields": {
+            "expiration_date": "2013-04-01",
+            "codename": "Lucid Lynx",
+            "version": "10.04",
+            "release_date": "2010-04-29",
+            "distro": 1
+        }
+    },
+    {
+        "pk": 6,
+        "model": "distro.distrorelease",
+        "fields": {
+            "expiration_date": "2011-04-30",
+            "codename": "Karmic Koala",
+            "version": "9.10",
+            "release_date": "2009-10-29",
+            "distro": 1
+        }
+    },
+    {
+        "pk": 7,
+        "model": "distro.distrorelease",
+        "fields": {
+            "expiration_date": "2011-04-28",
+            "codename": "Karmic Koala",
+            "version": "9.10",
+            "release_date": "2009-10-29",
+            "distro": 3
+        }
+    },
+    {
+        "pk": 8,
+        "model": "distro.distrorelease",
+        "fields": {
+            "expiration_date": "2013-04-01",
+            "codename": "Lucid Lynx",
+            "version": "10.04",
+            "release_date": "2010-04-29",
+            "distro": 3
+        }
+    },
+    {
+        "pk": 9,
+        "model": "distro.distrorelease",
+        "fields": {
+            "expiration_date": "2012-04-01",
+            "codename": "Maverick Meerkat",
+            "version": "10.10",
+            "release_date": "2010-10-10",
+            "distro": 3
+        }
+    },
+    {
+        "pk": 10,
+        "model": "distro.distrorelease",
+        "fields": {
+            "expiration_date": "2012-10-01",
+            "codename": "Natty Narwhal",
+            "version": "11.04",
+            "release_date": "2011-04-28",
+            "distro": 3
+        }
+    },
+    {
+        "pk": 11,
+        "model": "distro.distrorelease",
+        "fields": {
+            "expiration_date": "2013-04-01",
+            "codename": "Oneiric Ocelot",
+            "version": "11.10",
+            "release_date": "2011-10-13",
+            "distro": 3
+        }
+    },
+    {
+        "pk": 12,
+        "model": "distro.distrorelease",
+        "fields": {
+            "expiration_date": "2017-04-01",
+            "codename": "Precise Pangolin",
+            "version": "12.04",
+            "release_date": "2012-04-26",
+            "distro": 3
+        }
+    }
+]
\ No newline at end of file

=== modified file 'lang/models.py'
--- lang/models.py	2012-09-20 02:08:20 +0000
+++ lang/models.py	2012-10-19 13:46:19 +0000
@@ -1,3 +1,11 @@
 from django.db import models
 
-# Create your models here.
+CF_MAX_LENGTH = 500
+
+class ProgrammingLang(models.Model):
+	language_name = models.CharField(max_length=CF_MAX_LENGTH)
+	translator = models.URLField(max_length=CF_MAX_LENGTH)
+
+class LanguageNamespace(models.Model):
+	language = models.ForeignKey(ProgrammingLang)
+	namespace = models.ForeignKey('api.Namespace')

=== modified file 'support/models.py'
--- support/models.py	2012-09-20 02:08:20 +0000
+++ support/models.py	2012-10-19 13:46:19 +0000
@@ -1,3 +1,24 @@
 from django.db import models
 
-# Create your models here.
+CF_MAX_LENGTH = 500
+
+class RelatedQuestion(models.Model):
+	node = models.ForeignKey('api.Node')
+	question_text = models.CharField(max_length=CF_MAX_LENGTH)
+	question_url = models.URLField(max_length=CF_MAX_LENGTH)
+
+class RelatedTutorial(models.Model):
+	node = models.ForeignKey('api.Node')
+	tutorial_name = models.CharField(max_length=CF_MAX_LENGTH)
+	tutorial_url = models.URLField(max_length=CF_MAX_LENGTH)
+
+class RelatedSnippets(models.Model):
+	node = models.ForeignKey('api.Node')
+	snippet_name = models.CharField(max_length=CF_MAX_LENGTH)
+	snippet_code = models.TextField()
+
+class RelatedImage(models.Model):
+	node = models.ForeignKey('api.Node')
+	image_name = models.CharField(max_length=CF_MAX_LENGTH)
+	image_caption = models.CharField(max_length=CF_MAX_LENGTH)
+	image_url = models.URLField(max_length=CF_MAX_LENGTH)

=== added file 'templates/distro.html'
--- templates/distro.html	1970-01-01 00:00:00 +0000
+++ templates/distro.html	2012-10-19 13:46:19 +0000
@@ -0,0 +1,16 @@
+{% extends "base.html" %}
+
+{% block title %}Distro Overview {% endblock %}
+
+{% block content %}
+
+<h2>{{ distro.name }}</h2><a href="{{ distro.website }}">{{ distro.website }}</a>
+<p>{{ distro.description }}</p>
+
+<ul>
+   {% for release in releases %}
+	<li><a href="{% url distro.views.releaseview distro.name release.version %}">{{ release.version }} ({{ release.codename }})</a></li>
+  {% endfor %}
+</ul>
+
+{% endblock %}

=== added file 'templates/index.html'
--- templates/index.html	1970-01-01 00:00:00 +0000
+++ templates/index.html	2012-10-19 13:46:19 +0000
@@ -0,0 +1,15 @@
+{% extends "base.html" %}
+
+{% block title %}API Index {% endblock %}
+
+{% block content %}
+
+<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque nec nisl id metus tempor imperdiet. Integer hendrerit purus eget risus feugiat auctor. Aenean eget mi tincidunt velit ornare gravida et sed urna. Nulla facilisi. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Aliquam aliquam nibh eget massa tincidunt porttitor. Aenean et ornare turpis.</p>
+
+<ul>
+   {% for distro in distros %}
+	<li><a href="{% url distro.views.distroview distro.name %}">{{ distro.name }}</a></li>
+  {% endfor %}
+</ul>
+
+{% endblock %}

=== added file 'templates/release.html'
--- templates/release.html	1970-01-01 00:00:00 +0000
+++ templates/release.html	2012-10-19 13:46:19 +0000
@@ -0,0 +1,15 @@
+{% extends "base.html" %}
+
+{% block title %}Release Overview {% endblock %}
+
+{% block content %}
+
+<h2>{{ distro.name }} {{ release.version }}</h2>
+
+<ul>
+   {% for platform_item in platform_items %}
+	{{ platform_item }}
+  {% endfor %}
+</ul>
+
+{% endblock %}

=== modified file 'urls.py'
--- urls.py	2012-02-23 02:07:50 +0000
+++ urls.py	2012-10-19 13:46:19 +0000
@@ -9,7 +9,8 @@
     # Examples:
     # url(r'^$', 'gnome_developer_network.views.home', name='home'),
     # url(r'^gnome_developer_network/', include('gnome_developer_network.foo.urls')),
-    url(r'^api/', include('api.urls')),
+    url(r'^api/', include('distro.urls')),
+    url(r'^all/', include('api.urls')),
 
     # Uncomment the admin/doc line below to enable admin documentation:
     # url(r'^admin/doc/', include('django.contrib.admindocs.urls')),