Initial commit

Costs, Services, and Goods models and relationships.

.gitignore

@@ -0,0 +1,2 @@
+*.pyc
+db.sqlite3

costs/admin.py

@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.

costs/models.py

@@ -0,0 +1,71 @@
+from django.conf import settings
+from django.core.exceptions import ValidationError
+from django.db import models
+
+from .validators import less_than_one
+
+
+class AbstractItem(models.Model):
+    name = models.CharField(max_length=130)
+    description = models.TextField(blank=True)
+
+    class Meta:
+        abstract = True
+
+
+class Cost(AbstractItem):
+    """ A monthtly cost we have to pay
+    """
+    price = models.PositiveIntegerField()
+
+    def used(self):
+        sharing_costs = CostUse.objects.filter(resource=self)
+        existing_uses_sum = sum(
+            sharing_costs.values_list('share', flat=True))
+
+        return existing_uses_sum
+
+
+class Good(AbstractItem):
+    """ A good, which replacement is provisioned
+    """
+    price = models.PositiveIntegerField()
+    provisioning_duration = models.PositiveSmallIntegerField(
+        choices=settings.PROVISIONING_DURATIONS)
+
+
+class AbstractUse(models.Model):
+    share = models.FloatField(validators=[less_than_one])
+    service = models.ForeignKey('Service')
+
+    class Meta:
+        abstract = True
+
+    def clean(self):
+        if (self.resource.used() + self.share) > 1:
+            raise ValidationError(
+                "Cannot use more than 100% of {})".format(self.resource))
+
+
+class CostUse(AbstractUse):
+    resource = models.ForeignKey(Cost)
+
+
+class GoodUse(AbstractUse):
+    resource = models.ForeignKey(Good)
+
+
+class Service(AbstractItem):
+    """ A service we sell
+
+    (considered monthly)
+    """
+    costs = models.ManyToManyField(
+        Cost,
+        through=CostUse,
+        related_name='using_services')
+    goods = models.ManyToManyField(
+        Good,
+        through=GoodUse,
+        related_name='using_services')
+    # services = models.ManyToMany('Service') #TODO

costs/tests/test_models.py

@@ -0,0 +1,71 @@
+from django.test import TestCase
+from django.core.exceptions import ValidationError
+
+from ..models import Service, Cost, CostUse
+
+
+class AbstractUseTests(TestCase):
+    """ Testing AbstractUseTests through CostUse
+    """
+    def setUp(self):
+        self.hosting_service = Service.objects.create(
+            name='Physical hosting')
+        self.mailbox_service = Service.objects.create(
+            name='Mailbox')
+
+        self.datacenter_cost = Cost.objects.create(
+            name='Datacenter', price=100)
+
+    def test_can_add_service_share(self):
+        use = CostUse(
+            service=self.hosting_service,
+            resource=self.datacenter_cost,
+            share=0.4)
+
+        use.full_clean()
+        use.save()
+
+    def test_cannot_add_excess_share_one(self):
+        use = CostUse(
+            service=self.hosting_service,
+            resource=self.datacenter_cost,
+            share=1.1)
+
+        with self.assertRaises(ValidationError):
+            use.full_clean()
+            use.save()
+
+    def test_add_several_service_share(self):
+        u1 = CostUse(
+            service=self.hosting_service,
+            resource=self.datacenter_cost,
+            share=0.4)
+
+        u1.full_clean()
+        u1.save()
+
+        u2 = CostUse(
+            service=self.mailbox_service,
+            resource=self.datacenter_cost,
+            share=0.6)
+
+        u2.full_clean()
+        u2.save()
+
+    def test_add_several_service_share_excessive_sum(self):
+        u1 = CostUse(
+            service=self.hosting_service,
+            resource=self.datacenter_cost,
+            share=0.5)
+
+        u1.full_clean()
+        u1.save()
+
+        u2 = CostUse(
+            service=self.mailbox_service,
+            resource=self.datacenter_cost,
+            share=0.6)
+
+        with self.assertRaises(ValidationError):
+            u2.full_clean()
+            u2.save()

costs/validators.py

@@ -0,0 +1,7 @@
+from django.core.exceptions import ValidationError
+
+
+def less_than_one(value):
+    if value > 1:
+        raise ValidationError('Should be less than {}'.format(value))
+    return value

costs/views.py

@@ -0,0 +1,3 @@
+from django.shortcuts import render
+
+# Create your views here.

manage.py

@@ -0,0 +1,10 @@
+#!/usr/bin/env python
+import os
+import sys
+
+if __name__ == "__main__":
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "transparency.settings")
+
+    from django.core.management import execute_from_command_line
+
+    execute_from_command_line(sys.argv)

transparency/settings.py

@@ -0,0 +1,113 @@
+"""
+Django settings for transparency project.
+
+Generated by 'django-admin startproject' using Django 1.8.1.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/1.8/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/1.8/ref/settings/
+"""
+
+# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
+import os
+
+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.8/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = 'ii4gn&9@es!fny$c)-@@$#ynrzjgz&ssdp+9en1u0dpr@n^+h-'
+
+# 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',
+    'costs',
+)
+
+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',
+    'django.middleware.security.SecurityMiddleware',
+)
+
+ROOT_URLCONF = 'transparency.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 = 'transparency.wsgi.application'
+
+
+# Database
+# https://docs.djangoproject.com/en/1.8/ref/settings/#databases
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.sqlite3',
+        'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
+    }
+}
+
+
+# Internationalization
+# https://docs.djangoproject.com/en/1.8/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.8/howto/static-files/
+
+STATIC_URL = '/static/'
+
+## Non-technic Specifics
+
+
+import datetime
+
+PROVISIONING_DURATIONS = [
+    (36, datetime.timedelta(days=365)),
+    (60, datetime.timedelta(days=365))
+]

transparency/urls.py

@@ -0,0 +1,21 @@
+"""transparency URL Configuration
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/1.8/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')
+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')
+Including another URLconf
+    1. Add an import:  from blog import urls as blog_urls
+    2. Add a URL to urlpatterns:  url(r'^blog/', include(blog_urls))
+"""
+from django.conf.urls import include, url
+from django.contrib import admin
+
+urlpatterns = [
+    url(r'^admin/', include(admin.site.urls)),
+]

transparency/wsgi.py

@@ -0,0 +1,16 @@
+"""
+WSGI config for transparency project.
+
+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.8/howto/deployment/wsgi/
+"""
+
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "transparency.settings")
+
+application = get_wsgi_application()