models.py

# -*- coding: utf-8 -*-
"""All the models for muckamuchk
"""

import datetime
import json

import os
from passlib.hash import bcrypt
from peewee import *
import unittest

import utilities
#utilities.logger.info('log message')

####################################################
# Config
####################################################

OUTPUT_PATHS = {}
OUTPUT_PATHS['root'] = os.environ['MUCKAMUCK_OUTPUT_DIRECTORY']

OUTPUT_PATHS['audio'] = os.path.join(OUTPUT_PATHS['root'], "audio")
OUTPUT_PATHS['css'] = os.path.join(OUTPUT_PATHS['root'], "css")
OUTPUT_PATHS['hbs'] = os.path.join(OUTPUT_PATHS['root'], "hbs")
OUTPUT_PATHS['img'] = os.path.join(OUTPUT_PATHS['root'], "img")

OUTPUT_PATHS['js'] = os.path.join(OUTPUT_PATHS['root'], "js")

OUTPUT_PATHS['json'] = os.path.join(OUTPUT_PATHS['root'], "json")
OUTPUT_PATHS['json_site'] = os.path.join(OUTPUT_PATHS['json'], "site")
OUTPUT_PATHS['json_system'] = os.path.join(OUTPUT_PATHS['json'], "system")
OUTPUT_PATHS['json_user'] = os.path.join(OUTPUT_PATHS['json'], "user")

OUTPUT_PATHS['site'] = os.path.join(OUTPUT_PATHS['root'], "site")
OUTPUT_PATHS['site_domain'] = os.path.join(OUTPUT_PATHS['site'], "domain")
OUTPUT_PATHS['site_id'] = os.path.join(OUTPUT_PATHS['site'], "id")


####################################################
# Misc Helpers
####################################################


####################################################
# Database Connection
####################################################

db = MySQLDatabase(os.environ['MUCKAMUCK_DB_NAME'], host=os.environ['MUCKAMUCK_DB_HOST'], user=os.environ[
                                     'MUCKAMUCK_DB_USER_NAME'], password=os.environ['MUCKAMUCK_DB_USER_PASSWORD'])
"""Initialize database connection with database connection values from env variables
"""


####################################################
# Base Model
####################################################


class BaseModel(Model):
        """This is the base model class that all other models inherit
        """
        class Meta:
                """All models use same db
                """
                database = db


####################################################
# User Model
####################################################
class User(BaseModel):
    """This is the User model.

    Attributes:
            created_date (datetime): When user was created.

            email (str): User email.

            password (str): encrypted and salted password.

            public_email (str): Publicly accessible user email.

            name (str): Publicly accessible user name.

            bio (str): Publicly accessible user bio.

            twitter (str):    Publicly accessible user twitter ID.

            facebook (str): Publicly accessible user facebook ID.

            google (str):    Publicly accessible user googl ID.

            customer_id (str): User customer is for billing.

            uuid (str): A universally unique identifier assigned to user.


    """
    created_date = DateTimeField(default=datetime.datetime.now)
    email = CharField(index=True, unique=True)
    password = CharField(null=True)
    public_email = CharField(default="")
    name = CharField(default="")
    bio = CharField(default="")
    twitter = CharField(default="")
    facebook = CharField(default="")
    google = CharField(default="")
    customer_id = CharField(default="")
    uuid = CharField(index=True)


    @property
    def json_path(self):
            path = os.path.join(utilities.get_output_json_path(), "user", self.uuid)
            return path

    def write_to_disk(self):
        """Writes json to disk
        """
        self.make_dir()
        user_dict = self.to_dict()
        file_object = open(self.get_json_path(), "wb")
        file_object.write(utilities.jsonifyer(user_dict))
        file_object.close()


    def encrypt_password(self, password):
        """Generates a hashes and salted password.

        Note:
                Hashed password is assigned to password.

        Args:
                password (str): The plain text password entered by human
        """
        self.password = bcrypt.encrypt(password)

    def verify_password(self, password):
        """Validated a submitted password.

        Args:
                password (str): The plain text password entered by human

        Returns:
                True if successful, False otherwise.
        """
        return bcrypt.verify(password, self.password)

    def to_dict(self):
        """Creats dictionary with private info redacted.


        Returns:
                Dictionary
        """
        userDict = {}
        userDict["created_date"] = self.created_date.isoformat()
        userDict["email"] = self.public_email
        userDict["name"] = self.name
        userDict["uuid"] = self.uuid
        userDict["bio"] = self.bio
        userDict["twitter"] = self.twitterID
        userDict["facebook"] = self.facebookID
        userDict["google"] = self.googleID
        return userDict

    def make_dir(self):
        """bla bla.
        """
        utilities.make_dir(self.get_user_dir_path())

    def get_user_dir_path(self):
        """bla bla.
        """
        return os.path.join(OUTPUT_PATHS.get("json_user"), self.uuid)

    def get_json_path(self):
        """bla bla.
        """
        return os.path.join(self.get_user_dir_path(), "about.json")

    def write_json(self):
        """bla bla.
        """
        self.make_dir()
        user_dict = self.to_dict()
        file_object = open(self.get_json_path(), "wb")
        file_object.write(utilities.jsonifyer(user_dict))
        file_object.close()


