add user and request + test (#179)

* add user and request + test

* fix

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix

* add foreign key

* fix

* fix

* fix

* fix for adding ner user

* change type to string

* update to use uuid

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* add migrations

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: peterdudfield

nowcasting_datamodel/migrations/forecast/versions/d92996388b65_.py

@@ -0,0 +1,52 @@
+"""empty message
+
+Revision ID: d92996388b65
+Revises: caea7b5cf249
+Create Date: 2023-05-11 15:07:43.373248
+
+"""
+import sqlalchemy as sa
+from alembic import op
+from sqlalchemy.dialects import postgresql
+
+# revision identifiers, used by Alembic.
+revision = "d92996388b65"
+down_revision = "caea7b5cf249"
+branch_labels = None
+depends_on = None
+
+
+def upgrade():  # noqa
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table(
+        "user",
+        sa.Column(
+            "uuid", postgresql.UUID(), server_default=sa.text("gen_random_uuid()"), nullable=False
+        ),
+        sa.Column("email", sa.String(), nullable=True),
+        sa.PrimaryKeyConstraint("uuid"),
+    )
+    op.create_table(
+        "api_request",
+        sa.Column("created_utc", sa.DateTime(timezone=True), nullable=True),
+        sa.Column(
+            "uuid", postgresql.UUID(), server_default=sa.text("gen_random_uuid()"), nullable=False
+        ),
+        sa.Column("url", sa.String(), nullable=True),
+        sa.Column("user_uuid", postgresql.UUID(), nullable=True),
+        sa.ForeignKeyConstraint(
+            ["user_uuid"],
+            ["user.uuid"],
+        ),
+        sa.PrimaryKeyConstraint("uuid"),
+    )
+    op.create_index(op.f("ix_api_request_user_uuid"), "api_request", ["user_uuid"], unique=False)
+    # ### end Alembic commands ###
+
+
+def downgrade():  # noqa
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_index(op.f("ix_api_request_user_uuid"), table_name="api_request")
+    op.drop_table("api_request")
+    op.drop_table("user")
+    # ### end Alembic commands ###

nowcasting_datamodel/models/__init__.py

@@ -20,6 +20,7 @@
 The primary keys could be 'gsp_id' and 'target_datetime_utc'.
 """
 
+from .api import *  # noqa F403
 from .forecast import *  # noqa F403
 from .gsp import *  # noqa F403
 from .metric import *  # noqa F403

nowcasting_datamodel/models/api.py

@@ -0,0 +1,80 @@
+""" Pydantic and Sqlalchemy models for the database
+
+The following class are made
+1. User
+2. APIRequest
+
+"""
+
+from typing import Optional
+
+from pydantic import Field
+from sqlalchemy import (
+    Column,
+    ForeignKey,
+    String,
+    func,
+)
+from sqlalchemy.dialects.postgresql import UUID
+from sqlalchemy.orm import relationship
+
+from nowcasting_datamodel.models.base import Base_Forecast
+from nowcasting_datamodel.models.utils import CreatedMixin, EnhancedBaseModel
+
+
+########
+# 1. User
+########
+class UserSQL(Base_Forecast):
+    """ML model that is being used"""
+
+    __tablename__ = "user"
+
+    uuid = Column(UUID, primary_key=True, server_default=func.gen_random_uuid())
+    email = Column(String)
+
+    api_request = relationship("APIRequestSQL", back_populates="user")
+
+
+class User(EnhancedBaseModel):
+    """ML model that is being used"""
+
+    email: Optional[str] = Field(..., description="The name of the model", index=True)
+
+    def to_orm(self) -> UserSQL:
+        """Change model to MLModelSQL"""
+        return UserSQL(
+            email=self.email,
+        )
+
+
+########
+# 2. APIRequest
+########
+class APIRequestSQL(Base_Forecast, CreatedMixin):
+    """Information about what API route was called"""
+
+    __tablename__ = "api_request"
+
+    uuid = Column(UUID, primary_key=True, server_default=func.gen_random_uuid())
+    url = Column(String)
+
+    user_uuid = Column(UUID, ForeignKey("user.uuid"), index=True)
+    user = relationship("UserSQL", back_populates="api_request")
+
+
+class APIRequest(EnhancedBaseModel):
+    """Information about the input data that was used to create the forecast"""
+
+    url: str = Field(..., description="The url that was called")
+    user: Optional[User] = Field(
+        None,
+        description="The user associated with this api call",
+    )
+
+    def to_orm(self) -> APIRequestSQL:
+        """Change model to APIRequestSQL"""
+        return APIRequestSQL(
+            url=self.url,
+            user=self.user.to_orm() if self.user is not None else None,
+        )

nowcasting_datamodel/read/read_user.py

@@ -0,0 +1,42 @@
+""" Read user"""
+import logging
+
+from sqlalchemy.orm.session import Session
+
+from nowcasting_datamodel.models.api import UserSQL
+
+logger = logging.getLogger(__name__)
+
+
+def get_user(session: Session, email: str) -> UserSQL:
+    """
+    Get metric object from database
+
+    :param session: database session
+    :param email: email of user
+
+    return: One Metric SQl object
+
+    """
+
+    # start main query
+    query = session.query(UserSQL)
+
+    # filter on name
+    query = query.filter(UserSQL.email == email)
+
+    # get all results
+    users = query.all()
+
+    if len(users) == 0:
+        logger.debug(f"User for name {email} does not exist so going to add it")
+
+        user = UserSQL(email=email)
+
+        session.add(user)
+        session.commit()
+
+    else:
+        user = users[0]
+
+    return user

tests/read/test_read_user.py

@@ -0,0 +1,19 @@
+from nowcasting_datamodel.models import UserSQL
+from nowcasting_datamodel.read.read_user import get_user
+
+
+def test_get_user(db_session):
+    db_session.add(UserSQL(email="[email protected]"))
+
+    user = get_user(session=db_session, email="[email protected]")
+    assert user.email == "[email protected]"
+    assert len(db_session.query(UserSQL).all()) == 1
+
+
+def test_get_new_metric(db_session):
+    assert len(db_session.query(UserSQL).all()) == 0
+
+    _ = get_user(session=db_session, email="[email protected]")
+    user = get_user(session=db_session, email="[email protected]")
+    assert user.email == "[email protected]"
+    assert len(db_session.query(UserSQL).all()) == 1