def create_dummy_user():
    """Generats a utilities.fake user.

    Yields:
            User: One utilities.fake user.
    """
    user = User()
    user.uuid = utilities.generate_UUID()
    user.email = utilities.fake.free_email()
    user.encrypt_password(utilities.fake.password())
    user.name = utilities.fake.name()
    user.public_email = utilities.fake.free_email()
    user.bio = utilities.fake.text()
    user.twitterID = utilities.generate_UUID()
    user.facebookID = utilities.generate_UUID()
    user.googleID = utilities.generate_UUID()
    return user


####################################################
# Site Model
####################################################
json_site_subdirs = ["archive", "category", "page", "post", "tag"]


class Site(BaseModel):
    """This is the Site model.

    Attributes:
            created_date (datetime): When site was created.

            description (str): Site description.

            domain (str): active domain name.

            language (str): Site language. Defaults to en-us.

            owner (User): User that owns site.

            subscription_level (str): Customer subscription level.

            title (str):    Name of site.

            uuid (str): A universally unique identifier assigned to site.


    """
    created_date = DateTimeField(default=datetime.datetime.now)
    description = CharField(null=True)
    domain = CharField(unique=True)
    language = CharField(default="en-us")
    owner = ForeignKeyField(User)
    subscription_level = CharField(default="free", index=True)
    title = CharField()
    uuid = CharField(index=True)


    def to_dict(self):
        """Creats dictionary with private info redacted.

        Returns:
                Dictionary
        """
        siteDict = {}
        siteDict["created_date"] = self.created_date.isoformat()
        siteDict["description"] = self.description
        siteDict["domain"] = self.domain
        siteDict["language"] = self.language
        siteDict["owner"] = self.owner.uuid
        siteDict["subscription_level"] = self.subscription_level
        siteDict["title"] = self.title
        siteDict["uuid"] = self.uuid
        return siteDict

    def get_site_dir_path(self):
        """bla bla.
        """
        return os.path.join(OUTPUT_PATHS.get("json_site"), self.uuid)

    def get_site_dir_subdir_path(self, dir_name):
        """bla bla.
        """
        return os.path.join(OUTPUT_PATHS.get("json_site"), self.uuid, dir_name)

    def make_dir(self):
        """bla bla.
        """
        utilities.make_dir(self.get_site_dir_path())
        for subdir in json_site_subdirs:
            utilities.make_dir(self.get_site_dir_subdir_path(subdir))

    def get_json_path(self):
        """bla bla.
        """
        return os.path.join(self.get_site_dir_path(), "about.json")

    def write_json(self):
        """bla bla.
        """
        self.make_dir()
        user_dict = self.to_dict()
        file_object = open(self.get_json_path(), "wb")
        file_object.write(utilities.jsonifyer(user_dict))
        file_object.close()


def create_dummy_site():
    """Generats a utilities.fake site.

    Yields:
        Site: One utilities.fake site.
    """
    user = create_dummy_user()
    user.save()
    site = Site()
    site.description = utilities.fake.text(max_nb_chars=200)
    site.domain = utilities.fake.domain_name()
    site.owner = user
    site.title = utilities.fake.sentence(nb_words=6, variable_nb_words=True)
    site.uuid = utilities.generate_UUID()
    return site